Skip to content

Upgrade NATS library used for tests #1009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 22, 2025
Merged

Upgrade NATS library used for tests #1009

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
868b274
feat(nats): Upgrade NATS to v3.0.0
jdinsel-xealth May 22, 2025
92fed49
refactor: move to devDependencies
jdinsel-xealth May 22, 2025
359914f
restore container version -- tests still pass
jdinsel-xealth May 22, 2025
ff4e44b
Merge branch 'main' into main
cristianrgreco May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 57 additions & 28 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions packages/modules/nats/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@
"prepack": "shx cp ../../../README.md . && shx cp ../../../LICENSE .",
"build": "tsc --project tsconfig.build.json"
},
"devDependencies": {
"nats": "^2.28.0"
},
"dependencies": {
"@nats-io/jetstream": "^3.0.2",
"@nats-io/transport-node": "^3.0.2",
"testcontainers": "^10.27.0"
}
}
12 changes: 6 additions & 6 deletions packages/modules/nats/src/nats-container.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { connect, StringCodec } from "nats";
import { jetstreamManager } from "@nats-io/jetstream";
import { connect } from "@nats-io/transport-node";
import { NatsContainer } from "./nats-container";

describe("NatsContainer", { timeout: 180_000 }, () => {
Expand All @@ -25,19 +26,18 @@ describe("NatsContainer", { timeout: 180_000 }, () => {

const container = await new NatsContainer().start();
const nc = await connect(container.getConnectionOptions());
const sc = StringCodec();

//----------------
const sub = nc.subscribe(SUBJECT);
(async () => {
for await (const m of sub) {
const actual: string = sc.decode(m.data);
const actual: string = m.string();
Copy link
Contributor

@joebowbeer joebowbeer May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, Base64Codec static functions are provided by @nats-io/obj

Base64Codec.encode()
Base64Codec.decode()

Copy link
Contributor Author

@jdinsel-xealth jdinsel-xealth May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The NATS examples in their own documentation are out of date, but I found test cases which use string(), so I picked those. I do not think this PR should deviate to use the suggested Base64Codec.

Copy link
Contributor

@joebowbeer joebowbeer May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think toString is a suitable transport encoding to use even in an example.

expect(actual).toEqual(PAYLOAD);
}
})().then();

//----------------
nc.publish(SUBJECT, sc.encode(PAYLOAD));
nc.publish(SUBJECT, PAYLOAD);

//----------------
await nc.drain();
Expand Down Expand Up @@ -73,7 +73,7 @@ describe("NatsContainer", { timeout: 180_000 }, () => {
const nc = await connect(container.getConnectionOptions());

// ensure JetStream is enabled, otherwise this will throw an error
await nc.jetstream().jetstreamManager();
await jetstreamManager(nc);

// close the connection
await nc.close();
Expand All @@ -90,7 +90,7 @@ describe("NatsContainer", { timeout: 180_000 }, () => {
const nc = await connect(container.getConnectionOptions());

// ensure JetStream is not enabled, as this will throw an error
await expect(nc.jetstream().jetstreamManager()).rejects.toThrow("503");
await expect(jetstreamManager(nc)).rejects.toThrow("jetstream is not enabled");

// close the connection
await nc.close();
Expand Down
2 changes: 1 addition & 1 deletion packages/modules/nats/src/nats-container.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export class NatsContainer extends GenericContainer {
private args = new Set<string>();
private values = new Map<string, string | undefined>();

constructor(image = "nats:2.8.4-alpine") {
constructor(image = "nats:2.11.3-alpine") {
Copy link
Contributor

@joebowbeer joebowbeer May 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cristianrgreco I noticed that the other NATS Testcontainers (Go, .NET, Python) are defaulting to a scratch image (nats:2.9) which is actually smaller than the alpine image.

More importantly, the two images are not interchangeable. This Testcontainer's code requires the alpine base image, as explained below.

The standard image's Dockerfile provides nats-server in its ENTRYPOINT whereas the alpine Dockerfile combines nats-server with the rest of CMD. As a result, if the NodeJS user specifies NatsContainer("nats:2.11") instead of NatsContainer() or NatsContainer("nats:alpine") then the container will crash.

Would you be open to switching to the standard scratch nats image here, for consistency with other implementations?

Actually, I think best of both worlds can be achieved by simply omitting "nats-server" here:

testcontainers-node/packages/modules/nats/src/nats-container.ts

Line 84 in 40a945a

const result: string[] = ["nats-server"];

Then the alpine entry point script below will add it, and then this Testcontainer will also work if the scratch "nats" image is used instead of alpine:

https://github.com/nats-io/nats-docker/blob/main/2.11.x/alpine3.21/docker-entrypoint.sh

In other words, I think the default image can still be alpine and this Testcontainer can also be compatible with the scratch images.

Copy link
Collaborator

@cristianrgreco cristianrgreco May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joebowbeer Nice observation! Sounds good to me

Copy link
Contributor Author

@jdinsel-xealth jdinsel-xealth May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joebowbeer Can that be done in a separate pull request? I need a working NATS testcontainer to be unblocked. An optimal NATS testcontainer would be a future goal.

Copy link
Collaborator

@cristianrgreco cristianrgreco May 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jdinsel-xealth I agree it can be done in a separate PR. What I don't understand is, this PR is now only changing a dev dependency used only by this repository's tests, and updating a test. What part of this is blocking you?

Copy link
Contributor Author

@jdinsel-xealth jdinsel-xealth May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See issue #1008. While using the example provided for this testcontainer, there was an unknown exception caught in the connect operation which returned a connection refused message, but this was crafted by the NATS code. The root cause is not fully known.

console.log
      testcontainers:containers [949c57f40de8] [1] 2025/05/22 19:11:45.548358 [INF] Server is ready +1ms

      at Logger.debug [as logger] (../node_modules/debug/src/common.js:113:10)

  console.log
    socket error AggregateError: 
        at internalConnectMultiple (node:net:1139:18)
        at afterConnectMultiple (node:net:1714:7)
        at TCPConnectWrap.callbackTrampoline (node:internal/async_hooks:130:17) {
      code: 'ECONNREFUSED',
      [errors]: [
        Error: connect ECONNREFUSED ::1:33412
            at createConnectionError (node:net:1677:14)
            at afterConnectMultiple (node:net:1707:16)
            at TCPConnectWrap.callbackTrampoline (node:internal/async_hooks:130:17) {
          errno: -61,
          code: 'ECONNREFUSED',
          syscall: 'connect',
          address: '::1',
          port: 33412
        },
        Error: connect ECONNREFUSED 127.0.0.1:33412
            at createConnectionError (node:net:1677:14)
            at afterConnectMultiple (node:net:1707:16)
            at TCPConnectWrap.callbackTrampoline (node:internal/async_hooks:130:17) {
          errno: -61,
          code: 'ECONNREFUSED',
          syscall: 'connect',
          address: '127.0.0.1',
          port: 33412
        }
      ]
    }

      at Socket.<anonymous> (../node_modules/@nats-io/transport-node/src/node_transport.ts:128:7)

  console.log
    socket close

      at Socket.<anonymous> (../node_modules/@nats-io/transport-node/src/node_transport.ts:132:15)

  console.error
    Error connecting to NATS: ConnectionError: connection refused
        at NodeTransport.connect (/Users/jeremy.dinsel/git/xealth-patient-engagement-service/node_modules/@nats-io/transport-node/src/node_transport.ts:113:11)
        at processTicksAndRejections (node:internal/process/task_queues:105:5)
        at ProtocolHandler.dial (/Users/jeremy.dinsel/git/xealth-patient-engagement-service/node_modules/@nats-io/nats-core/build/src/protocol.ts:552:7)
        at ProtocolHandler._doDial (/Users/jeremy.dinsel/git/xealth-patient-engagement-service/node_modules/@nats-io/nats-core/build/src/protocol.ts:600:9)
        at ProtocolHandler.dodialLoop (/Users/jeremy.dinsel/git/xealth-patient-engagement-service/node_modules/@nats-io/nats-core/build/src/protocol.ts:652:11) {
      [cause]: AggregateError: 
          at internalConnectMultiple (node:net:1139:18)
          at afterConnectMultiple (node:net:1714:7)
          at TCPConnectWrap.callbackTrampoline (node:internal/async_hooks:130:17) {
        code: 'ECONNREFUSED',
        [errors]: [ [Error], [Error] ]
      }
    }

Copy link
Collaborator

@cristianrgreco cristianrgreco May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume then you're having the same error after the changes made in this PR?

Copy link
Contributor Author

@jdinsel-xealth jdinsel-xealth May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't explain the differences in the repositories. I've even created a separate repository with only vitest, @testcontainers/nats, and the two @nats-io dependencies. The only code in the repository is the example test from this repository for NATS. It fails with the same errors I've reported.

Copy link
Collaborator

@cristianrgreco cristianrgreco May 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right.. well I've no idea how this PR relates to #1008, but I guess thanks for updating the library used for our NATS tests! LMK if you're planning on making any additional changes, else LGTM.

@joebowbeer A separate PR with what you proposed would be great.

Copy link
Contributor Author

@jdinsel-xealth jdinsel-xealth May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the .devcontainer from this repository to my test repository and the connection with NATS succeeds.

Copy link
Contributor Author

@jdinsel-xealth jdinsel-xealth May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a solution with some combination of information from https://node.testcontainers.org/supported-container-runtimes/#usage_2. I'll post the details in the related issue. Please decide if you want to keep this PR or close it.

super(image);

this.withUsername("test");
Expand Down
Loading