Remove unnecessary unique port generator

The RandomPortGenerator now always returns an available port, so it doesn't matter if it's unique.

Author: cristianrgreco

packages/testcontainers/src/index.ts

@@ -22,7 +22,7 @@ export { CommitOptions, Content, ExecOptions, ExecResult, InspectResult } from "
 export { BoundPorts } from "./utils/bound-ports";
 export { LABEL_TESTCONTAINERS_SESSION_ID } from "./utils/labels";
 export { PortWithBinding, PortWithOptionalBinding, getContainerPort, hasHostBinding } from "./utils/port";
-export { PortGenerator, RandomUniquePortGenerator } from "./utils/port-generator";
+export { PortGenerator, RandomPortGenerator } from "./utils/port-generator";
 export { ImagePullPolicy, PullPolicy } from "./utils/pull-policy";
 export { HttpWaitStrategyOptions } from "./wait-strategies/http-wait-strategy";
 export { StartupCheckStrategy, StartupStatus } from "./wait-strategies/startup-check-strategy";

packages/testcontainers/src/port-forwarder/port-forwarder-reuse.test.ts

@@ -1,11 +1,11 @@
 import { GenericContainer } from "../generic-container/generic-container";
-import { RandomUniquePortGenerator } from "../utils/port-generator";
+import { RandomPortGenerator } from "../utils/port-generator";
 import { createTestServer } from "../utils/test-helper";
 
 describe("Port Forwarder reuse", { timeout: 180_000 }, () => {
-  it("should expose additional ports", async () => {
-    const portGen = new RandomUniquePortGenerator();
+  const portGen = new RandomPortGenerator();
 
+  it("should expose additional ports", async () => {
     const { TestContainers: TC1 } = await import("../test-containers");
     const { PortForwarderInstance: PFI1 } = await import("../port-forwarder/port-forwarder");
     const port1 = await portGen.generatePort();
@@ -35,7 +35,6 @@ describe("Port Forwarder reuse", { timeout: 180_000 }, () => {
   });
 
   it("should reuse same ports", async () => {
-    const portGen = new RandomUniquePortGenerator();
     const port = await portGen.generatePort();
     const server = await createTestServer(port);
 

packages/testcontainers/src/port-forwarder/port-forwarder.test.ts

@@ -2,15 +2,15 @@ import { Server } from "http";
 import { GenericContainer } from "../generic-container/generic-container";
 import { Network } from "../network/network";
 import { TestContainers } from "../test-containers";
-import { RandomUniquePortGenerator } from "../utils/port-generator";
+import { RandomPortGenerator } from "../utils/port-generator";
 import { createTestServer } from "../utils/test-helper";
 
 describe("PortForwarder", { timeout: 180_000 }, () => {
   let randomPort: number;
   let server: Server;
 
   beforeEach(async () => {
-    randomPort = await new RandomUniquePortGenerator().generatePort();
+    randomPort = await new RandomPortGenerator().generatePort();
     server = await createTestServer(randomPort);
   });
 

packages/testcontainers/src/reaper/reaper.test.ts

@@ -1,5 +1,5 @@
 import { ContainerRuntimeClient, getContainerRuntimeClient } from "../container-runtime";
-import { RandomUniquePortGenerator } from "../utils/port-generator";
+import { RandomPortGenerator } from "../utils/port-generator";
 
 describe("Reaper", { timeout: 120_000 }, () => {
   let client: ContainerRuntimeClient;
@@ -54,7 +54,7 @@ describe("Reaper", { timeout: 120_000 }, () => {
   });
 
   it("should use custom port when TESTCONTAINERS_RYUK_PORT is set", async () => {
-    const customPort = (await new RandomUniquePortGenerator().generatePort()).toString();
+    const customPort = (await new RandomPortGenerator().generatePort()).toString();
     vi.stubEnv("TESTCONTAINERS_RYUK_PORT", customPort);
     vi.spyOn(client.container, "list").mockResolvedValue([]);
 

packages/testcontainers/src/utils/port-generator.test.ts

@@ -1,11 +1,25 @@
-import { FixedPortGenerator, RandomUniquePortGenerator } from "./port-generator";
+import { FixedPortGenerator, RandomPortGenerator } from "./port-generator";
 
 describe("PortGenerator", () => {
-  describe("RandomUniquePortGenerator", () => {
-    it("should generate a random and unique port across all instances", async () => {
-      const fixedPortGenerator = new FixedPortGenerator([1000, 1000, 1001]);
-      expect(await new RandomUniquePortGenerator(fixedPortGenerator).generatePort()).toBe(1000);
-      expect(await new RandomUniquePortGenerator(fixedPortGenerator).generatePort()).toBe(1001);
+  describe("FixedPortGenerator", () => {
+    it("should return pre-determined ports", async () => {
+      const fixedPortGenerator = new FixedPortGenerator([1000, 1001]);
+
+      await expect(fixedPortGenerator.generatePort()).resolves.toBe(1000);
+      await expect(fixedPortGenerator.generatePort()).resolves.toBe(1001);
+    });
+  });
+
+  describe("RandomPortGenerator", () => {
+    it("should generate a random available port", async () => {
+      const randomPortGenerator = new RandomPortGenerator();
+
+      const port1 = await randomPortGenerator.generatePort();
+      const port2 = await randomPortGenerator.generatePort();
+
+      expect(port1).toBeDefined();
+      expect(port2).toBeDefined();
+      expect(port1).not.toBe(port2);
     });
   });
 });

packages/testcontainers/src/utils/port-generator.ts

@@ -2,31 +2,13 @@ export interface PortGenerator {
   generatePort(): Promise<number>;
 }
 
-class RandomPortGenerator {
+export class RandomPortGenerator {
   public async generatePort(): Promise<number> {
     const { default: getPort } = await import("get-port");
     return getPort();
   }
 }
 
-export class RandomUniquePortGenerator implements PortGenerator {
-  private static readonly assignedPorts = new Set();
-
-  constructor(private readonly portGenerator: PortGenerator = new RandomPortGenerator()) {}
-
-  public async generatePort(): Promise<number> {
-    let port: number;
-
-    do {
-      port = await this.portGenerator.generatePort();
-    } while (RandomUniquePortGenerator.assignedPorts.has(port));
-
-    RandomUniquePortGenerator.assignedPorts.add(port);
-
-    return port;
-  }
-}
-
 export class FixedPortGenerator implements PortGenerator {
   private portIndex = 0;