Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Separate module-author internals from the user-facing entry point

Đang mở
  • Có gì không ổn?
#1,562 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, node.js, typescript
Lĩnh vực
api, backend

Hướng nghiên cứu

Start with packages/testcontainers/src/index.ts, packages/testcontainers/package.json, and biome.json; review the imports used by the five named modules and the blockers #1558 and #1561, plus coordination issues #1528 and #1550. Define the test-author exports, the module subpath, and the deep-import boundary, then check that module imports and public Dockerode type exposure match the agreed split.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

maintenance major

What happens

testcontainers has a single entry point (main: build/index.js, no exports map) that serves both test authors and module authors. Utilities that exist for the modules and for core itself are exported next to the user-facing API, and every one of them is covered by semver:

  • log, IntervalRetry, Retry
  • Uuid, RandomUuid, randomUuid
  • PortGenerator, RandomPortGenerator
  • BoundPorts, getContainerPort, hasHostBinding
  • getReaper, LABEL_TESTCONTAINERS_SESSION_ID
  • ContainerRuntimeClient, getContainerRuntimeClient, waitForContainer

Dockerode types are part of the public contract as well:

  • WaitStrategy.waitUntilReady(container: Dockerode.Container, ...)
  • StartupCheckStrategy.checkStartupState(dockerClient: Dockerode, ...)
  • the protected createOpts: ContainerCreateOptions and hostConfig: HostConfig on GenericContainer, which subclasses read and write directly

That is why @types/dockerode is a runtime dependency, and why a Dockerode major is a breaking change here.

Because there is no exports map, consumers can also import anything under testcontainers/build/....

Usage inside this repo is narrow. Most modules import only GenericContainer, AbstractStartedContainer, Wait and StartedTestContainer. Five of them (kafka, redpanda, localstack, ollama, couchbase) reach for the runtime client, BoundPorts, waitForContainer or getReaper.

Expected

  • The main entry exports what a test author needs.
  • Module-author utilities move to a separate subpath (for example testcontainers/module) with its own, looser stability promise.
  • An exports map closes off deep imports.
  • Dockerode types stay out of the user-facing signatures where possible.

Where

  • packages/testcontainers/src/index.ts
  • packages/testcontainers/package.json
  • biome.json (the import boundary rule that pins modules to the testcontainers entry point)

Notes

  • Removing exports and adding an exports map are both breaking, hence major.
  • Related: #1528 (types that should be exported but are not).
  • Go keeps this split with internal/ packages.

Dependencies

  • Blocked by #1558: that removes Dockerode.Container and BoundPorts from the wait strategy interface, which decides what is left to move.
  • Blocked by #1561: that removes the Uuid exports outright.
  • Coordinate with #1528: both edit index.ts.
  • Coordinate with #1550: an escape hatch is the alternative to subclasses reaching into the protected fields.
Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
274
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
44

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của testcontainers/testcontainers-node

Tất cả issue của testcontainers/testcontainers-node

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.