fix(observability): inject TRA support-file listener synchronously (SDK-7121) - #1159
Closed
osho-20 wants to merge 3 commits into
Closed
fix(observability): inject TRA support-file listener synchronously (SDK-7121)#1159osho-20 wants to merge 3 commits into
osho-20 wants to merge 3 commits into
Conversation
… [SDK-7081]
getCiInfo() checked Jenkins first on mere presence of JENKINS_URL/
JENKINS_HOME, so a self-hosted GitHub Actions runner with leftover
Jenkins env vars was classified as Jenkins with build_url undefined.
obs-api force-disables the TRA Re-run control for builds without a CI
build_url, greying the button. Move the explicit GITHUB_ACTIONS check
ahead of the presence-only providers.
Also return after resolve({}) in getGitMetaData when no git directory
is found, instead of falling through.
Adds getCiInfo unit coverage: GHA detection, the Jenkins-shadowing
regression, pure Jenkins, and no-CI.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…DK-7121)
setEventListeners deferred the support-file write to an async glob callback
while runs.js proceeded synchronously to md5 hashing and zip archiving. The
injection raced the archive: a lost race shipped an un-instrumented suite, and
md5 caching ("Skipping zip upload...") made the bad zip sticky, so the new
Automate dashboard (TRA) received zero test events while the old dashboard
(independent of the injected plugin) kept working. This is why the symptom was
environment-specific — a slower CI pipeline loses the race.
Switch setEventListeners (and the identical race in the accessibility
setAccessibilityEventListeners glob branch) to glob.sync so the writes complete
before the caller reads the files. Adds a regression test asserting the
observability require is present synchronously after the call returns.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
osho-20
changed the title
Collaborator
Author
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.
Summary
The new Automate dashboard (TRA / Test Observability) received no test events for Cypress runs on a customer's DEV pipeline, while the old Automate dashboard worked and the same suite/CLI/packages worked on another environment. Ref: SDK-7121.
Root cause
setEventListeners(bin/testObservability/helper/helper.js) injects the observability plugin into the user's Cypress support file:It did this inside an async
glob(pattern, {}, cb)callback and returned immediately without awaiting it. Inbin/commands/runs.js, the caller proceeds synchronously to md5 hashing (checkUploadedMd5) and zip archiving (archiver.archive) right after the call. So the injection raced the archive:Md5 caching makes a lost race sticky: once a non-instrumented zip is cached under the original-content md5, every subsequent run logs
"Skipping zip upload since BrowserStack already has your test suite..."and reuses the bad zip. The old Automate dashboard is unaffected because it does not depend on the injected plugin — exactly the reported asymmetry.Reproduction
Calling
setEventListenersand reading the support file synchronously afterwards (as md5/archive do):Fix
setEventListeners→ useglob.syncso the support-file writes complete before the function returns.setAccessibilityEventListeners' glob-pattern branch (bin/accessibility-automation/helper.js).Testing
test/unit/bin/testObservability/setEventListeners.js— asserts the observability require is present synchronously after the call. Fails on unfixed code, passes with the fix.accessibility-automation/cypressunit tests: green (6/6).commands/runs.jsunit file shows the same pre-existing standalone failures with and without this change (unrelatedsetUsageReportingFlagassertions).Release
🤖 Generated with Claude Code