sinonjs/sinon

Sinon fails in comparing call order when running tests in parallel

Open

#2 472 ouverte le 17 sept. 2022

Voir sur GitHub
 (11 commentaires) (0 réactions) (0 assignés)JavaScript (9 548 stars) (764 forks)batch import
BugDifficulty: EasyHelp wantedImprovementgood first issue

Description

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

Guide contributeur

Stack technique
javascripttypescript
Domaine
testing
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Understanding of Sinon spy APIFamiliarity with node tap parallel testsBasic knowledge of JavaScript testing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.