@apollo/[email protected]

Minor Changes

• #8161 51acbeb Thanks @jerelmiller! - Fix an issue where some bundlers would fail to build because of the dynamic import for the optional peer dependency on @yaacovcr/transform introduced in @apollo/server 5.1.0. To provide support for the legacy incremental format, you must now provide the legacyExperimentalExecuteIncrementally option to the ApolloServer constructor.

  import { legacyExecuteIncrementally } from '@yaacovcr/transform';
  
  const server = new ApolloServer({
    // ...
    legacyExperimentalExecuteIncrementally: legacyExecuteIncrementally,
  });

  If the legacyExperimentalExecuteIncrementally option is not provided and the client sends an Accept header with a value of multipart/mixed; deferSpec=20220824, an error is returned by the server.

@apollo/[email protected]

Patch Changes

• Updated dependencies [51acbeb]:
  • @apollo/[email protected]

@apollo/[email protected]

Minor Changes

• #8148 80a1a1a Thanks @jerelmiller! - Apollo Server now supports the incremental delivery protocol (@defer and @stream) that ships with [email protected]. To use the current protocol, clients must send the Accept header with a value of multipart/mixed; incrementalSpec=v0.2.

  Upgrading to 5.1 will depend on what version of graphql you have installed and whether you already support the incremental delivery protocol.

  I use graphql@16 without incremental delivery

  Continue using graphql v16 with no additional changes. Incremental delivery won't be available.

  I use graphql@16 but would like to add support for incremental delivery

  Install [email protected] and follow the "Incremental delivery" guide to add the @defer and @stream directives to your schema. Clients should send the Accept header with a value of multipart/mixed; incrementalSpec=v0.2 to get multipart responses.

  I use [email protected] and use incremental delivery

  You must upgrade to [email protected] to continue using incremental delivery. If you'd like to continue providing support for the legacy incremental protocol, install the @yaacovcr/transform package. Apollo Server will attempt to load this module when the client specifies an Accept header with a value of multipart/mixed; deferSpec=20220824. If this package is not installed, an error is returned by the server.

  Because Apollo Server now supports multiple versions of the incremental delivery types, the existing incremental delivery types have been renamed with an Alpha2 suffix. If you import these types in your code, you will need to add the Alpha2 suffix.

  import type {
  - GraphQLExperimentalFormattedInitialIncrementalExecutionResult,
  + GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha2,
  
  - GraphQLExperimentalFormattedSubsequentIncrementalExecutionResult,
  + GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha2,
  
  - GraphQLExperimentalFormattedIncrementalResult,
  + GraphQLExperimentalFormattedIncrementalResultAlpha2,
  
  - GraphQLExperimentalFormattedIncrementalDeferResult,
  + GraphQLExperimentalFormattedIncrementalDeferResultAlpha2,
  
  - GraphQLExperimentalFormattedIncrementalStreamResult,
  + GraphQLExperimentalFormattedIncrementalStreamResultAlpha2,
  } from '@apollo/server';

  Incremental delivery types for the [email protected] version are now available using the Alpha9 suffix:

  import type {
    GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha9,
    GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha9,
    GraphQLExperimentalFormattedIncrementalResultAlpha9,
    GraphQLExperimentalFormattedIncrementalDeferResultAlpha9,
    GraphQLExperimentalFormattedIncrementalStreamResultAlpha9,
    GraphQLExperimentalFormattedCompletedResultAlpha9,
    GraphQLExperimentalPendingResultAlpha9,
  } from '@apollo/server';

@apollo/[email protected]

Patch Changes

• Updated dependencies [80a1a1a]:
  • @apollo/[email protected]

@apollo/[email protected]

Minor Changes

• #8148 80a1a1a Thanks @jerelmiller! - Apollo Server now supports the incremental delivery protocol (@defer and @stream) that ships with [email protected]. To use the current protocol, clients must send the Accept header with a value of multipart/mixed; incrementalSpec=v0.2.

  Upgrading to 5.1 will depend on what version of graphql you have installed and whether you already support the incremental delivery protocol.

  I use graphql@16 without incremental delivery

  Continue using graphql v16 with no additional changes. Incremental delivery won't be available.

  I use graphql@16 but would like to add support for incremental delivery

  Install [email protected] and follow the "Incremental delivery" guide to add the @defer and @stream directives to your schema. Clients should send the Accept header with a value of multipart/mixed; incrementalSpec=v0.2 to get multipart responses.

  I use [email protected] and use incremental delivery

  You must upgrade to [email protected] to continue using incremental delivery. If you'd like to continue providing support for the legacy incremental protocol, install the @yaacovcr/transform package. Apollo Server will attempt to load this module when the client specifies an Accept header with a value of multipart/mixed; deferSpec=20220824. If this package is not installed, an error is returned by the server.

  Because Apollo Server now supports multiple versions of the incremental delivery types, the existing incremental delivery types have been renamed with an Alpha2 suffix. If you import these types in your code, you will need to add the Alpha2 suffix.

  import type {
  - GraphQLExperimentalFormattedInitialIncrementalExecutionResult,
  + GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha2,
  
  - GraphQLExperimentalFormattedSubsequentIncrementalExecutionResult,
  + GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha2,
  
  - GraphQLExperimentalFormattedIncrementalResult,
  + GraphQLExperimentalFormattedIncrementalResultAlpha2,
  
  - GraphQLExperimentalFormattedIncrementalDeferResult,
  + GraphQLExperimentalFormattedIncrementalDeferResultAlpha2,
  
  - GraphQLExperimentalFormattedIncrementalStreamResult,
  + GraphQLExperimentalFormattedIncrementalStreamResultAlpha2,
  } from '@apollo/server';

  Incremental delivery types for the [email protected] version are now available using the Alpha9 suffix:

  import type {
    GraphQLExperimentalFormattedInitialIncrementalExecutionResultAlpha9,
    GraphQLExperimentalFormattedSubsequentIncrementalExecutionResultAlpha9,
    GraphQLExperimentalFormattedIncrementalResultAlpha9,
    GraphQLExperimentalFormattedIncrementalDeferResultAlpha9,
    GraphQLExperimentalFormattedIncrementalStreamResultAlpha9,
    GraphQLExperimentalFormattedCompletedResultAlpha9,
    GraphQLExperimentalPendingResultAlpha9,
  } from '@apollo/server';

@apollo/[email protected]

Patch Changes

• Updated dependencies [80a1a1a]:
  • @apollo/[email protected]

@apollo/[email protected]

Patch Changes

• Updated dependencies [80a1a1a]:
  • @apollo/[email protected]

@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 than v16.11.0. (Apollo Server 4 supports graphql v16.6.0 or later.) Upgrade graphql 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 the node-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 of graphql v17) now explicitly only works with version 17.0.0-alpha.2 of graphql. 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 of graphql. As this support is experimental, we may switch over from "only alpha.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 a String) 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 the status400ForVariableCoercionErrors: 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 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 100233a Thanks @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]:

  • @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 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, 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 add lib: ["dom"] to the compilerOptions section of your test suite's tsconfig.json.

Patch Changes

• #8078 dabe7ba Thanks @renovate! - Support Jest v30 as well as Jest v29.

• Updated dependencies [5b26558, 100233a, 100233a, 100233a, 100233a]:

  • @apollo/[email protected]