check-cross-client-sync.mjs

13.5 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 browserPairedDevices = readFileSync(resolve(browserRoot, "src/background/paired-devices.ts"), "utf8");16const androidPairedDevices = readFileSync(resolve(androidRoot, "app/src/main/java/com/peachpasswords/sync/PairedDeviceStore.kt"), "utf8");1718// Keep the source guards as cheap secondary checks. The real gate below crosses19// a process boundary and exercises each production coordinator and JSON codec.20if (browserCoordinator.includes('helloIn.version === localVersion')) throw new Error("Browser still contains the forbidden equal-version fast path");21if (!browserCoordinator.includes("helloIn.deviceManifestVersion === DEVICE_MANIFEST_VERSION")) throw new Error("Browser does not negotiate device manifests from SYNC_HELLO");22if (!androidCoordinator.includes("val exchangeDeviceManifest = vault.negotiatesDeviceManifest(hello)")) throw new Error("Android does not negotiate device manifests from SYNC_HELLO");23if (!androidCoordinator.includes("peerVersion == DEVICE_MANIFEST_VERSION")) throw new Error("Android does not require an exact device-manifest version match");24if (!browserSyncTypes.includes("DEVICE_MANIFEST_VERSION = 0x04") || !androidManifest.includes("DEVICE_MANIFEST_VERSION = 0x04")) throw new Error("Browser and Android device-manifest versions differ");25if (!browserPairedDevices.includes("MAX_REVOCATIONS = 500") || !androidPairedDevices.includes("MAX_REVOCATION_RECORDS = 500")) throw new Error("Browser and Android revocation ledger caps differ");26if (!browserPairedDevices.includes("enqueueDeviceMutation") || !androidPairedDevices.includes("RegistryMutationGate")) throw new Error("A paired-device registry lacks whole-list mutation serialization");27if (!browserPairedDevices.includes("function capRevocations") || !androidPairedDevices.includes("fun capRevocationRecords")) throw new Error("A client lacks largest-issuer-first revocation retention");2829const browserEndpoint = String.raw`30import { createInterface } from "node:readline";31import { createServer, createConnection } from "node:net";32const root = process.env.PEACH_BROWSER_ROOT;33const coordinator = await import(root + "/src/background/sync-coordinator.ts");34const mode = process.env.PEACH_SYNC_HARNESS_MODE;35const portFile = process.env.PEACH_SYNC_HARNESS_PORT_FILE;36const transcriptFile = process.env.PEACH_SYNC_HARNESS_TRANSCRIPT_FILE;37const id = mode === "initiator" ? "browser" : "android";38const socket = await new Promise((resolve, reject) => {39  if (mode === "initiator") {40    const server = createServer((client) => {41      // Stop listening as soon as the one conformance peer connects. Leaving42      // this listener open keeps Bun alive after the coordinator completes.43      server.close();44      resolve(client);45    });46    server.once("error", reject);47    server.listen(0, "127.0.0.1", () => require("node:fs").writeFileSync(portFile, String(server.address().port)));48  } else {49    const client = createConnection({ host: "127.0.0.1", port: Number(process.env.PEACH_SYNC_HARNESS_PORT) });50    client.once("connect", () => resolve(client));51    client.once("error", reject);52  }53});54socket.setEncoding("utf8");55const lines = createInterface({ input: socket });56const iterator = lines[Symbol.asyncIterator]();57const events = [];58const typeOf = (message) => message.type;59const session = {60  remoteStaticPublicKey: new Uint8Array(32).fill(7),61  send(bytes) {62    const message = JSON.parse(new TextDecoder().decode(bytes));63    events.push("send:" + typeOf(message));64    socket.write(Buffer.from(bytes).toString("base64") + "\n");65  },66  async receive() {67    const next = await iterator.next();68    if (next.done) throw new Error("cross-client peer closed");69    const bytes = Uint8Array.from(Buffer.from(next.value.trim(), "base64"));70    events.push("recv:" + typeOf(JSON.parse(new TextDecoder().decode(bytes))));71    return bytes;72  },73  async close() { socket.end(); },74};75const entryId = id + "-entry";76const localMtime = id === "browser" ? 10 : 20;77const remoteMtime = id === "browser" ? 20 : 10;78const adapter = {79  async computeVaultId() { return "cross-client-vault"; },80  async getOurDeviceId() { return id; },81  async getLocalVersion() { return 7; },82  async buildEntryManifest() { return { [entryId]: localMtime }; },83  async buildTombstoneManifest() { return {}; },84  async getEncryptedEntries(ids) { return Object.fromEntries(ids.filter((value) => value === entryId).map((value) => [value, id + "-frame"])); },85  async applyEntries() {},86  async applyTombstones() {},87  async buildOutgoingDeviceManifest() { return { body: { manifestVersion: 4, issuerDeviceId: id, issuedAt: 1700000000000, devices: [], revoked: [] }, signatureHex: "11".repeat(64) }; },88  async applyIncomingDeviceManifest() {},89};90const outcome = mode === "initiator"91  ? await coordinator.runSyncInitiator(session, adapter)92  : await coordinator.runSyncResponder(session, adapter);93require("node:fs").writeFileSync(transcriptFile, JSON.stringify({ status: outcome.status, events }));94socket.end();95`.replace("const remoteMtime = id === \"browser\" ? 20 : 10;", "");9697const MAX_DIAGNOSTIC_BYTES = 12_000;9899function spawnProcess(command, args, env) {100  const child = spawn(command, args, { cwd: env.PEACH_PROCESS_ROOT ?? env.PEACH_BROWSER_ROOT ?? browserRoot, env: { ...process.env, ...env }, stdio: ["ignore", "pipe", "pipe"] });101  const output = { stdout: "", stderr: "" };102  for (const [name, stream] of [["stdout", child.stdout], ["stderr", child.stderr]]) {103    stream.setEncoding("utf8");104    stream.on("data", (chunk) => {105      output[name] = (output[name] + chunk).slice(-MAX_DIAGNOSTIC_BYTES);106    });107  }108  child.diagnostics = output;109  return child;110}111112function waitForExit(child) {113  return new Promise((resolveExit, reject) => {114    child.once("error", reject);115    child.once("exit", (code, signal) => resolveExit({ code, signal, diagnostics: child.diagnostics }));116  });117}118119function terminate(child) {120  if (!child || child.exitCode !== null || child.signalCode !== null) return;121  child.kill("SIGTERM");122  setTimeout(() => {123    if (child.exitCode === null && child.signalCode === null) child.kill("SIGKILL");124  }, 1_000).unref();125}126127function formatResult(result) {128  const output = result.diagnostics;129  return `code=${result.code ?? "none"} signal=${result.signal ?? "none"}; stdout=${JSON.stringify(output.stdout)} stderr=${JSON.stringify(output.stderr)}`;130}131132async function waitForFile(path, child) {133  const deadline = Date.now() + 30_000;134  while (!existsSync(path)) {135    if (child.exitCode !== null) throw new Error(`endpoint exited before publishing ${path} (${child.exitCode})`);136    if (Date.now() > deadline) throw new Error(`timed out waiting for ${path}`);137    await new Promise((resolve) => setTimeout(resolve, 50));138  }139  return readFileSync(path, "utf8").trim();140}141142function readTranscript(path) {143  return JSON.parse(readFileSync(path, "utf8"));144}145146const androidTask = ["--no-daemon", "--no-configuration-cache", "--rerun-tasks", "testDebugUnitTest", "--tests", "com.peachpasswords.sync.CrossClientSyncProcessTest.exchange_production_frames_with_browser_process"];147const gradleProperty = (name, value) => `-D${name.toLowerCase().replaceAll("_", ".")}=${value}`;148149async function runRound({ initiator, mismatch = false }) {150  const dir = mkdtempSync(resolve(tmpdir(), "peach-cross-sync-"));151  const androidTranscript = resolve(dir, "android.json");152  const browserTranscript = resolve(dir, "browser.json");153  const androidPortFile = resolve(dir, "android.port");154  const browserPortFile = resolve(dir, "browser.port");155  const common = { PEACH_BROWSER_ROOT: browserRoot };156  const launchBrowser = (mode, port, transcript, portFile) => spawnProcess("bun", ["--eval", browserEndpoint], {157    ...common,158    PEACH_SYNC_HARNESS_MODE: mode,159    PEACH_SYNC_HARNESS_PORT: port ?? "",160    PEACH_SYNC_HARNESS_PORT_FILE: portFile ?? "",161    PEACH_SYNC_HARNESS_TRANSCRIPT_FILE: transcript,162  });163  const launchAndroid = (mode, port) => spawnProcess(resolve(androidRoot, "gradlew"), [164    gradleProperty("PEACH_SYNC_HARNESS_MODE", mode),165    gradleProperty("PEACH_SYNC_HARNESS_PORT", port ?? ""),166    gradleProperty("PEACH_SYNC_HARNESS_PORT_FILE", androidPortFile),167    gradleProperty("PEACH_SYNC_HARNESS_TRANSCRIPT_FILE", androidTranscript),168    ...(mismatch ? [gradleProperty("PEACH_SYNC_HARNESS_MISMATCH", "message-order")] : []),169    ...androidTask,170  ], {171    ...common,172    PEACH_PROCESS_ROOT: androidRoot,173    PEACH_SYNC_HARNESS_MODE: mode,174    PEACH_SYNC_HARNESS_PORT: port ?? "",175    PEACH_SYNC_HARNESS_PORT_FILE: androidPortFile,176    PEACH_SYNC_HARNESS_TRANSCRIPT_FILE: androidTranscript,177    ...(mismatch ? { PEACH_SYNC_HARNESS_MISMATCH: "message-order" } : {}),178    ...(javaHome ? { JAVA_HOME: javaHome } : {}),179  });180181  let first;182  let second;183  try {184    if (initiator === "android") {185      first = launchAndroid("initiator");186      const port = await waitForFile(androidPortFile, first);187      second = launchBrowser("responder", port, browserTranscript);188    } else {189      first = launchBrowser("initiator", undefined, browserTranscript, browserPortFile);190      const port = await waitForFile(browserPortFile, first);191      second = launchAndroid("responder", port);192    }193    const timeout = new Promise((_, reject) => setTimeout(() => reject(new Error(`cross-client ${initiator} round timed out after 120s`)), 120_000));194    const results = await Promise.race([195      Promise.all([waitForExit(first), waitForExit(second)]),196      timeout,197    ]);198    const [firstResult, secondResult] = results;199    if (!mismatch && (firstResult.code !== 0 || secondResult.code !== 0)) {200      throw new Error(`cross-client ${initiator} round failed: first ${formatResult(firstResult)}; second ${formatResult(secondResult)}`);201    }202    return { android: readTranscript(androidTranscript), browser: readTranscript(browserTranscript) };203  } catch (error) {204    const details = [first, second].filter(Boolean).map((child) => child.diagnostics).map((output) => `stdout=${JSON.stringify(output.stdout)} stderr=${JSON.stringify(output.stderr)}`).join("; ");205    throw new Error(`${error.message}; child diagnostics: ${details}`, { cause: error });206  } finally {207    terminate(first);208    terminate(second);209  }210}211212function assertTranscript(actual, expected, label) {213  const got = JSON.stringify(actual.events);214  const want = JSON.stringify(expected);215  if (got !== want) throw new Error(`${label} transcript mismatch: expected ${want}, got ${got}`);216}217218const 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"];219const 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"];220const 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"];221const 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"];222223const mismatch = await runRound({ initiator: "browser", mismatch: true });224if (mismatch.android.status === "COMPLETED" || mismatch.browser.status === "completed") throw new Error("intentional message-order mismatch unexpectedly completed");225const androidRound = await runRound({ initiator: "android" });226if (androidRound.android.status !== "COMPLETED" || androidRound.browser.status !== "completed") throw new Error("Android-initiated cross-client round did not complete");227assertTranscript(androidRound.android, androidInitiator, "Android initiator");228assertTranscript(androidRound.browser, browserResponder, "Browser responder");229const browserRound = await runRound({ initiator: "browser" });230if (browserRound.android.status !== "COMPLETED" || browserRound.browser.status !== "completed") throw new Error("Browser-initiated cross-client round did not complete");231assertTranscript(browserRound.browser, browserInitiator, "Browser initiator");232assertTranscript(browserRound.android, androidResponder, "Android responder");233console.log("Cross-client sync process conformance passed (both initiators, manifest negotiation, mismatch rejection).");