Skip to content

Commit

Permalink
Add EnvValidationFn user facing type
Browse files Browse the repository at this point in the history
  • Loading branch information
infomiho committed Oct 30, 2024
1 parent f0ffeec commit c46f961
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 33 deletions.
2 changes: 1 addition & 1 deletion waspc/data/Generator/templates/sdk/wasp/client/env.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{={= =}=}}
import * as z from 'zod'

import { ensureEnvSchema } from '../env/index.js'
import { ensureEnvSchema } from '../env/validation.js'

{=# envValidationFn.isDefined =}
{=& envValidationFn.importStatement =}
Expand Down
30 changes: 2 additions & 28 deletions waspc/data/Generator/templates/sdk/wasp/env/index.ts
Original file line number Diff line number Diff line change
@@ -1,29 +1,3 @@
import * as z from 'zod'
import type { ZodObject } 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
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
}
}
}
export type EnvValidationFn = () => ZodObject<any>
28 changes: 28 additions & 0 deletions waspc/data/Generator/templates/sdk/wasp/env/validation.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
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) {
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
}
}
}
1 change: 1 addition & 0 deletions waspc/data/Generator/templates/sdk/wasp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@
"./client/test": "./dist/client/test/index.js",
"./client": "./dist/client/index.js",
"./dev": "./dist/dev/index.js",
"./env": "./dist/env/index.js",

{=! todo(filip): Fixes below are for type errors in 0.13.1, remove ASAP =}
{=! Used by our code (SDK for full-stack type safety), uncodumented (but accessible) for users. =}
Expand Down
2 changes: 1 addition & 1 deletion waspc/data/Generator/templates/sdk/wasp/server/env.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{={= =}=}}
import * as z from 'zod'

import { ensureEnvSchema } from '../env/index.js'
import { ensureEnvSchema } from '../env/validation.js'

{=# envValidationFn.isDefined =}
{=& envValidationFn.importStatement =}
Expand Down
5 changes: 3 additions & 2 deletions waspc/examples/todoApp/src/env.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import * as z from 'zod'
import type { EnvValidationFn } from 'wasp/env'

export const serverEnvValidationFn = () =>
export const serverEnvValidationFn: EnvValidationFn = () =>
z.object({
MY_ENV_VAR: z.string({
required_error: 'MY_ENV_VAR is required.',
}),
})

export const clientEnvValidationFn = () =>
export const clientEnvValidationFn: EnvValidationFn = () =>
z.object({
REACT_APP_NAME: z.string().default('TODO App'),
})
3 changes: 2 additions & 1 deletion waspc/src/Wasp/Generator/SdkGenerator/EnvValidation.hs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ genEnvValidation spec =
sequence
[ genServerEnv spec,
genClientEnv spec,
genFileCopy [relfile|env/index.ts|]
genFileCopy [relfile|env/index.ts|],
genFileCopy [relfile|env/validation.ts|]
]
where
genFileCopy = return . C.mkTmplFd
Expand Down

0 comments on commit c46f961

Please sign in to comment.