Merge fix/SDK-4748-build-identifier-precedence - #251
Merged
Dalwin-Barnard merged 5 commits intoSep 29, 2026
Merged
Conversation
…ifier
_handleBuildIdentifier deleted the buildIdentifier whenever
BROWSERSTACK_BUILD_NAME was exported, even though a buildName was present
in the capabilities and the identifier had been configured explicitly.
The clause was ported from the yml-driven SDKs, where it exists only to
suppress the *default* '#${BUILD_NUMBER}' identifier. This service has no
default identifier and never reads BROWSERSTACK_BUILD_NAME as a buildName
source, so the clause could only ever discard user intent.
Three changes, all aligning this service with the SDK-wide precedence
contract (CLI args > env vars > config file > script):
- Skip the identifier only when there is no buildName at all.
- Resolve BROWSERSTACK_BUILD_IDENTIFIER, then BROWSERSTACK_BUILD_RUN_IDENTIFIER,
ahead of the service options / capabilities value. Neither env var was
read before; they appeared only in telemetry payloads.
- Sweep any remaining ${ENV_VAR} placeholder against process.env after the
${DATE_TIME} / ${BUILD_NUMBER} substitutions, leaving unset variables literal.
Mirrors browserstack-node-agent computeBuildIdentifier(),
browserstack-python-sdk ENV_CAPS_TO_CONFIG['buildIdentifier'] and
browserstack-csharp-sdk GetBuildIdentifier().
The unit test named "should delete buildIdentifier if BROWSERSTACK_BUILD_NAME
is defined as env var" asserted the broken behaviour by name only - its caps
carried no buildName, so it passed on the !this._buildName branch regardless.
It is replaced by a non-degenerate pair: one keeping the identifier when a
buildName is present, one still deleting it when it is absent.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…d tokens
Critical: the !buildName branch stripped buildIdentifier from capabilities but
left this._buildIdentifier set. launchTestSession reads that field for the
build-start payload's build_identifier, so an env-sourced value was reported to
O11y while never being applied to any capability. Pre-existing as a shape, but
the new env tier makes it reachable with zero user configuration, since CI
commonly injects BROWSERSTACK_BUILD_RUN_IDENTIFIER globally. Both the field and
browserStackConfig.buildIdentifier are now cleared alongside the caps update.
Warning: the generic ${ENV_VAR} sweep reprocessed ${BUILD_NUMBER}. When neither
getCiInfo() nor _getLocalBuildNumber() could resolve it the token was left
literal by design, and the sweep then substituted a raw process.env.BUILD_NUMBER
- without the 'CI ' prefix every other path applies. getCiInfo() recognises a
fixed vendor list that excludes GitHub Actions, and TeamCity exports a bare
BUILD_NUMBER, so this was reachable in practice. DATE_TIME and BUILD_NUMBER are
now excluded from the sweep.
Suggestion: `?? match` guarded only nullish, so an exported-but-empty variable
blanked that part of the identifier - contradicting the adjacent comment and
inconsistent with the tier-1 check, which treats whitespace-only as absent.
Empty and whitespace-only values now leave the literal placeholder.
Tests: the "buildName absent" case asserted only the caps side-effect, which the
pre-PR code would also have satisfied; it now asserts _buildIdentifier too. Added
regression tests for the reserved-token and empty-env cases. afterEach now clears
BUILD_NUMBER, so the pre-existing "stays literal" assertions no longer depend on
the ambient environment.
_handleBuildIdentifier block 17 -> 19 tests. Full suite 1347 passed (3 errors
pre-existing in uploadLogsArchive.test.ts, unchanged on a clean tree).
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
bsautomation
requested review from
kamal-kaur04 and
pranay-v29
and removed request for
a team
September 29, 2026 13:46
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited), Workspace UI (inherited) Review profile: ASSERTIVE Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
4 of 7 tasks
4 of 7 tasks
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
4 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.
Merge into sdk_v9_pre_prod :by automationbs