@expo/serve-sim 0.10.3 → 0.10.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/serve-sim",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "homepage": "https://github.com/expo/expo-device-hub/tree/main/packages/serve-sim/packages/serve-sim",
   "bugs": {
     "url": "https://github.com/expo/expo-device-hub/issues"

package/src/middleware.ts

@@ -1,3 +1,9 @@
+import { getScreenshotDisplayIdsAsync } from "./screenshot-display";
+import {
+  captureScreenshotFileAsync,
+  ScreenshotDisplay,
+  SCREENSHOT_DISPLAY_CHANGED,
+} from "./screenshot-store";
 import { openSseStream } from "./sse-stream";
 import { parseCaptureProxy } from "./capture/upstream";
 import { execFile, execSync } from "child_process";
@@ -46,7 +52,14 @@ import {
   type ForegroundTrackerCache,
 } from "./foreground-tracker";
 import { corsAllowOriginHeaders, frameAncestorsPolicy, isAllowedOrigin } from "./middleware-utils";
-import { closeDeviceSession, getDeviceSession, peekDeviceSession } from "./device-session";
+import {
+  closeDeviceSession,
+  getDeviceSession,
+  withScreenshotDeviceSession,
+  peekDeviceSession,
+  retainDeviceSession,
+  withDeviceSessionTask,
+} from "./device-session";
 import {
   assertBearerAccess,
   assertCaptureAccess,
@@ -766,8 +779,29 @@ function serveHelperInProcess(
     void live.handlePanel(req, res, Number(panelRoute[1]), panelRoute[2]!);
     return true;
   }
+  // Unknown and one-shot helper reads must not claim screenshot-owned capture.
+  if (
+    !panelRoute &&
+    ![
+      "/stream.mjpeg",
+      "/stream.avcc",
+      "/stream-settings",
+      "/config",
+      "/health",
+      "/webrtc/offer",
+      "/webrtc/close",
+      "/recording/video",
+      "/ax",
+      "/foreground",
+    ].includes(endpoint ?? "")
+  )
+    return false;
+  const retainsCapture =
+    Boolean(panelRoute) ||
+    ((endpoint === "/stream.mjpeg" || endpoint === "/stream.avcc") && req.method === "GET") ||
+    ((endpoint === "/webrtc/offer" || endpoint === "/recording/video") && req.method === "POST");
   try {
-    session = getDeviceSession(device, initialStreamSettings);
+    session = getDeviceSession(device, initialStreamSettings, retainsCapture);
   } catch {
     return false; // not booted / capture unavailable → 404
   }
@@ -783,7 +817,9 @@ function serveHelperInProcess(
       session.handleAvcc(req, res);
       return true;
     case "/stream-settings":
-      void session.handleStreamSettings(req, res);
+      void withDeviceSessionTask(session, async () => {
+        if (await session.handleStreamSettings(req, res)) retainDeviceSession(session);
+      });
       return true;
     case "/config":
       session.handleConfig(req, res);
@@ -2765,21 +2801,36 @@ export function simMiddleware(options?: SimMiddlewareOptions): SimMiddleware {
         res.end(JSON.stringify({ ok: false, error: "No booted simulator to screenshot" }));
         return;
       }
-      // simctl only writes to a file, so round-trip through a private tmp path
-      // instead of streaming; captures are a few MB at most.
+      const displayValue = new URL(rawUrl, "http://localhost").searchParams.get("display");
+      const display =
+        displayValue === null ? undefined : ScreenshotDisplay.safeParse(Number(displayValue));
+      if (display && !display.success) {
+        res.writeHead(400, { "Cache-Control": "no-store", "Content-Type": "application/json" });
+        res.end(JSON.stringify({ ok: false, error: "Invalid simulator display ID" }));
+        return;
+      }
+      udid = udid.toUpperCase();
+      // HTTP downloads avoid staging and Desktop copies, but share panel election.
       const file = join(tmpdir(), `serve-sim-screenshot-${randomBytes(8).toString("hex")}.png`);
       try {
-        await new Promise<void>((resolve, reject) => {
-          execFile(
-            "xcrun",
-            ["simctl", "io", udid, "screenshot", file],
-            { timeout: 5_000 },
-            (err, _stdout, stderr) => {
-              if (err) reject(Object.assign(err, { stderr: stderr?.toString() }));
-              else resolve();
-            },
-          );
-        });
+        const screenId = display?.data;
+        const capture = (id: number, read?: () => Promise<number>) =>
+          captureScreenshotFileAsync({ udid, file, display: id, timeoutMs: 5_000 }, read);
+        const result =
+          screenId !== undefined
+            ? await capture(screenId)
+            : await withScreenshotDeviceSession(udid, streamSettings, async (session) => {
+                const read = () => session.activeScreenId();
+                return await capture(await read(), read);
+              }).catch(async (error) => {
+                // A sole integrated display needs no native panel election. Never
+                // fall back on an unknown profile or a multi-display device.
+                if (!(await getBootedUdids())?.has(udid)) throw error;
+                const ids = await getScreenshotDisplayIdsAsync(udid);
+                if (ids?.length !== 1) throw error;
+                return await capture(ids[0]!);
+              });
+        if (result.exitCode !== 0) throw new Error(result.stderr || "simctl screenshot failed");
         const png = await readFile(file);
         const artifact = await saveScreenshotArtifact(png);
         recordScreenshotEvent(udid, artifact);
@@ -2806,7 +2857,15 @@ export function simMiddleware(options?: SimMiddlewareOptions): SimMiddleware {
           "Cache-Control": "no-store",
           "Content-Type": "application/json",
         });
-        res.end(JSON.stringify({ ok: false, error: message }));
+        res.end(
+          JSON.stringify({
+            ok: false,
+            error:
+              message === SCREENSHOT_DISPLAY_CHANGED
+                ? SCREENSHOT_DISPLAY_CHANGED
+                : "Simulator screenshot failed",
+          }),
+        );
       } finally {
         // Best-effort cleanup; the PNG is already in memory by now.
         await unlink(file).catch(() => {});

package/src/native.ts

@@ -25,7 +25,7 @@ interface SimHIDHandle {
   setScreen(screenId: number): Promise<boolean | void>;
   supportsHingeAngle(): Promise<boolean>;
   hingeState(): Promise<NativeHingeState>;
-  hingeControlEligibility(): Promise<NativeHingeState>;
+  hingeControlEligibility(): Promise<NativeHingeReadback>;
   setHingeAngle(angle: number): Promise<boolean>;
   setHingePose(pose: string): Promise<boolean>;
   supportsPhysicalOrientation(): Promise<boolean>;
@@ -77,6 +77,7 @@ interface SimCaptureHandle {
   closeWebRTCSession(sessionId: string): Promise<void>;
   webRTCSenderStats(sessionId: string): Promise<string>;
   screenSize(): Promise<NativeScreenInfo>;
+  activeScreenId(): Promise<number>;
   subscribeScreenChanges(onChange: () => Promise<void>): Promise<NativeUnsubscribe>;
   subscribeDeviceState(onSnapshot: (json: string) => Promise<void>): Promise<NativeUnsubscribe>;
   stop(): Promise<void>;
@@ -136,6 +137,9 @@ export type NativeHingeState = {
   physicalOrientation?: HingePhysicalOrientation;
 };
 
+/** Command reconciliation never synthesizes native tabletop activity. */
+export type NativeHingeReadback = NativeHingeState & { tableModeActive?: boolean };
+
 export type NativeDeviceStateSnapshot = {
   generation: number;
   revision: number;
@@ -289,13 +293,14 @@ export class NativeHid {
     return this.guard("hingeState", () => this.handle.hingeState(), {});
   }
 
-  async hingeControlEligibility(): Promise<NativeHingeState> {
+  async hingeControlEligibility(): Promise<NativeHingeReadback | null> {
+    // An empty sample has unknown fields; null means the read failed.
     return (
-      (await this.guard(
+      (await this.guard<NativeHingeReadback | null>(
         "hingeControlEligibility",
         () => this.handle.hingeControlEligibility(),
-        {},
-      )) ?? {}
+        null,
+      )) ?? null
     );
   }
 
@@ -484,6 +489,10 @@ export class NativeCapture {
     return this.handle.screenSize();
   }
 
+  activeScreenId(): Promise<number> {
+    return this.handle.activeScreenId();
+  }
+
   async subscribeDeviceState(
     onSnapshot: (snapshot: NativeDeviceStateSnapshot) => Promise<void>,
   ): Promise<NativeUnsubscribe> {