fix(angular): mention TraceDirective bug and workaround in Angular SDK
#4780
Conversation
This file contains 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
Add a warning alert to `tracehelpers.mdx` in the Angular SDK guide to make users aware that the usage of `TraceDirective` will most likely cause a compiler error on their end. The alert links to the original issue and our intended fix which will ship with the v7 major of the JS/Angular SDK. Fix suboptimal usage instruction of `TraceDirective`: Instead of declaring `TraceDirective` in the users' Angular module(s), `TraceModule` (which wraps the directive) should in fact be imported in the module(s). This conforms to the way how Angular component libraries should be used.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/sentry-docs/AiX93sGtdyrCmyBbrvLaKLU6taxS |
imatwawana
approved these changes
Mar 1, 2022
src/platforms/javascript/guides/angular/components/tracehelpers.mdx
Outdated
Show resolved
Hide resolved
src/platforms/javascript/guides/angular/components/tracehelpers.mdx
Outdated
Show resolved
Hide resolved
src/platforms/javascript/guides/angular/components/tracehelpers.mdx
Outdated
Show resolved
Hide resolved
…s.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
…s.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
…s.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
AbhiPrasad
approved these changes
Mar 1, 2022
|
Thanks for the reviews! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds a warning alert to
tracehelpers.mdxin the Angular SDK guide to make usersaware that the usage of
TraceDirectivewill currently most likely cause a compiler erroron their end. The alert links to the original issue (getsentry/sentry-javascript#3282) and our intended fix (getsentry/sentry-javascript#4644) which will ship with the v7 major of the JS/Angular SDK.
The
TraceDirectiveoption was moved down from the top option to the last one as it is essentially unusabledue to the compiler error. The other two options are suggested as workarounds until the bug is fixed and released in the next major.
Additionally, the PR fixes the suboptimal usage instruction of
TraceDirective: Instead of declaringTraceDirectivein the users' Angular module(s),TraceModule(which wraps the directive) should in fact be imported in the module(s). This conforms to the way how Angular components or directives from libraries should be used.