Skip to content

subscriptions.mdx

Latest commit

 

History

History
835 lines (628 loc) · 31.7 KB

subscriptions.mdx

File metadata and controls

835 lines (628 loc) · 31.7 KB
title Subscriptions in Apollo Server
description Persistent GraphQL read operations

Apollo Server 3 removes built-in support for subscriptions. You can reenable support as described below.

Subscriptions are not currently supported in Apollo Federation.

This article has been updated to use the graphql-ws library to add support for subscriptions to Apollo Server. We no longer recommend using the previously documented subscriptions-transport-ws, because this library is not actively maintained. For more information about the differences between the two libraries, see Switching from subscriptions-transport-ws.

Subscriptions are long-lasting GraphQL read operations that can update their result whenever a particular server-side event occurs. Most commonly, updated results are pushed from the server to subscribing clients. For example, a chat application's server might use a subscription to push newly received messages to all clients in a particular chat room.

Because subscription updates are usually pushed by the server (instead of polled by the client), they usually use the WebSocket protocol instead of HTTP.

Important: Compared to queries and mutations, subscriptions are significantly more complex to implement. Before you begin, confirm that your use case requires subscriptions.

Schema definition

Your schema's Subscription type defines top-level fields that clients can subscribe to:

type Subscription {
  postCreated: Post
}

The postCreated field will update its value whenever a new Post is created on the backend, thus pushing the Post to subscribing clients.

Clients can subscribe to the postCreated field with a GraphQL string, like this:

subscription PostFeed {
  postCreated {
    author
    comment
  }
}

Each subscription operation can subscribe to only one field of the Subscription type.

Enabling subscriptions

Beginning in Apollo Server 3, subscriptions are not supported by the "batteries-included" apollo-server package. To enable subscriptions, you must first swap to the apollo-server-express package (or any other Apollo Server integration package that supports subscriptions).

The following steps assume you've already swapped to apollo-server-express.

