Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { findSqliteRuntimeTests } from './vitest-sqlite-runtime-scan.mjs'

// SQLite publication, native bindings, worker IPC, socket liveness, and V8 retention use Node.
const NODE_RUNTIME_INCLUDE = [
'src/main/ipc/emulator-control-stream.test.ts',
// Exercise the native fetch error and abort contracts used by the Linear SDK in Electron.
'tests/e2e/linear-cli-recovery.unit.test.ts',
'src/main/runtime/agent-session/lifecycle/structured-agent-cli-writers.test.ts',
Expand Down
5 changes: 3 additions & 2 deletions src/main/emulator/emulator-bridge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ export class EmulatorBridge {
return this.sessionRegistry.getActiveForWorktree(worktreeId)
}

hasControlStreamUrl = (url: string): boolean => this.sessionRegistry.hasControlStreamUrl(url)

// Keep slow-booting Android devices alive across switches for fast reattachment.
async stopActiveForSwitch(worktreeId: string): Promise<string | null> {
const keepAlive = this.backendForActiveWorktree(worktreeId)?.kind === 'android'
Expand Down Expand Up @@ -133,10 +135,9 @@ export class EmulatorBridge {
if (!backend) {
return null
}
const sessionInfo = this.sessionRegistry.toSessionInfo(session)
await this.startLeases.cleanupWhenIdle(
backend,
sessionInfo,
this.sessionRegistry.toSessionInfo(session),
(info) => this.sessionRegistry.hasActiveWorktreeForSession(info.deviceUdid),
{
includeOrphaned: !options.managedOnly,
Expand Down
9 changes: 9 additions & 0 deletions src/main/emulator/emulator-session-registry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@ export class EmulatorSessionRegistry {
return [...this.sessions.values()]
}

hasControlStreamUrl(url: string): boolean {
for (const session of this.sessions.values()) {
if (session.wsUrl === url) {
return true
}
}
return false
}

clearSessionAndWorktrees(key: string): void {
this.sessions.delete(key)
for (const [worktreeId, activeKey] of this.activeByWorktree.entries()) {
Expand Down
122 changes: 122 additions & 0 deletions src/main/ipc/emulator-control-stream.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
import { EventEmitter, once } from 'node:events'
import { afterEach, expect, it, vi } from 'vitest'
import WebSocket, { WebSocketServer } from 'ws'
import type * as WsModule from 'ws'
import { EmulatorBridge } from '../emulator/emulator-bridge'
import { registerEmulatorControlStreamHandlers } from './emulator-control-stream'

const handlers = new Map<string, (event: unknown, args: unknown) => unknown>()
vi.mock('electron', () => ({
ipcMain: {
removeAllListeners: () => {},
removeHandler: () => {},
handle: (channel: string, handler: (event: unknown, args: unknown) => unknown) =>
handlers.set(channel, handler),
on: (channel: string, handler: (event: unknown, args: unknown) => unknown) =>
handlers.set(channel, handler)
},
BrowserWindow: { fromWebContents: () => ({}) }
}))
vi.mock('ws', async (importOriginal) => {
const actual = await importOriginal<typeof WsModule>()
return {
...actual,
default: Object.assign(
vi.fn(function (url: string) {
return new actual.default(url)
}),
{ OPEN: actual.default.OPEN }
)
}
})

class Owner extends EventEmitter {
isDestroyed = (): boolean => false
send = (_channel: string, event: { type: string; data?: unknown }): void => {
this.emit(event.type, event.data)
}
}

const owners: Owner[] = []
let server: WebSocketServer | undefined

afterEach(async () => {
for (const owner of owners.splice(0)) {
owner.emit('destroyed')
}
if (server) {
for (const socket of server.clients) {
socket.terminate()
}
const closed = once(server, 'close')
server.close()
await closed
server = undefined
}
vi.clearAllMocks()
})

function setup(wsUrl: string) {
const bridge = new EmulatorBridge()
bridge.registerActiveEmulator('worktree', {
deviceUdid: 'device',
streamUrl: 'http://127.0.0.1/stream.mjpeg',
wsUrl
})
registerEmulatorControlStreamHandlers(() => bridge)
const sender = new Owner()
owners.push(sender)
return {
sender,
start: (url = wsUrl, streamId = 'control') =>
handlers.get('emulator:controlStreamStart')?.({ sender }, { wsUrl: url, streamId })
}
}

it('never connects to URLs outside the registered session', () => {
const { start } = setup('ws://127.0.0.1:3100/ws')
for (const url of [
'ws://127.0.0.1:3101/ws',
'ws://example.com/ws',
'ws://127.0.0.1:3100/other'
]) {
expect(() => start(url)).toThrow('registered emulator session')
}
expect(WebSocket).not.toHaveBeenCalled()
})

it('relays text and binary without Origin and releases the socket when the renderer goes away', async () => {
server = new WebSocketServer({ host: '127.0.0.1', port: 0 })
await once(server, 'listening')
const address = server.address()
if (!address || typeof address === 'string') {
throw new Error('Expected TCP address')
}
const { sender, start } = setup(`ws://127.0.0.1:${address.port}/ws`)
const connection = once(server, 'connection')
const opened = once(sender, 'open')
start()
const [socket, request] = await connection
const otherRenderer = new Owner()
handlers.get('emulator:controlStreamSend')?.(
{ sender: otherRenderer },
{ streamId: 'control', data: 'unowned' }
)
handlers.get('emulator:controlStreamStop')?.({ sender: otherRenderer }, { streamId: 'control' })
await opened
expect(request.headers.origin).toBeUndefined()
for (const data of ['text', new Uint8Array([130, 1, 2])]) {
const received = once(socket, 'message')
handlers.get('emulator:controlStreamSend')?.({ sender }, { streamId: 'control', data })
const [bytes, binary] = await received
expect(binary).toBe(typeof data !== 'string')
expect(bytes.toString()).toBe(Buffer.from(data).toString())
const relayed = once(sender, 'message')
socket.send(data)
const [frame] = await relayed
expect(frame instanceof ArrayBuffer ? new Uint8Array(frame) : frame).toEqual(data)
}
const closed = once(socket, 'close')
sender.emit('destroyed')
await closed
})
90 changes: 90 additions & 0 deletions src/main/ipc/emulator-control-stream.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
import { BrowserWindow, ipcMain, type WebContents } from 'electron'
import WebSocket from 'ws'
import type { EmulatorBridge } from '../emulator/emulator-bridge'
import type { EmulatorControlStreamEvent } from '../../preload/api/emulator-api'
import { abortWhenRendererGone } from './renderer-lifetime-abort'
import { registerEmulatorScrcpyTouchHandler } from './emulator-scrcpy-touch'
import { registerEmulatorScrcpyKeyboardHandler } from './emulator-scrcpy-keyboard'

export function registerEmulatorControlStreamHandlers(
getBridge: () => EmulatorBridge | null
): void {
registerEmulatorScrcpyTouchHandler()
registerEmulatorScrcpyKeyboardHandler()
const streams = new Map<string, { owner: WebContents; socket: WebSocket; dispose: () => void }>()
const stop = (streamId: string, owner: WebContents): void => {
const stream = streams.get(streamId)
if (!stream || stream.owner !== owner) {
return
}
streams.delete(streamId)
stream.dispose()
// close() flushes queued release frames; terminate() would drop them.
if (stream.socket.readyState === WebSocket.OPEN) {
stream.socket.close()
} else {
stream.socket.terminate()
}
}

ipcMain.handle(
'emulator:controlStreamStart',
(event, args: { wsUrl: string; streamId: string }) => {
const owner = event.sender
if (!BrowserWindow.fromWebContents(owner) || !getBridge()?.hasControlStreamUrl(args?.wsUrl)) {
throw new Error('Control stream requires a registered emulator session.')
}
const { streamId } = args
if (typeof streamId !== 'string' || streams.has(streamId)) {
throw new Error('Control stream id is invalid or already in use.')
}
const socket = new WebSocket(args.wsUrl)
socket.binaryType = 'arraybuffer'
const lifetime = abortWhenRendererGone(owner)
const onGone = (): void => stop(streamId, owner)
streams.set(streamId, {
owner,
socket,
dispose: () => {
lifetime.signal.removeEventListener('abort', onGone)
lifetime.dispose()
}
})
lifetime.signal.addEventListener('abort', onGone, { once: true })
const send = (
type: EmulatorControlStreamEvent['type'],
data?: ArrayBuffer | string
): void => {
if (streams.has(streamId) && !owner.isDestroyed()) {
owner.send('emulator:controlStreamEvent', { streamId, type, data })
}
}
socket.on('open', () => send('open'))
socket.on('message', (data) =>
send('message', data instanceof ArrayBuffer ? data : data.toString())
)
socket.on('error', (error) => send('error', error.message))
socket.on('close', () => {
send('close')
stop(streamId, owner)
})
}
)
ipcMain.on(
'emulator:controlStreamSend',
(event, args: { streamId: string; data: string | Uint8Array } | null) => {
const stream = args && streams.get(args.streamId)
if (
args &&
stream?.owner === event.sender &&
stream.socket.readyState === WebSocket.OPEN &&
(typeof args.data === 'string' || args.data instanceof Uint8Array)
) {
stream.socket.send(args.data)
}
}
)
ipcMain.handle('emulator:controlStreamStop', (event, args: { streamId: string }) => {
stop(args.streamId, event.sender)
})
}
6 changes: 2 additions & 4 deletions src/main/ipc/register-core-handlers/register-core-handlers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,8 @@ import { registerPetHandlers } from '../pets/pet'
import { registerPluginHandlers } from '../plugins'
import { registerUIHandlers, setTrustedUIRendererWebContentsId } from '../ui'
import { registerEmulatorFrameStreamHandlers } from '../emulator-frame-stream'
import { registerEmulatorControlStreamHandlers } from '../emulator-control-stream'
import { registerEmulatorVideoStreamHandlers } from '../emulator-video-stream'
import { registerEmulatorScrcpyTouchHandler } from '../emulator-scrcpy-touch'
import { registerEmulatorScrcpyKeyboardHandler } from '../emulator-scrcpy-keyboard'
import { registerSpeechHandlers } from '../speech'
import { registerTerminalRenderDesyncEvidenceHandler } from '../terminal-render-desync-evidence'
import { registerOrcaProfileHandlers } from '../profiles/orca-profiles'
Expand Down Expand Up @@ -241,9 +240,8 @@ export function registerCoreHandlers(
registerSessionHandlers(store, runtime)
registerUIHandlers(store, { isDashboardPopoutRenderer })
registerEmulatorFrameStreamHandlers()
registerEmulatorControlStreamHandlers(() => runtime.getEmulatorBridge())
registerEmulatorVideoStreamHandlers((id) => runtime.getEmulatorBridge()?.getIosVideoStreamUrl(id))
registerEmulatorScrcpyTouchHandler()
registerEmulatorScrcpyKeyboardHandler()
registerWorkspaceSpaceHandlers(store)
registerWorkspacePortHandlers(store)
registerLinkPreviewHandlers()
Expand Down
10 changes: 10 additions & 0 deletions src/preload/api/emulator-api.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
export type EmulatorControlStreamEvent = {
streamId: string
type: 'open' | 'message' | 'error' | 'close'
data?: ArrayBuffer | string
}

export type EmulatorApi = {
startControlStream: (args: { wsUrl: string; streamId: string }) => Promise<void>
stopControlStream: (args: { streamId: string }) => Promise<void>
sendControlStream: (args: { streamId: string; data: string | Uint8Array }) => void
onControlStreamEvent: (callback: (event: EmulatorControlStreamEvent) => void) => () => void
onPaneFocus: (callback: (data: { worktreeId: string }) => void) => () => void
onAutoAttach: (
callback: (data: {
Expand Down
13 changes: 13 additions & 0 deletions src/preload/api/emulator-bridge.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
import { ipcRenderer } from 'electron'
import type { PreloadApi } from '../api-types'
import type { EmulatorControlStreamEvent } from './emulator-api'

export const emulatorApi = {
startControlStream: (args: { wsUrl: string; streamId: string }): Promise<void> =>
ipcRenderer.invoke('emulator:controlStreamStart', args),
stopControlStream: (args: { streamId: string }): Promise<void> =>
ipcRenderer.invoke('emulator:controlStreamStop', args),
sendControlStream: (args: { streamId: string; data: string | Uint8Array }): void =>
ipcRenderer.send('emulator:controlStreamSend', args),
onControlStreamEvent: (callback: (data: EmulatorControlStreamEvent) => void): (() => void) => {
const listener = (_event: Electron.IpcRendererEvent, data: EmulatorControlStreamEvent) =>
callback(data)
ipcRenderer.on('emulator:controlStreamEvent', listener)
return () => ipcRenderer.removeListener('emulator:controlStreamEvent', listener)
},
startFrameStream: (args: {
streamUrl: string
streamKey?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ beforeEach(() => {
configurable: true,
value: {
emulator: {
startControlStream: () => Promise.resolve(),
stopControlStream: () => Promise.resolve(),
onControlStreamEvent: () => () => {},
startFrameStream,
stopFrameStream,
onFrameStreamFrame: (_listener: FrameListener) => () => {},
Expand Down
Loading