[typescript-fetch] Fix oneOf with mixed array types causing TypeScript compile error#23500
Open
jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
Open
[typescript-fetch] Fix oneOf with mixed array types causing TypeScript compile error#23500jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
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.
When a
oneOfschema contains both complex array types (e.g.Array<SomeObject>) and primitive array types (e.g.Array<string>), the generated TypeScript code fails to compile:The generated
ToJSON/FromJSONfunctions handle complex array members inside anif (Array.isArray(value)) { ... return value; }block that always returns for arrays. TypeScript's control flow analysis then narrows the type to exclude arrays, making subsequentArray.isArray()checks for primitive array members unreachable — the type becomesnever.Example schema that triggers the bug:
Fix
returnfrom inside theoneOfArraysArray.isArray()block so TypeScript doesn't narrow the type after itif (Array.isArray()) { return value; }) after all primitive array checks, preserving the fallback behaviorisDateTypearrayToJSONtemplateBefore
After
PR 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)Summary by cubic
Fixes a TypeScript compile error (TS2339: 'every' on 'never') in generated
typescript-fetchclients when aoneOfmixes complex array types with primitive array types.returnfrom theArray.isArray()branch inFromJSON/ToJSONforoneOfarrays to prevent type narrowing; add a final array catch-all after primitive array checks.isDateTypeToJSONtemplate.TestArrayResponse.tsto reflect the new control flow.Written for commit 0faeea3. Summary will update on new commits.