feat(gateway): Implement new supergraphSdl() config option for dynamic gateway updates (version 2 port)
#1371
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mic gateway updates (#1246) (copied from the changelog entry) This change improves the `supergraphSdl` configuration option to provide a clean and flexible interface for updating gateway schema on load and at runtime. This PR brings a number of updates and deprecations to the gateway. Previous options for loading the gateway's supergraph (`serviceList`, `localServiceList`, `experimental_updateServiceDefinitions`, `experimental_supergraphSdl`) are all deprecated going forward. The migration paths all point to the updated `supergraphSdl` configuration option. The most notable change here is the introduction of the concept of a `SupergraphManager` (one new possible type of `supergraphSdl`). This interface (when implemented) provides a means for userland code to update the gateway supergraph dynamically, perform subgraph healthchecks, and access subgraph datasources. All of the mentioned deprecated configurations now either use an implementation of a `SupergraphManager` internally or export one to be configured by the user (`IntrospectAndCompose` and `LocalCompose`). For now: all of the mentioned deprecated configurations will still continue to work as expected. Their usage will come with deprecation warnings advising a switch to `supergraphSdl`. * `serviceList` users should switch to the now-exported `IntrospectAndCompose` class. * `localServiceList` users should switch to the similar `LocalCompose` class. * `experimental_{updateServiceDefinitions|supergraphSdl}` users should migrate their implementation to a custom `SupergraphSdlHook` or `SupergraphManager`. Since the gateway itself is no longer responsible for composition: * `experimental_didUpdateComposition` has been renamed more appropriately to `experimental_didUpdateSupergraph` (no signature change) * `experimental_compositionDidFail` hook is removed `experimental_pollInterval` is deprecated and will issue a warning. Its renamed equivalent is `pollIntervalInMs`. Some defensive code around gateway shutdown has been removed which was only relevant to users who are running the gateway within `ApolloServer` before v2.18. If you are still running one of these versions, server shutdown may not happen as smoothly.
…s actually consumed by gateway
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
|
This was reviewed extensively and approved in #1246. I cherry picked the commit from that PR, addressed conflicts, and adjusted a few things as needed. I've given it a full pass as a sanity check. Given that CI is passing, I'm going to go ahead and land this. Happy to address any issues if they arise. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is duplicated (ported) to v2 from PR #1246. The description is directly copied from the original PR.
This PR originally introduced a new way to update the gateway dynamically via a
supergraphSdlfunction. It's grown to substantially more than that (internally).Firstly, this PR brings 2 new options for the
supergraphSdlconfig. It can now be aSupergraphSdlHookorSupergraphManager. These new interfaces bring a much more "open" way to achieve gateway updates dynamically. These interfaces are probably best explained by their types (inconfig.ts) and usage examples in the docs. In short, the gateway now exposes a few handles to userland code via this option, which provide access to updating the supergraph, performing subgraph health checks, and accessing a subgraphs datasource.Via some great comments from @glasser, this PR has also turned into a significant refactor (which fortunately tests and proves the flexibility of this interface). All means of updating the gateway now use the
SupergraphManagerinterface under the hood. Ultimately, this should result in no change for existing use cases (minus oneexperimentalhook removal, at the moment).The gateway (instance itself) is no longer responsible for composition or polling. That responsibility now lives in various
SupergraphManagers.The following options are now deprecated, to be removed in a future version of gateway (and relatively soon) - all superseded by the capabilities of
SupergraphManagers. Each of these options remain viable, but we urge you to move tosupergraphSdl.serviceListlocalServiceListexperimental_updateSupergraphSdlexperimental_updateServiceDefinitionsThe
experimental_pollIntervaloption will also be deprecated (to be replaced by an equivalentpollIntervalInMs).Fixes #1180
TODO
serviceListandServiceListShimequivalence?schemaConfigDeliveryEndpoint(unrelated but it should have one via 1283)experimental_pollIntervalin favor ofpollIntervalInMs