Skip to content

Ensure cost directives are picked up when not explicitly imported#6328

Merged
tninesling merged 24 commits intodevfrom
tninesling/cost-with-updated-composition
Dec 9, 2024
Merged

Ensure cost directives are picked up when not explicitly imported#6328
tninesling merged 24 commits intodevfrom
tninesling/cost-with-updated-composition

Conversation

@tninesling
Copy link
Contributor

@tninesling tninesling commented Nov 22, 2024

With the recent composition changes, importing @cost results in a supergraph schema with the cost specification import at the top. The @cost directive itself is not explicitly imported, as it's expected to be available based on being the default export from the cost specification. In contrast, uses of @listSize to translate to an explicit import in the supergraph.

Old SDL link

@link(
    url: "https://specs.apollo.dev/cost/v0.1"
    import: ["@cost", "@listSize"]
)

New SDL link

@link(url: "https://specs.apollo.dev/cost/v0.1", import: ["@listSize"])

This exposed the brittle initial implementation of cost directive handling, which built up a map of directive name aliases from import statements. The core change made to address this issue is to remove the directive name map and replace it with calls to SpecDefinition::directive_name_in_schema, which is equivalent to the change we made on the composition side.

To avoid passing these names around during directive parsing, I have moved the directive parsing code into the CostSpecDefinition. This means the demand control plugin does not need to be concerned with the directives names in each schema.


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.

…directive name map to account for the new way cost directives are copied over to the supergraph in composition. This works for the supergraph, but currently fails on extracted subgraphs, likely because the cost link is not being carried over
…we always fall back to the federation spec when the cost spec is missing from the schema
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Nov 22, 2024

✅ Docs Preview Ready

No new or changed pages found.

@router-perf
Copy link

router-perf bot commented Nov 22, 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

@github-actions

This comment has been minimized.

@tninesling tninesling marked this pull request as ready for review December 3, 2024 16:47
@tninesling tninesling requested a review from a team December 3, 2024 16:47
@tninesling tninesling requested review from a team, TylerBloom, duckki and lrlna as code owners December 3, 2024 16:47
Copy link
Member

@lrlna lrlna left a comment

Choose a reason for hiding this comment

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

I like that we are moving this logic to apollo-federation crate. Makes this a lot cleaner! I have a couple of small suggestion and a question, but neither is blocking.

And overall question though, is this getting an update on the JS side, and do we need to bump router-bridge still? If so, we should get that in today, since the rc goes on wednesday.

@tninesling
Copy link
Contributor Author

And overall question though, is this getting an update on the JS side, and do we need to bump router-bridge still? If so, we should get that in today, since the rc goes on wednesday.

This change was made on the JS side in apollographql/federation#3136, which was release in federation 2.9.3, so it's already in the current bridge.

@tninesling tninesling merged commit cf7a42d into dev Dec 9, 2024
@tninesling tninesling deleted the tninesling/cost-with-updated-composition branch December 9, 2024 19:49
@BrynCooke BrynCooke mentioned this pull request Dec 16, 2024
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.

3 participants