[typescript-fetch] Remove returns in oneOf serialization code which short circuit additional type checks#21886
Open
cgual206 wants to merge 2 commits intoOpenAPITools:masterfrom
Open
Conversation
WIStudent
reviewed
Sep 5, 2025
| if (json.every(item => typeof item === 'object')) { | ||
| if (json.every(item => instanceOfTestA(item))) { | ||
| return json.map(value => TestAFromJSONTyped(value, true)); | ||
| if (json.every(item => instanceOfTestA(item as object))) { |
There was a problem hiding this comment.
Instead of using item as object we could also tell typescript that json is object[] if the condition that checks that every item is object is true:
if (json.every((item): item is object => typeof item === 'object')) {
if (json.every(item => instanceOfTestA(item))) {
// ...
}
}There was a problem hiding this comment.
Another thing: The check, that every item in the array is an object should also check that the item is not null, because typeof null also returns 'object'.
if (json.every((item): item is object => item !== null && typeof item === 'object')) {
// ...
}Otherwise instanceOfTestA will be called with null if json contains [null], and that will cause a TypeError because the in operator cannot be used with null.
export function instanceOfTestA(value: object): value is TestA {
if (!('foo' in value) || value['foo'] === undefined) return false;
return true;
}
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.
Fixes #21811
The JSON serialization/deserialization code generated for
oneOfschemas which do not use a discriminator follows a pattern of validating & serializing first the model schemas, then arrays of non-primitive objects, then primitive objects (including arrays).The area of the template which validates & serializes / deserializes arrays of non-primitive objects includes a
return value;orreturn json;statement if it does not find a matching object. For example:This return short circuits further validation / serialization that should happen if the schema is an array of a primitive type.
Additionally there are a couple of other fixes for:
.map(e.g.value.map(value => value.toISOString()))objectwhen callinginstanceOfmethodsPR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)