fix: Typing when explicitly setting sideEffect in RestEndpoint#3726
Merged
fix: Typing when explicitly setting sideEffect in RestEndpoint#3726
Conversation
🦋 Changeset detectedLatest commit: 592ba96 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
Size Change: 0 B Total Size: 79.8 kB ℹ️ View Unchanged
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3726 +/- ##
=======================================
Coverage 98.13% 98.13%
=======================================
Files 150 150
Lines 2736 2736
Branches 537 537
=======================================
Hits 2685 2685
Misses 11 11
Partials 40 40 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Motivation
When using
sideEffect: falsewithmethod: 'POST'on aRestEndpoint(e.g., JSON-RPC orPOST-based search endpoints), the
sideEffecttype resolved toneverinstead offalse.This caused type information to be completely lost — both
trueandfalsewere assignableto
sideEffect, and the type didn't persist through.extend()chains.The docs already state that explicit
sideEffectoverridesmethodinference, but the typesdidn't implement this correctly.
Solution
Replace
Extract<O['sideEffect'], undefined | true>withExtract<O['sideEffect'], boolean | undefined>across all 6 locations inRestEndpointTypes.tswhere the sideEffect type parameter is computed.The original
Extract<..., undefined | true>filtered outfalsebecausefalseis not inundefined | true, causingExtract<false, undefined | true>=never. Widening toboolean | undefinedpreserves all valid sideEffect values (false,true,undefined)while still satisfying the
M extends boolean | undefinedconstraint.Additionally,
RestExtendedEndpointwas missing asideEffectpriority check entirely — itonly checked
method. Added the samesideEffect > method > inheritedpriority chain usedeverywhere else.
Note
Low Risk
Type-only changes to
RestEndpointgenerics plus added TS tests; no runtime behavior changes, with the main risk being downstream compile-time type differences.Overview
Ensures
RestEndpointtype inference respects explicitsideEffectvalues (includingfalse) overmethod-based inference, fixing cases wheresideEffect: falsewithmethod: 'POST'previously collapsed tonever(and could be lost through.extend()).Adds TypeScript regression tests covering constructor/
extend()/chainedextend()scenarios, plus a patchchangesetand a release-note entry documenting the fix.Written by Cursor Bugbot for commit 592ba96. This will update automatically on new commits. Configure here.