feat(browserstack-service): render end-of-build summary entries (SDK-7358) [v8]

[shivam5643]

What is this about?

Renders end-of-build customer-visible summary entries (SDK-7358) — v8 line.

Mirrors #200 (v9 / main) onto the v8 branch. The binary returns
CustomerVisibleSummaryEntry items on StopBinSessionResponse for end-of-build messages
such as the SDK version nudge. The v8 line had neither the proto field nor a renderer, so
those messages arrived and were silently dropped for every wdio v8 customer on the CLI path.

Adds the proto field and a renderer that writes body, picks the stream from severity,
and archives a copy to the log file. Deliberately does not branch on entryType, so
future entry types need no further service change.

Stream choice: warn/warning/error -> stderr, everything else including unknown ->
stdout, so a malformed severity cannot false-alarm CI tooling watching stderr.

Colour. A warn entry (an outdated SDK) is tinted yellow and an error entry (a
deprecated one) red, with the block's first line of text emphasised. Lines are wrapped and
reset individually rather than the block as a whole, so a truncated or interleaved write
cannot leave the customer's terminal stuck in colour. Applied to the stream copy only — the
archived copy stays plain, because escape codes reach a log file as literal bytes and break
anchored searches over it. Border lines are detected as "carries no letters or digits"
rather than by matching U+2500, so a change to the binary's divider glyph cannot silently
start emphasising the wrong line.

Archive once. The archived copy goes through BStackLogger.logToFile rather than the
info/warn/error helpers. Those helpers also call @wdio/logger, which writes to the
console, so the customer would see the block twice — once raw from the stream write, once
prefixed by the logger. Note for reviewers: unlike the v9 line, this branch's logToFile
does not redact — but neither do the helpers it replaces (they pass message straight
through), so redaction behaviour is unchanged by this switch.

The tests follow this branch's existing idiom (new GrpcClient() + stream spies) rather
than copying v9's module-mock style.

Related Jira task/s

• https://browserstack.atlassian.net/browse/SDK-7358

Release (mandatory for every PR — required for the ready-for-review label)

Version bump: (required — tick exactly one)

• minor (backwards-compatible feature)
• patch (bug fix or other small change)

Release notes type: (optional)

• New Feature
• Bug Fix
• Other Improvement

Release notes (customer-facing): (optional but encouraged)

• End-of-build messages from BrowserStack — such as a notice that your SDK version is outdated or has a known issue — are now shown at the end of your test run, highlighted in yellow for a warning and red for an error, and written to the SDK log without colour so they stay searchable.

Release notes (internal): (required — engineer-facing; what actually changed / why)

• Adds entries + CustomerVisibleSummaryEntry to sdk-messages.proto, matching the binary's canonical definition (field 5).
• GrpcClient.renderCustomerVisibleSummary writes body to the stream chosen by severity, not through the logger, whose per-line prefix would break the binary's box-border alignment.
• GrpcClient.colouriseSummaryBody tints the stream copy by severity (yellow/warn, red/error, untouched otherwise), line by line with an explicit reset per line. Escapes are written as \x1b so the ESC byte stays visible in source.
• Archiving uses logToFile, not the info/warn/error helpers, which also call @wdio/logger and would print the block to the console a second time.
• Failure-tolerant throughout: a render or colour error is swallowed and logged at debug; stopBinSession still returns its response and the customer still gets the plain message.

Checklist

• Ready to review
• Has it been tested locally?

PR Validations

Run Tests: Comment RUN_TESTS to trigger sanity tests.

Testing

• File passes 22/22. Covers exact escape sequences per line for both tiers, plain archiving, and no-colour for info and unknown severities.
• tsc -p tsconfig.prod.json --noEmit and eslint both exit 0.
• No manual changeset added — per this template the changeset is generated automatically from the Release section above.
• Pairs with feat(browserstack-service): render end-of-build summary entries (SDK-7358) #200 (v9). Depends on browserstack-binary#1782. Deploy order: railsApp -> binary -> SDK.

🤖 Generated with Claude Code

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited), Workspace UI (inherited)

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 32514341-02a3-4735-b665-9365ba9465b0

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

_{Comment @coderabbitai help to get the list of available commands.}

[shivam5643]

✅ Good to go

File	Status	Reason
.changeset/pr-201.md	✅ All Clear	Covered — release-note text verified accurate against the code change
packages/browserstack-service/src/cli/grpcClient.ts	✅ All Clear	Covered — 1 non-blocking suggestion, no blocking findings
packages/browserstack-service/src/proto/browserstack/sdk/v1/sdk-messages.proto	✅ All Clear	Covered — additive, wire-compatible schema change
packages/browserstack-service/tests/cli/grpcClient.test.ts	✅ All Clear	Covered — new regression test verified to lock the fixed defect shape

Change map (generated deterministically from the diff)

graph LR
  subgraph nwdio_browserstack_service["wdio-browserstack-service"]
    npackages_browserstack_service_src_cli_grpcClient_ts["⚠ grpcClient.ts<br/>~128 lines"]
    npackages_browserstack_service_tests_cli_grpcClient_test_ts["⚠ grpcClient.test.ts<br/>~128 lines"]
    npackages_browserstack_service_src_proto_browserstack_sdk_v1_sdk_messages_proto["⚠ sdk-messages.proto<br/>~18 lines"]
    n_changeset_pr_201_md["pr-201.md<br/>~5 lines"]
  end
  nsvc_every_SDK___binary(["every SDK + binary"])
  npackages_browserstack_service_src_proto_browserstack_sdk_v1_sdk_messages_proto --> nsvc_every_SDK___binary

Loading

↻ This verdict comment is the review anchor — it's updated in place on each run (the gate posts its status separately).

— SDK PR Review Agent

[github-actions]

🟢 SDK PR Review gate is green — the SDK PR Review Agent has run on the current head commit (verdict: success).

This gate confirms a review ran on the latest commit. The verdict itself is advisory — read the findings and use your judgement; it does not block merge. A native GitHub reviewer approval is still separately required by branch protection before this PR can merge.

[shivam5643]

RUN_TESTS

[shivam5643]

RUN_TESTS