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

cli: add --expose-gc flag available to NODE_OPTIONS #53078

Merged
merged 1 commit into from
Jun 4, 2024
Merged

cli: add --expose-gc flag available to NODE_OPTIONS #53078

merged 1 commit into from
Jun 4, 2024

Conversation

juanarbol
Copy link
Member

This commits allows users to send --expose-gc via NODE_OPTIONS environment variable.

Using node --expose-gc is possible but via NODE_OPTIONS won't work.

NODE_OPTIONS='--expose-gc' node
node: --expose-gc is not allowed in NODE_OPTIONS

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. labels May 21, 2024
@juanarbol juanarbol added cli Issues and PRs related to the Node.js command line interface. request-ci Add this label to start a Jenkins CI on a PR. labels May 21, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 21, 2024
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@juanarbol
Copy link
Member Author

Whoops, this needs some tweaks. I'll work on them tomorrow

@nodejs-github-bot
Copy link
Collaborator

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

@juanarbol juanarbol added the request-ci Add this label to start a Jenkins CI on a PR. label May 22, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 22, 2024
@nodejs-github-bot
Copy link
Collaborator

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

joyeecheung
joyeecheung reviewed May 22, 2024
View reviewed changes
doc/api/cli.md Outdated

```js
// If the --expose-gc flag is provided, V8 will expose the garbage collector
// allowing users to trigger garbage collection on demand.
Copy link
Member

Choose a reason for hiding this comment

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

I'd prefer that we don't document this because what "trigger garbage collection" means is usually not what users expected (the kind of garbage collection that gc() does isn't very eager, it can leave unreachable objects around, which isn't a bug because it's only invented for V8's tests and only cater to what their tests need, which may on the other hand require a single round of GC. But that can be very surprising to users expecting or even relying on it to "clean up all the garbage in the heap if they are already unreachable"). We already saw that happenning to Jest's leak detector (even after doing gc() 10 times it can still produce false positives) #48510 (comment)

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 can remove the docs, or specify that is for testing purposes only and it is not meant to be ran in productive environments. Or do u have any suggestion for this?

Copy link
Member

Choose a reason for hiding this comment

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

+1 to not documenting as Joyee suggests.

@targos
Copy link
Member

targos commented May 22, 2024

With #53078 (comment) in mind, is there a legitimate use case for the flag?

@juanarbol
Copy link
Member Author

With #53078 (comment) in mind, is there a legitimate use case for the flag?

Debugging heap size.

jasnell
jasnell approved these changes May 25, 2024
View reviewed changes
Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

LGTM with the documentation removed.

@juanarbol
Copy link
Member Author

Ok, docs are gone now

joyeecheung
joyeecheung approved these changes May 27, 2024
View reviewed changes
doc/api/cli.md Outdated Show resolved Hide resolved
@juanarbol
cli: add --expose-gc flag available to NODE_OPTIONS
358a1dd 
This commits allows users to send `--expose-gc` via `NODE_OPTIONS`
environment variable.

Using `node --expose-gc` is possible but via `NODE_OPTIONS` won't
work.

```sh
NODE_OPTIONS='--expose-gc' node
node: --expose-gc is not allowed in NODE_OPTIONS
```

Signed-off-by: Juan José Arboleda <soyjuanarbol@gmail.com>
@juanarbol juanarbol added the request-ci Add this label to start a Jenkins CI on a PR. label May 27, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 27, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@juanarbol juanarbol added the request-ci Add this label to start a Jenkins CI on a PR. label May 28, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 28, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@juanarbol juanarbol added the request-ci Add this label to start a Jenkins CI on a PR. label May 30, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 30, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@juanarbol juanarbol added the request-ci Add this label to start a Jenkins CI on a PR. label Jun 3, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jun 3, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@juanarbol juanarbol added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 4, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 4, 2024
@nodejs-github-bot nodejs-github-bot merged commit b26a260 into nodejs:main Jun 4, 2024
65 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in b26a260

RafaelGSS pushed a commit that referenced this pull request Jun 7, 2024
@juanarbol @RafaelGSS
cli: add --expose-gc flag available to NODE_OPTIONS
638b510 
This commits allows users to send `--expose-gc` via `NODE_OPTIONS`
environment variable.

Using `node --expose-gc` is possible but via `NODE_OPTIONS` won't
work.

```sh
NODE_OPTIONS='--expose-gc' node
node: --expose-gc is not allowed in NODE_OPTIONS
```

Signed-off-by: Juan José Arboleda <soyjuanarbol@gmail.com>
PR-URL: #53078
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request Jun 7, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@bnb bnb bnb approved these changes

@joyeecheung joyeecheung joyeecheung approved these changes

@legendecas legendecas legendecas approved these changes

Assignees
No one assigned
Labels
c++ Issues and PRs that require attention from people who are familiar with C++. cli Issues and PRs related to the Node.js command line interface. needs-ci PRs that need a full CI run.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@juanarbol @nodejs-github-bot @targos @jasnell @bnb @joyeecheung @legendecas