refactor to use one Server implementation with Apollo Server Lambda as base implementation

Author: michalkvasnicak

Diff for: CHANGELOG.md

@@ -134,7 +134,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### [v0.1.0](https://github.com/michalkvasnicak/aws-lambda-graphql/releases/tag/v0.1.0) - 2019-01-13
 
-## `aws-lambda-ws-link`
+## `aws-lambda-ws-link` **⚠️ Deprecated, do not use with versions newer that `0.13.0`**
 
 ### [Unreleased](https://github.com/michalkvasnicak/aws-lambda-graphql/compare/[email protected])
 

Diff for: README.md

@@ -2,12 +2,12 @@
   "private": true,
   "dependencies": {
     "@types/graphql": "^14.5.0",
-    "apollo-link": "^1.2.13",
     "aws-sdk": "^2.577.0",
     "graphql": "^14.5.8",
     "graphql-subscriptions": "^1.1.0"
   },
   "resolutions": {
+    "@types/aws-lambda": "^8.10.36",
     "@types/node": "10.17.5"
   },
   "devDependencies": {
@@ -19,6 +19,7 @@
     "@babel/preset-typescript": "^7.7.2",
     "@types/jest": "^24.0.23",
     "@types/node": "10.17.5",
+    "@types/node-fetch": "^2.5.4",
     "@typescript-eslint/eslint-plugin": "^2.8.0",
     "@typescript-eslint/parser": "^2.8.0",
     "eslint": "^6.6.0",

Diff for: package.json

@@ -3,9 +3,12 @@
 [![CircleCI](https://img.shields.io/circleci/project/github/michalkvasnicak/aws-lambda-graphql/master.svg?style=flat-square)](https://circleci.com/gh/michalkvasnicak/aws-lambda-graphql)
 [![aws-lambda-graphql package version](https://img.shields.io/npm/v/aws-lambda-graphql?color=green&label=aws-lambda-graphql&style=flat-square)](https://www.npmjs.com/package/aws-lambda-graphql)
 
-GraphQL server and client implementation for AWS Lambda with WebSocket (AWS API Gateway v2) and HTTP support (AWS API Gateway v1).
+Use [Apollo Server Lambda](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-lambda) with GraphQL subscriptions over WebSocket (AWS API Gateway v2).
 
-The server is fully compatible with Apollo's [`subscriptions-transport-ws`](https://github.com/apollographql/subscriptions-transport-ws).
+With this library you can do:
+
+- same things as with [apollo-server-lambda](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-lambda) by utiizing AWS API Gateway v1
+- GraphQL subscriptions over WebSocket by utilizing AWS API Gateway v2 and [subscriptions-transport-ws](https://github.com/apollographql/subscriptions-transport-ws)
 
 ## Table of contents
 
@@ -17,60 +20,56 @@ The server is fully compatible with Apollo's [`subscriptions-transport-ws`](http
 ## Installation
 
 ```console
-yarn add aws-lambda-graphql apollo-link graphql graphql-subscriptions
+yarn add aws-lambda-graphql graphql graphql-subscriptions
 # or
-npm install aws-lamda-graphql apollo-link graphql graphql-subscriptions
+npm install aws-lamda-graphql graphql graphql-subscriptions
 ```
 
 ## Usage
 
-To implement WebSocket event handler and event stream handler please see the [example](https://github.com/michalkvasnicak/aws-lambda-graphql#1-websocket-server-handler).
-
-To implement HTTP event handler please see the [example](https://github.com/michalkvasnicak/aws-lambda-graphql#11-http-server-handler).
+There is a [quick start guide](https://github.com/michalkvasnicak/aws-lambda-graphql#quick-start).
 
 ## API
 
-### `createDynamoDBEventProcessor(options: Options): event handler function`
+### `Server`
 
-Creates an AWS DynamoDB Stream handler.
+Creates an [Apollo Lambda server](https://www.npmjs.com/package/apollo-server-lambda).
 
 #### Options
 
+All options from Apollo Lambda Server and
+
 - **connectionManager** (`IConnectionManager`, `required`)
-- **context** (`object` or [`Context creator function`](#context-creator-function), `optional`)
-- **schema** (`GraphQLSchema`, `required`)
+- **eventProcessor** (`IEventProcessor`, `required`)
 - **subscriptionManager** (`ISubscriptionManager`, `required`)
+- **subscriptions** (`optional`)
+  - **`onConnect(messagePayload: object, connection: IConnection): Promise<boolean|object> | object | boolean`** (`optional`)
+  - **`onOperation(message: OperationRequest, params: ExecutionParams, connection: IConnection): Promise<ExecutionParams>|ExecutionParams`** (`optional`)
+  - **`onOperationComplete(connection: IConnection, operationId: string): void`** (`optional`)
+  - **`onDisconnect(connection: IConnection): void`** (`optional`)
+  - **waitForInitialization** (`optional`) - if connection is not initialised on GraphQL operation, wait for connection to be initialised or throw prohibited connection error. If `onConnect` is specified then we wait for initialisation otherwise we don't wait. (this is usefull if you're performing authentication in `onConnect`).
+    - **retryCount** (`number`, `optional`, `default 10`) - how many times should we try to check the connection state?
+    - **timeout** (`number`, `optional`, `default 50ms`) - how long should we wait (in milliseconds) until we try to check the connection state again?
 
-### `createHttpHandler(options: Options): API Gateway v1 HTTP event handler function`
+#### `createHttpHandler()`
 
-Creates an AWS API Gateway v1 event handler.
+Creates an AWS Lambda API Gateway v1 handler. Events are handled by [apollo-server-lambda](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-lambda)
 
-#### Options
+#### `createWebSocketHandler()`
 
-- **connectionManager** (`IConnectionManager`, `required`)
-- **context** (`object` or [`Context creator function`](#context-creator-function), `optional`)
-- **schema** (`GraphQLSchema`, `required`)
-- **formatResponse** (`(body: any) => string`, `optional`) - formats response for `body` property of an AWS ApiGateway v1 response. Default is `JSON.stringify`
-- **validationRules** (`array of GraphQL validation rules`, `optional`)
+Creates an AWS Lambda API Gateway v2 handler that supports GraphQL subscriptions over WebSocket.
 
-### `createWsHandler(options: Options): API Gateway v2 WebSocket event handler function`
+#### `createEventHandler()`
 
-Creates an AWS API Gateway v1 event handler.
+Creates an AWS Lambda handler for events from events source (for example DynamoDBEventStore). This method internally work with `IEventProcessor`.
+
+### `DynamoDBEventProcessor: IEventProcessor`
+
+AWS Lambda DynamoDB stream handler. DynamoDBEventProcessor is used internally by Server.
 
 #### Options
 
-- **connectionManager** (`IConnectionManager`, `required`)
-- **context** (`object` or [`Context creator function`](#context-creator-function), `optional`)
-- **schema** (`GraphQLSchema`, `required`)
-- **subscriptionManager** (`ISubscriptionManager`, `required`)
-- **`onConnect(messagePayload: object, connection: IConnection): Promise<boolean|object> | object | boolean`**
-- **`onOperation(message: OperationRequest, params: object, connection: IConnection): Promise<object>|object`** (`optional`)
-- **`onOperationComplete(connection: IConnection, operationId: string): void`** (`optional`)
-- **`onDisconnect(connection: IConnection): void`** (`optional`)
-- **validationRules** (`array of GraphQL validation rules`, `optional`)
-- **waitForInitialization** (`optional`) - if connection is not initialised on GraphQL operation, wait for connection to be initialised or throw prohibited connection error. If `onConnect` is specified then we wait for initialisation otherwise we don't wait. (this is usefull if you're performing authentication in `onConnect`).
-  - **retryCount** (`number`, `optional`, `default 10`) - how many times should we try to check the connection state?
-  - **timeout** (`number`, `optional`, `default 50ms`) - how long should we wait (in milliseconds) until we try to check the connection state again?
+- **onError** (`(err: any) => void`, `optional`)
 
 ### `DynamoDBConnectionManager: IConnectionManager`
 

Diff for: packages/aws-lambda-graphql/README.md

@@ -12,6 +12,7 @@
   },
   "sideEffects": false,
   "keywords": [
+    "apollo",
     "aws",
     "lambda",
     "apollo",
@@ -20,38 +21,33 @@
     "apigateway",
     "websocket",
     "http",
-    "graphql-subscriptions"
+    "graphql-subscriptions",
+    "serverless"
   ],
   "files": [
     "dist",
     "README.md",
     "LICENSE"
   ],
-  "description": "GraphQL server and client implementation for AWS Lambda with WebSocket support (API Gateway v1 + v2)",
+  "description": "Apollo server for AWS Lambda with WebSocket subscriptions support over API Gateway v1 + v2)",
   "dependencies": {
     "@types/aws-lambda": "^8.10.36",
-    "@types/backo2": "^1.0.1",
-    "@types/websocket": "^1.0.0",
-    "backo2": "1.0.2",
-    "content-type": "^1.0.4",
-    "eventemitter3": "^3.1.2",
+    "apollo-server-core": "^2.9.14",
+    "apollo-server-lambda": "^2.9.14",
     "iterall": "^1.2.2",
-    "ulid": "^2.3.0",
-    "xstate": "^4.2.3"
+    "ulid": "^2.3.0"
   },
   "peerDependencies": {
-    "apollo-link": "^1.2.6",
     "aws-sdk": "^2.387.0",
     "graphql": "^14.0.2",
     "graphql-subscriptions": "^1.0.0"
   },
   "engines": {
-    "node": ">=8"
+    "node": ">=10"
   },
   "engineStrict": true,
   "devDependencies": {
-    "@types/content-type": "^1.1.2",
-    "apollo-link": "1.2.11",
+    "apollo-link": "^1.2.11",
     "graphql-tag": "^2.10.1",
     "graphql-tools": "^4.0.6",
     "mock-socket": "^8.0.5",

Diff for: packages/aws-lambda-graphql/package.json

@@ -0,0 +1,41 @@
+import { createAsyncIterator } from 'iterall';
+import { ISubscriptionEvent } from './types';
+
+/**
+ * Array PubSub works as local PubSub that is already fed with all the events that were published
+ *
+ * Each time you call asyncIterator it will create an iterator that iterates over events
+ */
+export class ArrayPubSub {
+  private events: ISubscriptionEvent[];
+
+  constructor(events: ISubscriptionEvent[]) {
+    this.events = events;
+  }
+
+  async publish() {
+    throw new Error('ArrayPubSub is read only');
+  }
+
+  async subscribe(): Promise<number> {
+    throw new Error('Please do not use this PubSub implementation');
+  }
+
+  async unsubscribe() {
+    throw new Error('Please do not use this PubSub implementation');
+  }
+
+  asyncIterator(eventNames: string | string[]) {
+    const names = Array.isArray(eventNames) ? eventNames : [eventNames];
+
+    return createAsyncIterator(
+      this.events
+        .filter(event => names.includes(event.event))
+        .map(event =>
+          typeof event.payload === 'string'
+            ? JSON.parse(event.payload)
+            : event.payload,
+        ),
+    );
+  }
+}

Diff for: packages/aws-lambda-graphql/src/ArrayPubSub.ts

@@ -15,7 +15,12 @@ type Options = {
   subscriptions: ISubscriptionManager;
 };
 
-class DynamoDBConnectionManager implements IConnectionManager {
+/**
+ * DynamoDBConnectionManager
+ *
+ * Stores connections in DynamoDB table (default table name is Connections, you can override that)
+ */
+export class DynamoDBConnectionManager implements IConnectionManager {
   private connectionsTable: string;
 
   private db: DynamoDB.DocumentClient;
@@ -28,10 +33,7 @@ class DynamoDBConnectionManager implements IConnectionManager {
     this.subscriptions = subscriptions;
   }
 
-  hydrateConnection = async (
-    connectionId: string,
-    useLegacyProtocol?: boolean,
-  ): Promise<IConnection> => {
+  hydrateConnection = async (connectionId: string): Promise<IConnection> => {
     // if connection is not found, throw so we can terminate connection
     const result = await this.db
       .get({
@@ -46,11 +48,6 @@ class DynamoDBConnectionManager implements IConnectionManager {
       throw new ConnectionNotFoundError(`Connection ${connectionId} not found`);
     }
 
-    if (useLegacyProtocol && !result.Item.data.useLegacyProtocol) {
-      await this.setLegacyProtocol(result.Item as IConnection);
-      result.Item.data.useLegacyProtocol = true;
-    }
-
     return result.Item as IConnection;
   };
 
@@ -75,24 +72,6 @@ class DynamoDBConnectionManager implements IConnectionManager {
       .promise();
   };
 
-  setLegacyProtocol = async (connection: IConnection): Promise<void> => {
-    await this.db
-      .update({
-        TableName: this.connectionsTable,
-        Key: {
-          id: connection.id,
-        },
-        UpdateExpression: 'set #data.useLegacyProtocol = :useLegacyProtocol',
-        ExpressionAttributeValues: {
-          ':useLegacyProtocol': true,
-        },
-        ExpressionAttributeNames: {
-          '#data': 'data',
-        },
-      })
-      .promise();
-  };
-
   registerConnection = async ({
     connectionId,
     endpoint,
@@ -170,6 +149,3 @@ class DynamoDBConnectionManager implements IConnectionManager {
     await managementApi.deleteConnection({ ConnectionId: id }).promise();
   };
 }
-
-export { DynamoDBConnectionManager };
-export default DynamoDBConnectionManager;