Cooperative Cancellation by Velfi · Pull Request #7604 · apollographql/router

Velfi · 2025-06-03T18:31:08Z

Cooperative Cancellation for Query Planning

This release introduces cooperative cancellation support for query planning operations. This feature allows the router to gracefully handle query planning timeouts and cancellations, improving resource utilization. Metrics are emitted for cooperative cancellation:

Records the "outcome" of query planning on the apollo.router.query_planning.plan.duration metric.
Records the "outcome" of query planning on the query_planning span.

Checklist

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

Changes are compatible¹
Documentation² completed
Performance impact assessed and acceptable
Metrics and logs are added³ and documented
Tests added and passing⁴
- Unit Tests
- Integration Tests
- Manual Tests

Exceptions

Note any exceptions here

Notes

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. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices. ↩
Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩

apollo-router/src/configuration/mod.rs

svc-apollo-docs · 2025-06-03T18:32:01Z

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 4f4ae430826a6c8c371b08ae

apollo-router/src/configuration/mod.rs

apollo-router/src/query_planner/caching_query_planner.rs

apollo-librarian · 2025-06-12T14:52:13Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 11 changed, 0 removed

* (developer-tools)/apollo-mcp-server/(latest)/command-reference.mdx
* (developer-tools)/apollo-mcp-server/(latest)/guides/index.mdx
* (developer-tools)/kotlin/(latest)/index.mdx
* (developer-tools)/kotlin/(latest)/advanced/apollo-ast.mdx
* (developer-tools)/kotlin/(latest)/advanced/compiler-plugins.mdx
* (developer-tools)/kotlin/(latest)/advanced/no-runtime.mdx
* (developer-tools)/kotlin/(latest)/caching/http-cache.mdx
* (developer-tools)/kotlin/(latest)/caching/normalized-cache.mdx
* (developer-tools)/kotlin/(latest)/testing/apollo-debug-server.mdx
* (developer-tools)/kotlin/(latest)/testing/mocking-graphql-responses.mdx
* graphos/routing/(latest)/performance/caching/in-memory.mdx

Build ID: ac25c6586d8308e5efbeae6c

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

…ive-cancellation

goto-bus-stop

Mostly minor comments, the actual feature is a little more involved than I expected and I overall like the solution :) My only real objection is the config shape.

apollo-router/src/query_planner/caching_query_planner.rs

apollo-router/src/configuration/cooperative_cancellation.rs

.changesets/feat_zelda_feature_cooperative_cancellation.md

apollo-router/src/query_planner/caching_query_planner.rs

goto-bus-stop

Pre-approval assuming comments are addressed in a manner considered adequate by the PR author 🫡

Co-authored-by: Renée <renee.kooi@apollographql.com>

BrynCooke

Locking as reviewing

BrynCooke · 2025-06-17T15:48:49Z

apollo-router/src/query_planner/caching_query_planner.rs

