sinonjs/sinon

Sinon fails in comparing call order when running tests in parallel

Open

#2,472 opened on 2022年9月17日

GitHub で見る
 (11 comments) (0 reactions) (0 assignees)JavaScript (9,548 stars) (764 forks)batch import
BugDifficulty: EasyHelp wantedImprovementgood first issue

説明

Describe the bug

spy1.calledImmediatelyBefore(spy2) fails when used in a node-tap test suite that is being executed in parallel. In serial mode it works without issue. calledBefore continues to work as normal.

I've even tried using sandboxes for each test but it did not fix the issue.

To Reproduce

Repo: https://github.com/Ethan-Arrowood/sinon-spy-parallel-bug-reproduction

git clone https://github.com/Ethan-Arrowood/sinon-spy-parallel-bug-reproduction
cd sinon-spy-parallel-bug-reproduction
pnpm install
pnpm run test

To see tests passing comment out line 27 in test/index.ts:

+ // tap.jobs = 2;
- tap.jobs = 2;

Expected behavior

I'd expect my spy assertions to pass in both serial and parallel mode

Context (please complete the following information):

  • Library version: 14.0.0
  • Environment: Node.js 18
  • Example URL:
  • Other libraries you are using: node-tap, typescript

コントリビューターガイド

技術スタック
javascripttypescript
領域
testing
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Understanding of Sinon spy APIFamiliarity with node tap parallel testsBasic knowledge of JavaScript testing
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
Examine the Sinon source code, specifically the implementation of `calledImmediatelyBefore` and related call order tracking methods. Look at how spies manage call history in sandboxes, especially when tests run concurrently. The reproduction repository (https://github.com/Ethan Arrowood/sinon spy parallel bug reproduction) provides a minimal failing test. Investigate whether there's a race condition or shared state between parallel test runs. Consider if the issue stems from how Sinon assigns unique identifiers to spies or how it timestamps calls. Check existing discussions in the issue for any hints or proposed fixes.