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

feat(coprocessor): add conditions on coprocessor stages #5557

Merged
merged 7 commits into from
Jul 4, 2024

Conversation

bnjjj
Copy link
Contributor

@bnjjj bnjjj commented Jun 27, 2024

Adding support of conditions on coprocessor stages (except for Execution service) based on existing conditions we already have in the router for custom telemetry. Including usage of existing selectors

Example if you would like to execute a coprocessor on supergraph response only on primary response and not subscription events for example:

coprocessor:
  url: http://127.0.0.1:3000 # mandatory URL which is the address of the coprocessor
  timeout: 2s # optional timeout (2 seconds in this example). If not set, defaults to 1 second
  supergraph:
    response: 
      condition:
        eq:
        - true
        - is_primary_response: true
      body: true

or another example to not execute the coprocessor at all if it's a subscription:

coprocessor:
  url: http://127.0.0.1:3000 # mandatory URL which is the address of the coprocessor
  timeout: 2s # optional timeout (2 seconds in this example). If not set, defaults to 1 second
  supergraph:
    response: 
      condition:
        not:
          eq:
          - subscription
          - operation_kind: string
      body: true

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 Coenen <5719034+bnjjj@users.noreply.github.com>

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Jun 27, 2024

CI performance tests

  • 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

bnjjj added 3 commits July 3, 2024 10:32
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj bnjjj marked this pull request as ready for review July 3, 2024 15:17
@bnjjj bnjjj requested review from a team as code owners July 3, 2024 15:17
bnjjj added 2 commits July 3, 2024 17:17
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
docs/source/customizations/coprocessor.mdx Outdated Show resolved Hide resolved
docs/source/customizations/coprocessor.mdx Outdated Show resolved Hide resolved
docs/source/customizations/coprocessor.mdx Outdated Show resolved Hide resolved
.changesets/feat_bnjjj_feat_condition_copro.md Outdated Show resolved Hide resolved
.changesets/feat_bnjjj_feat_condition_copro.md Outdated Show resolved Hide resolved
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
Copy link
Contributor

@BrynCooke BrynCooke left a comment

Choose a reason for hiding this comment

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

Approved!
But please can you follow up by moving the selectors to src/configuration/selectors.
Also it'd be good to have a separate file for each type of selector, so we would end up with:
src/configuration/selectors/router.rs
src/configuration/selectors/supergraph.rs

etc.

@@ -4892,8 +4902,8 @@ expression: "&schema"
"description": "The trace ID of the request.",
"properties": {
"trace_id": {
"$ref": "#/definitions/TraceIdFormat2",
Copy link
Contributor

@BrynCooke BrynCooke Jul 4, 2024

Choose a reason for hiding this comment

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

Looks like there is non-determinism here. I did a check and there are two TraceIdFormat enums. We need to unify them. This PR didn't cause this issue, I think it was my last one.

@bnjjj bnjjj merged commit d00ef08 into dev Jul 4, 2024
13 of 14 checks passed
@bnjjj bnjjj deleted the bnjjj/feat_condition_copro branch July 4, 2024 09:56
@abernix abernix mentioned this pull request Jul 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