[Telemetry] Bug fix in codedError.data from trackException()#14191
Merged
danielayala94 merged 4 commits intomicrosoft:mainfrom Dec 10, 2024
Merged
[Telemetry] Bug fix in codedError.data from trackException()#14191danielayala94 merged 4 commits intomicrosoft:mainfrom
codedError.data from trackException()#14191danielayala94 merged 4 commits intomicrosoft:mainfrom
Conversation
codedError.data from trackException()
jonthysell
approved these changes
Dec 10, 2024
danielayala94
added a commit
to danielayala94/react-native-windows
that referenced
this pull request
Jan 4, 2025
…rosoft#14191) * Bug fix * Simplify fix, add unit test * Change files * Nit: change test description
danielayala94
added a commit
to danielayala94/react-native-windows
that referenced
this pull request
Jan 28, 2025
…rosoft#14191) * Bug fix * Simplify fix, add unit test * Change files * Nit: change test description
danielayala94
added a commit
that referenced
this pull request
Jan 29, 2025
* [Telemetry] Migration from AppInsights to 1DS (#13493) * Draft of telemetry refactoring * Better draft, including most (if not all?) properties * Various fixes, it now compiles * Refactor, and temporary commenting tests * All tests passing! But will need to clean up a few things * Polished some code, re-enabled some errorUtils tests * Change files * Update yarn.lock * Let yarn lint:fix cook * Simplifying * Nit: ordering * Avoid unnecessary JSON work * nit * Mostly placing some common props into Part A ext, plus adding/removing props * Distinguish between deviceClass and nodePlatform * Nit * [Telemetry] Enable data uploading (#14039) * Set instrumentation key * Change files * Nit: Minor lint fix * [Telemetry] Expand field sanitization to codedError.data (#14161) * Scrub PII from codedError, add unit test * Nit: comment updates * Lint fixes * Change files * Enhanced bug fix using recursion, added test field cases * Lint fix * Sanitize any, and test fixes * Lint fix, again * [Telemetry] Bug fix in `codedError.data` from `trackException()` (#14191) * Bug fix * Simplify fix, add unit test * Change files * Nit: change test description * Manual change to add UseFabric (RnwNewArch not in 0.75) * [Telemetry] Address package name limitations - Take 2 (#14259) * Introducing package name processing * Add trimming if string length > 100 * Change files * Change files * Update yarn.lock * Lint fixes * Add RnwNewArch
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This PR eliminates the risk of writing into undefined struct fields in
trackException().Type of Change
Bug fix
Why
Error telemetry instances were lost when hitting MS Build errors sometimes, plus avoid unnecesssary CLI error noise.
Resolves #14184
What
One-line change:
codedErrorStruct.data[f] = (error as any)[f];instead of:
codedErrorStruct.data.codedError.data[f] = (error as any)[f];Context:
In error telemetry instances,
codedErrorcontains relevant information about an exception thrown from the RNW CLI.There are two ways to populate
codedError: either aerrorUtils.CodedErrorobject is passed totrackException(), or a MSBuild error was hit, and theErrorobject contains any of the following fields:errno,syscallorcode. It's in the second scenario where things go wrong.In
trackException(),codedErrorStructcopies the exception data from theErrorobject that was passed as parameter. This corresponds tocodedError.datain the telemetry envelope. However, the MSBuild info was attempted to be copied intocodedError.data.codedError.data, causing the Telemetry instance to throw.Screenshots
N/A
Testing
Added a unit test that makes use of a
CustomErrorTestobject, based onErrorbut different fromCodedError, to re-create the conditions where the bug was caught.Changelog
Yes - Fix bug in error telemetry collection.
Microsoft Reviewers: Open in CodeFlow