feat(fastify): Integrate apollo-fastify plugin #626 [WIP]

package.json

@@ -51,6 +51,7 @@
     "apollo-server-env": "file:packages/apollo-server-env",
     "apollo-server-errors": "file:packages/apollo-server-errors",
     "apollo-server-express": "file:packages/apollo-server-express",
+    "apollo-server-fastify": "file:packages/apollo-server-fastify",
     "apollo-server-hapi": "file:packages/apollo-server-hapi",
     "apollo-server-integration-testsuite": "file:packages/apollo-server-integration-testsuite",
     "apollo-server-koa": "file:packages/apollo-server-koa",
@@ -94,6 +95,7 @@
     "codecov": "3.1.0",
     "connect": "3.6.6",
     "express": "4.16.4",
+    "fastify": "1.12.1",
     "fibers": "3.0.0",
     "form-data": "2.3.3",
     "graphql": "14.0.2",

packages/apollo-server-fastify/.npmignore

@@ -0,0 +1,6 @@
+*
+!src/**/*
+!dist/**/*
+dist/**/*.test.*
+!package.json
+!README.md

packages/apollo-server-fastify/README.md

@@ -0,0 +1,42 @@
+---
+title: Fastify
+description: Setting up Apollo Server with Fastify
+---
+
+[![Coverage Status](https://coveralls.io/repos/github/apollographql/apollo-server/badge.svg?branch=master)](https://coveralls.io/github/apollographql/apollo-server?branch=master) [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://www.apollographql.com/#slack)
+
+This is the Fastify integration of GraphQL Server. Apollo Server is a community-maintained open-source GraphQL server that works with all Node.js HTTP server frameworks: Express, Connect, Fastify, Hapi, Koa and Restify. [Read the docs](https://www.apollographql.com/docs/apollo-server/). [Read the CHANGELOG.](https://github.com/apollographql/apollo-server/blob/master/CHANGELOG.md)
+
+```sh
+npm install apollo-server-fastify
+```
+
+## Fastify
+
+```js
+import fastify from 'fastify';
+import { graphqlFastify } from 'apollo-server-fastify';
+
+const myGraphQLSchema = // ... define or import your schema here!
+
+const app = fastify();
+
+app.register(graphqlFastify, { schema: myGraphQLSchema });
+
+try {
+  await app.listen(3007);
+} catch (err) {
+  app.log.error(err);
+  process.exit(1);
+}
+```
+
+## Principles
+
+GraphQL Server is built with the following principles in mind:
+
+* **By the community, for the community**: GraphQL Server's development is driven by the needs of developers
+* **Simplicity**: by keeping things simple, GraphQL Server is easier to use, easier to contribute to, and more secure
+* **Performance**: GraphQL Server is well-tested and production-ready - no modifications needed
+
+Anyone is welcome to contribute to GraphQL Server, just read [CONTRIBUTING.md](https://github.com/apollographql/apollo-server/blob/master/CONTRIBUTING.md), take a look at the [roadmap](https://github.com/apollographql/apollo-server/blob/master/ROADMAP.md) and make your first PR!

packages/apollo-server-fastify/jest.config.js

@@ -0,0 +1,3 @@
+const config = require('../../jest.config.base');
+
+module.exports = Object.assign(Object.create(null), config);

packages/apollo-server-fastify/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "apollo-server-fastify",
+  "version": "2.0.0",
+  "description": "Production-ready Node.js GraphQL server for fastify",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-fastify"
+  },
+  "engines": {
+    "node": ">=8"
+  },
+  "keywords": [
+    "GraphQL",
+    "Apollo",
+    "Server",
+    "Fastify",
+    "Javascript"
+  ],
+  "author": "Aditya pratap Singh <adisinghrajput@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/apollographql/apollo-server/issues"
+  },
+  "homepage": "https://github.com/apollographql/apollo-server#readme",
+  "dependencies": {
+    "@apollographql/apollo-upload-server": "^5.0.3",
+    "@apollographql/graphql-playground-html": "^1.6.0",
+    "apollo-server-core": "file:../apollo-server-core",
+    "fastify-accepts": "^0.5.0",
+    "graphql-subscriptions": "^0.5.8",
+    "graphql-tools": "^4.0.0"
+  },
+  "devDependencies": {
+    "apollo-server-integration-testsuite": "file:../apollo-server-integration-testsuite"
+  },
+  "peerDependencies": {
+    "graphql": "^0.12.0 || ^0.13.0 || ^14.0.0"
+  }
+}

packages/apollo-server-fastify/src/ApolloServer.ts

@@ -0,0 +1,139 @@
+import * as fastify from 'fastify';
+import { FastifyReply } from 'fastify';
+import { FastifyInstance } from 'fastify';
+const { parseAll } = require('fastify-accepts');
+import {
+  renderPlaygroundPage,
+  RenderPageOptions as PlaygroundRenderPageOptions,
+} from '@apollographql/graphql-playground-html';
+
+import { graphqlFastify } from './fastifyApollo';
+
+export { GraphQLOptions, GraphQLExtension } from 'apollo-server-core';
+import { ApolloServerBase, GraphQLOptions } from 'apollo-server-core';
+import { IncomingMessage, OutgoingMessage } from 'http';
+
+export class ApolloServer extends ApolloServerBase {
+  async createGraphQLServerOptions(
+    request: fastify.FastifyRequest<IncomingMessage>,
+    reply: fastify.FastifyReply<OutgoingMessage>,
+  ): Promise<GraphQLOptions> {
+    return await super.graphQLServerOptions({ request, reply });
+  }
+
+  protected supportsSubscriptions(): boolean {
+    return true;
+  }
+
+  protected supportsUploads(): boolean {
+    return true;
+  }
+
+  public async applyMiddleware({
+    app,
+    cors,
+    path,
+    route,
+    disableHealthCheck,
+    onHealthCheck,
+  }: ServerRegistration) {
+    if (!path) path = '/graphql';
+
+    await app.addHook(
+      'preHandler',
+      function(
+        this: any,
+        request: any,
+        reply: FastifyReply<OutgoingMessage>,
+        next: any,
+      ) {
+        if (request.path !== path) {
+          return next();
+        }
+
+        if (this.playgroundOptions && request.method === 'get') {
+          // perform more expensive content-type check only if necessary
+          const accept = parseAll(request.headers);
+          const types = accept.mediaTypes as string[];
+          const prefersHTML =
+            types.find(
+              (x: string) => x === 'text/html' || x === 'application/json',
+            ) === 'text/html';
+
+          if (prefersHTML) {
+            const playgroundRenderPageOptions: PlaygroundRenderPageOptions = {
+              endpoint: path,
+              subscriptionEndpoint: this.subscriptionsPath,
+              version: this.playgroundVersion,
+              ...this.playgroundOptions,
+            };
+
+            reply
+              .type('text/html')
+              .send(renderPlaygroundPage(playgroundRenderPageOptions));
+          }
+        }
+        return next();
+      }.bind(this),
+    );
+
+    if (!disableHealthCheck) {
+      await app.route({
+        method: [
+          'HEAD',
+          'PUT',
+          'DELETE',
+          'OPTIONS',
+          'PATCH',
+        ] as fastify.HTTPMethod[],
+        url: '/.well-known/apollo/server-health',
+        handler: async function(
+          request: any,
+          reply: FastifyReply<OutgoingMessage>,
+        ) {
+          if (onHealthCheck) {
+            try {
+              await onHealthCheck(request);
+            } catch {
+              const response = reply
+                .send({ status: 'fail' })
+                .code(503)
+                .type('application/health+json');
+              return response;
+            }
+          }
+          const response = reply
+            .send({ status: 'pass' })
+            .type('application/health+json');
+          return response;
+        },
+      });
+    }
+
+    await app.register(graphqlFastify as any, {
+      url: path,
+      graphqlOptions: this.createGraphQLServerOptions.bind(this),
+      route: route || { cors },
+    });
+
+    this.graphqlPath = path;
+  }
+}
+
+export interface ServerRegistration {
+  app?: FastifyInstance;
+  path?: string;
+  cors?: boolean;
+  route?: string;
+  onHealthCheck?: (
+    request: fastify.FastifyRequest<IncomingMessage>,
+  ) => Promise<any>;
+  disableHealthCheck?: boolean;
+  uploads?: boolean | Record<string, any>;
+}
+
+export const registerServer = () => {
+  throw new Error(
+    'Please use server.applyMiddleware instead of registerServer. This warning will be removed in the next release',
+  );
+};

packages/apollo-server-fastify/src/__tests__/ApolloServer.test.ts

@@ -0,0 +1,58 @@
+import fastify from 'fastify';
+import http from 'http';
+
+import { gql, Config } from 'apollo-server-core';
+import { ApolloServer, ServerRegistration } from '../ApolloServer';
+
+import { createServerInfo } from 'apollo-server-integration-testsuite';
+
+const typeDefs = gql`
+  type Query {
+    hello: String
+  }
+`;
+
+const resolvers = {
+  Query: {
+    hello: () => 'hi',
+  },
+};
+
+const port = 6666;
+
+describe('apollo-server-fastify', () => {
+  let server: ApolloServer;
+
+  let app: fastify.FastifyInstance;
+  let httpServer: http.Server;
+
+  async function createServer(
+    serverOptions: Config,
+    options: Partial<ServerRegistration> = {},
+  ) {
+    server = new ApolloServer(serverOptions);
+    app = fastify();
+
+    server.applyMiddleware({ ...options, app });
+
+    try {
+      await app.listen(port);
+    } catch (err) {
+      app.log.error('error in starting server', err);
+      process.exit(1);
+    }
+    httpServer = await app.server;
+    return createServerInfo(server, httpServer);
+  }
+
+  afterEach(async () => {
+    if (server) await server.stop();
+    if (httpServer) await httpServer.close();
+  });
+
+  describe('constructor', () => {
+    it('accepts typeDefs and resolvers', () => {
+      return createServer({ typeDefs, resolvers });
+    });
+  });
+});

packages/apollo-server-fastify/src/__tests__/fastifyApollo.test.ts

@@ -0,0 +1,57 @@
+import fastify from 'fastify';
+import { FastifyInstance } from 'fastify';
+import { ApolloServer } from '../ApolloServer';
+import { graphqlFastify } from '../fastifyApollo';
+import testSuite, {
+  schema as Schema,
+  CreateAppOptions,
+} from 'apollo-server-integration-testsuite';
+import { GraphQLOptions, Config } from 'apollo-server-core';
+
+async function createApp(options: CreateAppOptions = {}) {
+  const app = fastify();
+
+  const server = new ApolloServer(
+    (options.graphqlOptions as Config) || { schema: Schema },
+  );
+  await server.applyMiddleware({ app });
+
+  try {
+    await app.listen(3007);
+  } catch (err) {
+    app.log.error('error in starting server', err);
+    process.exit(1);
+  }
+
+  return app.server;
+}
+
+async function destroyApp(app: any) {
+  if (!app || !app.close) {
+    return;
+  }
+  await new Promise(cb => app.close(cb));
+}
+
+describe('fastifyApollo', () => {
+  it('throws error if called without schema', function() {
+    expect(() =>
+      graphqlFastify(
+        {} as FastifyInstance,
+        undefined as GraphQLOptions,
+        undefined,
+      ),
+    ).toThrow('Apollo Server requires options.');
+  });
+
+  it('throws an error if called with argument not equal to 3', function() {
+    expect(() => (<any>graphqlFastify)({}, { graphqlOptions: {} })).toThrow(
+      'Apollo Server expects exactly 3 argument, got 2',
+    );
+  });
+});
+
+// Uncomment this to see the breaking tests
+describe('integration:Fastify', () => {
+  testSuite(createApp, destroyApp);
+});

packages/apollo-server-fastify/src/__tests__/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../../tsconfig.test.base",
+  "include": ["**/*"],
+  "references": [{
+      "path": "../../"
+    },
+    {
+      "path": "../../../apollo-server-integration-testsuite"
+    }
+  ]
+}