Skip to content

Commit

Permalink
[Docs] AS Integrations AWS Lambda 2.0.0 Update (#7329)
Browse files Browse the repository at this point in the history 
With the v2.0.0 release of `@as-integrations/aws-lambda`, the docs
needed updates to reflect the new syntax and requirements. This PR also
describes more of the added functionality in the 2.0 release.

There was also an issue with the local event type that slipped through
the cracks the first time around due to our runtime type-parsing. The
local event we were using for testing was a `ProxyV1` event type, while
the `httpApi` spun up by `serverless` was of the `ProxyV2` type. I
normalized the example event and integration example to both be the new
`V2` event type (as its now necessary to be explicit with v2.0.0).

Fixes #7327 as `requestContext.http.method` was missing from the event
as it was not required in `ProxyV1`, but is in `ProxyV2`
  • Loading branch information
@BlenderDude
BlenderDude authored Feb 6, 2023
1 parent b35581d commit 7ed90a7
Showing 1 changed file with 221 additions and 76 deletions.
297 changes: 221 additions & 76 deletions docs/source/deployment/lambda.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,64 +60,20 @@ const server = new ApolloServer({
});
```

```js title="server.js"
import { ApolloServer } from '@apollo/server';

// The GraphQL schema
const typeDefs = `#graphql
type Query {
hello: String
}
`;

// A map of functions which return data for the schema.
const resolvers = {
Query: {
hello: () => 'world',
},
};

// Set up Apollo Server
const server = new ApolloServer({
typeDefs,
resolvers,
});
```

</MultiCodeBlock>

Now we can import the `startServerAndCreateLambdaHandler` function from [`@as-integrations/aws-lambda`](https://www.npmjs.com/package/@as-integrations/aws-lambda), passing in our `ApolloServer` instance:
Now we can import the `startServerAndCreateLambdaHandler` function and `handlers` object from [`@as-integrations/aws-lambda`](https://www.npmjs.com/package/@as-integrations/aws-lambda), passing in our `ApolloServer` instance:

<MultiCodeBlock>

```ts title="src/server.ts"
import { ApolloServer } from '@apollo/server';
import { startServerAndCreateLambdaHandler } from '@as-integrations/aws-lambda'; //highlight-line

const typeDefs = `#graphql
type Query {
hello: String
}
`;

const resolvers = {
Query: {
hello: () => 'world',
},
};

const server = new ApolloServer({
typeDefs,
resolvers,
});

// This final export is important!
export const graphqlHandler = startServerAndCreateLambdaHandler(server); //highlight-line
```

```js title="server.js"
import { ApolloServer } from '@apollo/server';
import { startServerAndCreateLambdaHandler } from '@as-integrations/aws-lambda'; //highlight-line
// highlight-start
import {
startServerAndCreateLambdaHandler,
handlers,
} from '@as-integrations/aws-lambda';
// highlight-end

const typeDefs = `#graphql
type Query {
Expand All @@ -137,7 +93,13 @@ const server = new ApolloServer({
});

// This final export is important!
export const graphqlHandler = startServerAndCreateLambdaHandler(server); //highlight-line
// highlight-start
export const graphqlHandler = startServerAndCreateLambdaHandler(
server,
// We will be using the Proxy V2 handler
handlers.createAPIGatewayProxyEventV2RequestHandler()
);
// highlight-end
```

</MultiCodeBlock>
Expand Down Expand Up @@ -206,13 +168,19 @@ You can store a mock HTTP requests locally by creating a `query.json` file, like
```json title="query.json"
{
"version": "2",
"httpMethod": "POST",
"path": "/",
"headers": {
"content-type": "application/json"
"content-type": "application/json",
},
"requestContext": {},
"isBase64Encoded": false,
"rawQueryString": "",
"requestContext": {
"http": {
"method": "POST",
},
// Other requestContext properties omitted for brevity
},
"rawPath": "/",
"routeKey": "/",
"body": "{\"operationName\": null, \"variables\": null, \"query\": \"{ hello }\"}"
}
```
Expand Down Expand Up @@ -284,42 +252,184 @@ If you ever want to remove the S3 bucket or Lambda functions that Serverless cre
serverless remove
```

## Customizing HTTP behavior
## Middleware

The `@as-integrations/aws-lambda` package is compatible with the following event types `APIGatewayProxyEvent`, `APIGatewayProxyEventV2`, `ALBEvent`. This supports a wide range of services like API Gateway HTTP Proxy APIs, API Gateway REST Proxy APIs, Lambda Function URLs, and Application Load Balancers. However, it does not let you customize HTTP behavior directly or support other AWS products that invoke Lambda functions (e.g., S3 or DynamoDB).
In order to implement event and result mutations, type-safe middleware can be passed to the `startServerAndCreateLambdaHandler` call. The API is as follows:

If you want to customize your HTTP behavior, you can couple Apollo Server's Express integration (i.e., [`expressMiddleware`](../api/express-middleware)) with the [`@vendia/serverless-express`](https://github.com/vendia/serverless-express) package. The `@vendia/serverless-express` library translates between Lambda events and Express requests. Despite their similar names, the Serverless CLI and the `@vendia/serverless-express` package are unrelated.
<MultiCodeBlock>

You can update your Apollo Server setup to the following to have a fully functioning Lambda server that works in a variety of AWS features:
```ts
<MultiCodeBlock>
import { middleware, startServerAndCreateLambdaHandler, handlers } from "@as-integrations/aws-lambda";
import { server } from "./server";
const requestHandler = handlers.createAPIGatewayProxyEventV2RequestHandler();
// Middleware is an async function whose type is based on your request handler. Middleware
// can read and mutate the incoming event. Additionally, returning an async function from your
// middleware allows you to read and mutate the result before it's sent.
const middlewareFn: middleware.MiddlewareFn<typeof requestHandler> = async (event) => {
// read or update the event here
// optionally return a callback to access the result
return async (result) => {
// read or update the result here
}
}
startServerAndCreateLambdaHandler(server, requestHandler, {
middleware: [middlewareFn],
});
```

</MultiCodeBlock>

One use case for middleware is cookie modification. The `APIGatewayProxyStructuredResultV2` type contains a property `cookies` which can be pushed to. This allows you to set multiple `set-cookie` headers in the response.

```ts
const { ApolloServer } = require('@apollo/server');
const { expressMiddleware } = require('@apollo/server/express4');
const serverlessExpress = require('@vendia/serverless-express');
const express = require('express');
const { json } = require('body-parser');
const cors = require('cors');
import {
startServerAndCreateLambdaHandler,
middleware,
handlers,
} from '@as-integrations/aws-lambda';
import { server } from './server';
import { refreshCookie } from './cookies';
const requestHandler = handlers.createAPIGatewayProxyEventV2RequestHandler();
// Utilizing typeof
const cookieMiddleware: middleware.MiddlewareFn<typeof requestHandler> = async (
event,
) => {
// Access existing cookies and produce a refreshed one
const cookie = refreshCookie(event.cookies);
return async (result) => {
// Ensure proper initialization of the cookies property on the result
result.cookies = result.cookies ?? [];
// Result is mutable so it can be updated here
result.cookies.push(cookie);
};
};
const server = new ApolloServer({
typeDefs: 'type Query { x: ID }',
resolvers: { Query: { x: () => 'hi!' } },
export default startServerAndCreateLambdaHandler(server, requestHandler, {
middleware: [
cookieMiddleware,
],
});
```

server.startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests();
More use-cases and API information can be found in the [library's README](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda#middleware).

const app = express();
app.use(cors(), json(), expressMiddleware(server));

exports.graphqlHandler = serverlessExpress({ app });
## Event extensions

In many cases, API Gateway events will have an authorizer in front of them that contains custom state that will be used for authorization during GraphQL resolution. All of the handlers that are packaged with the library contain a generic type which allows you to explicitly extend the base event type. By passing an event with authorization information, that event type will be used during the creation of `contextValue` and for `middleware`. Below is an example, and more information can be found in the [library's README](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda/blob/main/README.md#event-extensions).

<MultiCodeBlock>

```ts
import {
startServerAndCreateLambdaHandler,
middleware,
handlers,
} from '@as-integrations/aws-lambda';
import type { APIGatewayProxyEventV2WithLambdaAuthorizer } from 'aws-lambda';
import { server } from './server';
export default startServerAndCreateLambdaHandler(
server,
handlers.createAPIGatewayProxyEventV2RequestHandler<
APIGatewayProxyEventV2WithLambdaAuthorizer<{
myAuthorizerContext: string;
}>
>(),
);
```

</MultiCodeBlock>

The setup enables you to customize your HTTP behavior as needed.
## Custom request handling

In order to support all event types from AWS Lambda (including custom ones), a request handler creation utility is exposed as `handlers.createHandler(eventParser, resultGenerator)`. This function returns a fully typed request handler that can be passed as the second argument to the `startServerAndCreateLambdaHandler` call. Below is an example and the exact API is documented in the [library's README](https://github.com/apollo-server-integrations/apollo-server-integration-aws-lambda/blob/main/README.md#custom-request-handlers).

<MultiCodeBlock>

```ts
import {
startServerAndCreateLambdaHandler,
handlers,
} from '@as-integrations/aws-lambda';
import type { APIGatewayProxyEventV2 } from 'aws-lambda';
import { HeaderMap } from '@apollo/server';
import { server } from './server';
type CustomInvokeEvent = {
httpMethod: string;
queryParams: string;
headers: Record<string, string>;
body: string;
};
type CustomInvokeResult =
| {
success: true;
body: string;
}
| {
success: false;
error: string;
};
const requestHandler = handlers.createRequestHandler<
CustomInvokeEvent,
CustomInvokeResult
>(
{
parseHttpMethod(event) {
return event.httpMethod;
},
parseHeaders(event) {
const headerMap = new HeaderMap();
for (const [key, value] of Object.entries(event.headers)) {
headerMap.set(key, value);
}
return headerMap;
},
parseQueryParams(event) {
return event.queryParams;
},
parseBody(event) {
return event.body;
},
},
{
success({ body }) {
return {
success: true,
body: body.string,
};
},
error(e) {
if (e instanceof Error) {
return {
success: false,
error: e.toString(),
};
}
console.error('Unknown error type encountered!', e);
throw e;
},
},
);
export default startServerAndCreateLambdaHandler(server, requestHandler);
```

</MultiCodeBlock>



## Using request information
## Using event information

You can use the [`context` function](../data/context/#the-context-function) to get information about the current operation from the original Lambda data structures.

Expand Down Expand Up @@ -394,3 +504,38 @@ exports.handler = serverlessExpress({ app });
```

</MultiCodeBlock>


## Customizing HTTP routing behavior

If you want to customize your HTTP routing behavior, you can couple Apollo Server's Express integration (i.e., [`expressMiddleware`](../api/express-middleware)) with the [`@vendia/serverless-express`](https://github.com/vendia/serverless-express) package. The `@vendia/serverless-express` library translates between Lambda events and Express requests. Despite their similar names, the Serverless CLI and the `@vendia/serverless-express` package are unrelated.

You can update your Apollo Server setup to the following to have a fully functioning Lambda server that works in a variety of AWS features:

<MultiCodeBlock>

```ts
const { ApolloServer } = require('@apollo/server');
const { expressMiddleware } = require('@apollo/server/express4');
const serverlessExpress = require('@vendia/serverless-express');
const express = require('express');
const { json } = require('body-parser');
const cors = require('cors');
const server = new ApolloServer({
typeDefs: 'type Query { x: ID }',
resolvers: { Query: { x: () => 'hi!' } },
});
server.startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests();
const app = express();
app.use(cors(), json(), expressMiddleware(server));
exports.graphqlHandler = serverlessExpress({ app });
```

</MultiCodeBlock>

The setup enables you to customize your HTTP behavior as needed.

0 comments on commit 7ed90a7

Please sign in to comment.