Skip to content

feat: option to allow all error extensions#1217

Merged
endigma merged 4 commits intomasterfrom
jesse/eng-7495-custom-extension-field-stripping
Jul 10, 2025
Merged

feat: option to allow all error extensions#1217
endigma merged 4 commits intomasterfrom
jesse/eng-7495-custom-extension-field-stripping

Conversation

@endigma
Copy link
Copy Markdown
Member

@endigma endigma commented Jul 8, 2025

Summary by CodeRabbit

  • New Features
    • Added an option to preserve all custom extension fields in error responses for more detailed error information.
  • Bug Fixes
    • Improved error handling to correctly reference compatibility error types, enhancing stability.

Checklist

  • I have discussed my proposed changes in an issue and have received approval to proceed.
  • I have followed the coding standards of the project.
  • Tests or benchmarks have been added or updated.

@endigma endigma marked this pull request as ready for review July 8, 2025 14:02
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 8, 2025

Walkthrough

The update introduces two new boolean options, AllowAllErrorExtensionFields and ApolloRouterCompatibilitySubrequestHTTPError, to control error extension field propagation and Apollo Router compatibility handling. It modifies the loader and resolver to support these options, adjusts tests accordingly, and removes the deprecated flag from ResolvableOptions.

Changes

File(s) Change Summary
v2/pkg/engine/resolve/loader.go Added allowAllErrorExtensionFields field to Loader; made call to optionallyAllowCustomExtensionProperties conditional on this flag; fixed reference in addApolloRouterCompatibilityError.
v2/pkg/engine/resolve/resolve.go Added AllowAllErrorExtensionFields and ApolloRouterCompatibilitySubrequestHTTPError to ResolverOptions; propagated these to Loader in newTools.
v2/pkg/engine/resolve/resolvable.go Removed ApolloRouterCompatibilitySubrequestHTTPError field from ResolvableOptions.
execution/engine/execution_engine_test.go Added apolloRouterCompatibilitySubrequestHTTPError field to _executionTestOptions; updated tests to use this new field for Apollo Router compatibility flag.
v2/pkg/engine/resolve/loader_hooks_test.go Added test case verifying propagation of all extension fields from subgraph errors when the allow-all option is enabled.
v2/pkg/engine/resolve/resolve_test.go Added new test helper function to run tests with AllowAllErrorExtensionFields enabled in resolver options.

📜 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 7373c6f and 94add58.

📒 Files selected for processing (6)
  • execution/engine/execution_engine_test.go (5 hunks)
  • v2/pkg/engine/resolve/loader.go (3 hunks)
  • v2/pkg/engine/resolve/loader_hooks_test.go (1 hunks)
  • v2/pkg/engine/resolve/resolvable.go (0 hunks)
  • v2/pkg/engine/resolve/resolve.go (3 hunks)
  • v2/pkg/engine/resolve/resolve_test.go (1 hunks)
💤 Files with no reviewable changes (1)
  • v2/pkg/engine/resolve/resolvable.go
🚧 Files skipped from review as they are similar to previous changes (4)
  • v2/pkg/engine/resolve/resolve.go
  • v2/pkg/engine/resolve/loader.go
  • v2/pkg/engine/resolve/loader_hooks_test.go
  • v2/pkg/engine/resolve/resolve_test.go
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Build and test (go 1.23 / ubuntu-latest)
  • GitHub Check: Build and test (go 1.23 / windows-latest)
  • GitHub Check: Build and test (go 1.23 / windows-latest)
🔇 Additional comments (5)
execution/engine/execution_engine_test.go (5)

215-216: LGTM: Clean addition of new configuration field

The addition of apolloRouterCompatibilitySubrequestHTTPError field to the _executionTestOptions struct is well-structured and follows the existing pattern. The field name is descriptive and clearly indicates its purpose for Apollo Router compatibility handling.


263-263: LGTM: Correct integration with ResolverOptions

The field is properly passed to ResolverOptions during engine creation, which aligns with the refactoring described in the AI summary where the Apollo Router compatibility flag was moved from ResolvableOptions to ResolverOptions.


382-382: LGTM: Appropriate test configuration for enabled scenario

The test correctly sets apolloRouterCompatibilitySubrequestHTTPError = true for the "apollo router compatibility subrequest HTTP error enabled" test case, which matches the test's intent to verify the enabled behavior.


441-441: LGTM: Appropriate test configuration for disabled scenario

The test correctly sets apolloRouterCompatibilitySubrequestHTTPError = false for the "apollo router compatibility subrequest HTTP error disabled" test case, providing the necessary contrast to verify the disabled behavior.


500-500: LGTM: Consistent test configuration

The test appropriately sets apolloRouterCompatibilitySubrequestHTTPError = true for the "apollo router compatibility subrequest HTTP error enabled and non-error http status" test case, maintaining consistency with the expected behavior for this scenario.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@endigma endigma marked this pull request as draft July 8, 2025 14:18
@endigma endigma marked this pull request as ready for review July 9, 2025 09:41
@endigma endigma force-pushed the jesse/eng-7495-custom-extension-field-stripping branch 2 times, most recently from 8b91822 to 7373c6f Compare July 9, 2025 09:48
Comment thread v2/pkg/engine/resolve/loader.go
Comment thread v2/pkg/engine/resolve/loader.go
@endigma endigma changed the title feat: disable error extension filtering in passthrough mode feat: option to allow all error extensions Jul 9, 2025
@endigma endigma requested a review from a team as a code owner July 9, 2025 12:59
@endigma endigma force-pushed the jesse/eng-7495-custom-extension-field-stripping branch from d3dbd24 to 94add58 Compare July 9, 2025 13:00
@endigma endigma changed the title feat: option to allow all error extensions feat(v2): option to allow all error extensions Jul 9, 2025
@endigma endigma changed the title feat(v2): option to allow all error extensions feat: option to allow all error extensions Jul 10, 2025
@endigma endigma merged commit b2e6575 into master Jul 10, 2025
12 checks passed
@endigma endigma deleted the jesse/eng-7495-custom-extension-field-stripping branch July 10, 2025 09:12
endigma pushed a commit that referenced this pull request Jul 10, 2025
🤖 I have created a release *beep* *boop*
---


##
[2.0.0-rc.203](v2.0.0-rc.202...v2.0.0-rc.203)
(2025-07-10)


### Features

* option to allow all error extensions
([#1217](#1217))
([b2e6575](b2e6575))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **New Features**
  * Added an option to allow all error extensions.

* **Documentation**
  * Updated the changelog with details for version 2.0.0-rc.203.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.

2 participants