Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable users to define their env var validations #2363

Merged
merged 19 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions examples/thoughts/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 12 additions & 2 deletions waspc/data/Generator/templates/sdk/wasp/client/env.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
{{={= =}=}}
import * as z from 'zod'

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

const clientEnvSchema = z.object({
{=# envValidationSchema.isDefined =}
{=& envValidationSchema.importStatement =}
const userClientEnvSchema = {= envValidationSchema.importIdentifier =}
{=/ envValidationSchema.isDefined =}
{=^ envValidationSchema.isDefined =}
const userClientEnvSchema = z.object({})
{=/ envValidationSchema.isDefined =}

const waspClientEnvSchema = z.object({
REACT_APP_API_URL: z
.string({
required_error: 'REACT_APP_API_URL is required',
})
.default('{= defaultServerUrl =}')
})

const clientEnvSchema = userClientEnvSchema.merge(waspClientEnvSchema)

// PUBLIC API
export const env = ensureEnvSchema(import.meta.env, clientEnvSchema)
30 changes: 8 additions & 22 deletions waspc/data/Generator/templates/sdk/wasp/env/index.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,11 @@
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) {
const errorOutput = ['', '══ Env vars validation failed ══', '']
for (const error of e.errors) {
errorOutput.push(` - ${error.message}`)
}
errorOutput.push('')
errorOutput.push('════════════════════════════════')
console.error(redColor, errorOutput.join('\n'))
throw new Error('Error parsing environment variables')
} else {
throw e
}
}
// PUBLIC API
export function defineEnvValidationSchema<Schema extends z.ZodObject<any>>(
schema: Schema,
): Schema {
return schema
}

// PRIVATE API (SDK, Vite config)
export { ensureEnvSchema } from './validation.js'
25 changes: 25 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,25 @@
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) {
const errorOutput = ['', '══ Env vars validation failed ══', '']
for (const error of e.errors) {
errorOutput.push(` - ${error.message}`)
}
errorOutput.push('')
errorOutput.push('════════════════════════════════')
console.error(redColor, errorOutput.join('\n'))
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
13 changes: 11 additions & 2 deletions waspc/data/Generator/templates/sdk/wasp/server/env.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
{{={= =}=}}
import * as z from 'zod'

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

const serverCommonSchema = z.object({
{=# envValidationSchema.isDefined =}
{=& envValidationSchema.importStatement =}
const userServerEnvSchema = {= envValidationSchema.importIdentifier =}
{=/ envValidationSchema.isDefined =}
{=^ envValidationSchema.isDefined =}
const userServerEnvSchema = z.object({})
{=/ envValidationSchema.isDefined =}

const waspServerCommonSchema = z.object({
PORT: z.coerce.number().default({= defaultServerPort =}),
{= databaseUrlEnvVarName =}: z.string({
required_error: '{= databaseUrlEnvVarName =} is required',
Expand Down Expand Up @@ -135,6 +143,7 @@ const serverProdSchema = z.object({
{=/ isAuthEnabled =}
})

const serverCommonSchema = userServerEnvSchema.merge(waspServerCommonSchema)
const serverEnvSchema = z.discriminatedUnion('NODE_ENV', [
serverDevSchema.merge(serverCommonSchema),
serverProdSchema.merge(serverCommonSchema)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import PgBoss from 'pg-boss'
import { env } from '../../../env.js'
import { config } from '../../../index.js'
import { config, env } from '../../../index.js'

const boss = createPgBoss()

Expand Down
8 changes: 8 additions & 0 deletions waspc/e2e-test/test-outputs/waspBuild-golden/files.manifest

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading