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: add SuiteContext class #45687

Merged
merged 1 commit into from
Dec 2, 2022
Merged

test_runner: add SuiteContext class #45687

merged 1 commit into from
Dec 2, 2022

Conversation

debadree25
Copy link
Member

added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)

@debadree25
lib: added SuiteContext class
b23c449 
added SuiteContext class to replace object literal

Fixes: nodejs#45641
Refs: nodejs#45641 (comment)
@nodejs-github-bot nodejs-github-bot added dont-land-on-v14.x needs-ci PRs that need a full CI run. test_runner Issues and PRs related to the test runner subsystem. labels Nov 30, 2022
@MoLow MoLow added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 30, 2022
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 30, 2022
@nodejs-github-bot
Copy link
Collaborator

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

@aduh95 aduh95 changed the title lib: added SuiteContext class test_runner: add SuiteContext class Nov 30, 2022
aduh95
aduh95 reviewed Nov 30, 2022
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

Why, though?

@debadree25
Copy link
Member Author

debadree25 commented Nov 30, 2022 •
edited
Loading

Why, though?

To bring consistency with the docs, the docs mention the existence of SuiteContext class and it being the first argument passed to the functions but the actual class didn't exist and the arg list was empty, hence simply added the class here

@aduh95
Copy link
Contributor

aduh95 commented Nov 30, 2022

Wouldn't fixing the docs be a more reasonable approach? To be clear, I'm not blocking this PR, but I'm skeptical that having a class is what makes the most sense here.

@debadree25
Copy link
Member Author

debadree25 commented Nov 30, 2022 •
edited
Loading

Wouldn't fixing the docs be a more reasonable approach? To be clear, I'm not blocking this PR, but I'm skeptical that having a class is what makes the most sense here.

I guess the only reason I can give is that it was faster to make the change in the code than having to remove all refs in the doc as refed #45641 (comment) here too 😅😅

@debadree25
Copy link
Member Author

would be happy to go the doc approach too if you think that would be best practice!

cjihrig
cjihrig approved these changes Nov 30, 2022
View reviewed changes
Copy link
Contributor

@cjihrig cjihrig left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. commit-queue Add this label to land a pull request using GitHub Actions. and removed request-ci Add this label to start a Jenkins CI on a PR. labels Nov 30, 2022
@tniessen
Copy link
Member

tniessen commented Dec 1, 2022

I think @aduh95's point is valid. Is this class necessary or useful?

@cjihrig
Copy link
Contributor

cjihrig commented Dec 1, 2022

I think it's useful for matching the other context objects and the existing documentation.

@MoLow
Copy link
Member

MoLow commented Dec 1, 2022

FWIW I do think its better to change the code than the documentation, since this name dose help understanding the responsibility of this object

@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 2, 2022
@nodejs-github-bot nodejs-github-bot merged commit 8541b3a into nodejs:main Dec 2, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 8541b3a

targos pushed a commit that referenced this pull request Dec 12, 2022
@debadree25 @targos
lib: added SuiteContext class
99410ef 
added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)
PR-URL: #45687
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@targos targos mentioned this pull request Dec 12, 2022
Merged
@Semigradsky
Copy link
Contributor

Will this be merged to 18.x branch?

danielleadams pushed a commit that referenced this pull request Dec 30, 2022
@debadree25 @danielleadams
lib: added SuiteContext class
b466e45 
added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)
PR-URL: #45687
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@danielleadams danielleadams mentioned this pull request Dec 30, 2022
Merged
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
@debadree25 @danielleadams
lib: added SuiteContext class
8d8de8d 
added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)
PR-URL: #45687
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
@debadree25 @danielleadams
lib: added SuiteContext class
55f800b 
added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)
PR-URL: #45687
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 4, 2023
@debadree25 @danielleadams
lib: added SuiteContext class
c647adb 
added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)
PR-URL: #45687
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 5, 2023
@debadree25 @danielleadams
lib: added SuiteContext class
bf6fbe2 
added SuiteContext class to replace object literal

Fixes: #45641
Refs: #45641 (comment)
PR-URL: #45687
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 left review comments

@MoLow MoLow MoLow approved these changes

@cjihrig cjihrig cjihrig approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. 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.

[node:test] Incorrect SuiteContext description
7 participants
@debadree25 @nodejs-github-bot @aduh95 @tniessen @cjihrig @MoLow @Semigradsky