feat(executor): extensions.code

[ardatan]

Related graphql-hive/graphql-yoga#3672

Summary by CodeRabbit

• New Features
  • Enhanced error reporting in GraphQL responses with specific error codes and HTTP status details to provide clearer troubleshooting insights.
• Chores
  • Released a minor package update to deliver these improvements.

[changeset-bot]

🦋 Changeset detected

Latest commit: 6a26d65

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

This PR includes changesets to release 1 package

Name	Type
@graphql-tools/executor	Minor

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

[theguild-bot]

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
@graphql-tools/executor	1.4.0-alpha-20250116191119-6a26d655d70767d285e004908e047c7e4cdc1a54	npm ↗︎ unpkg ↗︎

[github-actions]

💻 Website Preview

The latest changes are available as preview in: https://4ac5151c.graphql-tools.pages.dev

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the @graphql-tools/executor package to enhance error reporting in GraphQL responses. The modifications add an extensions.code property to errors in both the buildExecutionContext and subscribe functions. In buildExecutionContext, errors related to operation resolution now include a code of 'OPERATION_RESOLUTION_FAILURE'. In subscribe, errors are directly updated to include an HTTP status of 400 and a code of 'BAD_USER_INPUT'. These changes improve the clarity of error information during GraphQL execution.

Changes

File(s)	Change Summary
.changeset/funny-berries-grin.md	Minor version bump for @graphql-tools/executor with added support for error specification using extensions.code in GraphQL responses.
packages/.../execute.ts	Enhanced error handling in buildExecutionContext and subscribe functions: added an extensions.code ('OPERATION_RESOLUTION_FAILURE' and 'BAD_USER_INPUT') and set HTTP status to 400 in subscription errors.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant E as GraphQL Executor
    participant B as buildExecutionContext
    C->>E: Send GraphQL query/mutation
    E->>B: Build execution context
    alt Operation missing/unknown
        B-->>E: Return error with extensions.code = 'OPERATION_RESOLUTION_FAILURE'
    else Valid Operation
        B-->>E: Return execution context
    end
    E->>C: Send response

Loading

sequenceDiagram
    participant C as Client
    participant E as GraphQL Executor
    participant S as subscribe Function
    C->>E: Initiate subscription
    E->>S: Process subscription
    S->>S: Iterate over errors
    S-->>E: Update error extensions (http: 400, code: 'BAD_USER_INPUT')
    E->>C: Send response with error details

Loading

Poem

I'm a rabbit, hopping in the code,
Where errors now wear a smarter mode.
Codes like 'BAD_USER_INPUT' lead the way,
And 'OPERATION_RESOLUTION_FAILURE' saves the day.
With carrots 🥕 and clean logs, I cheerfully play!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/executor/src/execution/execute.ts

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54751cf and 6a26d65.

📒 Files selected for processing (2)

• .changeset/funny-berries-grin.md (1 hunks)
• packages/executor/src/execution/execute.ts (3 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.