inspect: fix console.log(%s, { [Symbol.toPrimitive]: () => hello }) #50992

Ch3nYuY · 2023-12-01T08:48:25Z

console.log("%s", o) invokes the inspect method to retrieve the object. This results in console.log("%s", { [Symbol.toPrimitive]: () => "hello" }) displaying the object itself, rather than 'hello'.

Fixes: #50909

BridgeAR

The former implementation had it's reason as well as the internal toString method is mostly not ideal. The main problem is that hasBuiltInToString does not know about the toPrimitive symbol. By checking for that, it would handle both cases right.

Ch3nYuY · 2023-12-01T09:30:56Z

The former implementation had it's reason as well as the internal toString method is mostly not ideal. The main problem is that hasBuiltInToString does not know about the toPrimitive symbol. By checking for that, it would handle both cases right.

Thank you. Are you suggesting to modify it this way?

        case 115: { // 's'
          const tempArg = args[++a];
          if (typeof tempArg === 'number') {
            tempStr = formatNumberNoColor(tempArg, inspectOptions);
          } else if (typeof tempArg === 'bigint') {
            tempStr = formatBigIntNoColor(tempArg, inspectOptions);
          } else if (hasBuiltInToString(tempArg)) {
            tempStr = String(tempArg);
          } else {
            tempStr = inspect(tempArg, {
              ...inspectOptions,
              compact: 3,
              colors: false,
              depth: 0,
            });
          }
          break;
        }

BridgeAR · 2023-12-04T10:25:34Z

@chenyuyang2022 no, the hasBuiltInToString method has to check for for the toPrimitive symbol as well. Please always run the tests as well. There should be test failures related to the current change.

Ch3nYuY · 2024-03-18T07:20:25Z

@BridgeAR Thank you for the reminder. I have modified the implementation and passed all the tests with 'make test'.

Ch3nYuY · 2024-03-19T09:59:43Z

@legendecas PTAL

legendecas · 2024-03-19T10:23:20Z

Would you mind updating the hasBuiltInToString function instead as @BridgeAR suggested? Also, please add a test case in https://github.com/nodejs/node/blob/main/test/parallel/test-util-format.js as well. Thank you!

Ch3nYuY · 2024-03-24T18:44:23Z

@legendecas Thank you, I've made the changes according to your suggestions. Could you please take a look?

legendecas

LGTM

legendecas · 2024-03-26T03:01:25Z

@BridgeAR would you mind taking a look again?

nodejs-github-bot · 2024-03-26T03:04:48Z

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

BridgeAR

Thanks for following up upon this!
LGTM with the comment removed.

test/parallel/test-util-format.js

Ch3nYuY · 2024-03-28T10:01:42Z

@BridgeAR Would you mind reviewing it again?

BridgeAR

LGTM

We have to change the commit message when merging. It should be e.g., util: fix %s format for objects with Symbol.toPrimitive.

BridgeAR · 2024-04-24T12:41:44Z

@Ch3nYuY thank you for following up on the comments!

nodejs-github-bot · 2024-04-24T12:57:44Z

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

BridgeAR · 2024-04-27T14:59:09Z

@Ch3nYuY seems like there is a linter error that has to be resolved before it's possible to land this

Ch3nYuY · 2024-04-28T15:09:08Z

Thank you, @BridgeAR . I'll see how to solve it

Ch3nYuY · 2024-04-29T09:36:11Z

@BridgeAR I've solved all the linter error. Could you please add the 'request-ci' tag again?

nodejs-github-bot · 2024-05-02T18:31:18Z

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

nodejs-github-bot · 2024-05-04T12:01:43Z

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

nodejs-github-bot · 2024-05-04T15:28:30Z

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

BridgeAR · 2024-05-08T09:15:56Z

Hey @Ch3nYuY, the recent commits block the PR from being merged. Can you please rebase? :)

Ch3nYuY · 2024-05-09T01:36:18Z

Thanks! @BridgeAR I resolved the merge conflicts and it should look ok now.

This commit ensures `console.log("%s", obj)` correctly invokes `obj[Symbol.toPrimitive]` for string conversion, fixing unexpected object display issue. Fixes: nodejs#50909

nodejs-github-bot · 2024-05-11T14:49:20Z

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

nodejs-github-bot · 2024-05-12T07:24:07Z

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

aduh95 · 2024-05-12T10:28:58Z

~~Landed in 7129915~~ Sorry, wrong commit message!

Landed in dde2965

This commit ensures `console.log("%s", obj)` correctly invokes `obj[Symbol.toPrimitive]` for string conversion, fixing unexpected object display issue. PR-URL: #50992 Fixes: #50909 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>

This commit ensures `console.log("%s", obj)` correctly invokes `obj[Symbol.toPrimitive]` for string conversion, fixing unexpected object display issue. PR-URL: nodejs#50992 Fixes: nodejs#50909 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>

nodejs-github-bot added needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Dec 1, 2023

BridgeAR requested changes Dec 1, 2023

View reviewed changes

Ch3nYuY requested a review from BridgeAR December 4, 2023 01:32

Ch3nYuY force-pushed the fix/console-log branch 2 times, most recently from baf1b8c to 79df127 Compare March 18, 2024 07:09

legendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Mar 26, 2024

legendecas approved these changes Mar 26, 2024

View reviewed changes

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

BridgeAR reviewed Mar 26, 2024

View reviewed changes

test/parallel/test-util-format.js Outdated Show resolved Hide resolved

BridgeAR approved these changes Apr 24, 2024

View reviewed changes

BridgeAR added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 24, 2024

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

jasnell approved these changes Apr 27, 2024

View reviewed changes

himself65 approved these changes May 2, 2024

View reviewed changes

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

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

util: fix %s format behavior with Symbol.toPrimitive

796a3ab

This commit ensures `console.log("%s", obj)` correctly invokes `obj[Symbol.toPrimitive]` for string conversion, fixing unexpected object display issue. Fixes: nodejs#50909

aduh95 force-pushed the fix/console-log branch from 58e234b to 796a3ab Compare May 11, 2024 14:48

aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 11, 2024

aduh95 merged commit 7129915 into nodejs:main May 12, 2024
53 checks passed

targos mentioned this pull request May 13, 2024

v22.2.0 release proposal #52971

Merged

marco-ippolito mentioned this pull request Jun 17, 2024

v20.15.0 proposal #53486

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

inspect: fix console.log(%s, { [Symbol.toPrimitive]: () => hello }) #50992

inspect: fix console.log(%s, { [Symbol.toPrimitive]: () => hello }) #50992

Ch3nYuY commented Dec 1, 2023

BridgeAR left a comment

Ch3nYuY commented Dec 1, 2023

BridgeAR commented Dec 4, 2023 •

edited

Loading

Ch3nYuY commented Mar 18, 2024

Ch3nYuY commented Mar 19, 2024

legendecas commented Mar 19, 2024

Ch3nYuY commented Mar 24, 2024

legendecas left a comment

legendecas commented Mar 26, 2024

nodejs-github-bot commented Mar 26, 2024

BridgeAR left a comment

Ch3nYuY commented Mar 28, 2024

BridgeAR left a comment •

edited

Loading

BridgeAR commented Apr 24, 2024

nodejs-github-bot commented Apr 24, 2024

BridgeAR commented Apr 27, 2024

Ch3nYuY commented Apr 28, 2024

Ch3nYuY commented Apr 29, 2024

nodejs-github-bot commented May 2, 2024

nodejs-github-bot commented May 4, 2024

nodejs-github-bot commented May 4, 2024

BridgeAR commented May 8, 2024

Ch3nYuY commented May 9, 2024

nodejs-github-bot commented May 11, 2024

nodejs-github-bot commented May 12, 2024

aduh95 commented May 12, 2024 •

edited

Loading

inspect: fix console.log(%s, { [Symbol.toPrimitive]: () => hello }) #50992

inspect: fix console.log(%s, { [Symbol.toPrimitive]: () => hello }) #50992

Conversation

Ch3nYuY commented Dec 1, 2023

BridgeAR left a comment

Choose a reason for hiding this comment

Ch3nYuY commented Dec 1, 2023

BridgeAR commented Dec 4, 2023 • edited Loading

Ch3nYuY commented Mar 18, 2024

Ch3nYuY commented Mar 19, 2024

legendecas commented Mar 19, 2024

Ch3nYuY commented Mar 24, 2024

legendecas left a comment

Choose a reason for hiding this comment

legendecas commented Mar 26, 2024

nodejs-github-bot commented Mar 26, 2024

BridgeAR left a comment

Choose a reason for hiding this comment

Ch3nYuY commented Mar 28, 2024

BridgeAR left a comment • edited Loading

Choose a reason for hiding this comment

BridgeAR commented Apr 24, 2024

nodejs-github-bot commented Apr 24, 2024

BridgeAR commented Apr 27, 2024

Ch3nYuY commented Apr 28, 2024

Ch3nYuY commented Apr 29, 2024

nodejs-github-bot commented May 2, 2024

nodejs-github-bot commented May 4, 2024

nodejs-github-bot commented May 4, 2024

BridgeAR commented May 8, 2024

Ch3nYuY commented May 9, 2024

nodejs-github-bot commented May 11, 2024

nodejs-github-bot commented May 12, 2024

aduh95 commented May 12, 2024 • edited Loading

BridgeAR commented Dec 4, 2023 •

edited

Loading

BridgeAR left a comment •

edited

Loading

aduh95 commented May 12, 2024 •

edited

Loading