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

Remove access_json dependency and deprecated configurations #6621

Open
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

bnjjj
Copy link
Contributor

@bnjjj bnjjj commented Jan 22, 2025

Remove access_json from our dependencies. It's no longer needed and has been replaced by jsonpath-rust which follows the jsonpath specs.

It removes the deprecated subgraph_response_body selector from telemetry configuration and change the type of path field in headers configuration when you want to get a data from request body and insert it in a subgraph header.

  • If you have this configuration for headers:
headers:
  all:
    request:
      - insert:
          name: from_app_name
          path: .extensions.metadata[0].app_name

you'll have to migrate the path field to be jsonpath compliant and just add $ at the beginning of the path, example:

headers:
  all:
    request:
      - insert:
          name: from_app_name
          path: $.extensions.metadata[0].app_name
  • If you used the subgraph_response_body selector for telemetry like this:
telemetry:
  instrumentation:
    instruments:
      subgraph:
        http.client.request.duration:
          attributes:
            http.response.status_code:
              subgraph_response_status: code
            my_data_value:
              subgraph_response_body: .data.test

You'll have to migrate the subgraph_response_body to subgraph_response_data selector (or subgraph_response_errors if you want to target errors):

telemetry:
  instrumentation:
    instruments:
      subgraph:
        http.client.request.duration:
          attributes:
            http.response.status_code:
              subgraph_response_status: code
            my_data_value:
              subgraph_response_data: $.test # Heads up, we removed the .data prefix as it's directly targeting data and we added $

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.

Signed-off-by: Benjamin <[email protected]>
@bnjjj bnjjj requested review from a team as code owners January 22, 2025 10:41
Copy link
Contributor

@bnjjj, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@router-perf
Copy link

router-perf bot commented Jan 22, 2025

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

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Jan 22, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 1 changed, 0 removed
* graphos/reference/migration/from-router-v1.mdx

Build ID: f70396128e4aa52b2bec8c19

URL: https://www.apollographql.com/docs/deploy-preview/f70396128e4aa52b2bec8c19

Signed-off-by: Benjamin <[email protected]>
@bnjjj bnjjj requested a review from a team as a code owner January 22, 2025 10:46
Copy link
Member

@goto-bus-stop goto-bus-stop left a comment

Choose a reason for hiding this comment

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

Does the router fail to start if you use the old syntaxes? I assume yes but just checkin' :)

Maybe it'd be good to land the config validate command for 2.0 and tell people to use that in the migration guide so they can spot issues with that

Copy link
Contributor

@garypen garypen left a comment

Choose a reason for hiding this comment

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

Looks good, but I think we need to address the unwrap() that I reference.

apollo-router/src/plugins/headers.rs Show resolved Hide resolved
@bnjjj
Copy link
Contributor Author

bnjjj commented Jan 23, 2025

@goto-bus-stop Actually I thought it would fail to select the right data without $ as it's highly recommended in JSONPath specs. But I just added a new test to double check if it was working with previous notation (without $) and it works so it might be pretty transparent for our users but I think we should still mention it.

Signed-off-by: Benjamin <[email protected]>
@bnjjj bnjjj requested a review from garypen January 27, 2025 10:56
Signed-off-by: Benjamin <[email protected]>
@bnjjj bnjjj enabled auto-merge (squash) January 28, 2025 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants