@specific.dev/spectest 0.131.0 → 0.131.1

package/dist/harness/phone.py

@@ -14,7 +14,7 @@ import time
 import wave
 import math
 from array import array
-from phone_recording import StreamingRecording, MEDIA_RATE, PEAK_SAMPLES
+from phone_recording import RecordingError, StreamingRecording, MEDIA_RATE, PEAK_SAMPLES
 
 # PJSIP writes directly to fd 1. Keep the protocol on a private duplicate.
 protocol = os.fdopen(os.dup(1), "w", buffering=1)
@@ -179,22 +179,29 @@ class Call(pj.Call):
         result = {"event": "recording", "sessionId": self.session_id,
                   "startedAtMs": self.started_at_ms, "duration": 0, "bytes": 0,
                   "contentType": "audio/webm", "peaks": []}
+        errors = [self.capture_error] if self.capture_error else []
         try:
             self.clock.stopTransmit(self.recorder)
-            if self.media is not None:
-                try:
-                    self.media.stopTransmit(self.recorder)
-                    self.media.stopTransmit(self.recipient_meter)
-                except Exception:
-                    pass  # The remote peer may already have removed its port.
+        except Exception as error:
+            # Native error text can contain SIP identities or credentials.
+            errors.append(f"Could not disconnect recording clock ({type(error).__name__})")
+        if self.media is not None:
+            try:
+                self.media.stopTransmit(self.recorder)
+                self.media.stopTransmit(self.recipient_meter)
+            except Exception:
+                pass  # The remote peer may already have removed its port.
+        try:
+            # Always close the sink and reap the encoder, even if detach failed.
             result.update(self.recorder.finish())
             peaks = result["peaks"]
             for side, track in self.recorder.tracks.items():
                 result[side] = (track + [0.0] * max(0, len(peaks) - len(track)))[:len(peaks)]
-            if self.capture_error:
-                result["error"] = self.capture_error
-        except Exception:
-            result["error"] = "Call recording could not be finalized"
+        except Exception as error:
+            detail = str(error) if isinstance(error, RecordingError) else type(error).__name__
+            errors.append(f"Call recording could not be finalized: {detail}")
+        if errors:
+            result["error"] = "; ".join(errors)
         protocol.write(json.dumps(result) + "\n")
 
 

package/dist/harness/phone_recording.py

@@ -10,6 +10,10 @@ MEDIA_RATE = 48000
 PEAK_SAMPLES = MEDIA_RATE // 20
 
 
+class RecordingError(RuntimeError):
+    """SDK-authored capture diagnostics, safe to include in test results."""
+
+
 class StreamingRecording:
     def __init__(self, path):
         self.path = path
@@ -85,7 +89,7 @@ class StreamingRecording:
             self.encoder.kill()
             self.writer.join(timeout=1)
         if self.error:
-            raise RuntimeError(self.error)
+            raise RecordingError(self.error)
         return {
             "duration": self.frames / MEDIA_RATE,
             "bytes": os.path.getsize(self.path),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@specific.dev/spectest",
-  "version": "0.131.0",
+  "version": "0.131.1",
   "description": "Spectest SDK for defining test environments in TypeScript.",
   "type": "module",
   "main": "./dist/index.js",

package/src/harness/phone.py

@@ -14,7 +14,7 @@ import time
 import wave
 import math
 from array import array
-from phone_recording import StreamingRecording, MEDIA_RATE, PEAK_SAMPLES
+from phone_recording import RecordingError, StreamingRecording, MEDIA_RATE, PEAK_SAMPLES
 
 # PJSIP writes directly to fd 1. Keep the protocol on a private duplicate.
 protocol = os.fdopen(os.dup(1), "w", buffering=1)
@@ -179,22 +179,29 @@ class Call(pj.Call):
         result = {"event": "recording", "sessionId": self.session_id,
                   "startedAtMs": self.started_at_ms, "duration": 0, "bytes": 0,
                   "contentType": "audio/webm", "peaks": []}
+        errors = [self.capture_error] if self.capture_error else []
         try:
             self.clock.stopTransmit(self.recorder)
-            if self.media is not None:
-                try:
-                    self.media.stopTransmit(self.recorder)
-                    self.media.stopTransmit(self.recipient_meter)
-                except Exception:
-                    pass  # The remote peer may already have removed its port.
+        except Exception as error:
+            # Native error text can contain SIP identities or credentials.
+            errors.append(f"Could not disconnect recording clock ({type(error).__name__})")
+        if self.media is not None:
+            try:
+                self.media.stopTransmit(self.recorder)
+                self.media.stopTransmit(self.recipient_meter)
+            except Exception:
+                pass  # The remote peer may already have removed its port.
+        try:
+            # Always close the sink and reap the encoder, even if detach failed.
             result.update(self.recorder.finish())
             peaks = result["peaks"]
             for side, track in self.recorder.tracks.items():
                 result[side] = (track + [0.0] * max(0, len(peaks) - len(track)))[:len(peaks)]
-            if self.capture_error:
-                result["error"] = self.capture_error
-        except Exception:
-            result["error"] = "Call recording could not be finalized"
+        except Exception as error:
+            detail = str(error) if isinstance(error, RecordingError) else type(error).__name__
+            errors.append(f"Call recording could not be finalized: {detail}")
+        if errors:
+            result["error"] = "; ".join(errors)
         protocol.write(json.dumps(result) + "\n")
 
 

package/src/harness/phone_recording.py

@@ -10,6 +10,10 @@ MEDIA_RATE = 48000
 PEAK_SAMPLES = MEDIA_RATE // 20
 
 
+class RecordingError(RuntimeError):
+    """SDK-authored capture diagnostics, safe to include in test results."""
+
+
 class StreamingRecording:
     def __init__(self, path):
         self.path = path
@@ -85,7 +89,7 @@ class StreamingRecording:
             self.encoder.kill()
             self.writer.join(timeout=1)
         if self.error:
-            raise RuntimeError(self.error)
+            raise RecordingError(self.error)
         return {
             "duration": self.frames / MEDIA_RATE,
             "bytes": os.path.getsize(self.path),

package/src/phone.test.ts

@@ -16,7 +16,7 @@ beforeAll(async () => {
     runtime,
     `#!/usr/bin/env bun
 import { createInterface } from "node:readline";
-let connected = false, directory, sessionId, started, clockRate = 1;
+let connected = false, directory, sessionId, started, recordingError, clockRate = 1;
 const offset = () => (Date.now() - started) / 1000 * clockRate;
 function finish() {
   if (!sessionId) return;
@@ -24,7 +24,7 @@ function finish() {
   const bytes = Buffer.alloc(128);
   bytes.set([0x1a,0x45,0xdf,0xa3]);
   require("node:fs").writeFileSync(directory + "/" + sessionId + ".webm", bytes);
-  console.log(JSON.stringify({event:"recording", sessionId, startedAtMs:started, duration, contentType:"audio/webm", encodingFinalizeMs:1, bytes:bytes.length, peaks:[.2,.8], callerPeaks:[.2,0], recipientPeaks:[0,.8]}));
+  console.log(JSON.stringify({event:"recording", sessionId, startedAtMs:started, duration, contentType:"audio/webm", encodingFinalizeMs:1, bytes:bytes.length, peaks:[.2,.8], callerPeaks:[.2,0], recipientPeaks:[0,.8], error:recordingError}));
   sessionId = undefined;
 }
 createInterface({ input: process.stdin }).on("line", async line => {
@@ -34,6 +34,9 @@ createInterface({ input: process.stdin }).on("line", async line => {
   if (data.action === "open") directory = data.directory;
   if (data.action === "call") {
     sessionId = data.sessionId; started = Date.now();
+    recordingError = data.destination === "recording-failure"
+      ? "Call recording could not be finalized: Phone recording encoder could not keep up with audio"
+      : undefined;
     clockRate = data.destination === "clock-drift" ? 0.25 : 1;
     console.log(JSON.stringify({event:"operation_started", id:data.id, offset:0}));
     if (data.destination === "timeout") return;
@@ -412,10 +415,10 @@ test("real harness exposes ctx.phone, seals recordings on every outcome and serv
   await writeFile(join(root, "spectest/index.ts"), `
     import { defineEnvironment } from ${JSON.stringify(sdk)};
     const env = defineEnvironment({ name: "phone-integration", services: {} });
-    const cases = ["success", "failure", "timeout"].map(outcome => env.test(outcome,
+    const cases = ["success", "failure", "timeout", "recording-failure"].map(outcome => env.test(outcome,
       { timeoutMs: outcome === "timeout" ? 350 : 2000 }, async ctx => {
         const phone = await ctx.phone(${JSON.stringify(options)});
-        await phone.call("123");
+        await phone.call(outcome === "recording-failure" ? outcome : "123");
         await phone.say("One. Two.");
         await new Promise(r => setTimeout(r, 30));
         if (outcome === "failure") throw new Error("application assertion failed");
@@ -428,7 +431,7 @@ test("real harness exposes ctx.phone, seals recordings on every outcome and serv
     import { strict as assert } from "node:assert";
     import { METHODS } from ${JSON.stringify(daemon)};
     const loaded = await METHODS.load({});
-    assert.equal(loaded.cases.length, 3);
+    assert.equal(loaded.cases.length, 4);
     for (const [index, test] of loaded.cases.entries()) {
       const result = await METHODS.run({caseId:test.id});
       assert.equal(result.status, index === 0 ? "passed" : "failed", JSON.stringify(result));
@@ -436,6 +439,13 @@ test("real harness exposes ctx.phone, seals recordings on every outcome and serv
       if (index === 2) assert.match(result.error.message, /timed out/);
       assert.equal(result.phoneRecordings.length, 1);
       const recording = result.phoneRecordings[0];
+      if (index === 3) {
+        const message = "Call recording could not be finalized: Phone recording encoder could not keep up with audio";
+        assert.equal(recording.error, message);
+        assert.equal(result.error.message, message);
+        await assert.rejects(METHODS.phoneRecordingChunk({caseId:recording.id}), /Unknown/);
+        continue;
+      }
       assert.equal(recording.error, undefined);
       assert.ok(recording.duration > 0);
       assert.deepEqual(recording.callerPeaks, [.2,0]);