Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP edits to AS3 changelog #5286

Merged
merged 4 commits into from
Jun 10, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,14 @@ Certain undersupported and underused Apollo Server features have been removed in

#### Modified functionality

- Apollo Server now always fires the `willSendResponse` lifecycle event after firing `didEncounterError`.
- With one exception, all Apollo Server plugin methods (`requestDidStart`, `didResolveOperation`, etc.) are now `async`.
- Previously, some of these methods were synchronous, others were `async`, and some were "sometimes-`async`" by returning a `ValueOrPromise`.
- The exception is `willResolveField`, which remains synchronous. This method is called much more often than any other plugin method, and converting it to `async` might affect performance.
- In a future release, `willResolveField` might become "sometimes-`async`" by returning a `ValueOrPromise`.
- Apollo Server now always fires the `willSendResponse` plugin lifecycle event after firing `didEncounterError`.
- In certain error cases (mostly related to automated persisted queries), Apollo Server 2 skips firing `willSendResponse`.
- Renamed the `GraphQLService` interface to `GatewayInterface`.
- This interface is the type used to provide a federated gateway instance to Apollo Server. Its name has been changed to reduce ambiguity.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could note that the old name is still exported for backwards compatibility (so that we can have one version of @apollo/gateway that works with both server versions)

- Added support for serving a custom landing page at Apollo Server's base URL.
- Servers in dev mode still default to serving GraphQL Playground (this might change before release), but plugins can define a new `renderLandingPage` hook that returns an HTML page to serve to browsers.
- Removed the `playground` option provided to the `ApolloServer` constructor. You can customize GraphQL Playground or enable it in a production environment by installing the new `ApolloServerPluginLandingPageGraphQLPlayground` plugin.
Expand Down