fix: use global scope for metadata storage #929
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
this will be useful if you want to use "class-validator" with "class-controller". right now you need to import metadata inside the controller in order to validate if the transformation is working |
NoNameProvided
force-pushed
the
develop
branch
from
26cb79e to
c391cf3
Compare
|
@NoNameProvided |
EndyKaufman
referenced
this pull request
in EndyKaufman/ngx-dynamic-form-builder
Jan 22, 2022
BREAKING CHANGE: Version above 2 has a completely rewritten code, partially backwards compatible Now `@Expose` and `@Exclude` decorators are used to define model fields, the new version is rigidly dependent on class-transform Dependencies are not used original, but forks with additional necessary properties, when using this library, you need to replace all original imports with forks with modifications Fork [class-validator-multi-lang](https://github.com/EndyKaufman/class-validator-multi-lang) - adds translation capability for errors (PR:[https://github.com/typestack/class-validator/pull/743](https://github.com/typestack/class-validator/pull/743)) Fork [class-transformer-global-storage](https://github.com/petrzjunior/class-transformer) - adds the ability to get meta information about all used classes (PR:[https://github.com/typestack/class-transformer/pull/929](https://github.com/typestack/class-transformer/pull/929)) For correct parse metadata, need remove `compilerOptions.downlevelIteration` and append `compilerOptions.emitDecoratorMetadata: true` in `tsconfig.json`
4 tasks
|
Thanks! |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently, the type metadata are cached in
MetadataStoragewhich is createdsrc/storage.tsand exported. As long as this file is imported once, it works as intended. When importing (requiring) file, Node.js looks it up in the import cache so that the every file is imported only once. This however relies on consistent file names and has some caveats as covered in the documentation. For instance file case sensitiveness or using symlinks inside node_modules. This behavior can lead to having more than one instance ofMetadataStorageand failing to resolve the correct data types, consequently spitting up random errors.Solution
Taking inspiration from class-validator I propose to use
globalas a place which persists through the whole lifetime and is guaranteed to create a true singleton.In the meantime, I am publishing my own fork containing this fix at class-transformer-global-storage
Caveats
This solution might cause some problems if class-transformer is transitively required by multiple libraries using different versions. First package to import class-transformer will seize the global scope and creating the (possibly outdated) singleton.
Checklist
Update index.md)develop)npm run prettier:checkpassesnpm run lint:checkpassesFixes
fixes #928