Skip to content

Commit

Permalink
fix(devtools): Handle nullish values passed to `formatConsoleArgument…
Browse files Browse the repository at this point in the history
…s` (#32372)

<!--
  Thanks for submitting a pull request!
We appreciate you spending the time to work on these changes. Please
provide enough information so that others can review your pull request.
The three fields below are mandatory.

Before submitting a pull request, please make sure the following is
done:

1. Fork [the repository](https://github.com/facebook/react) and create
your branch from `main`.
  2. Run `yarn` in the repository root.
3. If you've fixed a bug or added code that should be tested, add tests!
4. Ensure the test suite passes (`yarn test`). Tip: `yarn test --watch
TestName` is helpful in development.
5. Run `yarn test --prod` to test in the production environment. It
supports the same options as `yarn test`.
6. If you need a debugger, run `yarn test --debug --watch TestName`,
open `chrome://inspect`, and press "Inspect".
7. Format your code with
[prettier](https://github.com/prettier/prettier) (`yarn prettier`).
8. Make sure your code lints (`yarn lint`). Tip: `yarn linc` to only
check changed files.
  9. Run the [Flow](https://flowtype.org/) type checks (`yarn flow`).
  10. If you haven't already, complete the CLA.

Learn more about contributing:
https://reactjs.org/docs/how-to-contribute.html
-->

## Summary

<!--
Explain the **motivation** for making this change. What existing problem
does the pull request solve?
-->

When using React Devtools, calling `console.log('%s', null)` in userland
can cause it to throw an error:

```
TypeError: Cannot read properties of null (reading 'toString')
```

## How did you test this change?

Added a unit test.

<!--
Demonstrate the code is solid. Example: The exact commands you ran and
their output, screenshots / videos if the pull request changes the user
interface.
How exactly did you verify that your PR solves the issue you wanted to
solve?
  If you leave this empty, your PR will very likely be closed.
-->

See 47ng/nuqs#808.
  • Loading branch information
franky47 authored Feb 13, 2025
1 parent 5a78dd7 commit e0131f1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions packages/react-devtools-shared/src/__tests__/utils-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -470,5 +470,14 @@ function f() { }
{},
]);
});

it('formats nullish values', () => {
expect(formatConsoleArguments('This is the %s template', null)).toEqual([
'This is the null template',
]);
expect(
formatConsoleArguments('This is the %s template', undefined),
).toEqual(['This is the undefined template']);
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export default function formatConsoleArguments(
}
case 's': {
const [arg] = args.splice(argumentsPointer, 1);
template += arg.toString();
template += String(arg);

break;
}
Expand Down

0 comments on commit e0131f1

Please sign in to comment.