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

Replace internal connectors subgraph name in errors #5947

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

pubmodmatt
Copy link
Contributor

@pubmodmatt pubmodmatt commented Sep 3, 2024

Replace the internal connectors subgraph name with the connector in error responses. Previously, errors at the HTTP transport level were returning the internal subgraph name.

The error response now looks like:

{
  "data": null,
  "errors": [
    {
      "message": "HTTP fetch failed from 'characters.simpsons http: GET /characters': error trying to connect: tcp connect error: Connection refused (os error 61)",
      "path": [],
      "extensions": {
        "code": "SUBREQUEST_HTTP_ERROR",
        "service": "characters.simpsons http: GET /characters",
        "reason": "error trying to connect: tcp connect error: Connection refused (os error 61)"
      }
    }
  ],
  "extensions": {
    "valueCompletion": [
      {
        "message": "Cannot return null for non-nullable field Query.characters",
        "path": []
      }
    ]
  }
}

Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@pubmodmatt pubmodmatt requested a review from a team September 3, 2024 18:10
@pubmodmatt pubmodmatt self-assigned this Sep 3, 2024
@pubmodmatt pubmodmatt requested review from a team as code owners September 3, 2024 18:10
@router-perf
Copy link

router-perf bot commented Sep 3, 2024

CI performance tests

  • connectors-const - Connectors stress test that runs with a constant number of users
  • const - Basic stress test that runs with a constant number of users
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • enhanced-signature - Enhanced signature enabled
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • extended-reference-mode - Extended reference mode enabled
  • large-request - Stress test with a 1 MB request payload
  • no-tracing - Basic stress test, no tracing
  • reload - Reload test over a long period of time at a constant rate of users
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • step-local-metrics - Field stats that are generated from the router rather than FTV1
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload

match e.downcast::<FetchError>() {
// Replace the internal subgraph name with the connector label
Ok(inner) => match *inner {
FetchError::SubrequestHttpError {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few different FetchError variants include service name: https://github.com/apollographql/router/blob/dev/apollo-router/src/error.rs#L66,75 ... patch response, ws, and batching are unlikely to happen but should we check for them anyway?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fetch service forces everything into SubrequestHttpError. However, I missed that it's setting the reason using the Display implementation of the original error, and since that's derived, it will include the service field. I'll need to fix.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, looking at it more, those errors are never returned except through the subgraph service, so they would never happen for connector service. The only error that can come out of the connector service is SubrequestHttpError, either from the HTTP client service (which this PR handles) or directly emitted by the fetch service, which already returned the connector label.

@pubmodmatt pubmodmatt merged commit 5477c6a into next Sep 3, 2024
11 of 13 checks passed
@pubmodmatt pubmodmatt deleted the pubmodmatt/connectors/errors branch September 3, 2024 18:51
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