Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(openapi-fetch): Allow returning Response from onRequest callback #2091

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

p-dubovitsky
Copy link

@p-dubovitsky p-dubovitsky commented Jan 4, 2025

Changes

This PR closes #2072 by adding ability to return Response from onRequest middleware hook. This allows middleware to short-circuit the request chain by returning a response directly, which is useful for cases such as deduplicating or caching responses to avoid unnecessary network requests.

How to Review

Please check that:

  • Early Response from onRequest properly skips remaining middleware chain
  • Test coverage is sufficient
  • Documentation clearly explains new functionality

Key implementation details:

  • No changes to existing middleware behavior
  • When Response is returned:
    • The request is not sent to the server
    • Subsequent onRequest handlers are skipped
    • onResponse handlers are skipped

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@p-dubovitsky p-dubovitsky requested a review from a team as a code owner January 4, 2025 14:33
@p-dubovitsky p-dubovitsky requested a review from gzm0 January 4, 2025 14:33
Copy link

netlify bot commented Jan 4, 2025

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit fad2a50

Copy link

changeset-bot bot commented Jan 4, 2025

🦋 Changeset detected

Latest commit: fad2a50

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
openapi-fetch Patch
openapi-react-query Patch
swr-openapi Patch

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow returning Response from onRequest callback
1 participant