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

Fix header multiple propagation of single header #6281

Merged
merged 3 commits into from
Nov 20, 2024

Conversation

BrynCooke
Copy link
Contributor

@BrynCooke BrynCooke commented Nov 19, 2024

#4535 introduced an issue where the following config would not work:

headers:
- propagate:
    named: a
    rename: b
- propagate:
    named: a
    rename: c

The existing logic maintained a set of headers that had been propagated already, but did not take into account renaming. It used the original name of the header when tracking which headers had been propagated.

This fix adds a test for propagation and fixes the logic to take into account renames.


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

  • No new documentation as this is a fix for a regression
  • No integration tests required as was unit tested.
  • No perf impact expected due to nature of change

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.

@BrynCooke BrynCooke requested review from a team as code owners November 19, 2024 11:06
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Nov 19, 2024

✅ Docs Preview Ready

No new or changed pages found.

This comment has been minimized.

@router-perf
Copy link

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

#4535 introduced an issue where the following config would not work:

```yaml
headers:
- propagate:
    named: a
    rename: b
- propagate:
    named: a
    rename: c
```

The existing logic maintained a set of headers that had been propagated already, but did not take into account renaming. It used the original name of the header when tracking which headers had been propagated.

This fix adds a test for propagation and fixes the logic to take into account renames.
@BrynCooke BrynCooke force-pushed the bryn/fix-header-propagation branch from 5d4fd22 to 2a4d6ff Compare November 19, 2024 11:24
@BrynCooke BrynCooke requested a review from a team as a code owner November 19, 2024 11:24
@BrynCooke BrynCooke changed the title Fix header propagation where renames have already taken place Fix header multiple propagation of single header Nov 19, 2024
@BrynCooke BrynCooke merged commit ae1dda6 into dev Nov 20, 2024
14 checks passed
@BrynCooke BrynCooke deleted the bryn/fix-header-propagation branch November 20, 2024 16:06
@abernix abernix mentioned this pull request Nov 26, 2024
@abernix abernix mentioned this pull request Feb 12, 2025
@lrlna lrlna mentioned this pull request Feb 25, 2025
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