Nats

Author: cristianrgreco

docs/modules/nats.md

@@ -1,6 +1,4 @@
-# Nats Module
-
-[NATS](https://nats.io/) is a simple, secure and high performance open source messaging system for cloud native applications, IoT messaging, and microservices architectures.
+# Nats
 
 ## Install
 
@@ -10,18 +8,32 @@ npm install @testcontainers/nats --save-dev
 
 ## Examples
 
-<!--codeinclude-->
-[Connect:](../../packages/modules/nats/src/nats-container.test.ts) inside_block:connect
-<!--/codeinclude-->
+These examples use the following libraries:
+
+- [@nats-io/transport-node](https://www.npmjs.com/package/@nats-io/transport-node)
+
+        npm install @nats-io/transport-node
+
+- [@nats-io/jetstream](https://www.npmjs.com/package/@nats-io/jetstream)
+
+        npm install @nats-io/jetstream
+
+Choose an image from the [container registry](https://hub.docker.com/_/nats) and substitute `IMAGE`.
+
+### Produce/consume a message
 
 <!--codeinclude-->
-[Publish and subscribe:](../../packages/modules/nats/src/nats-container.test.ts) inside_block:pubsub
+[](../../packages/modules/nats/src/nats-container.test.ts) inside_block:natsPubsub
 <!--/codeinclude-->
 
+### With credentials
+
 <!--codeinclude-->
-[Set credentials:](../../packages/modules/nats/src/nats-container.test.ts) inside_block:credentials
+[](../../packages/modules/nats/src/nats-container.test.ts) inside_block:natsCredentials
 <!--/codeinclude-->
 
+### With Jetstream
+
 <!--codeinclude-->
-[Enable JetStream:](../../packages/modules/nats/src/nats-container.test.ts) inside_block:jetstream
-<!--/codeinclude-->
+[](../../packages/modules/nats/src/nats-container.test.ts) inside_block:natsJetstream
+<!--/codeinclude-->

packages/modules/nats/src/nats-container.test.ts

@@ -6,89 +6,53 @@ import { NatsContainer } from "./nats-container";
 const IMAGE = getImage(__dirname);
 
 describe("NatsContainer", { timeout: 180_000 }, () => {
-  // connect {
-  it("should start, connect and close", async () => {
-    await using container = await new NatsContainer(IMAGE).start();
-
-    // establish connection
-    const nc = await connect(container.getConnectionOptions());
-    // close the connection
-    await nc.close();
-    // check if the close was OK
-    const err = await nc.closed();
-    expect(err).toBe(undefined);
-  });
-  // }
-
-  it("should start, connect and close using scratch image", async () => {
-    await using container = await new NatsContainer("nats:2.11").start();
-
-    // establish connection
-    const nc = await connect(container.getConnectionOptions());
-    // close the connection
-    await nc.close();
-    // check if the close was OK
-    const err = await nc.closed();
-    expect(err).toBe(undefined);
-  });
-
-  // pubsub {
   it("should subscribe and receive one published message", async () => {
+    // natsPubsub {
     const SUBJECT = "HELLO";
     const PAYLOAD = "WORLD";
+    const TE = new TextEncoder();
+    const TD = new TextDecoder();
 
     await using container = await new NatsContainer(IMAGE).start();
     const nc = await connect(container.getConnectionOptions());
-    const TE = new TextEncoder();
-    const TD = new TextDecoder();
 
-    //----------------
     const sub = nc.subscribe(SUBJECT);
+
     (async () => {
       for await (const m of sub) {
         const actual = TD.decode(m.data);
         expect(actual).toEqual(PAYLOAD);
       }
     })().then();
 
-    //----------------
     nc.publish(SUBJECT, TE.encode(PAYLOAD));
 
-    //----------------
     await nc.drain();
     await nc.close();
-    const err = await nc.closed();
-    expect(err).toBe(undefined);
+    // }
   });
-  // }
 
-  // credentials {
   it("should start with alternative username and password ", async () => {
-    // set username and password like this
-    await using container = await new NatsContainer(IMAGE).withPass("1234").withUsername("George").start();
+    // natsCredentials {
+    await using container = await new NatsContainer(IMAGE).withUsername("George").withPass("1234").start();
+    // }
 
     const nc = await connect(container.getConnectionOptions());
-    // close the connection
+
     await nc.close();
-    // check if the close was OK
     const err = await nc.closed();
     expect(err).toBe(undefined);
   });
-  // }
 
-  // jetstream {
   it("should start with JetStream ", async () => {
-    // enable JetStream
+    // natsJetstream {
     await using container = await new NatsContainer(IMAGE).withJetStream().start();
+    // }
 
     const nc = await connect(container.getConnectionOptions());
-
-    // ensure JetStream is enabled, otherwise this will throw an error
     await jetstreamManager(nc);
 
-    // close the connection
     await nc.close();
-    // check if the close was OK
     const err = await nc.closed();
     expect(err).toBe(undefined);
   });