fix: support arrow functions in OpenAPI generator #1058
Merged
+102
−1
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
yanxue-22
force-pushed
the
DX-1799-Openapi-Generator-Fails-At-Reading-Utils
branch
2 times, most recently
from
dee2852 to
e39ea36
Compare
yanxue-22
changed the title
yanxue-22
force-pushed
the
DX-1799-Openapi-Generator-Fails-At-Reading-Utils
branch
from
e39ea36 to
04aa45a
Compare
When arrow functions that return codecs were
imported from a utils module, the OpenAPI generator would output empty
schemas ({}) instead of the correct type definitions.
Example that broke:
```typescript
// utils.ts
export const BooleanFromNullableWithFallback = () =>
fromNullable(t.union([BooleanFromString, t.boolean]), false);
// schema.ts
import { BooleanFromNullableWithFallback } from './utils';
const Wallet = t.type({
hasLargeNumberOfAddresses: BooleanFromNullableWithFallback() // INCORRECTLY Generates: {}
});
```
The generator couldn't resolve CallExpressions where the callee is an
arrow function. When it looked up the identifier and found an arrow
function, it had no logic to parse the function body, falling back to
an empty schema.
This fix:
- Adds parseFunctionBody() to extract and parse arrow function return values
- Detects when CallExpression callees resolve to arrow functions
- Uses findSymbolInitializer() for cross-file lookup of imported functions
Test covers the bug scenario: calling an arrow function factory
(BooleanFromNullableWithFallback()) within a codec property definition.
yanxue-22
force-pushed
the
DX-1799-Openapi-Generator-Fails-At-Reading-Utils
branch
from
04aa45a to
cec1e8b
Compare
yanxue-22
deleted the
DX-1799-Openapi-Generator-Fails-At-Reading-Utils
branch
|
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
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.
Ticket: DX-1799
Problem
The generator couldn't resolve
CallExpressionswhere the callee is an arrow function. When it looked upBooleanFromNullableWithFallbackand found an arrow function, it had no logic to parse the function body to extract the codec it returns, falling back to an empty schema.Example of the issue can be found in the ticket description.
Fix:
parseFunctionBody()to extract and parse arrow function return valuesCallExpressioncallees resolve to arrow functionsfindSymbolInitializer()for cross-file lookup of imported functionsexpression body (() => expr)Validation:
Test covers the bug scenario: calling an arrow function
BooleanFromNullableWithFallback()within a codec property definition.Note:
Block statement arrow functions were not part of the bug, but its valid TypeScript that the parser is not supporting.
An example of one is:
block statement (() => { return expr }).I added that in the error message and have created a new ticket DX-2182 to address this.