Should a Mock inside a synctest test follow synctest's clock?

オープン
  • 何か問題がありますか？
#35 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
8/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
go
領域
testing-qa

調査の方向性

This is a design question, not a patch: the issue asks whether a *Mock inside a synctest test should follow synctest's fake clock or keep its own time. Read the mock clock implementation and the NewReal() clock in the quartz package, along with the prototype behaviour described in the issue (Advance, timers, ctx.Deadline). Done means a maintainer-agreed answer to the design question and the README wording that follows from it, which needs input from @spikecurtis first.

索引モデルが issue の本文から書いたものです。

説明

Go 1.25 made testing/synctest stable. In a synctest test, the time package runs on a fake clock that jumps forward whenever every goroutine in the test is blocked. That overlaps with what quartz does, so the README needs to say when to use which (#34). Before writing that, we want to agree on one design question:

Should a *Mock created inside a synctest test follow synctest's fake clock, or keep its own time as it does today?

Today the two clocks are independent. Calling time.Sleep(time.Hour) inside the test does not move the mock, and mClock.Advance(time.Hour) does not move time.Now(). quartz.NewReal() already follows synctest's clock, because it calls the time package.

We prototyped a mock that follows synctest's clock: timers are real time timers, and Advance(d) is time.Sleep(d) followed by synctest.Wait(). Compared with today's *Mock:

  • Better: ctx.Deadline() agrees with time.Now(), and Advance can move past several timers at once, firing them in order. Today Advance stops at the next timer.
  • Worse, time moves without Advance: a test that forgot to call Advance and then waited for the code to start its next timer still passed, because synctest moved time forward by 10s on its own. Today's mock fails that test.
  • Worse, real I/O: a 5s timeout never fired during a real TCP read. Advance(5s) blocked until the read finished, because synctest does not move time while a goroutine waits on the network. Today's mock canceled the read after 67µs.

We also tried keeping the mock's own timers but sleeping the same amount on every Advance, so both clocks stay equal. They drift apart as soon as code in the test sleeps on its own. After a 1-minute time.Sleep in library code, the mock was 1 minute behind.

The one thing a synctest-following mock adds over NewReal() is traps.

Our recommendation: keep the *Mock independent. The README would say: use synctest with NewReal() when the whole test can run inside synctest, and use a *Mock when it does real I/O or needs to control exactly when time moves. If traps turn out to be wanted with synctest, a separate option is to add traps to the real clock rather than changing the mock.

@spikecurtis, does that match your view?

🤖 This issue was created with the help of Coder Agents.

主要言語
Go
スター
273
フォーク
9
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

coder/quartz のほかの issue

coder/quartz の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。