test_runner: use validateStringArray for `timers.enable()` #49534

deokjinkim · 2023-09-07T14:23:37Z

apis which is argument of timers.enable() is string array. So use validatStringArray instead of validateArray. And
options is optional, so update JSDoc.
In document, some default value of timers are missed such as setImmediate and clearImmediate. Next, milliseconds which is argument of `timers.tick() is optional and default is 1.

nodejs-github-bot · 2023-09-07T14:23:42Z

Review requested:

@nodejs/test_runner

aduh95 · 2023-09-07T15:41:19Z

lib/internal/test_runner/mock/mock_timers.js

@@ -508,7 +508,7 @@ class MockTimers {
      );
    }

-    validateArray(timers, 'timers');
+    validateStringArray(timers, 'timers');


I assume this is semver-major, correct? If so, can you please take it as its own PR?

@aduh95 the MockTimers is currently experimental, I don't think we have to mark this as semver-major PRs that contain breaking changes and should be released in the next major version.

node/doc/api/test.md

Lines 1560 to 1568 in c86e700

## Class: `MockTimers`



> Stability: 1 - Experimental

Actually I'm not sure this PR is semver-major or not. How about checking jenkins-ci's result according to below collaborator guide?

node/doc/contributing/collaborator-guide.md

Lines 901 to 908 in 7bf29b5

* `semver-{minor,major}`

* be conservative – that is, if a change has the remote _chance_ of breaking

something, go for semver-major

* when adding a semver label, add a comment explaining why you're adding it

* minor vs. patch: roughly: "does it add a new method / does it add a new

section to the docs"

* major vs. everything else: run last versions tests against this version, if

they pass, **probably** minor or patch

doc/api/test.md

deokjinkim · 2023-09-08T13:54:29Z

cc @ErickWendel PTAL when you are available.

nodejs-github-bot · 2023-09-08T14:10:26Z

CI: https://ci.nodejs.org/job/node-test-pull-request/53817/

lpinca · 2024-01-27T20:19:15Z

This needs a rebase.

nodejs-github-bot · 2024-01-29T14:23:52Z

CI: https://ci.nodejs.org/job/node-test-pull-request/56953/

nodejs-github-bot · 2024-01-30T11:23:39Z

CI: https://ci.nodejs.org/job/node-test-pull-request/56966/

aduh95 · 2024-01-30T14:54:11Z

@deokjinkim please do not add request-ci Add this label to start a Jenkins CI on a PR. label on PRs that already have a running CI, it adds up unnecessary load to the CI infrastructure, and won't make the PR land sooner. At the very least, please cancel the running CI first.

nodejs-github-bot · 2024-01-31T23:29:34Z

CI: https://ci.nodejs.org/job/node-test-pull-request/57000/

nodejs-github-bot · 2024-02-02T14:50:24Z

CI: https://ci.nodejs.org/job/node-test-pull-request/57020/

nodejs-github-bot · 2024-02-02T19:19:22Z

CI: https://ci.nodejs.org/job/node-test-pull-request/57032/

deokjinkim · 2024-02-03T10:35:25Z

This needs a rebase.

@lpinca I rebased this PR. Could you review again?

aduh95

Can you add a test that's failing on main and passing on this branch please?

aduh95 · 2024-05-11T14:29:40Z

doc/api/test.md

This looks unrelateed, should this land as a separate PR?

I created a separate PR for document change.
Refs: #52969

Some timer values such as `setImmediate` and `clearImmediate` are missed. And `milliseconds` which is argument of `timers.tick()` is optional and default is 1. Refs: nodejs#49534 (comment)

`apis` which is argument of `timers.enable()` is string array. So use `validatStringArray` instead of `validateArray`. And `options` is optional, so update JSDoc.

deokjinkim · 2024-05-14T04:09:05Z

Can you add a test that's failing on main and passing on this branch please?

Thank you for review. I added a test you mentioned :)

Some timer values such as `setImmediate` and `clearImmediate` are missed. And `milliseconds` which is argument of `timers.tick()` is optional and default is 1. Refs: #49534 (comment) PR-URL: #52969 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

Some timer values such as `setImmediate` and `clearImmediate` are missed. And `milliseconds` which is argument of `timers.tick()` is optional and default is 1. Refs: nodejs#49534 (comment) PR-URL: nodejs#52969 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

Some timer values such as `setImmediate` and `clearImmediate` are missed. And `milliseconds` which is argument of `timers.tick()` is optional and default is 1. Refs: #49534 (comment) PR-URL: #52969 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

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 Sep 7, 2023

aduh95 reviewed Sep 7, 2023

View reviewed changes

atlowChemi reviewed Sep 7, 2023

View reviewed changes

doc/api/test.md Outdated Show resolved Hide resolved

deokjinkim added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 8, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 8, 2023

This was referenced Sep 9, 2023

CI Reliability 2023-09-09 nodejs/reliability#660

Open

CI Reliability 2023-09-10 nodejs/reliability#661

Open

CI Reliability 2023-09-12 nodejs/reliability#663

Open

lpinca approved these changes Jan 27, 2024

View reviewed changes

deokjinkim force-pushed the 230907_revise_mock_timers branch 2 times, most recently from ba15590 to 40e1c33 Compare January 29, 2024 14:16

deokjinkim added the request-ci Add this label to start a Jenkins CI on a PR. label Jan 29, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 29, 2024

deokjinkim added the request-ci Add this label to start a Jenkins CI on a PR. label Jan 30, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 30, 2024

aduh95 reviewed May 11, 2024

View reviewed changes

deokjinkim mentioned this pull request May 13, 2024

doc: add missing supported timer values in timers.enable() #52969

Merged

test_runner: use validateStringArray for timers.enable()

aa15c0c

`apis` which is argument of `timers.enable()` is string array. So use `validatStringArray` instead of `validateArray`. And `options` is optional, so update JSDoc.

deokjinkim force-pushed the 230907_revise_mock_timers branch from 40e1c33 to aa15c0c Compare May 14, 2024 04:06

aduh95 approved these changes May 14, 2024

View reviewed changes

aduh95 added the semver-major PRs that contain breaking changes and should be released in the next major version. label May 14, 2024

deokjinkim added the request-ci Add this label to start a Jenkins CI on a PR. label May 14, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 14, 2024

atlowChemi approved these changes May 14, 2024

View reviewed changes

MoLow approved these changes May 14, 2024

View reviewed changes

Lxxyx approved these changes May 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test_runner: use validateStringArray for `timers.enable()` #49534

test_runner: use validateStringArray for `timers.enable()` #49534

deokjinkim commented Sep 7, 2023 •

edited

Loading

nodejs-github-bot commented Sep 7, 2023

aduh95 Sep 7, 2023

atlowChemi Sep 7, 2023

deokjinkim Sep 8, 2023

deokjinkim commented Sep 8, 2023

nodejs-github-bot commented Sep 8, 2023

lpinca commented Jan 27, 2024

nodejs-github-bot commented Jan 29, 2024

nodejs-github-bot commented Jan 30, 2024

aduh95 commented Jan 30, 2024

nodejs-github-bot commented Jan 31, 2024

nodejs-github-bot commented Feb 2, 2024

nodejs-github-bot commented Feb 2, 2024

deokjinkim commented Feb 3, 2024

aduh95 left a comment

aduh95 May 11, 2024

deokjinkim May 14, 2024

deokjinkim commented May 14, 2024

	## Class: `MockTimers`

	<!-- YAML
	added:
	- v20.4.0
	-->

	> Stability: 1 - Experimental

	* `semver-{minor,major}`
	* be conservative – that is, if a change has the remote _chance_ of breaking
	something, go for semver-major
	* when adding a semver label, add a comment explaining why you're adding it
	* minor vs. patch: roughly: "does it add a new method / does it add a new
	section to the docs"
	* major vs. everything else: run last versions tests against this version, if
	they pass, probably minor or patch

test_runner: use validateStringArray for timers.enable() #49534

Are you sure you want to change the base?

test_runner: use validateStringArray for timers.enable() #49534

Conversation

deokjinkim commented Sep 7, 2023 • edited Loading

nodejs-github-bot commented Sep 7, 2023

aduh95 Sep 7, 2023

Choose a reason for hiding this comment

atlowChemi Sep 7, 2023

Choose a reason for hiding this comment

deokjinkim Sep 8, 2023

Choose a reason for hiding this comment

deokjinkim commented Sep 8, 2023

nodejs-github-bot commented Sep 8, 2023

lpinca commented Jan 27, 2024

nodejs-github-bot commented Jan 29, 2024

nodejs-github-bot commented Jan 30, 2024

aduh95 commented Jan 30, 2024

nodejs-github-bot commented Jan 31, 2024

nodejs-github-bot commented Feb 2, 2024

nodejs-github-bot commented Feb 2, 2024

deokjinkim commented Feb 3, 2024

aduh95 left a comment

Choose a reason for hiding this comment

aduh95 May 11, 2024

Choose a reason for hiding this comment

deokjinkim May 14, 2024

Choose a reason for hiding this comment

deokjinkim commented May 14, 2024

test_runner: use validateStringArray for `timers.enable()` #49534

test_runner: use validateStringArray for `timers.enable()` #49534

deokjinkim commented Sep 7, 2023 •

edited

Loading