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.

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

test_runner: add jsdocs to MockTimers #49476

Merged

Conversation

ErickWendel
Copy link
Member

@ErickWendel ErickWendel commented Sep 3, 2023

Add JSDocs for all public functions on MockTimers

cc @nodejs/test_runner

@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 Sep 3, 2023
@ErickWendel ErickWendel self-assigned this Sep 3, 2023
Signed-off-by: Erick Wendel <erick.workspace@gmail.com>
@ErickWendel ErickWendel force-pushed the test_runner/add-js-docs-to-mock branch from 8767073 to de65b28 Compare September 3, 2023 21:10
@ErickWendel ErickWendel added the fast-track PRs that do not need to wait for 48 hours to land. label Sep 3, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 3, 2023

Fast-track has been requested by @ErickWendel. Please 👍 to approve.

Copy link
Member

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

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

LGTM though I think Symbol.dispose should be encouraged

lib/internal/test_runner/mock/mock_timers.js Outdated Show resolved Hide resolved
lib/internal/test_runner/mock/mock_timers.js Outdated Show resolved Hide resolved
lib/internal/test_runner/mock/mock_timers.js Show resolved Hide resolved
Co-authored-by: Benjamin Gruenbaum <inglor@gmail.com>
Co-authored-by: Chemi Atlow <chemi@atlow.co.il>
@ErickWendel ErickWendel added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 5, 2023
@atlowChemi atlowChemi added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Sep 5, 2023
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Sep 5, 2023
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/49476
✘  Failed to get collaborator info from nodejs/node/README.md
Error: Couldn't find ### TSC (Technical Steering Committee) in the README
    at parseCollaborators (file:///opt/hostedtoolcache/node/18.17.1/x64/lib/node_modules/node-core-utils/lib/collaborators.js:81:11)
    at getCollaborators (file:///opt/hostedtoolcache/node/18.17.1/x64/lib/node_modules/node-core-utils/lib/collaborators.js:59:21)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async PRData.getCollaborators (file:///opt/hostedtoolcache/node/18.17.1/x64/lib/node_modules/node-core-utils/lib/pr_data.js:74:26)
    at async Promise.all (index 0)
    at async PRData.getAll (file:///opt/hostedtoolcache/node/18.17.1/x64/lib/node_modules/node-core-utils/lib/pr_data.js:58:5)
    at async getMetadata (file:///opt/hostedtoolcache/node/18.17.1/x64/lib/node_modules/node-core-utils/components/metadata.js:18:3)
    at async main (file:///opt/hostedtoolcache/node/18.17.1/x64/lib/node_modules/node-core-utils/components/git/land.js:204:22)
https://github.com/nodejs/node/actions/runs/6079853604

@atlowChemi atlowChemi added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Sep 5, 2023
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Sep 5, 2023
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/49476
✔  Done loading data for nodejs/node/pull/49476
----------------------------------- PR info ------------------------------------
Title      test_runner: add jsdocs to MockTimers (#49476)
Author     Erick Wendel  (@ErickWendel)
Branch     ErickWendel:test_runner/add-js-docs-to-mock -> nodejs:main
Labels     fast-track, needs-ci, commit-queue-squash, test_runner
Commits    2
 - test_runner: add jsdocs to MockTimers
 - test_runner: apply suggestions
Committers 2
 - Erick Wendel 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/49476
Reviewed-By: Benjamin Gruenbaum 
Reviewed-By: Chemi Atlow 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/49476
Reviewed-By: Benjamin Gruenbaum 
Reviewed-By: Chemi Atlow 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sun, 03 Sep 2023 21:04:58 GMT
   ✔  Approvals: 2
   ✔  - Benjamin Gruenbaum (@benjamingr) (TSC): https://github.com/nodejs/node/pull/49476#pullrequestreview-1609950368
   ✔  - Chemi Atlow (@atlowChemi): https://github.com/nodejs/node/pull/49476#pullrequestreview-1609909238
   ℹ  This PR is being fast-tracked
   ✔  Last GitHub CI successful
   ✘  No Jenkins CI runs detected
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/6081106699

@atlowChemi atlowChemi added request-ci Add this label to start a Jenkins CI on a PR. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Sep 5, 2023
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 5, 2023
@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

@atlowChemi atlowChemi added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 5, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 5, 2023
@nodejs-github-bot nodejs-github-bot merged commit f139cc3 into nodejs:main Sep 5, 2023
@nodejs-github-bot
Copy link
Collaborator

Landed in f139cc3

ruyadorno pushed a commit that referenced this pull request Sep 28, 2023
Signed-off-by: Erick Wendel <erick.workspace@gmail.com>
PR-URL: #49476
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
This was referenced Sep 28, 2023
alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023
Signed-off-by: Erick Wendel <erick.workspace@gmail.com>
PR-URL: nodejs#49476
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
targos pushed a commit that referenced this pull request Nov 27, 2023
Signed-off-by: Erick Wendel <erick.workspace@gmail.com>
PR-URL: #49476
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
Signed-off-by: Erick Wendel <erick.workspace@gmail.com>
PR-URL: nodejs/node#49476
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
sercher added a commit to sercher/graaljs that referenced this pull request Apr 25, 2024
Signed-off-by: Erick Wendel <erick.workspace@gmail.com>
PR-URL: nodejs/node#49476
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. fast-track PRs that do not need to wait for 48 hours to land. needs-ci PRs that need a full CI run. test_runner Issues and PRs related to the test runner subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants