fix(typescript): coerce unknown-typed global headers to string in generated SDKs#14331
Open
Swimburger wants to merge 2 commits intomainfrom
Open
fix(typescript): coerce unknown-typed global headers to string in generated SDKs#14331Swimburger wants to merge 2 commits intomainfrom
Swimburger wants to merge 2 commits intomainfrom
Conversation
…erated SDKs Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@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.
Description
Refs: polytomic/polytomic-typescript#4
When a global header's
valueTypein the IR isunknown(e.g. an OpenAPI-imported version header without an explicit schema type), the TypeScript generator producesSupplier<unknown>inBaseClientOptionsandunknowninBaseRequestOptions. This causes 114 identical TypeScript compilation errors (Type 'unknown' is not assignable to type 'string | undefined') wherever the header value is assigned in generated client code.Since HTTP headers are always strings, we coerce
unknown-typed headers tostringat generation time.Changes Made
isUnknownType()helper inBaseClientContextImpl.tsto detect when a header's IRTypeReferenceisunknowngenerateBaseClientOptionsInterface: usestringinstead ofunknownfor the header type (both literal andSupplier<T>-wrapped variants)generateBaseRequestOptionsInterface: same coercion for per-request header overridesgenerateBaseIdempotentRequestOptionsInterface: same coercion for idempotency headers3.60.4changelog entryTesting
pnpm run checkpasses (biome lint on 4289 files)Human Review Checklist
unknown. Consider running against the Polytomic API definition or adding a minimal fixture totest-definitions/.unknown: TheisUnknownTypecheck only handlestypeReference.type === "unknown". Wrapped variants likeoptional<unknown>are not coerced. Verify this is sufficient for real-world header definitions.Options/RequestOptions(notBaseClientOptions). This fix only addresses the current HEAD architecture. The customer would need to upgrade to benefit.Link to Devin session: https://app.devin.ai/sessions/25af4555f0324078a2c8e5be55d3f207
Requested by: @Swimburger