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

Ensure that batch entry contexts are correctly preserved #5162

Merged
merged 4 commits into from
May 14, 2024

Conversation

garypen
Copy link
Contributor

@garypen garypen commented May 14, 2024

Batch processing was not using contexts correctly. A representative context was chosen, the first item in a batch of items, and used to provide context functionality for all the generated responses.

The router now correctly preserves request contexts and uses them during response creation.


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

I've enhanced the existing it_assembles_batch test to ensure that output contexts match input contexts. This isn't fully testing all the new functionality, but along with manual testing, it does mean that the fix is fully tested.

Manual testing was performed by modifying the router to make Context id externally visible and then running a custom test program which updated context in Subgraph and Supergraph stages and ensuring that Context ids were correct.

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.

Batch processing was not using contexts correctly. A representative
context was chosen, the first item in a batch of items, and used to
provide context functionality for all the generated responses.

This bug is now fixed and the router correctly preserves request
contexts and uses them during response creation.
@garypen garypen requested a review from bnjjj May 14, 2024 09:35
@garypen garypen self-assigned this May 14, 2024

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented May 14, 2024

CI performance tests

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

@garypen garypen requested a review from BrynCooke May 14, 2024 09:37
Copy link
Contributor

@bnjjj bnjjj left a comment

Choose a reason for hiding this comment

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

Maybe a dumb question but are we sure the ordering of graphql requests is the same and so it's safe to use a Vec instead of a map or something ?
Also could you add tests please ?

@garypen
Copy link
Contributor Author

garypen commented May 14, 2024

Maybe a dumb question but are we sure the ordering of graphql requests is the same and so it's safe to use a Vec instead of a map or something ? Also could you add tests please ?

We are sure (Or at least I am). I did some manual testing to make sure that the ordering was correct. I should have documented that.

Adding tests is challenging, but I'll see what I can think of.

Add a check to make sure that the output list of contexts match the
input list of request contexts.
@garypen
Copy link
Contributor Author

garypen commented May 14, 2024

I've enhanced an existing unit test and documented the manual testing that I performed.

@garypen garypen requested a review from bnjjj May 14, 2024 12:09
@garypen garypen merged commit 0bcff8b into dev May 14, 2024
13 of 14 checks passed
@garypen garypen deleted the garypen/ROUTER-274/preserve-batch-contexts branch May 14, 2024 14:51
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.

None yet

2 participants