updates readme for nestjs #142

Jwagner347 · 2022-12-16T20:37:17Z

This PR updates the Readme with instructions on running with NestJS and with NestJS/GraphQL. This should also close out #115.

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

adrai · 2022-12-16T20:45:23Z

IMO, this is all knowledge not specific to aws-lambda-fastify, but general to how AWS Lambda works in combination with NestJS...
Isn't this making the Readme more noisy?

Jwagner347 · 2022-12-16T21:07:38Z

I would say it's about how aws-lambda-fastify works in combination with NestJS, not just generic AWS Lambda. But, I do see your point; however, there is an open issue inquiring about this which led to some more discussion and someone asked me to update the readme in order to persist the knowledge. Maybe that's not the right place for it, though.

mcollina · 2022-12-16T22:01:47Z

I think a better place for this documentation is on the Nest.js website.
We do not have the resources to support Nest.js users while they do.
i would not block this but I would not LGTM it either.

adrai · 2022-12-16T22:03:32Z

I think a better place for this documentation is on the Nest.js website.

We do not have the resources to support Nest.js users while they do.

i would not block this but I would not LGTM it either.

That's exactly what I meant 😉

Jwagner347 · 2022-12-16T22:04:00Z

@mcollina I agree. I'll see about getting this added to their documentation.

adrai · 2022-12-18T10:49:17Z

@Uzlopak ok for you if we close this PR in favor to document it on the Nest.js side somewhere?

Uzlopak · 2022-12-18T11:10:11Z

I am totally ok with it as long it is somewhere documented?!

Is it likely that nest js will accept that additional documentation?

toptal-dave · 2023-12-30T16:11:51Z

Just want to say that I was looking around today and was very happy to find a PR here with documentation about using Next.js with Fastify on Lambda. Is there a PR for Nest.js documentation I can upvote or whatever? I really appreciate being able to find some documentation somewhere on this so I hope it gets out there on the web somewhere somehow...

toptal-dave · 2023-12-30T21:31:24Z

@Jwagner347 I see some issues with the code in the README. Mostly variable names and types not lining up because the code is combined. Here's how it should look:

import { NestFactory } from '@nestjs/core';
import {
  FastifyAdapter,
  NestFastifyApplication,
} from '@nestjs/platform-fastify';
import { AppModule } from './app.module';
import awsLambdaFastify, { PromiseHandler } from '@fastify/aws-lambda';
import fastify, { FastifyInstance, FastifyServerOptions } from 'fastify';
import { Context, APIGatewayProxyEvent } from 'aws-lambda';
import { Logger } from '@nestjs/common';

interface NestApp {
  app: NestFastifyApplication;
  instance: FastifyInstance;
}

let cachedNestApp;

async function bootstrap(): Promise<NestApp> {
  const serverOptions: FastifyServerOptions = {
    logger: (process.env.LOGGER || '0') == '1',
  };
  const instance: FastifyInstance = fastify(serverOptions);
  const app = await NestFactory.create<NestFastifyApplication>(
    AppModule,
    new FastifyAdapter(instance),
    {
      logger: !process.env.AWS_EXECUTION_ENV ? new Logger() : console,
    },
  );

  const CORS_OPTIONS = {
    origin: '*',
    allowedHeaders: '*',
    exposedHeaders: '*',
    credentials: false,
    methods: ['GET', 'PUT', 'OPTIONS', 'POST', 'DELETE'],
  };

  app.register(require('fastify-cors'), CORS_OPTIONS);

  app.setGlobalPrefix(process.env.API_PREFIX);

  await app.init();

  return {
    app,
    instance,
  };
}

export const handler = async (
  event: APIGatewayProxyEvent,
  context: Context,
): Promise<PromiseHandler> => {
  if (!cachedNestApp) {
    const nestApp: NestApp = await bootstrap();
    cachedNestApp = awsLambdaFastify(nestApp.instance, {
      decorateRequest: true,
    });
  }

  return cachedNestApp(event, context);
};

However, we have a bigger issue and that is a type mismatch when adapting Fastify:

