schema-reporting: Options renaming + remove experimental_ prefix #4236
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
sachindshinde
force-pushed
the
sachin/remove-experimental-from-schema-reporting
branch
from
b9bc287
to
b3c3c69
Compare
This was referenced Jun 12, 2020
glasser
reviewed
Jun 12, 2020
CHANGELOG.md
Outdated
| @@ -12,6 +12,9 @@ The version headers in this history reflect the versions of Apollo Server itself | |||
| - `apollo-engine-reporting`: Add environment variable `APOLLO_SCHEMA_REPORTING` that can enable schema reporting. If `experimental__schemaReporting` is set it will override the environment variable. [PR #4206](https://github.com/apollographql/apollo-server/pull/4206) | |||
| - `apollo-engine-reporting`: The schema reporting URL has been changed to use the new dedicated sub-domain `https://edge-server-reporting.api.apollographql.com`. [PR #4232](https://github.com/apollographql/apollo-server/pull/4232) | |||
| - `apollo-server-core`: Though Apollo Server **is not affected** due to the way it is integrated, in response to [an upstream security advisory for GraphQL Playground](https://github.com/prisma-labs/graphql-playground/security/advisories/GHSA-4852-vrh7-28rf) we have published [the same patch](https://github.com/prisma-labs/graphql-playground/commit/bf1883db538c97b076801a60677733816cb3cfb7) on our `@apollographql/graphql-playground-html` fork and bumped Apollo Server to use it. Again, this was done out of an **abundance of caution** since the way that Apollo Server utilizes `renderPlaygroundPage` is _not_ vulnerable as it does not allow per-request Playground configuration that could allow interpolation of user-input. [PR #4231](https://github.com/apollographql/apollo-server/pull/4231) | |||
| - `apollo-engine-reporting`: Change the `experimental_schemaReporting` option name to `experimental_reportSchema`. [PR #4236](https://github.com/apollographql/apollo-server/pull/4236) | |||
There was a problem hiding this comment.
Surely this shouldn't contain experimental?
There was a problem hiding this comment.
Sorry for the confusion, I made two changelog entries here when really I should have just condensed them into one.
sachindshinde
force-pushed
the
sachin/remove-experimental-from-schema-reporting
branch
2 times, most recently
from
2e88316
to
8194e87
Compare
jsegaran
reviewed
Jun 15, 2020
There was a problem hiding this comment.
I think instead of whole sale removing the experimental_ fields we should deprecate them. In the case someone is using JS they will not get any feedback from their code/build processes that the experimental fields are removed, and we will break the build for anyone using ts.
|
I also think you will want to add a line to |
sachindshinde
force-pushed
the
sachin/remove-experimental-from-schema-reporting
branch
from
8194e87
to
814b710
Compare
|
I've changed the target branch to |
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 PR removes the
experimental_prefix from schema reporting option names, and specifically changesexperimental_schemaReportingtoreportSchema. Note that the old option names are still there, but they've been marked@deprecatedand trying to use them will log a warning.