Version 5 #7515

trevor-scheer · 2023-04-18T00:06:40Z

Apollo Server 5 will be an easy upgrade focused on modernizing its dependencies.

Unlike v3 and v4, it will have a short migration guide that mostly will consist of "make sure you're running current versions of your dependencies". The only non-trivial step will be following the graphql-js v16 to v17 upgrade guide if you used any of its features that have changed.

Dependency changes

Take advantage of dependency changes

Drop node-fetch dependency; switch default fetch implementation to be Node's built-in fetch
Update HTTP proxy docs for Node's built-in fetch
Drop node-abort-controller dependency in favor of Node's built-in AbortController
~~Reimplement hideSchemaDetailsFromClientErrors in terms of new hideSuggestions graphql option~~ not using GraphQL v17
~~Replace hacky isBadUserInputGraphQLError by using new validateExecutionArgs graphql function~~ not using GraphQL v17
Upgrade other dependencies to versions that dropped support for old Node.JS versions
~~Consider adding "max fields per operation" option/plugin taking advantage of graphql v17's AbortSignal functionality (can be shipped in a post-5.0.0 minor release or as a separate package too)~~ not using GraphQL v17

Miscellaneous changes

Remove precomputedNonce landing page configuration option. (This option was introduced and subsequently deprecated in v4. Removing this configuration in v4 is strictly an improvement to the security of your landing page, and no longer exists in v5.)
Change default value of status400ForVariableCoercionErrors configuration option from false to true; this v3-to-v4 regression mitigation will now be enabled by default. Setting this value (to true or false) will log a deprecation warning.

Other tasks

Update startStandaloneServer to not use Express
Audit outstanding PRs to see if there are any other major-version-bump-needing ones to get in (tracked in Apollo Server 5 release process #8089)
Update doc site (v4 and v5 will have a shared "doc version" with minor notes where their behavior differs)
Update READMEs
Write (short!) migration guide
Determine and publish EOL timeline for v4

netlify · 2023-04-18T00:06:51Z

✅ Deploy Preview for apollo-server-docs ready!

Name	Link
🔨 Latest commit	`bca644d`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-server-docs/deploys/64c803dd103ef70008fb68e1
😎 Deploy Preview	https://deploy-preview-7515--apollo-server-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codesandbox-ci · 2023-04-18T21:10:36Z

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.

benasher44 · 2023-07-21T16:57:27Z

packages/server/package.json

+    "@apollo/utils.logger": "^3.0.0",
+    "@apollo/utils.usagereporting": "^3.0.0",
+    "@apollo/utils.withrequired": "^3.0.0",
    "@graphql-tools/schema": "^9.0.0",


We should be able to bump this to ^10.0.0 now, too

Thanks, yeah a couple major dep updates have stacked up since I started this PR that I'll get merged once I get back to it 👍

…ate modifiers)

* Unify v4/v5 docs (migration guide mostly) * Restore `status400ForVariableCoercionErrors` option with proper messaging

Happily, if you're using Node v24, the instructions are very easy!

As per https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping This is slightly different from `@tsconfig/node20`; see tsconfig/bases#308

Docs review for the Proxy Configuration page for AS5! --------- Co-authored-by: David Glasser <[email protected]>

Because we are keeping a single "v4-v5" doc site version, the migration guide is split into a small "upgrading from v4 to v5" page and a longer "upgrading from v3 to v5" page based on the previous v3-to-v4 page. The recommendation in the latter page is to upgrade directly from v3 to v5; we have no docs specific to going from v3 to v4. (This also means we no longer have to document the recommendation to set `status400ForVariableCoercionErrors: true`). In the latter page, any time we describe a change that occurred between v3 and v4, we describe it as "in Apollo Server 4+"; however, when describing how a user will write code today, we describe it as "in Apollo Server 5".

Remaining: - Update docs-examples repo - Minor version bump for graphql-js - Come up with an EOL date for AS4

See apollographql/router#4272

Dealing with this is being tracked in #8089

@trevor-scheer

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. ⚠️

⚠️

⚠️ `main` is currently in **pre mode** so this branch has prereleases rather than normal releases. If you want to exit prereleases, run `changeset pre exit` on `main`. ⚠️

⚠️

