feat: support function validators for environment variables#16402
Conversation
|
Install the latest version of pnpm add https://pkg.svelte.dev/@sveltejs/kit/c/b22bc56f3fc83e2d2df1043ff3927bc35082d373Open in Note This PR is from a fork. A maintainer must approve approve each commit before it can be built and installed. |
🦋 Changeset detectedLatest commit: b22bc56 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
6cc8480 to
9e6d8dd
Compare
…#16403) `normalize_param_definition` checks for a function before checking for `~standard`, but standard schemas can themselves be callable. ArkType's `type()` returns one, so it gets wrapped as a plain function matcher and its own validation never runs. The wrapper then treats whatever the call returns as the parsed value, and ArkType returns an `ArkErrors` instance rather than throwing: ```js const matcher = normalize_param_definition(type('string.numeric')); matcher['~standard'].validate('not-a-number'); // { value: ArkErrors } so the route matches, with an ArkErrors instance as the param ``` Checking `~standard` first fixes this, verified against arktype 2.x (invalid values now produce `issues`, so the route no longer matches). It also matches `ParamEntry` in `public.d.ts`, which has resolved callable schemas to the schema branch since #16189. Same discriminator fix as #16402. The new test fails on `version-3`. --- ### Please don't delete this checklist! Before submitting the PR, please make sure you do the following: - [x] It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs - [x] This message body should clearly illustrate what problems it solves. - [x] Ideally, include a test that fails without this PR but passes with it. ### Tests - [x] Run the tests with `pnpm test` and lint the project with `pnpm lint` and `pnpm check` ### Changesets - [x] If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running `pnpm changeset` and following the prompts. Changesets that add features should be `minor` and those that fix bugs should be `patch`. Please prefix changeset messages with `feat:`, `fix:`, or `chore:`. ### Edits - [x] Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.
Rich-Harris
left a comment
There was a problem hiding this comment.
Thank you. I think it needs to be possible to return undefined, otherwise there's no way to describe something as optional (without providing a fallback value, which isn't always desirable). Unlike params, there's no fall-through here — the choice isn't between returning a value, throwing an error or trying the next match (by returning undefined), it's only between returning and throwing.
…ion-validators # Conflicts: # packages/kit/src/exports/internal/env.spec.js
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to version-3, this PR will be updated.⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ `version-3` is currently in **pre mode** so this branch has prereleases rather than normal releases. If you want to exit prereleases, run `changeset pre exit` on `version-3`.⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ # Releases ## @sveltejs/[email protected] ### Major Changes - breaking: `config` exported from a universal route file takes precedence over a server one ([#16400](#16400)) - breaking: consistent special filename patterns ([#16382](#16382)) ### Minor Changes - feat: support sourcemaps in production ([#16412](#16412)) - feat: support function validators for environment variables ([#16402](#16402)) - feat: better error logging ([#16374](#16374)) ### Patch Changes - fix: don't treat callable standard schemas as function param matchers ([#16403](#16403)) - fix: reject malformed streamed data encoding ([#16423](#16423)) - fix: hide stack traces for internal errors like 404s ([#16411](#16411)) - perf: match only unpaired surrogates when escaping HTML ([#16407](#16407)) - fix: don't report empty environment variables as missing ([#16401](#16401)) - chore: clarify which hooks run during server route resolution ([#16397](#16397)) ## @sveltejs/[email protected] ### Minor Changes - feat: better error logging ([#16374](#16374)) ### Patch Changes - Updated dependencies [[`5220191`](5220191), [`8cb2f7d`](8cb2f7d), [`b88c7a7`](b88c7a7), [`a6ea113`](a6ea113), [`6446f64`](6446f64), [`58f1789`](58f1789), [`09774a2`](09774a2), [`c542fdd`](c542fdd), [`aedaa27`](aedaa27), [`428ee1a`](428ee1a), [`fefb3ae`](fefb3ae)]: - @sveltejs/[email protected] Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
As invited in #16195,
defineEnvVarsnow accepts a function in place of a Standard Schema. The contract mirrorsdefineParams: the function returns the (possibly transformed) value, orundefinedif the value is invalid. It can also throw, in which case the error's message appears in the startup report, since a bareundefinedcan't carry one.Throwing is the only rejection path, returning any value including
undefinedaccepts it, so a function validator can describe an optional variable without a fallback.defineEnvVarsnormalizes functions to standard schemas, sovalidateand the generatedenv.d.tstypes are unchanged (the return type is mapped likeDefinedParams). Also adds the@sveltejs/kit/envtsconfig paths entry that #16378 didn't need yet.Built on top of #16401.
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits