feat(sentry): staging-only "Trigger Sentry Test" button (#1072)

[CodeGhost21]

Summary

• Adds a staging-only "Trigger Sentry Test" card at the top of Settings → Developer Options that fires a tagged exception so QA can validate the React → Sentry pipeline end-to-end.
• New triggerSentryTestEvent() helper in analytics.ts emits a SentryStagingTestError with tags.test=manual-staging, tags.source=developer-options-button, then flush(2000).
• The manual-staging tag is allow-listed in the existing beforeSend consent gate (mirroring the smoke-test bypass), so the event lands regardless of analytics opt-in state.
• Visibility gated by APP_ENVIRONMENT === 'staging' — production and dev builds never render the row.

Problem

Per #1072: the staging dashboard had not received any React events for several days, and there was no in-app trigger to distinguish "pipeline broken" from "no errors actually occurring." A QA-controllable button that bypasses the consent gate gives an unambiguous, on-demand signal.

Solution

• app/src/services/analytics.ts — new triggerSentryTestEvent() that captures a deterministic exception, applies QA-friendly tags, and flushes synchronously. beforeSend adds an isManualTest allow-list arm parallel to the existing smoke-test bypass.
• app/src/components/settings/panels/DeveloperOptionsPanel.tsx — SentryTestRow component with idle/sending/sent/error states; rendered only when APP_ENVIRONMENT === 'staging'.
• app/src/services/__tests__/analytics.test.ts — Vitest covering triggerSentryTestEvent (no-client / happy paths) plus three initSentry beforeSend cases (consent-off drop, manual-staging allow + PII strip, smoke-test pass-through).
• app/src/components/settings/panels/__tests__/DeveloperOptionsPanel.test.tsx — Vitest covering the production-build hide path, staging render, click → "Event sent. id: …", missing-id branch, and helper-throws → error message.

Verified locally with pnpm macos:build:debug (debug .app built with VITE_OPENHUMAN_APP_ENV=staging): button visible at the top of Developer Options, click fires the event, Sentry SDK accepts it (network POST to *.sentry.io).

While verifying, also fired the existing core + shell triggers from the same bundle so all three surfaces could be cross-checked:

• Rust core: OPENHUMAN_APP_ENV=staging openhuman-core sentry-test --message "..." → event id returned, project openhuman-core.
• Tauri shell: launched with OPENHUMAN_TAURI_SENTRY_TEST=message → smoke message captured + flushed at startup, project openhuman-tauri.

Submission Checklist

• Tests added or updated (happy path + at least one failure / edge case) per docs/TESTING-STRATEGY.md — both triggerSentryTestEvent paths covered (no-client + tagged capture); beforeSend consent gate + manual-staging bypass covered; SentryTestRow idle/sending/sent (with + without id) and error state covered.
• Diff coverage ≥ 80% — local diff-cover app/coverage/lcov.info --compare-branch=origin/main --fail-under=80 reports 100% on changed lines (29/29) for both analytics.ts and DeveloperOptionsPanel.tsx.
• N/A — Coverage matrix update: this is a temporary diagnostic affordance to be removed after pipeline verification per Add a Sentry test button in the staging app #1072 acceptance criteria; no tracked feature row.
• All affected feature IDs from the matrix are listed in the PR description under ## Related — see Related section (no matrix row, see N/A above).
• No new external network dependencies introduced (mock backend used per docs/TESTING-STRATEGY.md).
• N/A — Manual smoke checklist update: staging-only diagnostic, not on the release-cut surface (docs/RELEASE-MANUAL-SMOKE.md).
• Linked issue closed via Closes #NNN in the ## Related section.

Impact

• Desktop only. No backend, no migrations, no protocol changes.
• Production builds: row is not rendered (APP_ENVIRONMENT === 'staging' is false), so no production user impact and no production Sentry events from this path.
• Privacy: the new manual-staging allow-list arm only fires when an explicit button click is made by a user inside the staging app — beforeSend still strips frames, breadcrumbs, and PII before the event leaves the renderer. No new data classes are sent.
• Removal: per Add a Sentry test button in the staging app #1072, this is a temporary affordance. To remove, drop the SentryTestRow block in DeveloperOptionsPanel.tsx, the helper + manual-staging branch in analytics.ts, and the corresponding tests.

Related

Closes #1072

Test plan

• pnpm compile (tsc --noEmit) passes.
• pnpm lint src/services/analytics.ts src/components/settings/panels/DeveloperOptionsPanel.tsx clean.
• pnpm test:unit src/services/__tests__/analytics.test.ts src/components/settings/panels/__tests__/DeveloperOptionsPanel.test.tsx passes (9 tests across the two suites).
• pnpm macos:build:debug succeeds with VITE_OPENHUMAN_APP_ENV=staging; button is visible in the bundled UI.
• N/A pre-merge — Click the button on the next staging release, confirm event arrives in openhuman-react filtered by tag:test:manual-staging with environment:staging. (Verification deferred to post-merge staging build, per the issue's acceptance criteria.)

Summary by CodeRabbit

• New Features

  • Staging-only "Trigger Sentry Test" row in Developer Options to send manual error-reporting tests. Button shows sending/sent/error states, disables while sending, displays returned event ID (or "no id"), and uses an accessible live region for status announcements.
  • Backend handling updated to emit and gate manual staging test events.

• Tests

  • Added tests covering the UI flows and analytics/test-event behavior.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 650f5ed1-9f25-485e-b456-ecac564fcd08

📥 Commits

Reviewing files that changed from the base of the PR and between 89f6f09 and 52eafa6.

📒 Files selected for processing (2)

• app/src/services/__tests__/analytics.test.ts
• app/src/services/analytics.ts

🚧 Files skipped from review as they are similar to previous changes (1)

• app/src/services/analytics.ts

---

📝 Walkthrough

Walkthrough

Adds a staging-only “Trigger Sentry Test” UI row and local component, a new exported helper to emit a tagged manual-staging Sentry error, updates Sentry init's beforeSend to allow/sanitize manual-staging events, and adds service and UI tests covering gating, success, and failure modes.

Changes

Sentry Staging Test Event

Layer / File(s)	Summary
Consent Gate Update app/src/services/analytics.ts	beforeSend now treats APP_ENVIRONMENT === 'staging' && event.tags?.test === 'manual-staging' as a test exemption (in addition to the existing smoke-test exemption), allowing those events to bypass consent-based dropping and be sanitized.
Test Event Helper app/src/services/analytics.ts	Added `export async function triggerSentryTestEvent(): Promise<string
Developer UI Integration app/src/components/settings/panels/DeveloperOptionsPanel.tsx	Introduced local SentryTestRow component with status state (`idle → sending → sent
Tests: Service app/src/services/__tests__/analytics.test.ts	Hoisted mocks for @sentry/react and module mocks for analytics/config; tests triggerSentryTestEvent for non-staging guard, missing client, successful capture (asserts captured error, tags, flush(2000) and returned id), and flush-timeout rejection. Tests initSentry beforeSend behavior including sanitization for manual-staging events and environment gating.
Tests: UI app/src/components/settings/panels/__tests__/DeveloperOptionsPanel.test.tsx	Tests gating by APP_ENVIRONMENT (button absent in production), and in staging verifies click invokes helper, transitions through sending → sent/error, shows event id vs "no id", and renders failure message when helper rejects.

Sequence Diagram

sequenceDiagram
    participant User as User
    participant UI as SentryTestRow
    participant Service as triggerSentryTestEvent()
    participant Sentry as `@sentry/react` client
    participant Gate as initSentry beforeSend

    User->>UI: Click "Send test event"
    UI->>UI: state = 'sending'
    UI->>Service: call triggerSentryTestEvent()
    Service->>Sentry: getClient()
    alt client exists
        Service->>Sentry: captureException(Error with tags test:manual-staging, source:developer-options-button)
        Sentry->>Gate: beforeSend(event)
        Gate->>Gate: detect manual-staging → sanitize & allow
        Sentry-->>Service: return eventId
        Service->>Sentry: flush(2000)
        Sentry-->>Service: flush complete
        Service-->>UI: return eventId
        UI->>UI: state = 'sent', display eventId
    else no client
        Service-->>UI: return undefined
        UI->>UI: state = 'sent', display "no id / Sentry disabled"
    end
    alt flush fails
        Service-->>UI: throw/reject error
        UI->>UI: state = 'error', display failure message
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• fix(sentry): auto-send React events; collapse core→tauri for desktop #1086: Modifies Sentry handling and consent bypass logic related to test/smoke events.

Poem

🐰 I hopped to staging, gave a tiny shout,

Pressed the button, sent a test about,
The error bounced through Sentry's gate,
An event id twinkled — tidy fate,
The rabbit smiled and took a bow.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat(sentry): staging-only "Trigger Sentry Test" button (#1072)' clearly and concisely describes the main change—adding a staging-only button to trigger a Sentry test event.
Linked Issues check	✅ Passed	The pull request fully implements all acceptance criteria from issue #1072: button visible only in staging, clicking triggers a test error, error has correct metadata (manual-staging tag), production unaffected, and temporary nature is documented.
Out of Scope Changes check	✅ Passed	All changes are directly related to implementing the Sentry test button feature: analytics service helper, component with state machine, tests, and beforeSend gate updates—no unrelated modifications detected.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Review rate limit: 4/5 reviews remaining, refill in 12 minutes.}

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

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@app/src/components/settings/panels/DeveloperOptionsPanel.tsx`:
- Around line 162-191: The status messages in DeveloperOptionsPanel.tsx (the
conditional UI driven by status.kind and displayed below the send button) are
only visual; wrap the status output (the blocks rendered when status.kind ===
'sent' or 'error') in a single container element with an accessible live region
(e.g., aria-live="polite" and optionally role="status") so screen readers
announce the result when onClick triggers the send flow and status is updated;
ensure the same live region shows the sent message (including status.eventId or
the no-id text) and the error message (status.message) so assistive tech
receives updates.

In `@app/src/services/analytics.ts`:
- Around line 159-160: Remove the variable timestamp from the exception message
so the Sentry event signature stays stable: change the Error construction to a
constant message like "Manual Sentry test from staging UI" (replace the current
`const error = new Error(\`Manual Sentry test from staging UI @ ${stamp}\`)`),
and instead attach the `stamp` value as metadata (e.g., via Sentry.setExtra /
captureException extras or a tag) so timing info is recorded but does not affect
grouping; refer to the `stamp` and `error` constants when making the change.
- Around line 168-170: Sentry.flush(2000) returns Promise<boolean> and the
current code ignores it; update the code around the console.info/await
Sentry.flush(2000) block to capture the boolean result (from Sentry.flush) and
if it is false, throw an error or otherwise fail the test before returning
eventId so callers know the flush timed out; reference Sentry.flush and the
eventId variable to locate where to check the return value and fail fast when
flush returns false.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e1e92532-dd36-4259-a54b-3b6509f1ef02

📥 Commits

Reviewing files that changed from the base of the PR and between 995e5cc and 127c1f6.

📒 Files selected for processing (3)

• app/src/components/settings/panels/DeveloperOptionsPanel.tsx
• app/src/services/__tests__/analytics.test.ts
• app/src/services/analytics.ts

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@app/src/services/analytics.ts`:
- Around line 63-68: Scope the manual-staging consent bypass to staging by
requiring APP_ENVIRONMENT === 'staging' wherever isManualTest is computed (e.g.
replace the current isManualTest = event.tags?.test === 'manual-staging' with a
check that also verifies process.env.APP_ENVIRONMENT === 'staging' or equivalent
environment accessor), and add a fail-fast guard in triggerSentryTestEvent() to
return/throw immediately when APP_ENVIRONMENT !== 'staging'; apply the same
change to the other occurrence around lines 152-157 so no manual-staging tag can
bypass consent outside staging.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 17f61eb2-3317-4056-9c0e-53741bb43eea

📥 Commits

Reviewing files that changed from the base of the PR and between 80ea3ca and 89f6f09.

📒 Files selected for processing (4)

• app/src/components/settings/panels/DeveloperOptionsPanel.tsx
• app/src/components/settings/panels/__tests__/DeveloperOptionsPanel.test.tsx
• app/src/services/__tests__/analytics.test.ts
• app/src/services/analytics.ts

🚧 Files skipped from review as they are similar to previous changes (2)

• app/src/services/tests/analytics.test.ts
• app/src/components/settings/panels/DeveloperOptionsPanel.tsx