⚠️ # Releases ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. ### Patch Changes - [#8078](#8078) [`dabe7ba`](dabe7ba) Thanks [@renovate](https://github.com/apps/renovate)! - Support Jest v30 as well as Jest v29. - Updated dependencies \[[`5b26558`](5b26558), [`100233a`](100233a), [`100233a`](100233a), [`100233a`](100233a), [`100233a`](100233a)]: - @apollo/[email protected] ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. ### Patch Changes - [#8076](#8076) [`5b26558`](5b26558) Thanks [@valters](https://github.com/valters)! - Fix some error logs to properly call `logger.error` or `logger.warn` with `this` set. This fixes errors or crashes from logger implementations that expect `this` to be set properly in their methods. - Updated dependencies \[[`5b26558`](5b26558), [`100233a`](100233a), [`100233a`](100233a), [`100233a`](100233a), [`100233a`](100233a)]: - @apollo/[email protected] ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `precomputedNonce` landing page configuration option This option was introduced and subsequently deprecated in v4. Removing this configuration in v4 is strictly an improvement to the security of your landing page, and no longer exists in v5. - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `status400ForVariableCoercionErrors` configuration option; this regression mitigation is now the default behavior in Apollo Server v5. ### Patch Changes - [#8076](#8076) [`5b26558`](5b26558) Thanks [@valters](https://github.com/valters)! - Fix some error logs to properly call `logger.error` or `logger.warn` with `this` set. This fixes errors or crashes from logger implementations that expect `this` to be set properly in their methods. - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - ApolloServerPluginSubscriptionCallback now takes a `fetcher` argument, like the usage and schema reporting plugins. The default value is Node's built-in fetch. - Updated dependencies \[[`100233a`](100233a)]: - @apollo/[email protected] --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: David Glasser <[email protected]>

@trevor-scheer

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. ### Patch Changes - [#8078](#8078) [`dabe7ba`](dabe7ba) Thanks [@renovate](https://github.com/apps/renovate)! - Support Jest v30 as well as Jest v29. - Updated dependencies \[[`5b26558`](5b26558), [`100233a`](100233a), [`100233a`](100233a), [`100233a`](100233a), [`100233a`](100233a)]: - @apollo/[email protected] ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. ### Patch Changes - [#8076](#8076) [`5b26558`](5b26558) Thanks [@valters](https://github.com/valters)! - Fix some error logs to properly call `logger.error` or `logger.warn` with `this` set. This fixes errors or crashes from logger implementations that expect `this` to be set properly in their methods. ## @apollo/[email protected] ### Major Changes - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node.JS v14, v16, and v20. - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `precomputedNonce` landing page configuration option This option was introduced and subsequently deprecated in v4. Removing this configuration in v4 is strictly an improvement to the security of your landing page, and no longer exists in v5. - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `status400ForVariableCoercionErrors` configuration option; this regression mitigation is now the default behavior in Apollo Server v5. ### Patch Changes - [#8076](#8076) [`5b26558`](5b26558) Thanks [@valters](https://github.com/valters)! - Fix some error logs to properly call `logger.error` or `logger.warn` with `this` set. This fixes errors or crashes from logger implementations that expect `this` to be set properly in their methods. - [#7515](#7515) [`100233a`](100233a) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - ApolloServerPluginSubscriptionCallback now takes a `fetcher` argument, like the usage and schema reporting plugins. The default value is Node's built-in fetch. - Updated dependencies \[[`100233a`](100233a)]: - @apollo/[email protected] --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: David Glasser <[email protected]>

trevor-scheer requested review from StephenBarlow and glasser April 18, 2023 21:19

trevor-scheer marked this pull request as ready for review April 18, 2023 21:20

benasher44 reviewed Jul 21, 2023

View reviewed changes

trevor-scheer added 16 commits July 24, 2023 14:33

initial commit - drop support for node v14

716e00b

changeset

4a6f43c

Specify target of ES2015 (required by lru-cache major which uses priv…

4a9dd74

…ate modifiers)

Stop testing Node 14, start testing Node 20

13f0ee1

missed a target

ec0862d

Remove config option

ed04d99

changeset

440b97b

migration guide

229ffee

v4 docs should no longer redirect to main (which is now v5)

4022320

clean up references to AS4 + misc docs cleanup

f884c9e

pick the highest npm version compatible with CS:CI

9a19cd5

