Support undefined, number, and object in JSON module#3980
Open
mario-campos wants to merge 5 commits into
Open
Conversation
The previous implementation of `optional` is now `optionalOrNull`.
Contributor
There was a problem hiding this comment.
Warning
- Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.
Pull request overview
This PR extends the internal JSON schema-validation helpers to better distinguish “optional” vs “optional-or-null” fields, and to add first-class validators for number and object. It also updates start-proxy configuration schemas to use the new optionalOrNull semantics and adjusts unit tests accordingly.
Changes:
- Introduces
isNumber, plusjson.numberandjson.objectvalidators. - Renames the old “optional (undefined or null)” behavior to
optionalOrNulland redefinesoptionalto mean “undefined-only”. - Updates start-proxy schemas and unit tests to reflect the new optional semantics.
Show a summary per file
| File | Description |
|---|---|
| src/start-proxy/types.ts | Switches relevant schema fields from optional to optionalOrNull for backwards-compatible null acceptance. |
| src/json/index.ts | Adds number/object validators and splits optional handling into optionalOrNull vs optional. |
| src/json/index.test.ts | Updates/expands tests to cover the new optional semantics (optionalOrNull vs optional). |
| lib/entry-points.js | Generated output (content excluded from review per policy). |
Review details
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 3/4 changed files
- Comments generated: 3
- Review effort level: Low
Comment on lines
+63
to
+67
| /** A validator for number fields in schemas. */ | ||
| export const number = { | ||
| validate: isNumber, | ||
| required: true, | ||
| } as const satisfies Validator<number>; |
Using `unknown` meant that the validated object would not be indexable because its type would devolve to `{}`
Because `NaN` and Infinity are not representable in JSON. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This pull request introduces several additions to the JSON schema-validation utilities:
optionalvalidator tooptionalOrNullto clarify that schema fields may be optional and acceptnullas a valid value, in addition toundefined.optionalvalidator so that it only acceptsundefined(notnull), making its behavior more precise and distinct fromoptionalOrNull.numberandobjecttypes.isNumbertype guard function for type checking.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist