Move preview_connectors config to connectors for GA

[pubmodmatt]

Rename preview_connectors router config to connectors. In addition, subgraphs is now moved to sources, and under that, settings for a source are under <subgraph name>.<source name>. This matches other connectors config, for example, under telemetry and authorization.

The $config item has also changed, from being global to all sources in a subgraph, to being specific to a source under the <subgraph name>.<source name> entry.

A migrator is added to rename preview_connectors to connectors, but we cannot migrate the other changes. A warning is emitted if the subgraphs config was in use (which includes $config under subgraphs). Both the old subgraphs and new sources are allowed currently. This can be changed after a deprecation period, to remove the subgraphs form.

DRAFT because this cannot be merged until the GA release. Preview releases should continue to use the preview_connectors configuration.

Example

Preview Config

preview_connectors:
  max_requests_per_operation_per_source: 100 # This applies globally to all connectors
  subgraphs:
    example: # The name of the subgraph
      $config:
        my.config.value: true # applies to all sources in this subgraph
      sources:
        v1: # Refers to @source(name: "v1")
          # These apply to connectors with this source (v1) in this subgraph (example)
          override_url: 'https://api.example.com/v1/beta'
          max_requests_per_operation: 50

GA Config

connectors:
  max_requests_per_operation_per_source: 100 # This applies globally to all connectors
  sources:
    example.v1: # subgraph.source
      # These apply to connectors with this source (v1) in this subgraph (example)
      override_url: 'https://api.example.com/v1/beta'
      max_requests_per_operation: 50
      $config:
        my.config.value: true # applies only to this source
    

---

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

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

[svc-apollo-docs]

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: dbf694ff1c60f50ff55f7145

[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