check-cross-client-sync.mjs

15.2 KB · raw

1import { existsSync, readFileSync, mkdtempSync } from "node:fs";2import { dirname, resolve } from "node:path";3import { fileURLToPath } from "node:url";4import { spawn } from "node:child_process";5import { tmpdir } from "node:os";67const browserRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");8const androidRoot = resolve(browserRoot, "../peach-android");9const localJavaHome = "/opt/homebrew/opt/openjdk@17";10const javaHome = process.env.JAVA_HOME ?? (existsSync(localJavaHome) ? localJavaHome : undefined);11const browserCoordinator = readFileSync(resolve(browserRoot, "src/background/sync-coordinator.ts"), "utf8");12const androidCoordinator = readFileSync(resolve(androidRoot, "app/src/main/java/com/peachpasswords/sync/SyncCoordinator.kt"), "utf8");13const browserSyncTypes = readFileSync(resolve(browserRoot, "src/shared/sync-types.ts"), "utf8");14const androidManifest = readFileSync(resolve(androidRoot, "app/src/main/java/com/peachpasswords/sync/DeviceManifestSupport.kt"), "utf8");15const androidSyncMessage = readFileSync(resolve(androidRoot, "app/src/main/java/com/peachpasswords/sync/SyncMessage.kt"), "utf8");16const browserPairedDevices = readFileSync(resolve(browserRoot, "src/background/paired-devices.ts"), "utf8");17const androidPairedDevices = readFileSync(resolve(androidRoot, "app/src/main/java/com/peachpasswords/sync/PairedDeviceStore.kt"), "utf8");1819// Keep the source guards as cheap secondary checks. The real gate below crosses20// a process boundary and exercises each production coordinator and JSON codec.21if (browserCoordinator.includes('helloIn.version === localVersion')) throw new Error("Browser still contains the forbidden equal-version fast path");22if (!browserCoordinator.includes("helloIn.deviceManifestVersion === DEVICE_MANIFEST_VERSION")) throw new Error("Browser does not negotiate device manifests from SYNC_HELLO");23if (!androidCoordinator.includes("val exchangeDeviceManifest = vault.negotiatesDeviceManifest(hello)")) throw new Error("Android does not negotiate device manifests from SYNC_HELLO");24if (!androidCoordinator.includes("peerVersion == DEVICE_MANIFEST_VERSION")) throw new Error("Android does not require an exact device-manifest version match");2526const manifestVersion = (source, declaration) => {27  const match = source.match(new RegExp(`${declaration}\\s*=\\s*(0x[0-9a-f]+|\\d+)`));28  if (!match) throw new Error(`Missing ${declaration} declaration`);29  return Number(match[1]);30};31if (manifestVersion(browserSyncTypes, "DEVICE_MANIFEST_VERSION") !== manifestVersion(androidManifest, "DEVICE_MANIFEST_VERSION")) {32  throw new Error("Browser and Android device-manifest versions differ");33}34const syncProtocolVersion = (source, label) => {35  const match = source.match(/SYNC_PROTOCOL_VERSION\s*=\s*(\d+)/);36  if (!match) throw new Error(`Missing SYNC_PROTOCOL_VERSION declaration in ${label}`);37  return Number(match[1]);38};39const browserProtocolVersion = syncProtocolVersion(browserSyncTypes, "Browser");40const androidProtocolVersion = syncProtocolVersion(androidCoordinator, "Android");41if (browserProtocolVersion !== androidProtocolVersion) {42  throw new Error(`Browser and Android Sync protocol versions differ (${browserProtocolVersion} vs ${androidProtocolVersion})`);43}44// Both clients must require exact equality, never a "greater-or-equal" pass.45if (browserCoordinator.includes("protocolVersion ?? 1) < SYNC_PROTOCOL_VERSION") ||46    androidCoordinator.includes("< SYNC_PROTOCOL_VERSION")) {47  throw new Error("A client still accepts a peer protocol version below its own");48}49if (!browserSyncTypes.includes("issuerSigningPublicKeyHex") || !browserSyncTypes.includes("signatureHex") ||50    !androidSyncMessage.includes("issuerSigningKeyHex") || !androidSyncMessage.includes("signatureHex")) {51  throw new Error("A client lacks signed revocation fields");52}53if (!browserPairedDevices.includes("MAX_REVOCATIONS = 500") || !androidPairedDevices.includes("MAX_REVOCATION_RECORDS = 500")) throw new Error("Browser and Android revocation ledger caps differ");54if (!browserPairedDevices.includes("enqueueDeviceMutation") || !androidPairedDevices.includes("RegistryMutationGate")) throw new Error("A paired-device registry lacks whole-list mutation serialization");55if (!browserPairedDevices.includes("function capRevocations") || !androidPairedDevices.includes("fun capRevocationRecords")) throw new Error("A client lacks largest-issuer-first revocation retention");56const browserEndpoint = String.raw`57import { createInterface } from "node:readline";58import { createServer, createConnection } from "node:net";59const root = process.env.PEACH_BROWSER_ROOT;60const coordinator = await import(root + "/src/background/sync-coordinator.ts");61const syncTypes = await import(root + "/src/shared/sync-types.ts");62const mode = process.env.PEACH_SYNC_HARNESS_MODE;63const portFile = process.env.PEACH_SYNC_HARNESS_PORT_FILE;64const transcriptFile = process.env.PEACH_SYNC_HARNESS_TRANSCRIPT_FILE;65const id = mode === "initiator" ? "browser" : "android";66const socket = await new Promise((resolve, reject) => {67  if (mode === "initiator") {68    const server = createServer((client) => {69      // Stop listening as soon as the one conformance peer connects. Leaving70      // this listener open keeps Bun alive after the coordinator completes.71      server.close();72      resolve(client);73    });74    server.once("error", reject);75    server.listen(0, "127.0.0.1", () => require("node:fs").writeFileSync(portFile, String(server.address().port)));76  } else {77    const client = createConnection({ host: "127.0.0.1", port: Number(process.env.PEACH_SYNC_HARNESS_PORT) });78    client.once("connect", () => resolve(client));79    client.once("error", reject);80  }81});82socket.setEncoding("utf8");83const lines = createInterface({ input: socket });84const iterator = lines[Symbol.asyncIterator]();85const events = [];86const typeOf = (message) => message.type;87const session = {88  remoteStaticPublicKey: new Uint8Array(32).fill(7),89  send(bytes) {90    const message = JSON.parse(new TextDecoder().decode(bytes));91    events.push("send:" + typeOf(message));92    socket.write(Buffer.from(bytes).toString("base64") + "\n");93  },94  async receive() {95    const next = await iterator.next();96    if (next.done) throw new Error("cross-client peer closed");97    const bytes = Uint8Array.from(Buffer.from(next.value.trim(), "base64"));98    events.push("recv:" + typeOf(JSON.parse(new TextDecoder().decode(bytes))));99    return bytes;100  },101  async close() { socket.end(); },102};103const entryId = id + "-entry";104const localMtime = id === "browser" ? 10 : 20;105const remoteMtime = id === "browser" ? 20 : 10;106const adapter = {107  async computeVaultId() { return "cross-client-vault"; },108  async getOurDeviceId() { return id; },109  async getLocalVersion() { return 7; },110  async buildEntryManifest() { return { [entryId]: localMtime }; },111  async buildTombstoneManifest() { return {}; },112  async getEncryptedEntries(ids) { return Object.fromEntries(ids.filter((value) => value === entryId).map((value) => [value, id + "-frame"])); },113  async applyEntries() {},114  async applyTombstones() {},115  async buildOutgoingDeviceManifest() { return { body: { manifestVersion: syncTypes.DEVICE_MANIFEST_VERSION, issuerDeviceId: id, issuedAt: 1700000000000, devices: [], revoked: [] }, signatureHex: "11".repeat(64) }; },116  async applyIncomingDeviceManifest() {},117};118const outcome = mode === "initiator"119  ? await coordinator.runSyncInitiator(session, adapter)120  : await coordinator.runSyncResponder(session, adapter);121require("node:fs").writeFileSync(transcriptFile, JSON.stringify({ status: outcome.status, events }));122socket.end();123`.replace("const remoteMtime = id === \"browser\" ? 20 : 10;", "");124125const MAX_DIAGNOSTIC_BYTES = 12_000;126127function spawnProcess(command, args, env) {128  const child = spawn(command, args, { cwd: env.PEACH_PROCESS_ROOT ?? env.PEACH_BROWSER_ROOT ?? browserRoot, env: { ...process.env, ...env }, stdio: ["ignore", "pipe", "pipe"] });129  const output = { stdout: "", stderr: "" };130  for (const [name, stream] of [["stdout", child.stdout], ["stderr", child.stderr]]) {131    stream.setEncoding("utf8");132    stream.on("data", (chunk) => {133      output[name] = (output[name] + chunk).slice(-MAX_DIAGNOSTIC_BYTES);134    });135  }136  child.diagnostics = output;137  return child;138}139140function waitForExit(child) {141  return new Promise((resolveExit, reject) => {142    child.once("error", reject);143    child.once("exit", (code, signal) => resolveExit({ code, signal, diagnostics: child.diagnostics }));144  });145}146147function terminate(child) {148  if (!child || child.exitCode !== null || child.signalCode !== null) return;149  child.kill("SIGTERM");150  setTimeout(() => {151    if (child.exitCode === null && child.signalCode === null) child.kill("SIGKILL");152  }, 1_000).unref();153}154155function formatResult(result) {156  const output = result.diagnostics;157  return `code=${result.code ?? "none"} signal=${result.signal ?? "none"}; stdout=${JSON.stringify(output.stdout)} stderr=${JSON.stringify(output.stderr)}`;158}159160async function waitForFile(path, child) {161  const deadline = Date.now() + 30_000;162  while (!existsSync(path)) {163    if (child.exitCode !== null) throw new Error(`endpoint exited before publishing ${path} (${child.exitCode})`);164    if (Date.now() > deadline) throw new Error(`timed out waiting for ${path}`);165    await new Promise((resolve) => setTimeout(resolve, 50));166  }167  return readFileSync(path, "utf8").trim();168}169170function readTranscript(path) {171  return JSON.parse(readFileSync(path, "utf8"));172}173174const androidTask = ["--no-daemon", "--no-configuration-cache", "--rerun-tasks", "testDebugUnitTest", "--tests", "com.peachpasswords.sync.CrossClientSyncProcessTest.exchange_production_frames_with_browser_process"];175const gradleProperty = (name, value) => `-D${name.toLowerCase().replaceAll("_", ".")}=${value}`;176177async function runRound({ initiator, mismatch = false }) {178  const dir = mkdtempSync(resolve(tmpdir(), "peach-cross-sync-"));179  const androidTranscript = resolve(dir, "android.json");180  const browserTranscript = resolve(dir, "browser.json");181  const androidPortFile = resolve(dir, "android.port");182  const browserPortFile = resolve(dir, "browser.port");183  const common = { PEACH_BROWSER_ROOT: browserRoot };184  const launchBrowser = (mode, port, transcript, portFile) => spawnProcess("bun", ["--eval", browserEndpoint], {185    ...common,186    PEACH_SYNC_HARNESS_MODE: mode,187    PEACH_SYNC_HARNESS_PORT: port ?? "",188    PEACH_SYNC_HARNESS_PORT_FILE: portFile ?? "",189    PEACH_SYNC_HARNESS_TRANSCRIPT_FILE: transcript,190  });191  const launchAndroid = (mode, port) => spawnProcess(resolve(androidRoot, "gradlew"), [192    gradleProperty("PEACH_SYNC_HARNESS_MODE", mode),193    gradleProperty("PEACH_SYNC_HARNESS_PORT", port ?? ""),194    gradleProperty("PEACH_SYNC_HARNESS_PORT_FILE", androidPortFile),195    gradleProperty("PEACH_SYNC_HARNESS_TRANSCRIPT_FILE", androidTranscript),196    ...(mismatch ? [gradleProperty("PEACH_SYNC_HARNESS_MISMATCH", "message-order")] : []),197    ...androidTask,198  ], {199    ...common,200    PEACH_PROCESS_ROOT: androidRoot,201    PEACH_SYNC_HARNESS_MODE: mode,202    PEACH_SYNC_HARNESS_PORT: port ?? "",203    PEACH_SYNC_HARNESS_PORT_FILE: androidPortFile,204    PEACH_SYNC_HARNESS_TRANSCRIPT_FILE: androidTranscript,205    ...(mismatch ? { PEACH_SYNC_HARNESS_MISMATCH: "message-order" } : {}),206    ...(javaHome ? { JAVA_HOME: javaHome } : {}),207  });208209  let first;210  let second;211  try {212    if (initiator === "android") {213      first = launchAndroid("initiator");214      const port = await waitForFile(androidPortFile, first);215      second = launchBrowser("responder", port, browserTranscript);216    } else {217      first = launchBrowser("initiator", undefined, browserTranscript, browserPortFile);218      const port = await waitForFile(browserPortFile, first);219      second = launchAndroid("responder", port);220    }221    const timeout = new Promise((_, reject) => setTimeout(() => reject(new Error(`cross-client ${initiator} round timed out after 120s`)), 120_000));222    const results = await Promise.race([223      Promise.all([waitForExit(first), waitForExit(second)]),224      timeout,225    ]);226    const [firstResult, secondResult] = results;227    if (!mismatch && (firstResult.code !== 0 || secondResult.code !== 0)) {228      throw new Error(`cross-client ${initiator} round failed: first ${formatResult(firstResult)}; second ${formatResult(secondResult)}`);229    }230    return { android: readTranscript(androidTranscript), browser: readTranscript(browserTranscript) };231  } catch (error) {232    const details = [first, second].filter(Boolean).map((child) => child.diagnostics).map((output) => `stdout=${JSON.stringify(output.stdout)} stderr=${JSON.stringify(output.stderr)}`).join("; ");233    throw new Error(`${error.message}; child diagnostics: ${details}`, { cause: error });234  } finally {235    terminate(first);236    terminate(second);237  }238}239240function assertTranscript(actual, expected, label) {241  const got = JSON.stringify(actual.events);242  const want = JSON.stringify(expected);243  if (got !== want) throw new Error(`${label} transcript mismatch: expected ${want}, got ${got}`);244}245246const androidInitiator = ["send:SYNC_HELLO", "recv:SYNC_HELLO", "send:SYNC_MANIFEST", "recv:SYNC_MANIFEST", "send:SYNC_REQUEST", "recv:SYNC_REQUEST", "send:SYNC_ENTRIES", "send:SYNC_TOMBSTONES", "recv:SYNC_TOMBSTONES", "send:SYNC_DEVICE_MANIFEST", "recv:SYNC_DEVICE_MANIFEST", "send:SYNC_DONE", "recv:SYNC_DONE"];247const browserResponder = ["recv:SYNC_HELLO", "send:SYNC_HELLO", "recv:SYNC_MANIFEST", "send:SYNC_MANIFEST", "recv:SYNC_REQUEST", "send:SYNC_REQUEST", "recv:SYNC_ENTRIES", "recv:SYNC_TOMBSTONES", "send:SYNC_TOMBSTONES", "recv:SYNC_DEVICE_MANIFEST", "send:SYNC_DEVICE_MANIFEST", "recv:SYNC_DONE", "send:SYNC_DONE"];248const browserInitiator = ["send:SYNC_HELLO", "recv:SYNC_HELLO", "send:SYNC_MANIFEST", "recv:SYNC_MANIFEST", "send:SYNC_REQUEST", "recv:SYNC_REQUEST", "send:SYNC_ENTRIES", "send:SYNC_TOMBSTONES", "recv:SYNC_TOMBSTONES", "send:SYNC_DEVICE_MANIFEST", "recv:SYNC_DEVICE_MANIFEST", "send:SYNC_DONE", "recv:SYNC_DONE"];249const androidResponder = ["recv:SYNC_HELLO", "send:SYNC_HELLO", "recv:SYNC_MANIFEST", "send:SYNC_MANIFEST", "recv:SYNC_REQUEST", "send:SYNC_REQUEST", "recv:SYNC_ENTRIES", "recv:SYNC_TOMBSTONES", "send:SYNC_TOMBSTONES", "recv:SYNC_DEVICE_MANIFEST", "send:SYNC_DEVICE_MANIFEST", "recv:SYNC_DONE", "send:SYNC_DONE"];250251const mismatch = await runRound({ initiator: "browser", mismatch: true });252if (mismatch.android.status === "COMPLETED" || mismatch.browser.status === "completed") throw new Error("intentional message-order mismatch unexpectedly completed");253const androidRound = await runRound({ initiator: "android" });254if (androidRound.android.status !== "COMPLETED" || androidRound.browser.status !== "completed") throw new Error("Android-initiated cross-client round did not complete");255assertTranscript(androidRound.android, androidInitiator, "Android initiator");256assertTranscript(androidRound.browser, browserResponder, "Browser responder");257const browserRound = await runRound({ initiator: "browser" });258if (browserRound.android.status !== "COMPLETED" || browserRound.browser.status !== "completed") throw new Error("Browser-initiated cross-client round did not complete");259assertTranscript(browserRound.browser, browserInitiator, "Browser initiator");260assertTranscript(browserRound.android, androidResponder, "Android responder");261console.log("Cross-client sync process conformance passed (both initiators, manifest negotiation, mismatch rejection).");