Validate env vars with Zod #2362
+4,315
−3,812
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| {{={= =}=}} | ||
| import * as z from 'zod' | ||
|
|
||
| import { ensureEnvSchema } from '../env/index.js' | ||
|
|
||
| const clientEnvSchema = z.object({ | ||
| REACT_APP_API_URL: z | ||
| .string({ | ||
| required_error: 'REACT_APP_API_URL is required', | ||
| }) | ||
| .default('{= defaultServerUrl =}') | ||
| }) | ||
|
|
||
| export const env = ensureEnvSchema(import.meta.env, clientEnvSchema) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import * as z from 'zod' | ||
|
|
||
| const redColor = '\x1b[31m' | ||
|
|
||
| export function ensureEnvSchema<Schema extends z.ZodTypeAny>( | ||
| data: unknown, | ||
| schema: Schema | ||
| ): z.infer<Schema> { | ||
| try { | ||
| return schema.parse(data) | ||
| } catch (e) { | ||
| // TODO: figure out how to output the error message in a better way | ||
infomiho marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (e instanceof z.ZodError) { | ||
| console.error() | ||
| console.error(redColor, '╔═════════════════════════════╗'); | ||
| console.error(redColor, '║ Env vars validation failed ║'); | ||
| console.error(redColor, '╚═════════════════════════════╝'); | ||
| console.error() | ||
| for (const error of e.errors) { | ||
| console.error(redColor, `- ${error.message}`) | ||
| } | ||
| console.error() | ||
| console.error(redColor, '═══════════════════════════════'); | ||
| throw new Error('Error parsing environment variables') | ||
| } else { | ||
| throw e | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // Used for internal Wasp development only, not copied to generated app. | ||
| module.exports = { | ||
sodic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| trailingComma: 'es5', | ||
| tabWidth: 2, | ||
| semi: false, | ||
| singleQuote: true, | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,19 @@ | ||
| import { OAuth2Provider, OAuth2ProviderWithPKCE } from "arctic"; | ||
|
|
||
| export function defineProvider< | ||
| OAuthClient extends OAuth2Provider | OAuth2ProviderWithPKCE | ||
| >({ | ||
| id, | ||
| displayName, | ||
| oAuthClient, | ||
| }: { | ||
| id: string; | ||
| displayName: string; | ||
|
There was a problem hiding this comment. Instead of OAuth env vars having their special validation and living in a special place, they are now used directly from the |
||
| oAuthClient: OAuthClient; | ||
| }) { | ||
| return { | ||
| id, | ||
| displayName, | ||
| oAuthClient, | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,47 @@ | ||
| {{={= =}=}} | ||
| import { env } from './env.js' | ||
| import { stripTrailingSlash } from '../universal/url.js' | ||
|
|
||
| type NodeEnv = typeof env.NODE_ENV | ||
|
|
||
| type Config = { | ||
| env: NodeEnv; | ||
| isDevelopment: boolean; | ||
| port: number; | ||
| databaseUrl: string; | ||
| frontendUrl: string; | ||
| serverUrl: string; | ||
| allowedCORSOrigins: string | string[]; | ||
| {=# isAuthEnabled =} | ||
| auth: { | ||
| jwtSecret: string; | ||
| } | ||
| {=/ isAuthEnabled =} | ||
| } | ||
|
|
||
| const frontendUrl = stripTrailingSlash(env.WASP_WEB_CLIENT_URL) | ||
| const serverUrl = stripTrailingSlash(env.WASP_SERVER_URL) | ||
|
|
||
| const allowedCORSOriginsPerEnv: Record<NodeEnv, string | string[]> = { | ||
|
There was a problem hiding this comment. Default CORS values per NODE_ENV, same as before. |
||
| development: '*', | ||
| production: [frontendUrl] | ||
| } | ||
| const allowedCORSOrigins = allowedCORSOriginsPerEnv[env.NODE_ENV] | ||
|
|
||
| const config: Config = { | ||
|
There was a problem hiding this comment. Simplified the creation of the There was a problem hiding this comment. Do we loose anyting this way? Anythihg int he old appraoch that was beneficial from having that split? Why was that split there otherwise, I do think it had some benefits possibly? There was a problem hiding this comment. I think the previous approach we clever since it envisioned many different options for dev and for production, but it in the end, we only vary the CORS origins between dev and production. So, it seemed like an overkill and I know I had these complex types to capture the different objects. But when I looked closer, it turned out this simple There was a problem hiding this comment. Ok, makes sense, we can always modify it if needed! |
||
| frontendUrl, | ||
| serverUrl, | ||
| allowedCORSOrigins, | ||
| env: env.NODE_ENV, | ||
| isDevelopment: env.NODE_ENV === 'development', | ||
| port: env.PORT, | ||
| databaseUrl: env.{= databaseUrlEnvVarName =}, | ||
| {=# isAuthEnabled =} | ||
| auth: { | ||
| jwtSecret: env.JWT_SECRET | ||
| } | ||
| {=/ isAuthEnabled =} | ||
| } | ||
|
|
||
| // PUBLIC API | ||
| export default config | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is that, what is wrong with dotenv? Node.js now has native support for it that is equally good?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's always nicer to use natively supported methods than a package to do the same thing. It's available since Node.js 20 and we should probably go for it when Node.js 20 becomes our minimum version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probabl make nodejs 20 our minimum version any moment hm. Ok, so it does do the same thing? If so, great.