Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-02-03 22:29:08 -05:00
Code Issues Activity

feat: improve astro:env config error (#12912)

Browse source 
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
This commit is contained in:
Florian Lefebvre 2025-01-08 14:29:01 +01:00 • committed by GitHub
parent 44841fc281
commit 0c0c66bf0d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 43 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/curvy-readers-invent.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Improves the config error for invalid combinations of `context` and `access` properties under `env.schema`

19
packages/astro/src/env/schema.ts vendored
View file

@ -75,11 +75,28 @@ const SecretServerEnvFieldMetadata = z.object({
context: z.literal('server'),
access: z.literal('secret'),
});
const EnvFieldMetadata = z.union([
const _EnvFieldMetadata = z.union([
PublicClientEnvFieldMetadata,
PublicServerEnvFieldMetadata,
SecretServerEnvFieldMetadata,
]);
const EnvFieldMetadata = z.custom<z.input<typeof _EnvFieldMetadata>>().superRefine((data, ctx) => {
const result = _EnvFieldMetadata.safeParse(data);
if (result.success) {
return;
}
for (const issue of result.error.issues) {
if (issue.code === z.ZodIssueCode.invalid_union) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
message: `**Invalid combination** of "access" and "context" options:\n Secret client variables are not supported. Please review the configuration of \`env.schema.${ctx.path.at(-1)}\`.\n Learn more at https://docs.astro.build/en/guides/environment-variables/#variable-types`,
path: ['context', 'access'],
});
} else {
ctx.addIssue(issue);
}
}
});
const EnvSchemaKey = z
.string()

20
packages/astro/test/units/config/config-validate.test.js
View file

@ -406,5 +406,25 @@ describe('Config Validation', () => {
'A valid variable name cannot start with a number.',
);
});
it('Should provide a useful error for access/context invalid combinations', async () => {
const configError = await validateConfig(
{
env: {
schema: {
BAR: envField.string({ access: 'secret', context: 'client' }),
},
},
},
process.cwd(),
).catch((err) => err);
assert.equal(configError instanceof z.ZodError, true);
assert.equal(
configError.errors[0].message.includes(
'**Invalid combination** of "access" and "context" options',
),
true,
);
});
});
});