Files
Piik/tests/native-client.test.ts
AAA 1b9f5bd2a2 feat: add room interactions and media sharing improvements
## Problem and outcome / 问题与结果

This phase adds lightweight room interaction without making media depend on chat,
and adds Windows source-audio exclusion and optional SFU-only hosting at their
existing owners. It also corrects confirmed encoder/capture ownership and native
color-conversion defects. Host microphone commentary remains on the shared media
path; room voice and 4K are outside this phase.

## Release notes

### 中文

这是一次功能更新:Piik 加入了文字聊天与表情互动,并完善了 Windows 声音采集、画面颜色和自部署选项。

#### 新功能

- **边看边聊。** 在可移动、可缩放的聊天窗口中发送消息,或开启弹幕。停止分享后,房间中的朋友仍可继续聊天。
- **表情互动。** 点击沙发上的人物,给自己发表情,或把番茄等表情送给朋友;各端按同一事件显示动画。
- **排除应用声音。** Windows App 分享整个屏幕时,可排除一个应用及其子进程的声音,适合同时使用语音软件。所选应用退出后,来源声音停止,避免恢复为未过滤的系统声音。
- **可选的纯 SFU 模式。** 自部署管理员可让共享画面和声音统一通过媒体服务器转发。默认仍为优先 P2P;App 公网邀请保持纯 P2P。
- **Windows HDR 转 SDR。** 原生采集与缩略图自动将 HDR 来源转换为 SDR,沿用现有观看链路。

#### 修复与改进

- 修复原生颜色转换的范围与矩阵处理,避免已复现的暗部丢失、高光裁切和颜色偏差。
- 修复共享编码器切换时使用过期需求或过期帧信息的问题,保护正在观看的画面;修复换源后旧采集事件可能影响新来源的问题。
- 统一新控件、浮窗与来源选择文案,补充中英文使用说明。

#### 使用与升级

聊天与表情需要新版站点页面和 Server;声音排除需要新版页面与支持此能力的 Windows App。聊天只保留本页最近收到的消息,刷新后清空,不补发历史,且不提供端到端加密。

HDR 转换输出为 SDR,不代表端到端 HDR 或多声道支持。既有房主麦克风与立体声能力保留。

### English

This feature update brings text chat and reactions to Piik, alongside improvements to Windows audio capture, picture colors and self-hosting options.

#### New features

- **Chat while watching.** Send messages in a movable, resizable window, or enable on-screen chat. Friends can keep chatting after the host stops sharing.
- **Reactions.** Select a person on the sofa to react above yourself or send a tomato and other reactions to a friend. Participants animate the same shared event.
- **Exclude application audio.** When sharing a whole screen with Windows App, exclude one application and its child processes, useful when using a separate voice app. Source audio stops if the selected app exits, preventing a return to unfiltered system sound.
- **Optional SFU-only hosting.** Site operators can require shared video and audio to pass through the media server. P2P-first remains the default; App Public invite remains P2P-only.
- **Windows HDR-to-SDR conversion.** Native capture and source thumbnails automatically convert HDR sources to SDR for the existing viewing path.

#### Fixes and improvements

- Correct native color-conversion ranges and matrices, addressing reproduced crushed shadows, clipped highlights and color shifts.
- Correct stale demand and frame evidence during shared-encoder handoffs to protect the current picture. Prevent events from a replaced capture from affecting its successor.
- Align new controls, floating panels and source-picker copy, with updated Chinese and English guides.

#### Using this update

Chat and reactions require updated site pages and Server. Audio exclusion requires updated pages and a Windows App that supports the capability. Chat retains only recent messages received by the current page, clears on refresh and does not replay history. It is not end-to-end encrypted.

HDR conversion produces SDR; it does not add end-to-end HDR or surround sound. Existing host microphone commentary and stereo support remain available.

## Verification / 验证

- Web type checks, 78 test files / 1275 tests and production build: PASS.
- Go core tests, formatting/vet and target builds: PASS; Darwin cgo remains platform-limited on this Windows runner.
- Native build/check/color probes and synthetic HDR-to-SDR H.264/VP8 browser reception: PASS.
- Access/privacy gate, Native H.264 SFU-only media gate and local Auto/H.264 Host gate: PASS.
- Three real production pages: chat/reactions, stop/resume, idle-room join, host departure/return, offline draft recovery and invitation revocation: PASS.
- Synthetic parent/child process-audio exclusion and target lifetime: PASS; no raw audio retained.
- Windows candidate archive extraction and packaged Local startup/shutdown: PASS.
- Documentation and website build: PASS.
- [Candidate CI](https://github.com/TNTcraftHIM/Piik/actions/runs/36873766646) at
  `f26cd208d03bc0dcbe353f8cac217f993216b0a3`: Go core and race checks, Web tests,
  Server/container checks and Windows/macOS/Linux App packaging all PASS.
  Publication was skipped as intended.

The owner accepted the UI/model and bounded local walkthrough for phase closure.
Physical HDR/mixed displays, mobile keyboard,
real voice applications across output devices and macOS/Linux capture remain
unverified. Existing field reports without matched evidence are not claimed
resolved. The owner authorized v1.7.0 publication on 2026-10-02. The final
documentation-only commit records that authorization; product code matches
the verified candidate above.

## Impact / 影响

Authorized version: **v1.7.0**, matching the local release planner. Current wire
contracts remain Browser/server 23, Native control 9 and capture 7. Optional
capabilities gate new functionality; existing room/media authority remains owned
by the existing services. No new ports, message persistence, room voice or
automatic room creation on page visit. Updated README, guides, standards,
research evidence and TODO stay with the candidate phase.
2026-10-02 01:36:45 +08:00

749 lines
32 KiB
TypeScript

import { afterEach, describe, expect, it, vi } from "vitest";
import { discoverNativeHealth, NativeClient, NativeCompatibilityError, notifyNativePresentation } from "../src/client/native/client";
import { DEFAULT_QUALITY_SETTINGS } from "../src/shared/protocol";
import {
nativeEventSchema,
nativeHealthSchema,
NATIVE_CLIENT_PROTOCOL,
NATIVE_CLIENT_PORT_START,
NATIVE_CLIENT_PORT_END,
nativeCaptureTargetSchema,
shareSourceReplacedResponseSchema,
shareStartedResponseSchema,
shareUpdatedResponseSchema,
sourcePreviewResponseSchema,
receiveAnswerResponseSchema,
} from "../src/client/native/wire";
afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});
describe("native App private wire", () => {
const health = {
protocol: NATIVE_CLIENT_PROTOCOL,
service: "piik-client",
port: NATIVE_CLIENT_PORT_START,
instanceToken: "a".repeat(43),
nativeMedia: { video: true, hardwareH264: true },
};
it.each(["prompt", "denied"] as const)("does not hold Viewer reception for %s permission and observes a later grant", async (state) => {
vi.stubGlobal("window", { setTimeout, clearTimeout, location: { hostname: "piik.example" } });
const query = vi.fn().mockResolvedValue({ state });
vi.stubGlobal("navigator", { permissions: { query } });
const fetcher = vi.fn(async () => new Response(JSON.stringify(health)));
vi.stubGlobal("fetch", fetcher);
const socket = vi.fn();
vi.stubGlobal("WebSocket", socket);
await expect(NativeClient.connect({ waitForPermission: false })).resolves.toBeNull();
expect(fetcher).not.toHaveBeenCalled();
expect(socket).not.toHaveBeenCalled();
query.mockResolvedValue({ state: "granted" });
await expect(discoverNativeHealth({ waitForPermission: false })).resolves.toMatchObject({ port: health.port });
});
it("still lets explicit source discovery ask for local permission", async () => {
vi.stubGlobal("window", { setTimeout, clearTimeout, location: { hostname: "piik.example" } });
const query = vi.fn().mockResolvedValue({ state: "prompt" });
vi.stubGlobal("navigator", { permissions: { query } });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify(health))));
await expect(discoverNativeHealth()).resolves.toMatchObject({ port: health.port });
expect(query).not.toHaveBeenCalled();
});
it.each(["localhost", "127.0.0.1", "[::1]"])("keeps App Local reception on %s available without cross-address-space consent", async (hostname) => {
vi.stubGlobal("window", { setTimeout, clearTimeout, location: { hostname } });
const query = vi.fn().mockResolvedValue({ state: "prompt" });
vi.stubGlobal("navigator", { permissions: { query } });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify(health))));
await expect(discoverNativeHealth({ waitForPermission: false })).resolves.toMatchObject({ port: health.port });
expect(query).not.toHaveBeenCalled();
});
it("uses the older combined permission when split permission is unsupported", async () => {
vi.stubGlobal("window", { setTimeout, clearTimeout, location: { hostname: "piik.example" } });
const query = vi.fn().mockRejectedValueOnce(new TypeError("Unsupported permission"))
.mockResolvedValue({ state: "prompt" });
vi.stubGlobal("navigator", { permissions: { query } });
const fetcher = vi.fn();
vi.stubGlobal("fetch", fetcher);
await expect(discoverNativeHealth({ waitForPermission: false })).resolves.toBeNull();
expect(query).toHaveBeenLastCalledWith({ name: "local-network-access" });
expect(fetcher).not.toHaveBeenCalled();
});
it.each([undefined, { query: vi.fn().mockRejectedValue(new TypeError("Unsupported permission")) }])(
"retains ordinary discovery when local permissions cannot be queried",
async (permissions) => {
vi.stubGlobal("window", { setTimeout, clearTimeout, location: { hostname: "piik.example" } });
vi.stubGlobal("navigator", { permissions });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify(health))));
await expect(discoverNativeHealth({ waitForPermission: false })).resolves.toMatchObject({ port: health.port });
},
);
it.each([NATIVE_CLIENT_PROTOCOL - 1, NATIVE_CLIENT_PROTOCOL + 1])(
"reports observed Piik App protocol %s without opening control or presentation",
async (protocol) => {
vi.stubGlobal("window", { setTimeout, clearTimeout });
const socket = vi.fn();
vi.stubGlobal("WebSocket", socket);
const fetcher = vi.fn(async (url: string) => url === `http://127.0.0.1:${health.port}/health`
? new Response(JSON.stringify({ ...health, protocol }))
: new Response(null, { status: 403 }));
vi.stubGlobal("fetch", fetcher);
await expect(NativeClient.connect()).rejects.toMatchObject({
name: "NativeCompatibilityError", actualProtocol: protocol,
});
await expect(notifyNativePresentation("en", new AbortController().signal))
.rejects.toBeInstanceOf(NativeCompatibilityError);
expect(socket).not.toHaveBeenCalled();
expect(fetcher.mock.calls.every(([url]) => url.endsWith("/health"))).toBe(true);
expect(fetcher).toHaveBeenCalledTimes(2 * (NATIVE_CLIENT_PORT_END - NATIVE_CLIENT_PORT_START + 1));
},
);
it("prefers a compatible App on a later port after observing an incompatible App", async () => {
vi.stubGlobal("window", { setTimeout, clearTimeout });
const fetcher = vi.fn(async (url: string) => {
const port = Number(new URL(url).port);
return new Response(JSON.stringify({ ...health, port,
protocol: port === health.port ? NATIVE_CLIENT_PROTOCOL + 1 : NATIVE_CLIENT_PROTOCOL,
}));
});
vi.stubGlobal("fetch", fetcher);
await expect(discoverNativeHealth()).resolves.toMatchObject({
protocol: NATIVE_CLIENT_PROTOCOL, port: NATIVE_CLIENT_PORT_START + 1,
});
expect(fetcher).toHaveBeenCalledTimes(NATIVE_CLIENT_PORT_END - NATIVE_CLIENT_PORT_START + 1);
});
it("keeps discovery alive while local access takes longer than 400 ms", async () => {
vi.useFakeTimers();
vi.stubGlobal("window", { setTimeout, clearTimeout });
vi.stubGlobal("fetch", vi.fn(async (url: string, options: RequestInit) => {
if (new URL(url).port !== String(health.port)) throw new TypeError("No listener");
await new Promise<void>((resolve, reject) => {
const timer = setTimeout(resolve, 1_500);
options.signal!.addEventListener("abort", () => {
clearTimeout(timer);
reject(new DOMException("Aborted", "AbortError"));
}, { once: true });
});
return new Response(JSON.stringify(health));
}));
const discovery = discoverNativeHealth();
await vi.advanceTimersByTimeAsync(1_500);
await expect(discovery).resolves.toMatchObject({ port: health.port });
expect(vi.getTimerCount()).toBe(0);
});
it("finds a later App without waiting for a silent port and aborts the unused probe", async () => {
vi.stubGlobal("window", { setTimeout, clearTimeout });
let silentSignal: AbortSignal | undefined;
vi.stubGlobal("fetch", vi.fn(async (url: string, options: RequestInit) => {
const port = Number(new URL(url).port);
if (port === health.port) {
silentSignal = options.signal!;
return new Promise<Response>((_resolve, reject) => {
silentSignal!.addEventListener("abort", () => reject(new DOMException("Aborted", "AbortError")), { once: true });
});
}
if (port !== health.port + 1) throw new TypeError("No listener");
return new Response(JSON.stringify({ ...health, port }));
}));
await expect(discoverNativeHealth()).resolves.toMatchObject({ port: health.port + 1 });
expect(silentSignal?.aborted).toBe(true);
});
it("bounds all silent discovery ports with one deadline", async () => {
vi.useFakeTimers();
vi.stubGlobal("window", { setTimeout, clearTimeout });
const signals: AbortSignal[] = [];
vi.stubGlobal("fetch", vi.fn(async (_url: string, options: RequestInit) => {
signals.push(options.signal!);
return new Promise<Response>((_resolve, reject) => {
options.signal!.addEventListener("abort", () => reject(new DOMException("Aborted", "AbortError")), { once: true });
});
}));
const discovery = discoverNativeHealth();
await vi.advanceTimersByTimeAsync(8_000);
await expect(discovery).resolves.toBeNull();
expect(signals).toHaveLength(NATIVE_CLIENT_PORT_END - NATIVE_CLIENT_PORT_START + 1);
expect(signals.every((signal) => signal.aborted)).toBe(true);
expect(vi.getTimerCount()).toBe(0);
});
it("identifies an incompatible App even when that protocol uses different token or media metadata", async () => {
vi.stubGlobal("window", { setTimeout, clearTimeout });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify({
...health, protocol: NATIVE_CLIENT_PROTOCOL + 1,
instanceToken: { format: "different-protocol" }, nativeMedia: "different-protocol",
}))));
await expect(NativeClient.connect()).rejects.toMatchObject({
name: "NativeCompatibilityError", actualProtocol: NATIVE_CLIENT_PROTOCOL + 1,
});
});
it("treats denied, absent and malformed endpoints as ordinary Browser-only operation", async () => {
vi.stubGlobal("window", { setTimeout, clearTimeout });
const malformed = [
{ ...health, service: "another-service" },
{ ...health, protocol: "8" },
{ ...health, instanceToken: "invalid" },
{ ...health, nativeMedia: { video: "yes" } },
{ ...health, protocol: 8, port: NATIVE_CLIENT_PORT_END },
];
let responseIndex = 0;
vi.stubGlobal("fetch", vi.fn(async () => {
const body = malformed[responseIndex++];
if (body) return new Response(JSON.stringify(body));
if (responseIndex % 2 === 0) return new Response(null, { status: 403 });
throw new TypeError("Network unavailable");
}));
await expect(NativeClient.connect()).resolves.toBeNull();
});
it("notifies only the current presentation request after App discovery", async () => {
vi.stubGlobal("window", {
setTimeout: globalThis.setTimeout,
clearTimeout: globalThis.clearTimeout,
});
const fetcher = vi.fn(async (url: string) => url.endsWith("/health")
? new Response(JSON.stringify({
protocol: 9, service: "piik-client", port: 39_721,
instanceToken: "a".repeat(43),
nativeMedia: {video: true, processAudio: false, systemAudio: true, hardwareH264: true, softwareVP8: true},
}), {status: 200})
: new Response(null, {status: 204}));
vi.stubGlobal("fetch", fetcher);
const stale = new AbortController();
const staleNotification = notifyNativePresentation("zh", stale.signal);
stale.abort();
await staleNotification;
expect(fetcher).toHaveBeenCalledTimes(NATIVE_CLIENT_PORT_END - NATIVE_CLIENT_PORT_START + 1);
expect(fetcher).toHaveBeenCalledWith("http://127.0.0.1:39721/health", expect.anything());
const current = new AbortController();
await notifyNativePresentation("vis", current.signal);
expect(fetcher).toHaveBeenLastCalledWith("http://127.0.0.1:39721/presentation", expect.objectContaining({
method: "POST", body: JSON.stringify({language: "vis"}), signal: current.signal,
}));
});
it("notifies the owner once on an unexpected close and stays silent on cleanup", async () => {
const sockets: FakeWebSocket[] = [];
const token = "a".repeat(43);
class FakeWebSocket extends EventTarget {
static readonly OPEN = 1;
static readonly CLOSING = 2;
static readonly CLOSED = 3;
readyState = FakeWebSocket.OPEN;
protocol = `piik-client-v9.${token}`;
readonly close = vi.fn(() => {
this.readyState = FakeWebSocket.CLOSING;
});
constructor(readonly url: string, readonly protocols: string[]) {
super();
sockets.push(this);
queueMicrotask(() => this.dispatchEvent(new Event("open")));
}
send(payload: string): void {
const request = JSON.parse(payload) as { id: string; type: string };
if (!["hello", "update-share", "ping"].includes(request.type)) return;
queueMicrotask(() => {
const event = new Event("message");
Object.defineProperty(event, "data", {
value: JSON.stringify({
version: 9,
id: request.id,
type: request.type === "hello" ? "ready" : request.type === "ping" ? "pong" : "request-failed",
...(request.type === "update-share" ? { code: "operation-failed" } : {}),
}),
});
this.dispatchEvent(event);
});
}
emitUnexpectedClose(): void {
this.readyState = FakeWebSocket.CLOSED;
this.dispatchEvent(new Event("close"));
}
}
vi.stubGlobal("WebSocket", FakeWebSocket);
vi.stubGlobal("window", {
setTimeout: globalThis.setTimeout,
clearTimeout: globalThis.clearTimeout,
});
vi.stubGlobal("fetch", vi.fn(async () =>
new Response(JSON.stringify({
protocol: 9,
service: "piik-client",
port: 39_721,
instanceToken: token,
nativeMedia: {
video: true,
processAudio: false,
systemAudio: false,
hardwareH264: true,
softwareVP8: true,
},
}), { status: 200 }),
));
const client = await NativeClient.connect();
expect(client).not.toBeNull();
const unexpected = vi.fn();
client!.onClose(unexpected);
await expect(client!.updateShare("share_123456", DEFAULT_QUALITY_SETTINGS))
.rejects.toThrow("Piik App request failed");
await client!.ping();
expect(sockets[0]!.close).not.toHaveBeenCalled();
expect(unexpected).not.toHaveBeenCalled();
sockets[0]!.emitUnexpectedClose();
sockets[0]!.emitUnexpectedClose();
expect(unexpected).toHaveBeenCalledOnce();
const cleanClient = await NativeClient.connect();
expect(cleanClient).not.toBeNull();
const intentional = vi.fn();
cleanClient!.onClose(intentional);
cleanClient!.close();
sockets[1]!.emitUnexpectedClose();
expect(intentional).not.toHaveBeenCalled();
});
it("accepts descriptive health extensions and treats absent media features as unavailable", () => {
expect(
nativeHealthSchema.parse({
protocol: 9,
service: "piik-client",
port: 39_721,
instanceToken: "a".repeat(43),
nativeMedia: {
video: true,
processAudio: false,
systemAudio: true,
hardwareH264: true,
softwareVP8: true,
},
}),
).toMatchObject({ nativeMedia: { processAudio: false } });
expect(
nativeHealthSchema.safeParse({
protocol: NATIVE_CLIENT_PROTOCOL,
service: "piik-client",
port: 39_721,
instanceToken: "a".repeat(43),
nativeMedia: {
video: true,
processAudio: true,
systemAudio: true,
hardwareH264: true,
softwareVP8: false,
},
adapters: ["private"],
}).success,
).toBe(true);
expect(nativeHealthSchema.parse({
...health, futureDescription: "ignored", nativeMedia: { video: true, futureFeature: true },
})).toEqual({
...health, nativeMedia: {
receiverReuse: false,
video: true, processAudio: false, processAudioExclusion: false, systemAudio: false, microphone: false, captureBorderControl: false, hardwareH264: false, softwareVP8: false,
},
});
expect(nativeHealthSchema.parse({ ...health, nativeMedia: undefined }).nativeMedia)
.toEqual({ receiverReuse: false, video: false, processAudio: false, processAudioExclusion: false, systemAudio: false, microphone: false, captureBorderControl: false, hardwareH264: false, softwareVP8: false });
for (const invalid of [
{ protocol: 0 }, { protocol: 9.5 }, { protocol: Number.MAX_SAFE_INTEGER + 1 },
{ service: "other" }, { port: NATIVE_CLIENT_PORT_END + 1 }, { instanceToken: "short" },
{ nativeMedia: { softwareVP8: "true" } }, { nativeMedia: { captureBorderControl: "true" } }, { nativeMedia: null },
]) expect(nativeHealthSchema.safeParse({ ...health, ...invalid }).success).toBe(false);
});
it.each([undefined, false, true])("gates capture-border commands on advertised support: %s", async (supported) => {
const requests: Record<string, unknown>[] = [];
class CaptureSocket extends EventTarget {
static readonly OPEN = 1;
static readonly CLOSING = 2;
readyState = CaptureSocket.OPEN;
protocol = `piik-client-v9.${health.instanceToken}`;
constructor() {
super();
queueMicrotask(() => this.dispatchEvent(new Event("open")));
}
close() { this.readyState = CaptureSocket.CLOSING; }
send(payload: string) {
const request = JSON.parse(payload) as Record<string, unknown>;
requests.push(request);
queueMicrotask(() => this.dispatchEvent(new MessageEvent("message", {
data: JSON.stringify({
version: NATIVE_CLIENT_PROTOCOL, id: request.id,
...(request.type === "hello" ? { type: "ready" } : {
type: request.type === "start-share" ? "share-started" : "share-source-replaced",
shareId: request.shareId,
...(request.type === "start-share" ? { audio: true, codec: "h264" } : {}),
}),
}),
})));
}
}
vi.stubGlobal("WebSocket", CaptureSocket);
vi.stubGlobal("window", { setTimeout, clearTimeout });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify({
...health, nativeMedia: { ...health.nativeMedia, captureBorderControl: supported },
}))));
const client = await NativeClient.connect();
expect(client).not.toBeNull();
expect(client!.health.nativeMedia.captureBorderControl).toBe(supported ?? false);
const input = {
shareId: "share_123456", source: { kind: "display" as const, sourceId: "2", title: "Display 1" },
audio: true, adapterIndex: 0, encoderIndex: 0, edgeCapacity: 2,
profile: DEFAULT_QUALITY_SETTINGS, codec: "auto" as const,
};
try {
for (const showCaptureBorder of [undefined, false, true]) {
await client!.startShare({ ...input, showCaptureBorder });
await client!.replaceShareSource(input.shareId, input.source, input.audio, input, showCaptureBorder);
const extension = supported ? { showCaptureBorder: showCaptureBorder ?? false } : {};
expect(requests.at(-2)).toEqual({
version: NATIVE_CLIENT_PROTOCOL, id: expect.any(String), type: "start-share", ...input, ...extension,
});
expect(requests.at(-1)).toEqual({
version: NATIVE_CLIENT_PROTOCOL, id: expect.any(String), type: "replace-share-source",
shareId: input.shareId, source: input.source, audio: true, adapterIndex: 0, encoderIndex: 0, ...extension,
});
}
} finally { client!.close(); }
});
it.each([false, true])("never silently drops requested audio exclusion (%s)", async (supported) => {
const requests: Record<string, unknown>[] = [];
class Socket extends EventTarget {
static readonly OPEN = 1;
static readonly CLOSING = 2;
readyState = Socket.OPEN;
protocol = `piik-client-v9.${health.instanceToken}`;
constructor() { super(); queueMicrotask(() => this.dispatchEvent(new Event("open"))); }
close() { this.readyState = Socket.CLOSING; }
send(payload: string) {
const request = JSON.parse(payload) as Record<string, unknown>;
requests.push(request);
queueMicrotask(() => this.dispatchEvent(new MessageEvent("message", { data: JSON.stringify({
version: NATIVE_CLIENT_PROTOCOL, id: request.id,
...(request.type === "hello" ? { type: "ready" } : {
type: request.type === "start-share" ? "share-started" : "share-source-replaced", shareId: request.shareId,
...(request.type === "start-share" ? { audio: true, codec: "vp8", sourceAudio: true } : {}),
}),
}) })));
}
}
vi.stubGlobal("WebSocket", Socket);
vi.stubGlobal("window", { setTimeout, clearTimeout });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify({ ...health,
nativeMedia: { ...health.nativeMedia, microphone: true, ...(supported ? { processAudioExclusion: true } : {}) },
}))));
const client = (await NativeClient.connect())!;
const input = { shareId: "share_123456", source: { kind: "display" as const, sourceId: "1", title: "Display" },
audio: true, adapterIndex: 0, encoderIndex: 0, edgeCapacity: 1, profile: DEFAULT_QUALITY_SETTINGS, codec: "vp8" as const };
const excludeAudio = { kind: "window" as const, sourceId: "2", pid: 123, creationTime: "456", title: "Voice fixture" };
try {
expect(client.health.nativeMedia.processAudioExclusion).toBe(supported);
await client.startShare(input);
expect(requests.at(-1)).not.toHaveProperty("excludeAudio");
if (supported) {
await client.startShare({ ...input, excludeAudio });
await client.replaceShareSource(input.shareId, input.source, true, input, false, excludeAudio);
expect(requests.at(-2)?.excludeAudio).toEqual(excludeAudio);
expect(requests.at(-1)?.excludeAudio).toEqual(excludeAudio);
} else {
const count = requests.length;
await expect(client.startShare({ ...input, excludeAudio })).rejects.toThrow("audio exclusion");
await expect(client.replaceShareSource(input.shareId, input.source, true, input, false, excludeAudio)).rejects.toThrow("audio exclusion");
expect(requests).toHaveLength(count);
}
} finally { client.close(); }
});
it.each([false, true])("gates microphone mixing and coalesces volume without delaying Stop (%s)", async (supported) => {
const requests: Record<string, unknown>[] = [];
let socket!: Socket;
class Socket extends EventTarget {
static readonly OPEN = 1;
static readonly CLOSING = 2;
readyState = Socket.OPEN;
protocol = `piik-client-v9.${health.instanceToken}`;
constructor() { super(); socket = this; queueMicrotask(() => this.dispatchEvent(new Event("open"))); }
close() { this.readyState = Socket.CLOSING; }
ack(request: Record<string, unknown>, type: string, fields = {}) {
this.dispatchEvent(new MessageEvent("message", { data: JSON.stringify({ version: 9, id: request.id, type, ...fields }) }));
}
send(payload: string) {
const request = JSON.parse(payload) as Record<string, unknown>;
requests.push(request);
if (request.type === "set-microphone") return;
if (request.type === "list-microphones") {
queueMicrotask(() => this.ack(request, "microphone-list", { devices: [{ id: "headset", label: "USB Headset" }] }));
return;
}
queueMicrotask(() => this.ack(request,
request.type === "hello" ? "ready" : request.type === "start-share" ? "share-started" : "share-stopped",
request.type === "start-share" ? { shareId: request.shareId, audio: supported, codec: "vp8", ...(supported ? { sourceAudio: false } : {}) } : {}));
}
}
vi.stubGlobal("WebSocket", Socket);
vi.stubGlobal("window", { setTimeout, clearTimeout });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify({
...health, nativeMedia: { ...health.nativeMedia, ...(supported ? { microphone: true } : {}) },
}))));
const client = (await NativeClient.connect())!;
try {
const started = await client.startShare({ shareId: "share_123456", audio: false,
source: { kind: "display", sourceId: "1", title: "Screen" }, adapterIndex: 0, encoderIndex: 0,
edgeCapacity: 1, profile: DEFAULT_QUALITY_SETTINGS, codec: "vp8" });
expect(requests.at(-1)?.microphoneMixing).toBe(supported ? true : undefined);
expect(started.audio).toBe(supported);
if (!supported) {
await expect(client.setMicrophone("share_123456", true, 1)).rejects.toThrow();
await expect(client.microphones()).rejects.toThrow();
expect(requests.some(request => request.type === "set-microphone")).toBe(false);
return;
}
expect(await client.microphones()).toEqual([{ id: "headset", label: "USB Headset" }]);
const choosing = client.setMicrophone("share_123456", true, 1, "headset");
expect(requests.at(-1)).toMatchObject({ type: "set-microphone", deviceId: "headset", enabled: true });
socket.ack(requests.at(-1)!, "microphone-set");
await choosing;
requests.length = 0;
const pending = client.setMicrophoneVolume("share_123456", 0.1);
for (let value = 2; value <= 20; value++) expect(client.setMicrophoneVolume("share_123456", value / 10)).toBe(pending);
expect(requests.filter(request => request.type === "set-microphone")).toHaveLength(1);
socket.ack(requests.at(-1)!, "microphone-set");
await vi.waitFor(() => expect(requests.at(-1)?.volume).toBe(2));
const last = requests.at(-1)!;
expect(last).not.toHaveProperty("enabled");
await client.stopShare("share_123456");
socket.ack(last, "microphone-set");
await pending;
expect(requests.at(-1)?.type).toBe("stop-share");
} finally { client.close(); }
});
it.each([false, true])("requests receiver reuse only from a capable App (%s)", async (supported) => {
const requests: Record<string, unknown>[] = [];
class Socket extends EventTarget {
static readonly OPEN = 1;
static readonly CLOSING = 2;
readyState = Socket.OPEN;
protocol = `piik-client-v9.${health.instanceToken}`;
constructor() { super(); queueMicrotask(() => this.dispatchEvent(new Event("open"))); }
close() { this.readyState = Socket.CLOSING; }
send(payload: string) {
const request = JSON.parse(payload) as Record<string, unknown>;
requests.push(request);
queueMicrotask(() => this.dispatchEvent(new MessageEvent("message", { data: JSON.stringify({
version: 9, id: request.id, ...(request.type === "hello" ? { type: "ready" } : {
type: "receive-answer", shareId: request.shareId, connectionId: request.connectionId,
sdp: "answer", audio: false, codec: "vp8", ...(supported ? { reused: true } : {}),
}),
}) })));
}
}
vi.stubGlobal("WebSocket", Socket);
vi.stubGlobal("window", { setTimeout, clearTimeout });
vi.stubGlobal("fetch", vi.fn(async () => new Response(JSON.stringify({
...health, nativeMedia: { ...health.nativeMedia, ...(supported ? { receiverReuse: true } : {}) },
}))));
const client = (await NativeClient.connect())!;
try {
const result = await client.receiveOffer("share_123456", "connection_1234", { type: "offer", sdp: "offer" }, { iceServers: [] }, 2);
expect(requests.at(-1)).toEqual({ version: 9, id: expect.any(String), type: "receive-offer",
shareId: "share_123456", connectionId: "connection_1234", sdp: "offer", iceServers: [], edgeCapacity: 2,
...(supported ? { reuseReceiver: true } : {}),
});
expect(result.reused).toBe(supported);
} finally { client.close(); }
});
it("keeps 64-bit Windows identities as exact decimal strings", () => {
expect(
nativeCaptureTargetSchema.safeParse({
kind: "window",
sourceId: "12345678901234567890",
pid: 1234,
creationTime: "134327999999999999",
title: "Game",
}).success,
).toBe(true);
expect(
nativeCaptureTargetSchema.safeParse({
kind: "window",
sourceId: 12345678901234567890,
pid: 1234,
creationTime: 134327999999999999,
title: "Game",
}).success,
).toBe(false);
expect(
nativeCaptureTargetSchema.safeParse({
kind: "display",
sourceId: "65537",
title: "Display 1",
}).success,
).toBe(true);
expect(
nativeCaptureTargetSchema.safeParse({
kind: "picker",
sourceId: "1",
title: "System picker",
}).success,
).toBe(true);
});
it("fences native events by share and connection identity", () => {
const event = {
version: 9,
type: "edge-state",
shareId: "share_123456",
connectionId: "edge_1234567",
state: "connected",
};
expect(nativeEventSchema.safeParse(event).success).toBe(true);
expect(
nativeEventSchema.safeParse({ ...event, connectionId: "short" }).success,
).toBe(false);
expect(
nativeEventSchema.safeParse({ ...event, routeRevision: 1 }).success,
).toBe(false);
const path = {
version: 9,
type: "edge-path",
shareId: "share_123456",
connectionId: "edge_1234567",
localType: "host",
remoteType: "srflx",
natTraversalPath: "predicted",
};
expect(nativeEventSchema.safeParse(path).success).toBe(true);
const { natTraversalPath: _missing, ...incompletePath } = path;
expect(nativeEventSchema.safeParse(incompletePath).success).toBe(false);
});
it("keeps an unavailable preview advisory instead of treating it as media failure", () => {
const preview = {
version: 9,
id: "request_preview",
type: "source-preview",
sourceKey: "display:65537",
mime: "image/bmp",
data: "",
};
expect(sourcePreviewResponseSchema.safeParse(preview).success).toBe(true);
expect(sourcePreviewResponseSchema.safeParse({
...preview,
data: Buffer.alloc(54 + 320 * 180 * 3).toString("base64"),
}).success).toBe(true);
expect(sourcePreviewResponseSchema.safeParse({
...preview,
data: "A".repeat(256 * 1024 + 1),
}).success).toBe(false);
});
it("keeps native share lifecycle responses as strict acknowledgements", () => {
const profile = {
resolution: "1440p",
maxFramerate: 60,
maxBitrate: 12_000_000,
degradationPreference: "maintain-framerate",
screenAudioQuality: "very-high",
};
expect(shareStartedResponseSchema.safeParse({
version: 9,
id: "request_start",
type: "share-started",
shareId: "share_123456",
audio: true,
codec: "h264",
}).success).toBe(true);
expect(shareUpdatedResponseSchema.safeParse({
version: 9,
id: "request_update",
type: "share-updated",
shareId: "share_123456",
}).success).toBe(true);
expect(shareSourceReplacedResponseSchema.safeParse({
version: 9,
id: "request_source",
type: "share-source-replaced",
shareId: "share_123456",
}).success).toBe(true);
expect(shareUpdatedResponseSchema.safeParse({
version: 9,
id: "request_update",
type: "share-updated",
shareId: "share_123456",
profile,
}).success).toBe(false);
});
it("requires the actual Native codec instead of reporting Auto as media", () => {
const response = {
version: 9,
id: "request_receive",
type: "receive-answer",
shareId: "share_123456",
connectionId: "edge_1234567",
sdp: "v=0\r\n",
audio: false,
};
for (const codec of ["h264", "vp8"]) {
expect(receiveAnswerResponseSchema.safeParse({ ...response, codec }).success).toBe(true);
expect(shareStartedResponseSchema.safeParse({
version: 9, id: "request_start", type: "share-started",
shareId: response.shareId, audio: false, codec,
}).success).toBe(true);
}
expect(receiveAnswerResponseSchema.safeParse(response).success).toBe(false);
expect(receiveAnswerResponseSchema.safeParse({ ...response, codec: "auto" }).success).toBe(false);
});
it("accepts only internally consistent native quality evidence", () => {
const event = {
version: 9,
type: "edge-quality",
shareId: "share_123456",
connectionId: "edge_1234567",
sampleTimestampMs: 10_000,
sampleWindowMs: 2_000,
rtpStatsId: "pc_12345678",
trackIdentifier: "screen",
state: "degraded",
reason: "bandwidth",
intervalFramesEncoded: 60,
framesPerSecond: 30,
bitrateKbps: 3_000,
availableOutgoingKbps: 1_000,
width: 1280,
height: 720,
};
expect(nativeEventSchema.safeParse(event).success).toBe(true);
expect(
nativeEventSchema.safeParse({ ...event, reason: "none" }).success,
).toBe(false);
expect(
nativeEventSchema.safeParse({
...event,
state: "unknown",
reason: null,
}).success,
).toBe(true);
});
});