+            // When cooperative cancellation is enabled, we want to cancel the query planner
+            // task if the request is canceled.
+            if self.cooperative_cancellation.is_enabled() {
+                let outcome_recorded = Arc::new(AtomicU8::new(Outcome::None as u8));


Outcome needs to be documented in the docs.

I think docs will be a follow up, because merging docs for unreleased features into dev goes straight to the public docs website...

Is there a way to include comments in our MDX doc files? That way releasing the feature would just involve uncommenting the docs that were added as part of this PR.

Popping in here from Edu team! I'm not as familiar with the router side of docs, but I did come across this PR on the MCP server that uncomments out the part of the docs so it seems like it should be possible!

I added docs that explain outcome to the metric docs.

.changesets/feat_zelda_feature_cooperative_cancellation.md

apollo-router/src/query_planner/query_planner_service.rs

refactor cooperative cancellation default config use humantime for CC timeout

apollo-router/src/query_planner/caching_query_planner.rs

BrynCooke

Approved, but make sure to manually check the spans.

add cooperative cancellation and timeout test

fe1e0f5

This comment has been minimized.

Sign in to view

Velfi commented Jun 3, 2025

View reviewed changes

apollo-router/src/configuration/mod.rs Show resolved Hide resolved

Velfi commented Jun 3, 2025

View reviewed changes

apollo-router/src/configuration/mod.rs Outdated Show resolved Hide resolved

Velfi commented Jun 3, 2025

View reviewed changes

apollo-router/src/query_planner/caching_query_planner.rs Show resolved Hide resolved

Velfi added 6 commits June 3, 2025 13:35

update test name

6b0a5ef

update insta snapshots

f093728

use enum for coop cancellation config

dff11b5

add cancellation test

ca5e396

add measurement mode

822ef3a

add client drop test

e8f6c38

bnjjj reviewed Jun 11, 2025

View reviewed changes

apollo-router/src/query_planner/caching_query_planner.rs Outdated Show resolved Hide resolved

apollo-router/src/query_planner/caching_query_planner.rs Outdated Show resolved Hide resolved

apollo-router/src/query_planner/caching_query_planner.rs Outdated Show resolved Hide resolved

add proper metric and span support for CC

9d77cf4

Velfi added 7 commits June 12, 2025 09:57

undo histogram breaking change

176b20d

run formatter

3e73bd1

fix clippy lints

459fc56

fix bug in CC impl

f88b253

prepare for PR review

6502284

add changeset

937a30b

Merge remote-tracking branch 'origin/dev' into zelda/feature-cooperat…

f8139fe

…ive-cancellation

Velfi marked this pull request as ready for review June 13, 2025 15:50

Velfi requested a review from a team June 13, 2025 15:50

Velfi requested review from a team as code owners June 13, 2025 15:50

remove leftover fixtures

e36f9ae

goto-bus-stop reviewed Jun 16, 2025

View reviewed changes

goto-bus-stop approved these changes Jun 17, 2025

View reviewed changes

Velfi and others added 3 commits June 17, 2025 09:49

Update apollo-router/src/query_planner/caching_query_planner.rs

2080e00

Co-authored-by: Renée <renee.kooi@apollographql.com>

respond to PR comments

0c66b09

Merge branch 'dev' into zelda/feature-cooperative-cancellation

bb2a1de

BrynCooke requested changes Jun 17, 2025

View reviewed changes

BrynCooke reviewed Jun 17, 2025

View reviewed changes

bnjjj reviewed Jun 17, 2025

View reviewed changes

.changesets/feat_zelda_feature_cooperative_cancellation.md Outdated Show resolved Hide resolved

apollo-router/src/query_planner/query_planner_service.rs Show resolved Hide resolved

Velfi added 4 commits June 17, 2025 13:50

respond to PR comments

bf6575b

refactor cooperative cancellation default config use humantime for CC timeout

Merge branch 'dev' into zelda/feature-cooperative-cancellation

f9ecebd

fix snapshot test

91692b2

add missing description

9cdde3f

bnjjj approved these changes Jun 18, 2025

View reviewed changes

BrynCooke requested changes Jun 18, 2025

View reviewed changes

apollo-router/src/query_planner/caching_query_planner.rs Show resolved Hide resolved

BrynCooke approved these changes Jun 18, 2025

View reviewed changes

Velfi added 3 commits June 18, 2025 09:56

fix snapshot test

a39455e

fix clippy lint

09dd3ae

put back what was accidentally deleted

54a0d97

Velfi enabled auto-merge June 18, 2025 15:27

Velfi merged commit cdc3ebb into dev Jun 18, 2025
15 checks passed

Velfi deleted the zelda/feature-cooperative-cancellation branch June 18, 2025 15:48

abernix mentioned this pull request Jul 1, 2025

prep release: v2.4.0 #7789

Merged

goto-bus-stop mentioned this pull request Jul 3, 2025

Add metric to track query plan failures #3730

Closed

Conversation

Velfi commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Footnotes

Uh oh!

This comment has been minimized.

Uh oh!

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

Uh oh!

✅ Docs preview has no changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apollo-librarian bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

goto-bus-stop left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

goto-bus-stop left a comment

Choose a reason for hiding this comment

Uh oh!

BrynCooke left a comment

Choose a reason for hiding this comment

Uh oh!

BrynCooke Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

goto-bus-stop Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

carodewig Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

mabuyo Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Velfi Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrynCooke left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Velfi commented Jun 3, 2025 •

edited

Loading

svc-apollo-docs commented Jun 3, 2025 •

edited

Loading

apollo-librarian bot commented Jun 12, 2025 •

edited

Loading

goto-bus-stop left a comment •

edited

Loading