lockfile

2827286

update node version

8cca0cc

Revert a few things

1c538de

* Unify v4/v5 docs (migration guide mostly) * Restore `status400ForVariableCoercionErrors` option with proper messaging

update test

c2ea69b

node 20 test updates

106fc66

trevor-scheer force-pushed the version-5 branch from 1846360 to 106fc66 Compare July 24, 2023 21:44

trevor-scheer requested a review from a team as a code owner July 24, 2023 21:44

trevor-scheer added 6 commits July 24, 2023 15:00

update previously blocked major versions

c7cedc1

remove precomputedNonce

a09145c

target es2015 for smoke tests

4b99b26

cleanup unused imports

5d939f3

Merge branch 'main' into version-5

1c4dd18

remove a couple fixmes

04d8f07

glasser added 2 commits June 16, 2025 17:35

Update proxy configuration for AS5

96396ba

Happily, if you're using Node v24, the instructions are very easy!

Update TS lib/target to ES2023 (supported by Node v20)

685fd33

As per https://github.com/microsoft/TypeScript/wiki/Node-Target-Mapping This is slightly different from `@tsconfig/node20`; see tsconfig/bases#308

mabuyo requested review from mabuyo June 18, 2025 14:34

mabuyo and others added 7 commits June 18, 2025 14:07

AS5 proxy configuration docs suggestions (#8080)

d59b600

Docs review for the Proxy Configuration page for AS5! --------- Co-authored-by: David Glasser <[email protected]>

Update previous-versions

acaaefd

Minor doc improvements

0a53649

Improve how we describe subscription support

f3a94e5

Address all FIXMEs that can easily be addressed offline

f047b68

Remaining: - Update docs-examples repo - Minor version bump for graphql-js - Come up with an EOL date for AS4

Slightly bump graphql-js peer dep

a5d908d

glasser mentioned this pull request Jun 24, 2025

@apollo/server's dependencies are incompatible with TypeScript’s stricter checks in 5.8+. #8081

Closed

glasser added 3 commits June 25, 2025 12:38

The subscription callback protocol has not been preview for a while

dd49923

See apollographql/router#4272

Set AS4 deprecation date

bbeddd1

Miscellaneous doc updates

4d80fd1

glasser mentioned this pull request Jun 25, 2025

Apollo Server 5 release process #8089

Closed

17 tasks

glasser added 5 commits June 27, 2025 13:00

More miscellaneous doc updates

08dd5fe

More doc updates

f1e5c06

Update descriptions of plans

2b16d06

Remove FIXMEs from docs-examples links

c700d79

Dealing with this is being tracked in #8089

Merge branch 'version-4' into version-5

034fca0

glasser approved these changes Jul 1, 2025

View reviewed changes

glasser merged commit 100233a into main Jul 1, 2025
19 of 20 checks passed

glasser deleted the version-5 branch July 1, 2025 22:34

github-actions bot mentioned this pull request Jul 1, 2025

Version Packages (rc) #8092

Merged

github-actions bot mentioned this pull request Jul 16, 2025

Version Packages #8114

Merged

github-actions bot locked as resolved and limited conversation to collaborators Aug 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Version 5 #7515

Version 5 #7515

Uh oh!

trevor-scheer commented Apr 18, 2023 •

edited by glasser

Loading

Uh oh!

netlify bot commented Apr 18, 2023 •

edited

Loading

Uh oh!

codesandbox-ci bot commented Apr 18, 2023 •

edited

Loading

Uh oh!

benasher44 Jul 21, 2023

Uh oh!

trevor-scheer Jul 21, 2023

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Version 5 #7515

Version 5 #7515

Uh oh!

Conversation

trevor-scheer commented Apr 18, 2023 • edited by glasser Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency changes

Take advantage of dependency changes

Miscellaneous changes

Other tasks

Uh oh!

netlify bot commented Apr 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for apollo-server-docs ready!

Uh oh!

codesandbox-ci bot commented Apr 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benasher44 Jul 21, 2023

Choose a reason for hiding this comment

Uh oh!

trevor-scheer Jul 21, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

trevor-scheer commented Apr 18, 2023 •

edited by glasser

Loading

netlify bot commented Apr 18, 2023 •

edited

Loading

codesandbox-ci bot commented Apr 18, 2023 •

edited

Loading