Argument of type 'FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>' is not assignable to parameter of type 'FastifyHttp2Options<any, FastifyBaseLogger> | FastifyHttp2SecureOptions<any, FastifyBaseLogger> | FastifyHttpsOptions<...> | FastifyInstance<...> | FastifyServerOptions<...>'.
  Type 'FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, FastifyTypeProviderDefault>' is not assignable to type 'FastifyInstance<any, any, any, FastifyBaseLogger, FastifyTypeProviderDefault>'.
    The types of 'withTypeProvider().decorate' are incompatible between these types.
      Type 'DecorationMethod<FastifyInstance<RawServerDefault, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger, Provider>, FastifyInstance<...>>' is not assignable to type 'DecorationMethod<FastifyInstance<any, any, any, FastifyBaseLogger, Provider>, FastifyInstance<any, any, any, FastifyBaseLogger, Provider>>'.
        Target signature provides too few arguments. Expected 2 or more, but got 1.

I'll see if I can figure it out and update below.

toptal-dave · 2023-12-30T22:23:29Z

I submitted an bug report issue here.

toptal-dave · 2023-12-31T22:28:55Z

OK I took another crack at fixing it using the Fastify instance from the NestFactory; plus I updated some of the parts to work with the latest Nest version 10.2:

import { NestFactory } from '@nestjs/core';
import {
  FastifyAdapter,
  NestFastifyApplication,
} from '@nestjs/platform-fastify';
import { AppModule } from './app.module';
import awsLambdaFastify, { PromiseHandler } from '@fastify/aws-lambda';
import { Context, APIGatewayProxyEvent } from 'aws-lambda';
import { Logger } from '@nestjs/common';

let cachedNestApp;

async function bootstrap(): Promise<NestFastifyApplication> {
  // Create the app
  const app = await NestFactory.create<NestFastifyApplication>(
    AppModule,
    // Use an env var to set the logger to nest or console
    new FastifyAdapter({ logger: (process.env.LOGGER || '0') == '1' }),
    {
      logger: !process.env.AWS_EXECUTION_ENV ? new Logger() : console,
    },
  );

  // Enable cors
  app.enableCors({
    origin: '*',
    allowedHeaders: '*',
    exposedHeaders: '*',
    credentials: false,
    methods: ['GET', 'PUT', 'OPTIONS', 'POST', 'DELETE'],
  });

  // Set the prefix as necessary
  app.setGlobalPrefix(process.env.API_PREFIX);

  await app.init();

  return app;
}

export const handler = async (
  event: APIGatewayProxyEvent,
  context: Context,
): Promise<PromiseHandler> => {
  // If there's no cached app
  if (!cachedNestApp) {
    // Bootstrap
    const nestApp: NestFastifyApplication = await bootstrap();
    // Create an AWS Lambda Fastify cached app from the Nest app
    cachedNestApp = awsLambdaFastify(nestApp.getHttpAdapter().getHttpServer(), {
      decorateRequest: true,
    });
  }

  return cachedNestApp(event, context);
};

toptal-dave · 2024-01-05T14:15:50Z

I got it working!

The code that works is as follows:

import { NestFactory } from '@nestjs/core';
import {
  FastifyAdapter,
  NestFastifyApplication,
} from '@nestjs/platform-fastify';
import { AppModule } from './app.module';
import awsLambdaFastify, { PromiseHandler } from '@fastify/aws-lambda';
import { Context, APIGatewayProxyEvent } from 'aws-lambda';
import { Logger } from '@nestjs/common';
import { fastify, FastifyServerOptions, FastifyInstance } from 'fastify';

interface NestApp {
  app: NestFastifyApplication;
  instance: FastifyInstance;
}

let cachedNestApp;

async function bootstrap(): Promise<NestApp> {
  const serverOptions: FastifyServerOptions = {
    logger: (process.env.LOGGER || '0') == '1',
  };
  const instance: FastifyInstance = fastify(serverOptions);
  // Create the app
  const app = await NestFactory.create<NestFastifyApplication>(
    AppModule,
    // Use an env var to set the logger to nest or console
    new FastifyAdapter(instance),
    {
      logger: !process.env.AWS_EXECUTION_ENV ? new Logger() : console,
    },
  );

  // Enable cors
  app.enableCors({
    origin: '*',
    allowedHeaders: '*',
    exposedHeaders: '*',
    credentials: false,
    methods: ['GET', 'PUT', 'OPTIONS', 'POST', 'DELETE'],
  });

  // Set the prefix as necessary
  app.setGlobalPrefix(process.env.API_PREFIX);

  await app.init();

  return {
    app,
    instance,
  };
}

