Add ability to specify path as regex in snapshots

[pubmodmatt]

Add the ability to specify a regex for the URL path in a shapshot file. This is useful when constructing tests that may result in a number of HTTP requests where responses can be reused, or where the path is dynamically generated during the test (such as a randomly generated identifier).

    "request": {
        "method": "GET",
        "path": null,
        "regex": "users/.*/posts",
        "body": null
    },

The snapshot server first looks for an exact match to the URL path in the map, then sequentially applies each regex if no exact match if found. Performance could degrade if there were a lot of regex snapshots, but this should be reasonable for a small number of snapshots.

The regular expression provided will need to escape any special characters used by the regex crate, such as the ? in query parameters, using \\.

The regex is never set when taking snapshots from the upstream API. The only way to use it is to manually edit a snapshot file, typically by converting an existing snapshot by changing path to regex and replacing the variable part of the path with wilcards.

These changes are backward compatible with existing snapshot files, so there is no need to update any source controlled snapshots.

---

Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

• Changes are compatible¹
• Documentation² completed
• Performance impact assessed and acceptable
• Tests added and passing³
  • Unit Tests
  • Integration Tests
  • Manual Tests

Exceptions

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. ↩

[svc-apollo-docs]

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 1ece3c0f3eee50b7cfed4ecd

[github-actions]

@pubmodmatt, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

[router-perf]

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

[dylan-apollo]

A couple questions, but LGTM