@mentra/engine 0.1.0-beta.0

package/src/services/CaptionsTesterReportService.ts

@@ -0,0 +1,107 @@
+import CrustModule from "@mentra/crust"
+
+import {submitAutomaticReport} from "../facades/reports"
+import {
+  logAutomaticReportSubmissionStatus,
+  logUnexpectedAutomaticReportError,
+  toAutomaticReportSubmissionStatus,
+  type AutomaticReportSubmissionStatus,
+} from "./AutomaticReportResult"
+
+const LOG_TAG = "CaptionsTesterBugReport"
+const EVENT_NAME = "captions_tester_incident"
+
+let subscription: {remove: () => void} | null = null
+
+function readString(event: Record<string, unknown>, key: string): string | undefined {
+  const value = event[key]
+  return typeof value === "string" && value.trim().length > 0 ? value : undefined
+}
+
+function logIncidentResult(params: {
+  alertId?: string
+  testRunId?: string
+  failureCode: string
+  scenarioName?: string
+  result: AutomaticReportSubmissionStatus
+}): void {
+  const {alertId, testRunId, failureCode, scenarioName, result} = params
+  const reportId = result.status === "filed" ? result.reportId : undefined
+
+  console.log(
+    `CAPTIONS_TESTER_INCIDENT_RESULT ${JSON.stringify({
+      alert_id: alertId,
+      test_run_id: testRunId,
+      failure_code: failureCode,
+      scenario_name: scenarioName,
+      status: result.status,
+      report_id: reportId,
+      incident_id: reportId,
+      reason: result.status === "skipped" ? result.reason : undefined,
+      error: result.status === "failed" ? result.error : undefined,
+    })}`,
+  )
+}
+
+export async function submitCaptionsTesterIncidentReport(rawEvent: unknown): Promise<void> {
+  const event = rawEvent && typeof rawEvent === "object" ? (rawEvent as Record<string, unknown>) : {}
+  const failureCode = readString(event, "failure_code") ?? "unknown"
+  const failureMessage = readString(event, "failure_message") ?? "Captions tester incident detected."
+  const testRunId = readString(event, "test_run_id")
+  const scenarioName = readString(event, "scenario_name")
+  const alertId = readString(event, "alert_id") ?? testRunId
+  const dashboardUrl = readString(event, "dashboard_url")
+  const expectedBehavior = dashboardUrl
+    ? `Captions tester runs should complete without a captions incident. Check live dashboard: ${dashboardUrl}.`
+    : "Captions tester runs should complete without a captions incident."
+
+  const actualBehavior = JSON.stringify(
+    {
+      failureCode,
+      failureMessage,
+      testRunId,
+      scenarioName,
+      event,
+    },
+    null,
+    2,
+  )
+
+  const throttleKey = ["captions_tester", failureCode, scenarioName || "unknown", testRunId || "unknown"].join("|")
+
+  try {
+    const submitResult = await submitAutomaticReport({
+      kind: "automatic",
+      trigger: {
+        type: "automatic",
+        source: "captions_tester",
+        reason: "captions_incident_detected",
+      },
+      report: {
+        expectedBehavior,
+        actualBehavior,
+        systemPriority: "medium",
+      },
+      throttleKey,
+    })
+
+    const result = toAutomaticReportSubmissionStatus(submitResult)
+    logAutomaticReportSubmissionStatus(LOG_TAG, result, throttleKey)
+    logIncidentResult({alertId, testRunId, failureCode, scenarioName, result})
+  } catch (error) {
+    const result = logUnexpectedAutomaticReportError(LOG_TAG, error)
+    logIncidentResult({alertId, testRunId, failureCode, scenarioName, result})
+  }
+}
+
+export function startCaptionsTesterReportService(): void {
+  if (subscription) return
+  subscription = (CrustModule.addListener as any)(EVENT_NAME, (event: unknown) => {
+    void submitCaptionsTesterIncidentReport(event)
+  })
+}
+
+export function stopCaptionsTesterReportService(): void {
+  subscription?.remove()
+  subscription = null
+}

package/src/services/CloudAudioSubscriptionSync.ts

@@ -0,0 +1,41 @@
+/**
+ * Tracks cloud-audio subscription writes so LocalMiniappRuntime can dedupe
+ * successful writes without losing retryability after transient Core/network
+ * failures.
+ *
+ * Failure mode this protects:
+ * 1. Local captions subscribes to transcription.
+ * 2. The first Cloud V2 `PUT /api/audio/subscriptions` throws while the socket
+ *    is reconnecting or Core is briefly unreachable.
+ * 3. A reconnect/resync recomputes the same desired subscription set.
+ *
+ * If we mark the set as "last applied" before the PUT succeeds, step 3 is
+ * incorrectly deduped and captions can wait forever even though Cloud V2 later
+ * reconnects. So `begin()` only blocks exact duplicates while a write is in
+ * flight; only `succeeded()` promotes that key to the applied state.
+ */
+export class CloudAudioSubscriptionSync {
+  private lastAppliedKey = ""
+  private pendingKey = ""
+
+  public begin(nextKey: string): boolean {
+    if (nextKey === this.lastAppliedKey || nextKey === this.pendingKey) {
+      return false
+    }
+    this.pendingKey = nextKey
+    return true
+  }
+
+  public succeeded(key: string): void {
+    if (this.pendingKey === key) {
+      this.pendingKey = ""
+    }
+    this.lastAppliedKey = key
+  }
+
+  public failed(key: string): void {
+    if (this.pendingKey === key) {
+      this.pendingKey = ""
+    }
+  }
+}