Add deprecation warnings for GraphQLExtension usage.
#4135
Merged
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
This introduces a deprecation warning which will be emitted once per extension which is defined in the `extensions` parameter of an Apollo Server configuration. With the introduction of the last missing integration point (`willResolveField`) via the recently landed #3988, the new [[Plugin API]] should now have all of the abilities (a super-set, in fact) of the prior `graphql-extensions` API. Furthermore, rather than being undocumented, rather untested and largely experimental, the new plugin API is considered stable and well-understood in terms of what it aims to support. Its documentation and API are now considered part of the Apollo Server API and we will do our best to maintain first-class support for it, including the addition of new functionality as deemed necessary. As of this commit, we will now print deprecation warnings one time per server start-up for _each_ legacy extension. Since extensions were often defined as factory functions which were invoked on each request - and expected to return an instance of the extension by calling `new` on it - we limit this deprecation warning to once per start-up by attaching a `Symbol` to the `constructor` and skipping the warning when the `Symbol` is already present. An alternative design might use a `Map` to track the `constructor`s at the module-level within `requestPipeline.ts`, but I believe this should be functionally the same. [Plugin API]: https://www.apollographql.com/docs/apollo-server/integrations/plugins/
trevor-scheer
approved these changes
May 18, 2020
| @@ -399,6 +400,88 @@ describe('runQuery', () => { | |||
| } | |||
| } | |||
|
|
|||
| describe('deprecation warnings', () => { | |||
| const queryString = `{ testString }`; | |||
| async function runWithExtAndReturnLogger( | |||
This was referenced Jun 6, 2020
This was referenced Mar 12, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 introduces a deprecation warning which will be emitted once per extension which is defined in the
extensionsparameter of an Apollo Server configuration.With the introduction of the last missing integration point (
willResolveField) via the recently landed #3988, the new Plugin API should now have all of the abilities (a super-set, in fact) of the priorgraphql-extensionsAPI.Furthermore, rather than being undocumented, rather untested and largely experimental, the new plugin API is considered stable and well-understood in terms of what it aims to support. Its documentation and API are now considered part of the Apollo Server API and we will do our best to maintain first-class support for it, including the addition of new functionality as deemed necessary.
As of this commit, we will now print deprecation warnings one time per server start-up for each legacy extension. Since extensions were often defined as factory functions which were invoked on each request - and expected to return an instance of the extension by calling
newon it - we limit this deprecation warning to once per start-up by attaching aSymbolto theconstructorand skipping the warning when theSymbolis already present.An alternative design might use a
Mapto track theconstructors at the module-level withinrequestPipeline.ts, but I believe this should be functionally the same.