To run both an Express app and a separate WebSocket server for subscriptions, we'll create an http.Server instance that effectively wraps the two and becomes our new listener.

  1. Install graphql-ws, ws, @graphql-tools/schema, and apollo-server-core:

    npm install graphql-ws ws @graphql-tools/schema apollo-server-core

  2. Add the following imports to the file where you initialize your ApolloServer instance (we'll use these in later steps):

    import { createServer } from 'http';
import {
  ApolloServerPluginDrainHttpServer,
  ApolloServerPluginLandingPageLocalDefault,
} from "apollo-server-core";
import { makeExecutableSchema } from '@graphql-tools/schema';
import { WebSocketServer } from 'ws';
import { useServer } from 'graphql-ws/lib/use/ws';

  3. Next, in order to set up both the HTTP and subscription servers, we need to first create an http.Server. Do this by passing your Express app to the createServer function, which we imported from the http module:

    // This `app` is the returned value from `express()`.
const httpServer = createServer(app);

  4. Create an instance of GraphQLSchema (if you haven't already).

    If you already pass the schema option to the ApolloServer constructor (instead of typeDefs and resolvers), you can skip this step.

    The subscription server (which we'll instantiate next) doesn't take typeDefs and resolvers options. Instead, it takes an executable GraphQLSchema. We can pass this schema object to both the subscription server and ApolloServer. This way, we make sure that the same schema is being used in both places.

    const schema = makeExecutableSchema({ typeDefs, resolvers });
// ...
const server = new ApolloServer({
  schema,
  csrfPrevention: true,
  cache: "bounded",
  plugins: [
    ApolloServerPluginLandingPageLocalDefault({ embed: true }),
  ],
});

  5. Create a WebSocketServer to use as your subscription server.

      // Creating the WebSocket server
  const wsServer = new WebSocketServer({
    // This is the `httpServer` we created in a previous step.
    server: httpServer,
    // Pass a different path here if your ApolloServer serves at
    // a different path.
    path: '/graphql',
  });

  // Hand in the schema we just created and have the
  // WebSocketServer start listening.
  const serverCleanup = useServer({ schema }, wsServer);

  6. Add plugins to your ApolloServer constructor to shutdown both the HTTP server and the WebSocketServer:

      const server = new ApolloServer({
    schema,
    csrfPrevention: true,
    cache: "bounded",
    plugins: [
      // Proper shutdown for the HTTP server.
      ApolloServerPluginDrainHttpServer({ httpServer }),

      // Proper shutdown for the WebSocket server.
      {
        async serverWillStart() {
          return {
            async drainServer() {
              await serverCleanup.dispose();
            },
          };
        },
      },
      ApolloServerPluginLandingPageLocalDefault({ embed: true }),
    ],
  });

  7. Finally, ensure you are listening to your httpServer.

    Most Express applications call app.listen(...), but for your setup change this to httpServer.listen(...) using the same arguments. This way, the server starts listening on the HTTP and WebSocket transports simultaneously.

A completed example of setting up subscriptions is shown below:

import { ApolloServer } from 'apollo-server-express';
import { createServer } from 'http';
import express from 'express';
import { ApolloServerPluginDrainHttpServer } from "apollo-server-core";
import { makeExecutableSchema } from '@graphql-tools/schema';
import { WebSocketServer } from 'ws';
import { useServer } from 'graphql-ws/lib/use/ws';
import resolvers from './resolvers';
import typeDefs from './typeDefs';

// Create the schema, which will be used separately by ApolloServer and
// the WebSocket server.
const schema = makeExecutableSchema({ typeDefs, resolvers });

// Create an Express app and HTTP server; we will attach both the WebSocket
// server and the ApolloServer to this HTTP server.
const app = express();
const httpServer = createServer(app);

// Create our WebSocket server using the HTTP server we just set up.
const wsServer = new WebSocketServer({
  server: httpServer,
  path: '/graphql',
});
// Save the returned server's info so we can shutdown this server later
const serverCleanup = useServer({ schema }, wsServer);

// Set up ApolloServer.
const server = new ApolloServer({
  schema,
  csrfPrevention: true,
  cache: "bounded",
  plugins: [
    // Proper shutdown for the HTTP server.
    ApolloServerPluginDrainHttpServer({ httpServer }),

    // Proper shutdown for the WebSocket server.
    {
      async serverWillStart() {
        return {
          async drainServer() {
            await serverCleanup.dispose();
          },
        };
      },
    },
    ApolloServerPluginLandingPageLocalDefault({ embed: true }),
  ],
});
await server.start();
server.applyMiddleware({ app });

const PORT = 4000;
// Now that our HTTP server is fully set up, we can listen to it.
httpServer.listen(PORT, () => {
  console.log(
    `Server is now running on http://localhost:${PORT}${server.graphqlPath}`,
  );
});

⚠️ Running into an error? If you're using the graphql-ws library, your specified subscription protocol must be consistent across your backend, frontend, and every other tool you use (including Apollo Sandbox. For more information, see Switching from subscriptions-transport-ws.

Resolving a subscription

Resolvers for Subscription fields differ from resolvers for fields of other types. Specifically, Subscription field resolvers are objects that define a subscribe function:

const resolvers = {
  Subscription: {
    hello: {
      // Example using an async generator
      subscribe: async function* () {
        for await (const word of ["Hello", "Bonjour", "Ciao"]) {
          yield { hello: word };
        }
      },
    },
    postCreated: {
      // More on pubsub below
      subscribe: () => pubsub.asyncIterator(['POST_CREATED']),
    },
  },
  // ...other resolvers...
};

The subscribe function must return an object of type AsyncIterator, a standard interface for iterating over asynchronous results. In the above postCreated.subscribe field, an AsyncIterator is generated by pubsub.asyncIterator (more on this below).

The PubSub class

The PubSub class is not recommended for production environments, because it's an in-memory event system that only supports a single server instance. After you get subscriptions working in development, we strongly recommend switching it out for a different subclass of the abstract PubSubEngine class. Recommended subclasses are listed in Production PubSub libraries.

Apollo Server uses a publish-subscribe (pub/sub) model to track events that update active subscriptions. The graphql-subscriptions library provides the PubSub class as a basic in-memory event bus to help you get started:

To use the graphql-subscriptions package, first install it like so:

npm install graphql-subscriptions

A PubSub instance enables your server code to both publish events to a particular label and listen for events associated with a particular label. We can create a PubSub instance like so:

import { PubSub } from 'graphql-subscriptions';

const pubsub = new PubSub();

Publishing an event

You can publish an event using the publish method of a PubSub instance:

pubsub.publish('POST_CREATED', {
  postCreated: {
    author: 'Ali Baba',
    comment: 'Open sesame'
  }
});
  • The first parameter is the name of the event label you're publishing to, as a string.
    • You don't need to register a label name before publishing to it.
  • The second parameter is the payload associated with the event.
    • The payload should include whatever data is necessary for your resolvers to populate the associated Subscription field and its subfields.

When working with GraphQL subscriptions, you publish an event whenever a subscription's return value should be updated. One common cause of such an update is a mutation, but any back-end logic might result in changes that should be published.

As an example, let's say our GraphQL API supports a createPost mutation:

type Mutation {
  createPost(author: String, comment: String): Post
}

A basic resolver for createPost might look like this:

const resolvers = {
  Mutation: {
    createPost(parent, args, context) {
      // Datastore logic lives in postController
      return postController.createPost(args);
    },
  },
  // ...other resolvers...
};

Before we persist the new post's details in our datastore, we can publish an event that also includes those details:

const resolvers = {
  Mutation: {
    createPost(parent, args, context) {
      pubsub.publish('POST_CREATED', { postCreated: args }); // highlight-line
      return postController.createPost(args);
    },
  },
  // ...other resolvers...
};

Next, we can listen for this event in our Subscription field's resolver.

Listening for events

An AsyncIterator object listens for events that are associated with a particular label (or set of labels) and adds them to a queue for processing.

You can create an AsyncIterator by calling the asyncIterator method of PubSub and passing in an array containing the names of the event labels that this AsyncIterator should listen for.

pubsub.asyncIterator(['POST_CREATED']);

Every Subscription field resolver's subscribe function must return an AsyncIterator object.

This brings us back to the code sample at the top of Resolving a subscription:

const resolvers = {
  Subscription: {
    postCreated: {
      subscribe: () => pubsub.asyncIterator(['POST_CREATED']),
    },
  },
  // ...other resolvers...
};

With this subscribe function set, Apollo Server uses the payloads of POST_CREATED events to push updated values for the postCreated field.

Filtering events

Sometimes, a client should only receive updated subscription data if that data meets certain criteria. To support this, you can call the withFilter helper function in your Subscription field's resolver.

Example

Let's say our server provides a commentAdded subscription, which should notify clients whenever a comment is added to a specified code repository. A client can execute a subscription that looks like this:

subscription($repoName: String!){
  commentAdded(repoFullName: $repoName) {
    id
    content
  }
}

This presents a potential issue: our server probably publishes a COMMENT_ADDED event whenever a comment is added to any repository. This means that the commentAdded resolver executes for every new comment, regardless of which repository it's added to. As a result, subscribing clients might receive data they don't want (or shouldn't even have access to).

To fix this, we can use the withFilter helper function to control updates on a per-client basis.

Here's an example resolver for commentAdded that uses the withFilter function:

import { withFilter } from 'graphql-subscriptions';

const resolvers = {
  Subscription: {
    commentAdded: {
      subscribe: withFilter(
        () => pubsub.asyncIterator('COMMENT_ADDED'),
        (payload, variables) => {
          // Only push an update if the comment is on
          // the correct repository for this operation
          return (payload.commentAdded.repository_name === variables.repoFullName);
        },
      ),
    }
  },
    // ...other resolvers...
};

The withFilter function takes two parameters:

  • The first parameter is exactly the function you would use for subscribe if you weren't applying a filter.
  • The second parameter is a filter function that returns true if a subscription update should be sent to a particular client, and false otherwise (Promise<boolean> is also allowed). This function takes two parameters of its own:
    • payload is the payload of the event that was published.
    • variables is an object containing all arguments the client provided when initiating their subscription.

Use withFilter to make sure clients get exactly the subscription updates they want (and are allowed to receive).

Basic runnable example

An example server is available on GitHub and CodeSandbox:

Edit server-subscriptions-as3

The server exposes one subscription (numberIncremented) that returns an integer that's incremented on the server every second. Here's an example subscription that you can run against your server:

subscription IncrementingNumber {
  numberIncremented
}

If you don't see the result of your subscription operation you might need to adjust your Sandbox settings to use the graphql-ws protocol.

After you start up the server in CodeSandbox, follow the instructions in the browser to test running the numberIncremented subscription in Apollo Sandbox. You should see the subscription's value update every second.

Operation context

When initializing context for a query or mutation, you usually extract HTTP headers and other request metadata from the req object provided to the context function.

For subscriptions, you can extract information from a client's request by adding options to the first argument passed to the useServer function.

For example, you can provide a context property to add values to your GraphQL operation context:

// ...
useServer(
  {
    // Our GraphQL schema.
    schema,
    // Adding a context property lets you add data to your GraphQL operation context
     context: (ctx, msg, args) => {
       // You can define your own function for setting a dynamic context
       // or provide a static value
      return getDynamicContext(ctx, msg, args);
    },
  },
  wsServer,
);

Notice that the first parameter passed to the context function above is ctx. The ctx object represents the context of your subscription server, not the GraphQL operation context that's passed to your resolvers.

You can access the parameters of a client's subscription request to your WebSocket server via the ctx.connectionParams property.

Below is an example of the common use case of extracting an authentication token from a client subscription request and using it to find the current user:

const getDynamicContext = async (ctx, msg, args) => {
  // ctx is the graphql-ws Context where connectionParams live
 if (ctx.connectionParams.authentication) {
    const currentUser = await findUser(ctx.connectionParams.authentication);
    return { currentUser };
  }
  // Otherwise let our resolvers know we don't have a current user
  return { currentUser: null };
};

useServer(
  {
    schema,
    // Adding a context property lets you add data to your GraphQL operation context
     context: (ctx, msg, args) => {
       // Returning an object will add that information to our
       // GraphQL context, which all of our resolvers have access to.
      return getDynamicContext(ctx, msg, args);
    },
  },
  wsServer,
);

Putting it all together, if the useServer.context function returns an object, that object is passed to the GraphQL operation context, which is available to your resolvers.

Note that the context option is called once per subscription request, not once per event emission. This means that in the above example, every time a client sends a subscription operation, we check their authentication token.

onConnect and onDisconnect

You can configure the subscription server's behavior whenever a client connects (onConnect) or disconnects (onDisconnect).

Defining an onConnect function enables you to reject a particular incoming connection by returning false or by throwing an exception. This can be helpful if you want to check authentication when a client first connects to your subscription server.

You provide these functions as options to the first argument of useServer, like so:

useServer(
  {
    schema,
    // As before, ctx is the graphql-ws Context where connectionParams live.
    onConnect: async (ctx) => {
      // Check authentication every time a client connects.
      if (tokenIsNotValid(ctx.connectionParams)) {
        // You can return false to close the connection  or throw an explicit error
        throw new Error('Auth token missing!');
      }
    },
    onDisconnect(ctx, code, reason) {
      console.log('Disconnected!');
    },
  },
  wsServer,
);

For more information and examples of using onConnect and onDisconnect, see the graphql-ws documentation.

Example: Authentication with Apollo Client

If you plan to use subscriptions with Apollo Client, ensure both your client and server subscription protocols are consistent for the subscription library you're using (this example uses the graphql-ws library).

In Apollo Client, the GraphQLWsLink constructor supports adding information to connectionParams (example). Those connectionParams are sent to your server when it connects, allowing you to extract information from the client request by accessing Context.connectionParams.

Let's suppose we create our subscription client like so:

import { GraphQLWsLink } from '@apollo/client/link/subscriptions';
import { createClient } from 'graphql-ws';

const wsLink = new GraphQLWsLink(createClient({
  url: 'ws://localhost:4000/subscriptions',
  connectionParams: {
    authentication: user.authToken,
  },
}));

The connectionParams argument (which contains the information provided by the client) is passed to your server, enabling you to validate the user's credentials.

From there you can use the useServer.context property to authenticate the user, returning an object that's passed into your resolvers as the context argument during execution.

For our example, we can use the connectionParams.authentication value provided by the client to look up the related user before passing that user along to our resolvers:

const findUser = async (authToken) => {
  // Find a user by their auth token
};

const getDynamicContext = async (ctx, msg, args) => {
 if (ctx.connectionParams.authentication) {
    const currentUser = await findUser(connectionParams.authentication);
    return { currentUser };
  }
  // Let the resolvers know we don't have a current user so they can
  // throw the appropriate error
  return { currentUser: null };
};

// ...
useServer(
  {
    // Our GraphQL schema.
    schema,
     context: (ctx, msg, args) => {
       // This will be run every time the client sends a subscription request
      return getDynamicContext(ctx, msg, args);
    },
  },
  wsServer,
);

To sum up, the example above looks up a user based on the authentication token sent with each subscription request before returning the user object to be used by our resolvers. If no user exists or the lookup otherwise fails, our resolvers can throw an error and the corresponding subscription operation is not executed.

Production PubSub libraries

As mentioned above, the PubSub class is not recommended for production environments, because its event-publishing system is in-memory. This means that events published by one instance of your GraphQL server are not received by subscriptions that are handled by other instances.

Instead, you should use a subclass of the PubSubEngine abstract class that you can back with an external datastore such as Redis or Kafka.

The following are community-created PubSub libraries for popular event-publishing systems:

If none of these libraries fits your use case, you can also create your own PubSubEngine subclass. If you create a new open-source library, click Edit on GitHub to let us know about it!

Switching from subscriptions-transport-ws

If you use subscriptions with Apollo Client you must ensure both your client and server subscription protocols are consistent for the subscription library you're using.

This article previously demonstrated using the subscriptions-transport-ws library to set up subscriptions. However, this library is no longer actively maintained. You can still use it with Apollo Server, but we strongly recommend using graphql-ws instead.

For more information on using Apollo Server with subscriptions-transport-ws, you can view the previous version of this article.

Updating subscription clients

If you intend to switch from subscriptions-transport-ws to graphql-ws you will need to update the following clients:

Client Name To use graphql-ws (RECOMMENDED) To use subscriptions-transport-ws

Apollo Studio Explorer

graphql-ws

subscriptions-transport-ws

Apollo Client Web

Use GraphQLWsLink
(Requires v3.5.10 or later)

Use WebSocketLink

Apollo iOS

graphql_transport_ws
(Requires v0.51.0 or later)

graphql_ws

Apollo Kotlin

GraphQLWsProtocol
(Requires v3.0.0 or later)

SubscriptionWsProtocol

Switching to graphql-ws

The following steps assume you've already swapped to the apollo-server-express package.

To switch from subscriptions-transport-ws to graphql-ws, you can follow the steps below.

  1. Install graphql-ws and ws into your app:

    npm install graphql-ws ws

  2. Add the following imports to the file where you initialize your HTTP and subscription servers:

    import { WebSocketServer } from 'ws';
import { useServer } from 'graphql-ws/lib/use/ws';

  3. Instantiate a WebSocketServer to use as your new subscription server. This server will replace the SubscriptionServer from subscriptions-transport-ws.

  // Creating the WebSocket subscription server
  const wsServer = new WebSocketServer({
    // This is the `httpServer` returned by createServer(app);
    server: httpServer,
    // Pass a different path here if your ApolloServer serves at
    // a different path.
    path: "/graphql",
  });

  // Passing in an instance of a GraphQLSchema and
  // telling the WebSocketServer to start listening
  const serverCleanup = useServer({ schema }, wsServer);
  const subscriptionServer = SubscriptionServer.create(
    {
      schema,
      // These are imported from `graphql`.
      execute,
      subscribe,
    },
    {
      server: httpServer,
      path: "/graphql",
    },
  );

If your SubscriptionServer extracts information from a subscription to use in your GraphQL operation context, you can configure your new WebSocket server to do the same.

For example, if your SubscriptionServer checks a client's authentication token and adds the current user to the GraphQL operation context:

  const subscriptionServer = SubscriptionServer.create(
    {
      schema,
      execute,
      subscribe,
      // This will check authentication every time a
      // client first connects to the subscription server.
      async onConnect(connectionParams) {
        if (connectionParams.authentication) {
          const currentUser = await findUser(connectionParams.authentication);
          return { currentUser };
        }
        throw new Error("Missing auth token!");
      },
    },
    {
      server: httpServer,
      path: "/graphql",
    },
  );

You can replicate this behavior by providing a context option to the first argument passed to the useServer function.

In the example below, we check a client's authentication every time they send a subscription operation. If that user exists, we then add the current user to our GraphQL operation context:

const getDynamicContext = async (ctx, msg, args) => {
  // ctx is the `graphql-ws` Context where connectionParams live
 if (ctx.connectionParams.authentication) {
    const currentUser = await findUser(connectionParams.authentication);
    return { currentUser };
  }
  return { currentUser: null };
};

useServer(
  {
    schema,
    // Adding a context property lets you add data to your GraphQL operation context.
     context: (ctx, msg, args) => {
       // Returning an object here will add that information to our
       // GraphQL context, which all of our resolvers have access to.
      return getDynamicContext(ctx, msg, args);
    },
  },
  wsServer,
);

See Operation Context for more examples of setting GraphQL operation context.

  1. Add a plugin to your ApolloServer constructor to properly shutdown your new WebSocketServer:
  const server = new ApolloServer({
    schema,
    plugins: [
      // Proper shutdown for the WebSocket server.
      {
        async serverWillStart() {
          return {
            async drainServer() {
              await serverCleanup.dispose();
            },
          };
        },
      },
    ],
  });
  1. Ensure you are listening to your httpServer call. You can now remove the code related to your SubscriptionServer, start your HTTP server, and test that everything works.

If everything is running smoothly, you can (and should) uninstall subscriptions-transport-ws. The final step is to update all your subscription clients to ensure they use the same subscription protocol.