Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Type-check the ports passed to `getMappedPort`

Aperta
  • Qualcosa non va?
#1,583 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, node.js, typescript
Ambito
backend, testing

Direzione di ricerca

Start by reading withExposedPorts and start in packages/testcontainers/src/test-container.ts and packages/testcontainers/src/generic-container/generic-container.ts, then inspect getMappedPort on StartedTestContainer. Check the repository’s existing TypeScript type tests and add cases for literal exposed ports, UDP ports, repeated calls, and dynamic ports. Done means exposed literal ports are type-checked while dynamic ports retain current behavior; coordinate the interface changes with #1529 and #1563.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement minor

What happens

getMappedPort accepts any number. Asking for a port that was never exposed compiles, and fails when the test runs:

const container = await new GenericContainer(image).withExposedPorts(8080).start();

container.getMappedPort(8081); // compiles
// Error: No port binding found for :8081/tcp

The mistake is usually a typo, or a port constant that drifted from the one passed to withExposedPorts.

Expected

The ports given to withExposedPorts are carried in the builder's type, and getMappedPort on the started container accepts only those:

const container = await new GenericContainer(image).withExposedPorts(8080, "53/udp").start();

container.getMappedPort(8080);
container.getMappedPort(53, "udp");
container.getMappedPort(8081); // compile error

Where the ports are not known statically, nothing changes: getMappedPort accepts any number, as it does today.

Where

  • withExposedPorts and start in packages/testcontainers/src/test-container.ts and packages/testcontainers/src/generic-container/generic-container.ts
  • getMappedPort on StartedTestContainer

Notes

A prototype of the types compiles under the repo's TypeScript (7.0.2) with these cases checked. It needs no class type parameter, so the fluent this return type and module subclasses are unaffected:

declare const exposed: unique symbol;
type Exposed<P extends number> = { readonly [exposed]: { readonly [K in P]: true } };
type PortsOf<T> = T extends { readonly [exposed]: infer M } ? keyof M & number : number;

interface StartedTestContainer<P extends number = number> {
  getMappedPort(port: P, protocol?: string): number;
  getMappedPort(portWithProtocol: `${P}/${"tcp" | "udp"}`): number;
}

class GenericContainer {
  withExposedPorts<const T extends PortWithOptionalBinding[]>(...ports: T): this & Exposed<ContainerPort<T[number]>>;
  start(): Promise<StartedTestContainer<PortsOf<this>>>;
}
  • Each withExposedPorts call intersects a marker onto this. Later with* calls return this, so the marker survives the rest of the chain, and repeated calls accumulate.
  • It falls back to number, and so to today's behaviour, when a port is a number variable, when the builder is stored in a variable typed GenericContainer, and when withExposedPorts was never called.
  • Module containers are unaffected, because their start() returns their own started type. A module could opt in later.
  • Ports that a subclass exposes in its constructor or hooks are not visible to the caller's type.
  • The const type parameter needs TypeScript 5.0 or later in consuming projects. Without it, only the object form ({ container, host }) loses precision.
  • The intersection shows up in editor hovers, for example GenericContainer & Exposed<8080 | 53>.
  • Changing the signature on the TestContainer interface is a compile error for anyone who implements that interface without extending GenericContainer.

Dependencies

  • Nothing blocks this. It can start now.
  • Coordinate with #1529: both change the TestContainer interface.
  • Coordinate with #1563: the started type gains a type parameter, which the forwarding wrapper has to pass through until it is removed.
Lingua principale
TypeScript
Stelle
2.6k
Fork
274
Merge medio
1g 14h
PR unite (30g)
44

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di testcontainers/testcontainers-node

Tutte le issue di testcontainers/testcontainers-node

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.