[rush-lib] Ensure async telemetry hooks flush during error report #4666
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
MichaelSitter
force-pushed
the
patch-failed-operation-telemetry-flush
branch
2 times, most recently
from
bb878c1
to
35d5f7c
Compare
|
@microsoft-github-policy-service agree company="DoorDash" |
MichaelSitter
force-pushed
the
patch-failed-operation-telemetry-flush
branch
5 times, most recently
from
5c62714
to
9b6e54b
Compare
MichaelSitter
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
dmichon-msft
as code owners
build-tests/install-test-workspace/workspace/common/pnpm-lock.yaml
Outdated
Show resolved
Hide resolved
MichaelSitter
force-pushed
the
patch-failed-operation-telemetry-flush
branch
2 times, most recently
from
cbf220d
to
442278b
Compare
MichaelSitter
commented
May 10, 2024
MichaelSitter
force-pushed
the
patch-failed-operation-telemetry-flush
branch
from
442278b
to
ed4dba5
Compare
…operation-telemetry-flush # Conflicts: # libraries/rush-lib/src/cli/test/RushCommandLineParser.test.ts
…nd is already running" even though the operation was successful
octogonz
approved these changes
May 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Hey team, I raised a question in Zulip about an issue with custom plugins using the the
flushTelemetryhook:https://rushstack.zulipchat.com/#narrow/stream/262513-general/topic/flushTelemetry.20hook.20receives.20no.20data.20for.20failed.20operations/near/432975837
Summarizing here,
RushCommandLineParserdoesn't wait for theflushTelemetryasync tasks to finish for processes which ended in failure.Details
I created a reproduction for this issue here, with a really simple plugin that just taps the telemetry and re-writes it to a custom file. You should be able to see the following:
rush build --to rush-flush-telemetry-example-plugin: Task succeeds, and the custom telemetry file gets written with the telemetry report.rush build --to my-app: Task fails, and the custom file gets written but contains no data.We did a little more digging & it looks like the tap hook actually works, its just the async hooks that aren't getting processed correctly. The approach I used is moving the process exit into the finally of
ensureFlushedAsync. I think this is probably the right behavior, but this is a change in behavior for failed operations since it'll delay the process terminating until the telemetry hooks can be safely flushed. If this isn't an acceptable change in behavior, could we consider supporting this behind a feature flag? Or if there is a better approach I'm missing very open to suggestions. 🙇How it was tested
There is a new test file I added,
RushCommandLineParserFailureCaseswhich is separate from the existing test file to avoid the mocking imports. This necessitated moving some of the test setup code into another file so it could be reused.Impacted documentation
None, this addresses an issue with the native telemetry.