export const handler = async (
  event: APIGatewayProxyEvent,
  context: Context,
): Promise<PromiseHandler> => {
  // If there's no cached app
  if (!cachedNestApp) {
    // Bootstrap
    const nestApp: NestApp = await bootstrap();
    // Create an AWS Lambda Fastify cached app from the Nest app
    cachedNestApp = awsLambdaFastify(nestApp.instance, {
      decorateRequest: true,
    });
  }

  return cachedNestApp(event, context);
};

I had to make sure that the Fastify version was the same between what was installed here and what @nestjs/platform-fastify as per this comment.

Copilot

Pull request overview

This PR adds documentation for using @fastify/aws-lambda with NestJS, addressing issue #115 which requested examples of integrating the library with NestJS. The documentation includes two sections: basic NestJS setup and NestJS with GraphQL integration.

Changes:

Added a "Usage with NestJS" section with a complete example showing how to integrate NestJS with aws-lambda-fastify
Added a "Usage with NestJS/GraphQL" section explaining how to handle GraphQL schema files in a Lambda environment
Included explanation of lambda caching patterns to minimize cold-start times

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-04T09:30:31Z

README.md

+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})


The code example is incomplete and missing the class decorator and export. The example should start with export class AppModule {} to be a complete and valid TypeScript class definition.

Suggested change

})

})

export class AppModule {}

Copilot · 2026-02-04T09:30:31Z

README.md

+You will also need to modify your `app.module.ts` file:
+
+### app.module.ts
+```typescript


The app.module.ts example is missing necessary import statements. At minimum, it should include imports for Module, GraphQLModule, MercuriusDriverConfig, GqlModuleOptions, MercuriusDriver, join, and any other referenced symbols like createXYZLoader, XYZService, XYZModule, AppController, and AppService. Without these imports, the code example cannot be used as-is.

Suggested change

```typescript

