feat: remove config object cloning to fix TokenCredential issues #1771
Conversation
|
The README mentions that the config is cloned a few different times e.g., "It is safe to pass read-only config objects to the library; config objects are now cloned". Not sure how you want to handle this re: breaking changes |
|
Thanks for taking the time to do this, please can you reword the commit to meet the commit conventions (https://www.conventionalcommits.org/en/v1.0.0/); I'd suggest this is RE docs, yeah - we should change that to remove the mention that we clone the config object and that any subsequent modifications by reference will lead to undefined behaviour. |
dhensby
force-pushed
the
feat/rm-config-cloning
branch
from
24e0620 to
f37c02a
Compare
|
I've gone and updated the commit message; I could only see the one instance of the docs mentioning cloned config objects and that was the upgrade guide for a very old version, so I don't think that should be removed. |
dhensby
force-pushed
the
feat/rm-config-cloning
branch
from
f37c02a to
800027b
Compare
BREAKING CHANGE: Config objects are not longer cloned by the library. The objects are intended to be readonly and that no modification happens to them during the lifetime of the process, changing these values will result in undefined behaviour.
dhensby
force-pushed
the
feat/rm-config-cloning
branch
from
800027b to
5fcc7d7
Compare
Thank you. Sorry for the delay on my end. |
|
🎉 This PR is included in version 12.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
2 participants
What this does:
Config objects are no longer cloned. If a
TokenCredentialwas being passed asconfig.authentication.options.credential, it wasn't being handled correctly (see #1745 (comment) for more details)Related issues:
Fixes #1745
Pre/Post merge checklist: