Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Add `getLogs()` and a line-based log consumer

未关闭
  • 哪里不对？
#1,544 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
62/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
docker, node.js, typescript
领域
devtools, testing

调研方向

Read logs in packages/testcontainers/src/generic-<container>/started-generic-<container>.ts, withLogConsumer in packages/testcontainers/src/generic-<container>/generic-<container>.ts, and the StartedTestContainer interface and forwarder in packages/testcontainers/src/test-<container>.ts. Trace how the existing streams expose stdout and stderr, then add the string retrieval options and a distinct line consumer while preserving stream access. Done when the documented examples work and the API changes are covered.

由索引模型根据 Issue 内容生成。

描述

enhancement minor

What happens

Reading a container's logs takes stream handling in both places it is offered.

After start, logs() resolves to a Readable. Getting text to assert on means collecting it by hand:

const stream = await container.logs();
const lines: string[] = [];
stream.on("data", (line) => lines.push(line));
await new Promise((resolve) => stream.on("end", resolve));

Before start, withLogConsumer hands over the raw stream, with stderr delivered on a custom err event:

.withLogConsumer((stream) => {
  stream.on("data", (line) => console.log(line));
  stream.on("err", (line) => console.error(line));
  stream.on("end", () => console.log("Stream closed"));
})

Expected

  • await container.getLogs() resolves to the logs so far as a string, with options for since, tail and stdout/stderr.
  • A line-based consumer, so the common case is one line: .withLogConsumer((line) => console.log(line)) or a helper such as LogConsumers.toConsole({ prefix: "redis" }).
  • The stream forms stay for callers who want them.

Where

  • logs in packages/testcontainers/src/generic-container/started-generic-container.ts
  • withLogConsumer in packages/testcontainers/src/generic-container/generic-container.ts
  • packages/testcontainers/src/test-container.ts

Notes

  • Java has String getLogs() and getLogs(OutputType...), and withLogConsumer(Consumer<OutputFrame>), where each frame carries its text and whether it is stdout or stderr. Go's LogConsumer.Accept(Log) is also per entry.
  • A function argument cannot tell a line consumer from a stream consumer, so the line form needs its own method name or a helper that returns a stream consumer.
  • Related: #1506. A string of recent logs is also what a start failure wants to include.

Dependencies

  • Nothing blocks this. It can start now.
  • Changes StartedTestContainer, which today means the interface, StartedGenericContainer and the forwarder on AbstractStartedContainer. Several other issues do the same. The edits do not overlap, so they can go in parallel.
主要语言
TypeScript
星标
2.6k
派生
274
平均合并
1 天 14 小时
30 天内合并 PR
44

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

testcontainers/testcontainers-node 的其他 Issue

查看 testcontainers/testcontainers-node 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。