npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nest-memory-transport

v1.0.3

Published

An in-memory (fake) transport strategy for NestJS microservices, useful for in-process integrative tests

Downloads

9

Readme

NestJS Memory Transport

This package aims to replace existing NestJS transport layers with a memory-based implementation. This is useful for testing purposes, as it allows you to run your application in memory without the need for a network connection. Specifically, it allows you to write in-process acceptance tests for a monorepo that consists of multiple microservices, without going out of process.

Installation

$ npm install nest-memory-transport

Getting Started

In order to replace existing transports such as Kafka or TCP, you'll need to restructure your NestJS application to allow injection of the transport layer from the outside.

Server

Assuming that your init code looks something like this:

async function bootstrap() {
  const app = await NestFactory.createMicroservice<MicroserviceOptions>(
    MyMicroserviceModule,
    {
      transport: Transport.KAFKA,
      options: {
        client: {
          clientId: 'some-client-id',
          brokers: ['localhost:9092'],
        },
        consumer: {
          groupId: 'some-consumer',
        },
      },
    },
  );
  await app.listen();
}
bootstrap();

with this:

// app.ts
export async function bootstrap(transportOptions: MicroserviceOptions) {
  const app = await NestFactory.createMicroservice<MicroserviceOptions>(
    MyMicroserviceModule,
    transportOptions,
  );
  await app.listen();
}

// main.ts
bootstrap({
  transport: Transport.KAFKA,
  options: {
    client: {
      clientId: 'some-client-id',
      brokers: ['localhost:9092'],
    },
    consumer: {
      groupId: 'some-consumer',
    },
  },
});

Then in your test, initialize the same microservice with the memory transport:

const emitter = new EventEmitter();
const myMicroService = await bootstrap({
  strategy: new MemoryTransportServer(emitter)
});

Client

Convert your AppModule to a DynamicModule that takes the transport layer as a parameter:

export class AppModule {
  static register(transport: DynamicModule): DynamicModule {
    return {
      imports: [transport, ...any other imports],
      controllers: [...your controllers],
      providers: [...your providers],
      module: AppModule,
    };
  }
}

In your main.ts, initialize the app with the production transport:

export async function bootstrap() {
  const app = await NestFactory.create(
    AppModule.register(
      ClientsModule.register([
        {
          name: 'KAFKA_CLIENT',
          transport: Transport.KAFKA,
          options: {
            client: {
              clientId: 'some-client-id',
              brokers: ['localhost:9092'],
            },
            consumer: {
              groupId: 'some-consumer',
            },
          },
        },
      ]),
    ),
  );
  await app.listen(3000);
  return app;
}

Then in your test, initialize the same app with the memory transport:

const appTestingModule = await Test.createTestingModule({ 
  imports: [AppModule.register(MemoryClientsModule.register({
    name: 'KAFKA_CLIENT',
    emitter, // the same emitter declared earlier, shared between all microservices and their clients
  }))],
}).compile();
await appTestingModule.createNestApplication().init();

See the e2e test for a full working example.

Issues

Ideally, add a failing test to any issue you submit.

Contributing

If you wish to contribute, please open a PR with a failing test, then implement the feature and make the test pass.