Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test_runner: error on mocking an already mocked date #55858

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test_runner: error on mocking an already mocked date #55858

wants to merge 1 commit into from
+10 −0

Conversation

RedYetiDev
Copy link
Member

Fixes #55849

Previously, the properties from the global Date, including the not-writable isMock and [kMock] values, would be copied if the global Date was already mocked. This became an issue because the mock setup would attempt overwrite these properties.

Now, ERR_INVALID_STATE is thrown, as Date is already being mocked!.

Example

import { test } from 'node:test'

test((outer) => {
    outer.mock.timers.enable()
    test((inner) => inner.mock.timers.enable())
});

Before

✖ <anonymous> (0.536701ms)
  TypeError: Cannot redefine property: Symbol(MockTimers)
      at defineProperties (<anonymous>)
      at #createDate (node:internal/test_runner/mock/mock_timers:396:5)
      at Object.Date (node:internal/test_runner/mock/mock_timers:635:45)
      at node:internal/test_runner/mock/mock_timers:659:74
      at Array.forEach (<anonymous>)
      at #toggleEnableTimers (node:internal/test_runner/mock/mock_timers:659:5)
      at MockTimers.enable (node:internal/test_runner/mock/mock_timers:740:29)
      at TestContext.<anonymous> (file:///repro.js:5:39)
      at Test.runInAsyncScope (node:async_hooks:211:14)
      at Test.run (node:internal/test_runner/test:934:25)

After

✖ <anonymous> (0.573319ms)
  Error [ERR_INVALID_STATE]: Invalid state: Date is already being mocked!
      at #createDate (node:internal/test_runner/mock/mock_timers:332:13)
      at Object.Date (node:internal/test_runner/mock/mock_timers:638:45)
      at node:internal/test_runner/mock/mock_timers:662:74
      at Array.forEach (<anonymous>)
      at #toggleEnableTimers (node:internal/test_runner/mock/mock_timers:662:5)
      at MockTimers.enable (node:internal/test_runner/mock/mock_timers:743:29)
      at TestContext.<anonymous> (file:///repro.js:5:39)
      at Test.runInAsyncScope (node:async_hooks:211:14)
      at Test.run (node:internal/test_runner/test:934:25)
      at Test.start (node:internal/test_runner/test:833:17) {
    code: 'ERR_INVALID_STATE'
  }

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/test_runner

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. test_runner Issues and PRs related to the test runner subsystem. labels Nov 14, 2024
@RedYetiDev RedYetiDev mentioned this pull request Nov 14, 2024
Open
@codecov Codecov
Copy link

codecov bot commented Nov 15, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.41%. Comparing base (b52a49b) to head (52a34ef).
Report is 5 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #55858   +/-   ##
=======================================
  Coverage   88.41%   88.41%           
=======================================
  Files         654      654           
  Lines      187824   187827    +3     
  Branches    36134    36137    +3     
=======================================
+ Hits       166060   166064    +4     
+ Misses      15005    15003    -2     
- Partials     6759     6760    +1
Files with missing lines Coverage Δ
lib/internal/test_runner/mock/mock_timers.js 98.74% <100.00%> (+<0.01%) ⬆️

... and 33 files with indirect coverage changes

JakobJingleheimer
JakobJingleheimer reviewed Nov 15, 2024
View reviewed changes
Copy link
Contributor

@JakobJingleheimer JakobJingleheimer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is throwing necessary/helpful? If it's already mocked, why not just silently abort? (don't re-mock, but don't throw)

lib/internal/test_runner/mock/mock_timers.js
@@ -328,6 +328,9 @@ class MockTimers {
#createDate() {
kMock ??= Symbol('MockTimers');
const NativeDateConstructor = this.#nativeDateDescriptor.value;
if (NativeDateConstructor.isMock) {
throw new ERR_INVALID_STATE('Date is already being mocked!');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit

Suggested change
throw new ERR_INVALID_STATE('Date is already being mocked!');
throw new ERR_INVALID_STATE('Date is already mocked.');

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm following the same format from the other throw in the file (which also includes the !)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, okay. I think we don't usually shout in errors, but if that's how it is in the rest here, sure. It was a nit :)

@RedYetiDev
Copy link
Member Author

IMO throwing is helpful because in this case, we aren't the ones mocking.

If the user attempts to perform any other mocking utilities (such as restoring the mock), it won't work.

@JakobJingleheimer
Copy link
Contributor

IMO throwing is helpful because in this case, we aren't the ones mocking.

If the user attempts to perform any other mocking utilities (such as restoring the mock), it won't work.

Ahh, good then :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JakobJingleheimer JakobJingleheimer JakobJingleheimer approved these changes

Assignees
No one assigned
Labels
needs-ci PRs that need a full CI run. test_runner Issues and PRs related to the test runner subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Timers mock panic with sub-test
3 participants
@RedYetiDev @nodejs-github-bot @JakobJingleheimer