Releases: apollographql/apollo-server
@apollo/[email protected]
BREAKING CHANGES
Apollo Server v5 has very few breaking API changes. It is a small upgrade focused largely on adjusting which versions of Node.js and Express are supported.
Read our migration guide for more details on how to update your app.
- Dropped support for Node.js v14, v16, and v18, which are no longer under long-term support from the Node.js Foundation. Apollo Server 5 supports Node.js v20 and later; v24 is recommended. Ensure you are on a non-EOL version of Node.js before upgrading Apollo Server.
- Dropped support for versions of the
graphql
library older thanv16.11.0
. (Apollo Server 4 supportsgraphql
v16.6.0
or later.) Upgradegraphql
before upgrading Apollo Server. - Express integration requires a separate package. In Apollo Server 4, you could import the Express 4 middleware from
@apollo/server/express4
, or you could import it from the separate package@as-integrations/express4
. In Apollo Server 5, you must import it from the separate package. You can migrate your server to the new package before upgrading to Apollo Server 5. (You can also use@as-integrations/express5
for a middleware that works with Express 5.) - Usage Reporting, Schema Reporting, and Subscription Callback plugins now use the Node.js built-in
fetch
implementation for HTTP requests by default, instead of thenode-fetch
npm package. If your server uses an HTTP proxy to make HTTP requests, you need to configure it in a slightly different way. See the migration guide for details. - The server started with
startStandaloneServer
no longer uses Express. This is mostly invisible, but it does set slightly fewer headers. If you rely on the fact that this server is based on Express, you should explicitly use the Express middleware. - The experimental support for incremental delivery directives
@defer
and@stream
(which requires using a pre-release version ofgraphql
v17) now explicitly only works with version17.0.0-alpha.2
ofgraphql
. Note that this supports the same incremental delivery protocol implemented by Apollo Server 4, which is not the same protocol in the latest alpha version ofgraphql
. As this support is experimental, we may switch over from "onlyalpha.2
is supported" to "only a newer alpha or final release is supported, with a different protocol" during the lifetime of Apollo Server 5. - Apollo Server is now compiled by the TypeScript compiler targeting the ES2023 standard rather than the ES2020 standard.
- Apollo Server 5 responds to requests with variable coercion errors (eg, if a number is passed in the
variables
map for a variable declared in the operation as aString
) with a 400 status code, indicating a client error. This is also the behavior of Apollo Server 3. Apollo Server 4 mistakenly responds to these requests with a 200 status code by default; we recommended the use of thestatus400ForVariableCoercionErrors: true
option to restore the intended behavior. That option now defaults to true. - The unsafe
precomputedNonce
option to landing page plugins (which was only non-deprecated for 8 days) has been removed.
Patch Changes
There are a few other small changes in v5:
-
#8076
5b26558
Thanks @valters! - Fix some error logs to properly calllogger.error
orlogger.warn
withthis
set. This fixes errors or crashes from logger implementations that expectthis
to be set properly in their methods. -
#7515
100233a
Thanks @trevor-scheer! - ApolloServerPluginSubscriptionCallback now takes afetcher
argument, like the usage and schema reporting plugins. The default value is Node's built-in fetch. -
Updated dependencies [
100233a
]:- @apollo/[email protected]
@apollo/[email protected]
Major Changes
- Drop support for Node.JS v14, v16, and v20.
Patch Changes
-
#8076
5b26558
Thanks @valters! - Fix some error logs to properly calllogger.error
orlogger.warn
withthis
set. This fixes errors or crashes from logger implementations that expectthis
to be set properly in their methods. -
Updated dependencies [
5b26558
,100233a
,100233a
,100233a
,100233a
]:- @apollo/[email protected]
@apollo/[email protected]
Major Changes
-
Drop support for Node.JS v14, v16, and v20.
-
The integration test suite no longer uses
lib: ["dom"]
to tell TypeScript to assume DOM-related symbols are in the global namespace. If your integration library's test suite relied on this behavior, you may need to addlib: ["dom"]
to thecompilerOptions
section of your test suite'stsconfig.json
.
Patch Changes
@apollo/[email protected]
Major Changes
- Drop support for Node.JS v14, v16, and v20.
@apollo/[email protected]
BREAKING CHANGES
Apollo Server v5 has very few breaking API changes. It is a small upgrade focused largely on adjusting which versions of Node.js and Express are supported.
Read our migration guide for more details on how to update your app.
- Dropped support for Node.js v14, v16, and v18, which are no longer under long-term support from the Node.js Foundation. Apollo Server 5 supports Node.js v20 and later; v24 is recommended. Ensure you are on a non-EOL version of Node.js before upgrading Apollo Server.
- Dropped support for versions of the
graphql
library older thanv16.11.0
. (Apollo Server 4 supportsgraphql
v16.6.0
or later.) Upgradegraphql
before upgrading Apollo Server. - Express integration requires a separate package. In Apollo Server 4, you could import the Express 4 middleware from
@apollo/server/express4
, or you could import it from the separate package@as-integrations/express4
. In Apollo Server 5, you must import it from the separate package. You can migrate your server to the new package before upgrading to Apollo Server 5. (You can also use@as-integrations/express5
for a middleware that works with Express 5.) - Usage Reporting, Schema Reporting, and Subscription Callback plugins now use the Node.js built-in
fetch
implementation for HTTP requests by default, instead of thenode-fetch
npm package. If your server uses an HTTP proxy to make HTTP requests, you need to configure it in a slightly different way. See the migration guide for details. - The server started with
startStandaloneServer
no longer uses Express. This is mostly invisible, but it does set slightly fewer headers. If you rely on the fact that this server is based on Express, you should explicitly use the Express middleware. - The experimental support for incremental delivery directives
@defer
and@stream
(which requires using a pre-release version ofgraphql
v17) now explicitly only works with version17.0.0-alpha.2
ofgraphql
. Note that this supports the same incremental delivery protocol implemented by Apollo Server 4, which is not the same protocol in the latest alpha version ofgraphql
. As this support is experimental, we may switch over from "onlyalpha.2
is supported" to "only a newer alpha or final release is supported, with a different protocol" during the lifetime of Apollo Server 5. - Apollo Server is now compiled by the TypeScript compiler targeting the ES2023 standard rather than the ES2020 standard.
- Apollo Server 5 responds to requests with variable coercion errors (eg, if a number is passed in the
variables
map for a variable declared in the operation as aString
) with a 400 status code, indicating a client error. This is also the behavior of Apollo Server 3. Apollo Server 4 mistakenly responds to these requests with a 200 status code by default; we recommended the use of thestatus400ForVariableCoercionErrors: true
option to restore the intended behavior. That option now defaults to true. - The unsafe
precomputedNonce
option to landing page plugins (which was only non-deprecated for 8 days) has been removed.
Patch Changes
There are a few other small changes in v5:
-
#8076
5b26558
Thanks @valters! - Fix some error logs to properly calllogger.error
orlogger.warn
withthis
set. This fixes errors or crashes from logger implementations that expectthis
to be set properly in their methods. -
#7515
100233a
Thanks @trevor-scheer! - ApolloServerPluginSubscriptionCallback now takes afetcher
argument, like the usage and schema reporting plugins. The default value is Node's built-in fetch. -
Updated dependencies [
100233a
]:- @apollo/[email protected]
@apollo/[email protected]
Major Changes
- Drop support for Node.JS v14, v16, and v20.
Patch Changes
-
#8076
5b26558
Thanks @valters! - Fix some error logs to properly calllogger.error
orlogger.warn
withthis
set. This fixes errors or crashes from logger implementations that expectthis
to be set properly in their methods. -
Updated dependencies [
5b26558
,100233a
,100233a
,100233a
,100233a
]:- @apollo/[email protected]
@apollo/[email protected]
Major Changes
-
Drop support for Node.JS v14, v16, and v20.
-
The integration test suite no longer uses
lib: ["dom"]
to tell TypeScript to assume DOM-related symbols are in the global namespace. If your integration library's test suite relied on this behavior, you may need to addlib: ["dom"]
to thecompilerOptions
section of your test suite'stsconfig.json
.
Patch Changes
@apollo/[email protected]
Major Changes
- Drop support for Node.JS v14, v16, and v20.
@apollo/[email protected]
(No change; there is a change to the @apollo/server-integration-testsuite
used to test integrations, and the two packages always have matching versions.)
@apollo/[email protected]
Patch Changes
-
#8070
0dee3c9
Thanks @glasser! - Provide dual-build CJS and ESM for@apollo/server-integration-testsuite
.We previously provided only a CJS build of this package, unlike
@apollo/server
itself and the other helper packages that come with it. We may make all of
Apollo Server ESM-only in AS5; this is a step in that direction. Specifically,
only providing this package for CJS makes it challenging to run the tests in
ts-jest
in some ESM-only setups, because the copy of@apollo/server
fetched
directly in your ESM-based test may differ from the copy fetched indirectly via
@apollo/server-integration-testsuite
, causing the "lockstep versioning" test
to fail. -
Updated dependencies:
- @apollo/[email protected]