Version 3 (#115)

* Drop support for Node v14, start testing against Node v20 (#110)

* Drop support for Node v14, start testing against Node v20

* Build release PRs on version-* branches

* latest node@16 types

* Updated middleware execution to provide new functionality (#91)

* Updated middleware execution to provide new functionality

* Add missing headers to the changeset

* Remove context modification from result middleware

* Update from review

* Added new README sections and changelog message

* Spelling

* Prettier

* Version Packages (#114)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: Trevor Scheer <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 3 people

.circleci/config.yml

@@ -67,17 +67,16 @@ jobs:
       - run: npm run spell-check
 
 workflows:
-  version: 2
   Build:
     jobs:
       - NodeJS:
           name: NodeJS << matrix.node-version >>
           matrix:
             parameters:
               node-version:
-                - "14"
                 - "16"
                 - "18"
+                - "20"
       - Prettier
       - Lint
       - Spell Check

.github/workflows/release-pr.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - version-*
 
 jobs:
   release:

CHANGELOG.md

@@ -1,5 +1,46 @@
 # @as-integrations/aws-lambda
 
+## 3.0.0
+
+### Major Changes
+
+- [#110](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda/pull/110) [`e76fc08`](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda/commit/e76fc08da5152f1bfb9bae3e29033d714474fd33) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Drop support for Node v14
+
+### Minor Changes
+
+- [#91](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda/pull/91) [`71c94df`](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda/commit/71c94dfc96aa6f3a3d08928162f7480be375a31e) Thanks [@BlenderDude](https://github.com/BlenderDude)! - ## Short circuit middleware execution
+
+  You can now opt to return a Lambda result object directly from the middleware. This will cancel the middleware chain, bypass GraphQL request processing, and immediately return the Lambda result.
+
+  Example
+
+  ```ts
+  export const handler = startServerAndCreateLambdaHandler(
+    server,
+    handlers.createAPIGatewayProxyEventV2RequestHandler(),
+    {
+      context: async () => {
+        return {};
+      },
+      middleware: [
+        async (event) => {
+          const psk = Buffer.from('SuperSecretPSK');
+          const token = Buffer.from(event.headers['X-Auth-Token']);
+          if (
+            psk.byteLength !== token.byteLength ||
+            crypto.timingSafeEqual(psk, token)
+          ) {
+            return {
+              statusCode: '403',
+              body: 'Forbidden',
+            };
+          }
+        },
+      ],
+    },
+  );
+  ```
+
 ## 2.0.1
 
 ### Patch Changes

README.md

@@ -22,7 +22,7 @@ import {
 // The GraphQL schema
 const typeDefs = `#graphql
   type Query {
-    hello: String
+    hello: String!
   }
 `;
 
@@ -45,6 +45,59 @@ export default startServerAndCreateLambdaHandler(
 );
 ```
 
+## Context
+
+As with all Apollo Server 4 integrations, the context resolution is done in the integration. For the Lambda integration, it will look like the following:
+
+```ts
+import { ApolloServer } from '@apollo/server';
+import {
+  startServerAndCreateLambdaHandler,
+  handlers,
+} from '@as-integrations/aws-lambda';
+
+type ContextValue = {
+  isAuthenticated: boolean;
+};
+
+// The GraphQL schema
+const typeDefs = `#graphql
+  type Query {
+    hello: String!
+    isAuthenticated: Boolean!
+  }
+`;
+
+// Set up Apollo Server
+const server = new ApolloServer<ContextValue>({
+  typeDefs,
+  resolvers: {
+    Query: {
+      hello: () => 'world',
+      isAuthenticated: (root, args, context) => {
+        // For context typing to be valid one of the following must be implemented
+        //   1. `resolvers` defined inline in the server config (not particularly scalable, but works)
+        //   2. Add the type in the resolver function. ex. `(root, args, context: ContextValue)`
+        //   3. Propagate the type from an outside definition like GraphQL Codegen
+        return context.isAuthenticated;
+      },
+    },
+  },
+});
+
+export default startServerAndCreateLambdaHandler(
+  server,
+  handlers.createAPIGatewayProxyEventV2RequestHandler({
+    context: async ({ event }) => {
+      // Do some parsing on the event (parse JWT, cookie, auth header, etc.)
+      return {
+        isAuthenticated: true,
+      };
+    },
+  }),
+);
+```
+
 ## Middleware
 
 For mutating the event before passing off to `@apollo/server` or mutating the result right before returning, middleware can be utilized.
@@ -83,6 +136,8 @@ export default startServerAndCreateLambdaHandler(
 );
 ```
 
+### Middleware Typing
+
 If you want to define strictly typed middleware outside of the middleware array, the easiest way would be to extract your request handler into a variable and utilize the `typeof` keyword from Typescript. You could also manually use the `RequestHandler` type and fill in the event and result values yourself.
 
 ```typescript
@@ -133,6 +188,47 @@ export default startServerAndCreateLambdaHandler(server, requestHandler, {
 });
 ```
 
+### Middleware Short Circuit
+
+In some situations, a middleware function might require the execution end before reaching Apollo Server. This might be a global auth guard or session token lookup.
+
+To achieve this, the request middleware function accepts `ResultType` or `Promise<ResultType>` as a return type. Should middleware resolve to such a value, that result is returned and no further execution occurs.
+
+```typescript
+import {
+  startServerAndCreateLambdaHandler,
+  middleware,
+  handlers,
+} from '@as-integrations/aws-lambda';
+import type {
+  APIGatewayProxyEventV2,
+  APIGatewayProxyStructuredResultV2,
+} from 'aws-lambda';
+import { server } from './server';
+
+const requestHandler = handlers.createAPIGatewayProxyEventV2RequestHandler();
+
+// Utilizing typeof
+const sessionMiddleware: middleware.MiddlewareFn<typeof requestHandler> = (
+  event,
+) => {
+  // ... check session
+  if (!event.headers['X-Session-Key']) {
+    // If header doesn't exist, return early
+    return {
+      statusCode: 401
+      body: 'Unauthorized'
+    }
+  }
+};
+
+export default startServerAndCreateLambdaHandler(server, requestHandler, {
+  middleware: [
+    sessionMiddleware,
+  ],
+});
+```
+
 ## Event Extensions
 
 Each of the provided request handler factories has a generic for you to pass a manually extended event type if you have custom authorizers, or if the event type you need has a generic you must pass yourself. For example, here is a request that allows access to the lambda authorizer:

cspell-dict.txt

@@ -12,4 +12,5 @@ unawaited
 vendia
 withrequired
 typeof
-instanceof
+instanceof
+codegen

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@as-integrations/aws-lambda",
   "description": "An Apollo Server integration for hosting on AWS Lambda",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "author": "Michael Watson & Daniel Abdelsamed",
   "license": "MIT",
   "repository": {
@@ -15,7 +15,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "engines": {
-    "node": ">=14.0"
+    "node": ">=16.0"
   },
   "scripts": {
     "build": "tsc --build tsconfig.build.json",
@@ -40,7 +40,7 @@
     "@changesets/changelog-github": "0.4.8",
     "@changesets/cli": "2.26.2",
     "@types/jest": "29.5.3",
-    "@types/node": "14.18.54",
+    "@types/node": "16.18.39",
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
     "cspell": "6.31.2",

package.json

@@ -21,7 +21,7 @@
     // versions we support.
     {
       "matchPackageNames": ["@types/node"],
-      "allowedVersions": "14.x"
+      "allowedVersions": "16.x"
     },
   ],
 }