Update Docs, Add Example, Fix Header Bug

fixes #2

Added `node-fetch` to polyfill the DOM Headers API.

Changed server response to use `res.send()` instead of `res.json()` because it was causing the response to be sent as a string.

Minor config changes to ignore files in testing/builds.

.gitignore

@@ -26,3 +26,5 @@ serverless.env.yml
 
 coverage.lcov
 engine.json
+
+.vercel

README.md

@@ -9,9 +9,9 @@
 ## 📦 Installation
 
 ```bash
-npm install --save @saeris/apollo-server-vercel
+npm install --save @saeris/apollo-server-vercel graphql
 # or
-yarn add @saeris/apollo-server-vercel
+yarn add @saeris/apollo-server-vercel graphql
 ```
 
 ## 🔧 Usage
@@ -49,9 +49,33 @@ const server = new ApolloServer({
 export default server.createHandler();
 ```
 
-## 🏖️ Example
+## 🕹️ Demo
 
-Give it a try [via CodeSandbox](https://codesandbox.io/s/apollo-server-vercel-demo-oumls?file=/pages/api/demo.ts)!
+You can give it a try [via CodeSandbox](https://codesandbox.io/s/apollo-server-vercel-demo-oumls?file=/pages/api/demo.ts) or locally by cloning this repo, running `yarn && yarn start`, and then navigate to the URL provided in your terminal (usually http://localhost:3000/api/example).
+
+## 🧪 Testing
+
+Testing is provided via `jest` and is pre-configured to run with `codecov` as well. Tests for this project have been adapted from the official Apollo Server integration tests and they can be found under `src/__test__`. Additionally, this project uses `eslint`, `typescript`, and `prettier`, all three of which are automatically run on each commit via `husky` + `lint-staged`. To manually lint and test, use the following commands:
+
+Lint:
+```bash
+yarn lint
+```
+
+Typecheck:
+```bash
+yarn typecheck
+```
+
+Test and watch for changes:
+```bash
+yarn test:watch
+```
+
+Lint + Typecheck + Test:
+```bash
+yarn test
+```
 
 ## 🥂 License
 

api/example.ts

@@ -0,0 +1,29 @@
+import { ApolloServer } from "../pkg";
+
+// Construct a schema, using GraphQL schema language
+const typeDefs = `
+  type Query {
+    hello: String
+  }
+`;
+
+// Provide resolver functions for your schema fields
+const resolvers = {
+  Query: {
+    hello: () => `Hello world!`
+  }
+};
+
+const server = new ApolloServer({
+  typeDefs,
+  resolvers,
+  // By default, the GraphQL Playground interface and GraphQL introspection
+  // is disabled in "production" (i.e. when `process.env.NODE_ENV` is `production`).
+  //
+  // If you'd like to have GraphQL Playground and introspection enabled in production,
+  // the `playground` and `introspection` options must be set explicitly to `true`.
+  playground: true,
+  introspection: true
+});
+
+export default server.createHandler();

jest.config.js

@@ -2,6 +2,15 @@ module.exports = {
   displayName: `graphql-scalars`,
   coverageDirectory: `./.coverage/`,
   collectCoverage: true,
+  collectCoverageFrom: [
+    // include
+    `./src/**/*.ts`,
+    // exclude
+    `!**/__mocks__/**/*`,
+    `!**/__test__/**/*`,
+    `!**/node_modules/**`,
+    `!**/vendor/**`
+  ],
   testEnvironment: `node`,
   transform: {
     "^.+\\.(js|ts)x?$": `babel-jest`

package.json

@@ -23,8 +23,13 @@
     "access": "public"
   },
   "main": "src/index.js",
+  "engines": {
+    "node": ">=10.x"
+  },
   "scripts": {
-    "build": "pika build",
+    "start": "vercel dev",
+    "build": "yarn build:lib && yarn build:docs",
+    "build:lib": "pika build",
     "build:docs": "fiddly",
     "typecheck": "tsc --noEmit",
     "lint": "eslint ./src/**/*.{js,ts}",
@@ -83,9 +88,11 @@
     "js-sha256": "^0.9.0",
     "lint-staged": "^10.2.11",
     "micro": "^9.3.4",
+    "node-fetch": "^2.6.0",
     "prettier": "2.0.5",
     "supertest": "^4.0.2",
     "typescript": "^3.9.7",
+    "vercel": "^19.2.0",
     "vercel-node-server": "^2.2.1"
   },
   "peerDependencies": {
@@ -98,7 +105,8 @@
         {
           "exclude": [
             "*.gql",
-            "__TEST__/*"
+            "__mocks__/**/*",
+            "__test__/**/*"
           ]
         }
       ],

sandbox.config.json

@@ -0,0 +1,6 @@
+{
+  "infiniteLoopProtection": true,
+  "hardReloadOnChange": false,
+  "view": "browser",
+  "template": "node"
+}

src/ApolloServer.ts

@@ -12,6 +12,7 @@ import {
   RenderPageOptions as PlaygroundRenderPageOptions
 } from "@apollographql/graphql-playground-html";
 import { NowRequest, NowResponse } from "@vercel/node";
+import { Headers } from 'node-fetch';
 import { graphqlVercel } from "./vercelApollo";
 import { setHeaders } from "./setHeaders";
 
@@ -174,7 +175,7 @@ export class ApolloServer extends ApolloServerBase {
         }
       };
 
-      fileUploadHandler(() =>
+      return fileUploadHandler(() =>
         graphqlVercel(async () => {
           await promiseWillStart;
           return this.createGraphQLServerOptions(req, res);

src/vercelApollo.ts

@@ -29,7 +29,7 @@ export function graphqlVercel(options: GraphQLOptions | NowGraphQLOptionsFunctio
         request: convertNodeHttpToRequest(req)
       });
       setHeaders(res, responseInit.headers ?? {});
-      return res.status(200).json(graphqlResponse);
+      return res.status(200).send(graphqlResponse);
     } catch (error) {
       const { headers, statusCode, message }: HttpQueryError = error;
       setHeaders(res, headers ?? {});

tsconfig.json

@@ -15,5 +15,5 @@
     "sourceMap": true
   },
   "include": ["./src/**/*"],
-  "exclude": ["node_modules", "**/*.spec.ts"]
+  "exclude": ["node_modules", "**/__mocks__/**/*", "**/__test__/**/*", "**/*.spec.ts"]
 }

vercel.json

@@ -0,0 +1,10 @@
+{
+	"name": "apollo-server-vercel",
+	"version": 2,
+	"scope": "saeris",
+  "functions": {
+    "api/example.ts": {
+      "maxDuration": 5
+    }
+  }
+}