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(subscription): add configurable heartbeat for websocket protocol #4802

Merged
merged 11 commits into from Mar 20, 2024

Conversation

IvanGoncharov
Copy link
Member

@IvanGoncharov IvanGoncharov commented Mar 14, 2024

Add the ability to enable heartbeat for cases where the subgraph drops idle connections.
For example, https://netflix.github.io/dgs/

Example of configuration:

subscription:
  mode:
    passthrough:
      all:
        path: /graphql
        heartbeat_interval: enable #Optional

Fixes #4621


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.

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Mar 14, 2024

CI performance tests

  • reload - Reload test over a long period of time at a constant rate of users
  • 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_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • large-request - Stress test with a 1 MB request payload
  • const - Basic stress test that runs with a constant number of users
  • no-graphos - Basic stress test, no GraphOS.
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • 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_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • xxlarge-request - Stress test with 100 MB request payload
  • xlarge-request - Stress test with 10 MB request payload
  • step - Basic stress test that steps up the number of users over time

@IvanGoncharov IvanGoncharov force-pushed the i1g/subscription-websocket-heartbeat branch from f6111ae to 9d245df Compare March 14, 2024 03:19
@IvanGoncharov IvanGoncharov marked this pull request as ready for review March 14, 2024 03:20
@IvanGoncharov IvanGoncharov requested a review from a team as a code owner March 14, 2024 03:20
@IvanGoncharov
Copy link
Member Author

Missing unit tests 😞
I made a few attempts to add them, but each time they ended up being flaky and unreliable.

apollo-router/src/protocols/websocket.rs Outdated Show resolved Hide resolved
apollo-router/src/protocols/websocket.rs Outdated Show resolved Hide resolved
docs/source/executing-operations/subscription-support.mdx Outdated Show resolved Hide resolved
@IvanGoncharov IvanGoncharov requested a review from Geal March 20, 2024 07:18
@IvanGoncharov IvanGoncharov changed the base branch from dev to 1.43.0 March 20, 2024 07:49
Copy link
Contributor

@Geal Geal left a comment

Choose a reason for hiding this comment

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

this sounds very reasonable, nicely done. I'd like to get a second review on this before merging, to make sure I did not miss something (I did not sleep much last night)

apollo-router/src/protocols/websocket.rs Show resolved Hide resolved
apollo-router/src/protocols/websocket.rs Show resolved Hide resolved
@BrynCooke
Copy link
Contributor

BrynCooke commented Mar 20, 2024

@IvanGoncharov Is there a test that exercises the new behaviour? As in it should check the heartbeat from the subgraph perspective.

@IvanGoncharov IvanGoncharov merged commit 3400cf3 into 1.43.0 Mar 20, 2024
10 checks passed
@IvanGoncharov IvanGoncharov deleted the i1g/subscription-websocket-heartbeat branch March 20, 2024 21:47
@abernix abernix mentioned this pull request Mar 21, 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.

Configure a subgraph websocket ping interval
6 participants