Clarify coprocessor config `context: true` behaviour by goto-bus-stop · Pull Request #7349 · apollographql/router

goto-bus-stop · 2025-04-28T10:44:21Z

context: true is how you enabled propagating context through coprocessors in 1.x. Now, you should use context: deprecated to use the 1.x context key names, or context: all to use the 2.x context key names.

context: true is an alias for context: deprecated but should not be used. This patch clarifies in the docs that you should not use context: true, and logs a runtime warning on startup if you do use it.

svc-apollo-docs · 2025-04-28T10:45:04Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 2 changed, 0 removed

* graphos/routing/(latest)/customization/coprocessor.mdx
* graphos/routing/(latest)/upgrade/from-router-v1.mdx

Build ID: 9e3b283ecfbe46ee19cfa3bb

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

bnjjj · 2025-04-29T07:46:20Z

apollo-router/src/plugins/coprocessor/mod.rs

+            ContextConf::Deprecated(true)
+        ) {
+            tracing::warn!(
+                "Configuration `coprocessor.router.request.context: true` is deprecated. Use one of the new values, `deprecated` or `all`"


Is it intentional to not mention the third option selective ? Should we provide a link to the official docs ?

i was trying to keep it simple, but a docs link might be better (especially as selective is the best thing to use...)

Mostly took the wording from the upgrade guide which was more heavily copy edited by the docs team.

* Remove duplicate reqwest (apollographql#7329) * Port first batch of supgraph validation tests (apollographql#7321) - Adds a portion of the subgraph validation tests being ported over from the federation repo. - Exposes error fields on SubgraphError and FederationError for use in the tests. - Creates a public getter method for SubgraphError's error field - Creates a public getter method returning an array of errors associated with a given FederationError - Ports over the build_for_errors() test utility. * chore(deps): update xtask/Cargo.lock h2 dependency (apollographql#7336) * [docs] Add new page for query planning best practices (apollographql#7263) Co-authored-by: Lucas Leadbetter <5595530+lleadbet@users.noreply.github.com> Co-authored-by: Edward Huang <edhuang@gmail.com> * fix: terminate unused Redis connections on schema update (apollographql#7319) Co-authored-by: Renée <renee.kooi@apollographql.com> * test(federation/composition): ported the rest of "@core/@link handling" tests (apollographql#7335) * Add code for add_shareable and has_applied_directive (apollographql#7327) * Basic changes to connect/ * docs: otlp metrics exporters (apollographql#7334) * Removes redundant clones * add const fn warning * Remove const_fn warning * Apply comments * Remove todo comment * Update apollo-federation/src/sources/connect/json_selection/parser.rs Co-authored-by: Dylan Anthony <dylan@apollographql.com> * Update apollo-federation/src/sources/connect/json_selection/parser.rs Co-authored-by: Dylan Anthony <dylan@apollographql.com> * Reformats code after suggestions * fix(deps): update rust crate thiserror to v2 (apollographql#7288) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Renée Kooi <renee.kooi@apollographql.com> * deps: update apollo-compiler (apollographql#7338) * Add _dd.measured to spans when agent sampling is enabled (apollographql#7344) Co-authored-by: bryn <bryn@apollographql.com> * Fix metric `apollo.router.operations.batching.size` (apollographql#7306) Signed-off-by: Benjamin <5719034+bnjjj@users.noreply.github.com> Co-authored-by: Jesse Rosenberger <git@jro.cc> * Clarify coprocessor config `context: true` behaviour (apollographql#7349) * Avoid unnecessary cloning in the deduplication plugin (apollographql#7347) * expanded supergraph now uses join spec v0.5 so that we don't skip the… (apollographql#7351) * make use of new build image when building the router (apollographql#7355) * Move content negotiation to a plugin (apollographql#7316) Co-authored-by: Iryna Shestak <shestak.irina@gmail.com> * Port batch of `subgraph_validation_tests` from federation repo (apollographql#7345) * DOC-391 clarify tracing exporters configs of OTLP * edit overview * Add subgraph validation for interface objects (apollographql#7317) Port `validateKeyOnInterfacesAreAlsoOnAllImplementations()` and `validateInterfaceObjectsAreOnEntities()` from the JS composition code, i.e. the per-subgraph validations for interface objects. Note that as part of this, `printHumanReadableList()` and `joinStrings()`, were also ported. * rewrite upgrade_subgraphs_if_necessary() to minimize cloning and fix tests. (apollographql#7346) * Update schema upgrader to use apollo-compiler 1.28 (apollographql#7356) * test(federation/composition): Port subgraph validation tests (part 2) (apollographql#7343) Co-authored-by: Taylor Ninesling <taylor.ninesling@apollographql.com> * Fix clippy when run with `--all-features` (apollographql#7352) * Move aggressive lints to connectors module * temporarily ignore failing tests in dev (apollographql#7375) * fix-less-performant-code * docs: fix typo in distributed caching (apollographql#7358) * docs: typo on PQ docs (apollographql#7373) * Fix router enforcement of connect spec version. (apollographql#7377) * Add a test in connectors batching for handling gaps (apollographql#7328) * Remove fed1 links and reexpand after fixing federation arguments (apollographql#7374) * DOC-448 clarify apollo_router_session_count_active removal * feat(federation/composition): ported `@external` directive validation (apollographql#7381) * Remove 0.2 version checks in composition for headers & connect-on-type (apollographql#7387) * feat(federation/composition): implemented `UNSUPPORTED_ON_INTERFACE` errors (apollographql#7382) * implement ->joinNotNull method (apollographql#7165) Co-authored-by: Ben Newman <ben@apollographql.com> * chore: remove dead code (apollographql#7391) * Auto-upgrade connect 0.1 subgraphs to 0.2 in composition (apollographql#7388) * telemetry: remove excessive bool from DisplayRouterResponse(refactoring) (apollographql#7331) * Simplify condition handling in coprocessor (apollographql#7320) * Implement demand control directive validations (apollographql#7376) * Remove aws-lc from dependencies (apollographql#7389) * Account for spec aliases/imports when auto-injecting `link` spec directives/types (apollographql#7365) When the `@link` directive definition is missing, we have some logic that automatically adds the `link` spec's type/directive definitions to the schema. We weren't accounting for the link spec's aliases/imports when doing this, while the JS codebase was, so we've ported that logic here. Note that this logic has several bugs, but we're going to port it as-is for now and address the bugs later. * chore(federation/composition): deleted a duplicate test module `link_handling_tests` (apollographql#7392) * fix: decrease log level for JWT authentication failure (apollographql#7396) * fix: make sure all input types end up in the expanded supergraph (apollographql#7383) * remove apollographql#7383 changeset (apollographql#7401) * Revert "Add _dd.measured to spans when agent sampling is enabled" (apollographql#7403) * fix: spans should only include path in `http.route` (apollographql#7390) * fix: propagate client name and version modifications through telemetry (apollographql#7369) * Manage all CI versions through mise and use binstall (backport apollographql#7393) (apollographql#7410) * prep release: v2.2.1-rc.0 * macos specific mise: we need x86_64-apple-darwin + aarch64-apple-darwin these both need to be installed on our releasing image * Remove no-longer-necessary installation of `gh` via Orb ✨ This is now accomplished with `gh` * prep release: v2.2.1-rc.1 * Include inadvertently removed fetch_dependencies This was inadverently removed in apollographql#7410 but should continue to exist. * prep release: v2.2.1 --------- Signed-off-by: Benjamin <5719034+bnjjj@users.noreply.github.com> Co-authored-by: Dylan Anthony <dylan@apollographql.com> Co-authored-by: Chidimma O <conwuegb@users.noreply.github.com> Co-authored-by: Jesse Rosenberger <git@jro.cc> Co-authored-by: Shane Myrick <mail@shanemyrick.com> Co-authored-by: Lucas Leadbetter <5595530+lleadbet@users.noreply.github.com> Co-authored-by: Edward Huang <edhuang@gmail.com> Co-authored-by: Caroline Rodewig <16093297+carodewig@users.noreply.github.com> Co-authored-by: Renée <renee.kooi@apollographql.com> Co-authored-by: Duckki Oe <duckki.oe@apollographql.com> Co-authored-by: Chris Lenfest <clenfest@apollographql.com> Co-authored-by: Julia Naomi <jnboeira@outlook.com> Co-authored-by: Edward Huang <edward.huang@apollographql.com> Co-authored-by: Julia Naomi <naomijub@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bryn Cooke <BrynCooke@gmail.com> Co-authored-by: bryn <bryn@apollographql.com> Co-authored-by: Coenen Benjamin <benjamin.coenen@hotmail.com> Co-authored-by: Gary Pennington <gary@apollographql.com> Co-authored-by: Lenny Burdette <lenny@apollographql.com> Co-authored-by: Iryna Shestak <shestak.irina@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Sachin D. Shinde <sachin@apollographql.com> Co-authored-by: Taylor Ninesling <taylor.ninesling@apollographql.com> Co-authored-by: Sam Friedman <sam.friedman@apollographql.com> Co-authored-by: Dale Seo <5466341+DaleSeo@users.noreply.github.com> Co-authored-by: Ben Newman <ben@apollographql.com> Co-authored-by: Dariusz Kuc <9501705+dariuszkuc@users.noreply.github.com> Co-authored-by: Ivan Goncharov <ivan.goncharov.ua@gmail.com>

goto-bus-stop added 3 commits April 28, 2025 12:28

docs: describe context: true behaviour

5f19391

Log a warning when coprocessor config context: true is used

6ed8c20

add a changeset

8976a5a

goto-bus-stop requested a review from a team April 28, 2025 10:44

goto-bus-stop requested a review from a team as a code owner April 28, 2025 10:44

fmt

1ea5df7

lrlna approved these changes Apr 28, 2025

View reviewed changes

bnjjj reviewed Apr 29, 2025

View reviewed changes

goto-bus-stop added 3 commits April 29, 2025 09:59

Link to docs

7a6274a

Rephrase context configuration paragraph

d2a98d1

Mostly took the wording from the upgrade guide which was more heavily copy edited by the docs team.

move note

8dec89c

bnjjj approved these changes Apr 29, 2025

View reviewed changes

goto-bus-stop enabled auto-merge (squash) April 29, 2025 08:37

goto-bus-stop merged commit 788f707 into dev Apr 29, 2025
15 checks passed

goto-bus-stop deleted the renee/ROUTER-1272 branch April 29, 2025 08:39

abernix mentioned this pull request May 13, 2025

prep release: v2.2.1 #7480

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Clarify coprocessor config `context: true` behaviour#7349

Clarify coprocessor config `context: true` behaviour#7349
goto-bus-stop merged 7 commits intodevfrom
renee/ROUTER-1272

goto-bus-stop commented Apr 28, 2025

Uh oh!

svc-apollo-docs commented Apr 28, 2025 •

edited

Loading

Uh oh!

bnjjj Apr 29, 2025

Uh oh!

goto-bus-stop Apr 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Conversation

goto-bus-stop commented Apr 28, 2025

Uh oh!

svc-apollo-docs commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

bnjjj Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

goto-bus-stop Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

svc-apollo-docs commented Apr 28, 2025 •

edited

Loading