fix(observability): honour configured build_name over BROWSERSTACK_BUILD_NAME on new dashboard [SDK-6431]#1130
Open
harshit-browserstack wants to merge 1 commit into
Open
Conversation
…ILD_NAME on new dashboard [SDK-6431] getBuildDetails() prioritised process.env.BROWSERSTACK_BUILD_NAME above the explicitly configured build name. On CI (e.g. Atlassian Bamboo) where that env var carries a CI-derived value, the new (TestHub/TRA-backed) dashboard showed the CI name while the Automate dashboard kept the configured run_settings.build_name — a cross-dashboard discrepancy. Demote BROWSERSTACK_BUILD_NAME / BROWSERSTACK_PROJECT_NAME to a fallback so explicit config (testObservabilityOptions.buildName -> run_settings.build_name) wins, matching the Automate capability path. The env var is still honoured when no build name is configured (no regression for env-only users). Adds 4 unit tests for getBuildDetails precedence. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
What & why
SDK-6431 On CI (reported on Atlassian Bamboo), the new TestHub/TRA-backed dashboard showed a CI-derived build name (e.g.
Bamboo-42) instead of thebuild_name: "sanity"configured inbrowserstack.json, while the old Automate dashboard correctly showed the configured value.Root cause
getBuildDetails()(bin/helpers/helper.js) putprocess.env.BROWSERSTACK_BUILD_NAMEat the top of its precedence chain, above explicit config:The Automate capability path (
capabilityHelper.js) uses onlyrun_settings.build_nameand never reads the env var. When the customer's CI exposesBROWSERSTACK_BUILD_NAME, the two dashboards disagree. The build name in the TRA build-creation request body (testhubHandler.jsname: buildName) is built fromgetBuildDetails, so it carried the CI value.Confirmed against the customer's reported TRA payload (
{"request_body":{"name":"Bamboo-42",...}}) and SDK 1.36.8 (identical precedence).Fix
Demote
BROWSERSTACK_BUILD_NAME/BROWSERSTACK_PROJECT_NAMEto a fallback so explicit config wins. New precedence:Makes the new dashboard consistent with Automate and preserves the env var for users who don't configure a build name (no regression).
Tests
test/unit/bin/helpers/helper.js: config beats env, testObs.buildName beats env, env fallback when unconfigured, project_name precedence.npx mocha test/unit/bin/helpers/helper.js-> 7 passing.Note
Precedence/behaviour change (explicit config now beats
BROWSERSTACK_BUILD_NAMEon the new dashboard). Intentional for cross-dashboard consistency — flagging for reviewer awareness.🤖 Generated with Claude Code