better stringify key in LAZY_IN_SYNC - Githubissues

inversify / InversifyJS

A powerful and lightweight inversion of control container for JavaScript & Node.js apps powered by TypeScript.

http://inversify.io/

MIT License

11.21k stars 715 forks source link

better stringify key in LAZY_IN_SYNC #1511

Closed paul-marechal closed 11 months ago

paul-marechal commented 1 year ago

Description

When LAZY_IN_SYNC is invoked with a symbol it might throw an error because the JS runtime doesn't know how to stringify a symbol on its own for some reason.
When passing a function/class as key, then the output gets weird as the JS runtime may return the whole class body when stringifying it.

This PR adjusts the way the key is stringified by:

If it's a function then print as [function/class NAME].
If it's a symbol then we explicitly convert it to string using symbol.toString() before printing.
Wrap with single quotes in a template string.

Related Issue

https://github.com/inversify/InversifyJS/issues/1510

Motivation and Context

Better error message.

How Has This Been Tested?

Manually called LAZY_IN_SYNC with a symbol using the node REPL.

Types of changes

[ ] Updated docs / Refactor code / Added a tests case (non-breaking change)
[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.
[ ] I have updated the changelog.