```typescript

import { Module } from '@nestjs/common';

import { GraphQLModule, GqlModuleOptions } from '@nestjs/graphql';

import { MercuriusDriver, MercuriusDriverConfig } from '@nestjs/mercurius';

import { join } from 'path';

import { createXYZLoader } from './xyz.loader';

import { XYZService } from './xyz.service';

import { XYZModule } from './xyz.module';

import { AppController } from './app.controller';

import { AppService } from './app.service';

Copilot · 2026-02-04T09:30:32Z

README.md

+let cachedNestApp;
+
+async function bootstrapServer(): Promise {


The variable cachedNestApp is missing a type annotation. It should be typed to match what awsLambdaFastify returns. Consider adding a type annotation such as let cachedNestApp: PromiseHandler | undefined; or let cachedNestApp: any; for clarity.

Suggested change

let cachedNestApp;

async function bootstrapServer(): Promise {

let cachedNestApp: PromiseHandler | undefined;

async function bootstrapServer(): Promise<NestApp> {

Copilot · 2026-02-04T09:30:32Z

README.md

+  context: Context,
+): Promise<PromiseHandler> => {
+    if (!cachedNestApp) {
+      const nestApp = await bootstrap();


The function being called is bootstrap() but the function defined above is named bootstrapServer(). This is a critical bug that would prevent the code from working. The call should be changed to bootstrapServer().

Suggested change

const nestApp = await bootstrap();

const nestApp = await bootstrapServer();

Copilot · 2026-02-04T09:30:32Z

README.md

+      methods: ['GET', 'PUT', 'OPTIONS', 'POST', 'DELETE'],
+  };
+
+  app.register(require('fastify-cors'), CORS_OPTIONS);


The package fastify-cors has been deprecated and replaced with @fastify/cors. The code should use the newer package instead. Update the line to use @fastify/cors and consider importing it at the top of the file rather than using require() inline, which would be more consistent with the TypeScript imports used elsewhere in the example.

Copilot · 2026-02-04T09:30:32Z

README.md

+async function bootstrapServer(): Promise {
+
+  const serverOptions: FastifyServerOptions = {
+      logger: (process.env.LOGGER || '0') == '1',


Using == for comparison is not recommended in TypeScript/JavaScript. Use strict equality === instead: (process.env.LOGGER || '0') === '1'.

Suggested change

logger: (process.env.LOGGER || '0') == '1',

logger: (process.env.LOGGER || '0') === '1',

Copilot · 2026-02-04T09:30:33Z

README.md

+export const handler = async (
+  event: APIGatewayProxyEvent,
+  context: Context,
+): Promise<PromiseHandler> => {


The return type Promise<PromiseHandler> appears to be incorrect. The PromiseHandler type from @fastify/aws-lambda represents the handler function type, not the return value of the handler. The handler should return the actual response from the lambda proxy, which is typically something like Promise<APIGatewayProxyResult>. Consider removing the explicit return type or using the correct return type.

Suggested change

): Promise<PromiseHandler> => {

) => {

Copilot · 2026-02-04T09:30:33Z

README.md

+
+let cachedNestApp;
+
+async function bootstrapServer(): Promise {


The function bootstrapServer is missing the generic type parameter for its Promise return type. The return type should be Promise<NestApp> instead of just Promise.

Suggested change

async function bootstrapServer(): Promise {

async function bootstrapServer(): Promise<NestApp> {

Copilot · 2026-02-04T09:30:33Z

README.md

+Notice we are caching the initialized app. In a lambda environment, the handler will be called on each new request. Anything outside the handler may be cached between calls, which lasts as long as AWS has kept the same lambda execution environment up for your function. By storing the initialized app as a variable, we can minimize the cold-start time of our app since it will be constructed once per execution environment spin up.
+
+## Usage with NestJS/GraphQL
+In addition to the above, when using NestJS with GraphQL in a lambda environment, you will need to copy your `schema.gql` into your `dist` folder rather than relying on the `autoSchemaFile` option since this tries to write to `/src` directory inside a running lambda function and you are only allowed to write to `/tmp` directory. You can modify your build script in your `package.json` to acheive this:


There's a spelling error: "acheive" should be "achieve".

Suggested change

In addition to the above, when using NestJS with GraphQL in a lambda environment, you will need to copy your `schema.gql` into your `dist` folder rather than relying on the `autoSchemaFile` option since this tries to write to `/src` directory inside a running lambda function and you are only allowed to write to `/tmp` directory. You can modify your build script in your `package.json` to acheive this:

In addition to the above, when using NestJS with GraphQL in a lambda environment, you will need to copy your `schema.gql` into your `dist` folder rather than relying on the `autoSchemaFile` option since this tries to write to `/src` directory inside a running lambda function and you are only allowed to write to `/tmp` directory. You can modify your build script in your `package.json` to achieve this:

updates readme for nestjs

cfb987c

Jwagner347 mentioned this pull request Dec 16, 2022

Use with NestJS #115

Open

2 tasks

mcollina requested a review from adrai December 16, 2022 22:01

adrai added the documentation Improvements or additions to documentation label Dec 16, 2022

adrai removed their request for review December 18, 2022 10:49

toptal-dave mentioned this pull request Dec 30, 2023

FastifyAdapter can't take a FastifyInstance due to a type error nestjs/nest#12979

Closed

15 tasks

Fdawgs requested a review from Copilot February 4, 2026 09:27

Copilot started reviewing on behalf of Fdawgs February 4, 2026 09:27 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

-```typescript
+```typescript
+import { Module } from '@nestjs/common';
+import { GraphQLModule, GqlModuleOptions } from '@nestjs/graphql';
+import { MercuriusDriver, MercuriusDriverConfig } from '@nestjs/mercurius';
+import { join } from 'path';
+import { createXYZLoader } from './xyz.loader';
+import { XYZService } from './xyz.service';
+import { XYZModule } from './xyz.module';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';

		let cachedNestApp;

		async function bootstrapServer(): Promise {

	const nestApp = await bootstrap();
	const nestApp = await bootstrapServer();

	logger: (process.env.LOGGER \|\| '0') == '1',
	logger: (process.env.LOGGER \|\| '0') === '1',

Uh oh!

updates readme for nestjs #142

Are you sure you want to change the base?

updates readme for nestjs #142

Uh oh!

Conversation

Jwagner347 commented Dec 16, 2022

Checklist

Uh oh!

adrai commented Dec 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jwagner347 commented Dec 16, 2022

Uh oh!

mcollina commented Dec 16, 2022

Uh oh!

adrai commented Dec 16, 2022

Uh oh!

Jwagner347 commented Dec 16, 2022

Uh oh!

adrai commented Dec 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uzlopak commented Dec 18, 2022

Uh oh!

toptal-dave commented Dec 30, 2023

Uh oh!

toptal-dave commented Dec 30, 2023

Uh oh!

toptal-dave commented Dec 30, 2023

Uh oh!

toptal-dave commented Dec 31, 2023

Uh oh!

toptal-dave commented Jan 5, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

adrai commented Dec 16, 2022 •

edited

Loading

adrai commented Dec 18, 2022 •

edited

Loading