check-cross-client-sync.mjs

15.9 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 numericConstant = (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 (numericConstant(browserSyncTypes, "DEVICE_MANIFEST_VERSION") !== numericConstant(androidManifest, "DEVICE_MANIFEST_VERSION")) {32  throw new Error("Browser and Android device-manifest versions differ");33}34if (numericConstant(browserSyncTypes, "DEVICE_REVOCATION_RECORD_VERSION") !== numericConstant(androidSyncMessage, "DEVICE_REVOCATION_RECORD_VERSION")) {35  throw new Error("Browser and Android revocation record versions differ");36}37// The canonical revocation object is signed field-by-field, so a renamed or38// dropped field silently stops the two clients verifying each other.39for (const field of ["recordVersion", "deviceId", "longTermPublicKeyHex", "revokedByDeviceId"]) {40  if (!browserSyncTypes.includes(field) || !androidSyncMessage.includes(field)) {41    throw new Error(`A client lacks revocation field ${field}`);42  }43}44if (browserSyncTypes.includes("issuerSigningPublicKeyHex") || androidSyncMessage.includes("issuerSigningKeyHex")) {45  throw new Error("A client still carries an issuer key inside the revocation record");46}47const syncProtocolVersion = (source, label) => {48  const match = source.match(/SYNC_PROTOCOL_VERSION\s*=\s*(\d+)/);49  if (!match) throw new Error(`Missing SYNC_PROTOCOL_VERSION declaration in ${label}`);50  return Number(match[1]);51};52const browserProtocolVersion = syncProtocolVersion(browserSyncTypes, "Browser");53const androidProtocolVersion = syncProtocolVersion(androidCoordinator, "Android");54if (browserProtocolVersion !== androidProtocolVersion) {55  throw new Error(`Browser and Android Sync protocol versions differ (${browserProtocolVersion} vs ${androidProtocolVersion})`);56}57// Both clients must require exact equality, never a "greater-or-equal" pass.58if (browserCoordinator.includes("protocolVersion ?? 1) < SYNC_PROTOCOL_VERSION") ||59    androidCoordinator.includes("< SYNC_PROTOCOL_VERSION")) {60  throw new Error("A client still accepts a peer protocol version below its own");61}62if (!browserSyncTypes.includes("signatureHex") || !androidSyncMessage.includes("signatureHex")) {63  throw new Error("A client lacks the revocation signature field");64}65if (!browserPairedDevices.includes("MAX_REVOCATIONS = 500") || !androidPairedDevices.includes("MAX_REVOCATION_RECORDS = 500")) throw new Error("Browser and Android revocation ledger caps differ");66if (!browserPairedDevices.includes("enqueueDeviceMutation") || !androidPairedDevices.includes("RegistryMutationGate")) throw new Error("A paired-device registry lacks whole-list mutation serialization");67if (!browserPairedDevices.includes("function capRevocations") || !androidPairedDevices.includes("fun capRevocationRecords")) throw new Error("A client lacks largest-issuer-first revocation retention");68const browserEndpoint = String.raw`69import { createInterface } from "node:readline";70import { createServer, createConnection } from "node:net";71const root = process.env.PEACH_BROWSER_ROOT;72const coordinator = await import(root + "/src/background/sync-coordinator.ts");73const syncTypes = await import(root + "/src/shared/sync-types.ts");74const mode = process.env.PEACH_SYNC_HARNESS_MODE;75const portFile = process.env.PEACH_SYNC_HARNESS_PORT_FILE;76const transcriptFile = process.env.PEACH_SYNC_HARNESS_TRANSCRIPT_FILE;77const id = mode === "initiator" ? "browser" : "android";78const socket = await new Promise((resolve, reject) => {79  if (mode === "initiator") {80    const server = createServer((client) => {81      // Stop listening as soon as the one conformance peer connects. Leaving82      // this listener open keeps Bun alive after the coordinator completes.83      server.close();84      resolve(client);85    });86    server.once("error", reject);87    server.listen(0, "127.0.0.1", () => require("node:fs").writeFileSync(portFile, String(server.address().port)));88  } else {89    const client = createConnection({ host: "127.0.0.1", port: Number(process.env.PEACH_SYNC_HARNESS_PORT) });90    client.once("connect", () => resolve(client));91    client.once("error", reject);92  }93});94socket.setEncoding("utf8");95const lines = createInterface({ input: socket });96const iterator = lines[Symbol.asyncIterator]();97const events = [];98const typeOf = (message) => message.type;99const session = {100  remoteStaticPublicKey: new Uint8Array(32).fill(7),101  send(bytes) {102    const message = JSON.parse(new TextDecoder().decode(bytes));103    events.push("send:" + typeOf(message));104    socket.write(Buffer.from(bytes).toString("base64") + "\n");105  },106  async receive() {107    const next = await iterator.next();108    if (next.done) throw new Error("cross-client peer closed");109    const bytes = Uint8Array.from(Buffer.from(next.value.trim(), "base64"));110    events.push("recv:" + typeOf(JSON.parse(new TextDecoder().decode(bytes))));111    return bytes;112  },113  async close() { socket.end(); },114};115const entryId = id + "-entry";116const localMtime = id === "browser" ? 10 : 20;117const remoteMtime = id === "browser" ? 20 : 10;118const adapter = {119  async computeVaultId() { return "cross-client-vault"; },120  async getOurDeviceId() { return id; },121  async getLocalVersion() { return 7; },122  async buildEntryManifest() { return { [entryId]: localMtime }; },123  async buildTombstoneManifest() { return {}; },124  async getEncryptedEntries(ids) { return Object.fromEntries(ids.filter((value) => value === entryId).map((value) => [value, id + "-frame"])); },125  async applyEntries() {},126  async applyTombstones() {},127  async buildOutgoingDeviceManifest() { return { body: { manifestVersion: syncTypes.DEVICE_MANIFEST_VERSION, issuerDeviceId: id, issuedAt: 1700000000000, devices: [], revoked: [] }, signatureHex: "11".repeat(64) }; },128  async applyIncomingDeviceManifest() {},129};130const outcome = mode === "initiator"131  ? await coordinator.runSyncInitiator(session, adapter)132  : await coordinator.runSyncResponder(session, adapter);133require("node:fs").writeFileSync(transcriptFile, JSON.stringify({ status: outcome.status, events }));134socket.end();135`.replace("const remoteMtime = id === \"browser\" ? 20 : 10;", "");136137const MAX_DIAGNOSTIC_BYTES = 12_000;138139function spawnProcess(command, args, env) {140  const child = spawn(command, args, { cwd: env.PEACH_PROCESS_ROOT ?? env.PEACH_BROWSER_ROOT ?? browserRoot, env: { ...process.env, ...env }, stdio: ["ignore", "pipe", "pipe"] });141  const output = { stdout: "", stderr: "" };142  for (const [name, stream] of [["stdout", child.stdout], ["stderr", child.stderr]]) {143    stream.setEncoding("utf8");144    stream.on("data", (chunk) => {145      output[name] = (output[name] + chunk).slice(-MAX_DIAGNOSTIC_BYTES);146    });147  }148  child.diagnostics = output;149  return child;150}151152function waitForExit(child) {153  return new Promise((resolveExit, reject) => {154    child.once("error", reject);155    child.once("exit", (code, signal) => resolveExit({ code, signal, diagnostics: child.diagnostics }));156  });157}158159function terminate(child) {160  if (!child || child.exitCode !== null || child.signalCode !== null) return;161  child.kill("SIGTERM");162  setTimeout(() => {163    if (child.exitCode === null && child.signalCode === null) child.kill("SIGKILL");164  }, 1_000).unref();165}166167function formatResult(result) {168  const output = result.diagnostics;169  return `code=${result.code ?? "none"} signal=${result.signal ?? "none"}; stdout=${JSON.stringify(output.stdout)} stderr=${JSON.stringify(output.stderr)}`;170}171172async function waitForFile(path, child) {173  const deadline = Date.now() + 30_000;174  while (!existsSync(path)) {175    if (child.exitCode !== null) throw new Error(`endpoint exited before publishing ${path} (${child.exitCode})`);176    if (Date.now() > deadline) throw new Error(`timed out waiting for ${path}`);177    await new Promise((resolve) => setTimeout(resolve, 50));178  }179  return readFileSync(path, "utf8").trim();180}181182function readTranscript(path) {183  return JSON.parse(readFileSync(path, "utf8"));184}185186const androidTask = ["--no-daemon", "--no-configuration-cache", "--rerun-tasks", "testDebugUnitTest", "--tests", "com.peachpasswords.sync.CrossClientSyncProcessTest.exchange_production_frames_with_browser_process"];187const gradleProperty = (name, value) => `-D${name.toLowerCase().replaceAll("_", ".")}=${value}`;188189async function runRound({ initiator, mismatch = false }) {190  const dir = mkdtempSync(resolve(tmpdir(), "peach-cross-sync-"));191  const androidTranscript = resolve(dir, "android.json");192  const browserTranscript = resolve(dir, "browser.json");193  const androidPortFile = resolve(dir, "android.port");194  const browserPortFile = resolve(dir, "browser.port");195  const common = { PEACH_BROWSER_ROOT: browserRoot };196  const launchBrowser = (mode, port, transcript, portFile) => spawnProcess("bun", ["--eval", browserEndpoint], {197    ...common,198    PEACH_SYNC_HARNESS_MODE: mode,199    PEACH_SYNC_HARNESS_PORT: port ?? "",200    PEACH_SYNC_HARNESS_PORT_FILE: portFile ?? "",201    PEACH_SYNC_HARNESS_TRANSCRIPT_FILE: transcript,202  });203  const launchAndroid = (mode, port) => spawnProcess(resolve(androidRoot, "gradlew"), [204    gradleProperty("PEACH_SYNC_HARNESS_MODE", mode),205    gradleProperty("PEACH_SYNC_HARNESS_PORT", port ?? ""),206    gradleProperty("PEACH_SYNC_HARNESS_PORT_FILE", androidPortFile),207    gradleProperty("PEACH_SYNC_HARNESS_TRANSCRIPT_FILE", androidTranscript),208    ...(mismatch ? [gradleProperty("PEACH_SYNC_HARNESS_MISMATCH", "message-order")] : []),209    ...androidTask,210  ], {211    ...common,212    PEACH_PROCESS_ROOT: androidRoot,213    PEACH_SYNC_HARNESS_MODE: mode,214    PEACH_SYNC_HARNESS_PORT: port ?? "",215    PEACH_SYNC_HARNESS_PORT_FILE: androidPortFile,216    PEACH_SYNC_HARNESS_TRANSCRIPT_FILE: androidTranscript,217    ...(mismatch ? { PEACH_SYNC_HARNESS_MISMATCH: "message-order" } : {}),218    ...(javaHome ? { JAVA_HOME: javaHome } : {}),219  });220221  let first;222  let second;223  try {224    if (initiator === "android") {225      first = launchAndroid("initiator");226      const port = await waitForFile(androidPortFile, first);227      second = launchBrowser("responder", port, browserTranscript);228    } else {229      first = launchBrowser("initiator", undefined, browserTranscript, browserPortFile);230      const port = await waitForFile(browserPortFile, first);231      second = launchAndroid("responder", port);232    }233    const timeout = new Promise((_, reject) => setTimeout(() => reject(new Error(`cross-client ${initiator} round timed out after 120s`)), 120_000));234    const results = await Promise.race([235      Promise.all([waitForExit(first), waitForExit(second)]),236      timeout,237    ]);238    const [firstResult, secondResult] = results;239    if (!mismatch && (firstResult.code !== 0 || secondResult.code !== 0)) {240      throw new Error(`cross-client ${initiator} round failed: first ${formatResult(firstResult)}; second ${formatResult(secondResult)}`);241    }242    return { android: readTranscript(androidTranscript), browser: readTranscript(browserTranscript) };243  } catch (error) {244    const details = [first, second].filter(Boolean).map((child) => child.diagnostics).map((output) => `stdout=${JSON.stringify(output.stdout)} stderr=${JSON.stringify(output.stderr)}`).join("; ");245    throw new Error(`${error.message}; child diagnostics: ${details}`, { cause: error });246  } finally {247    terminate(first);248    terminate(second);249  }250}251252function assertTranscript(actual, expected, label) {253  const got = JSON.stringify(actual.events);254  const want = JSON.stringify(expected);255  if (got !== want) throw new Error(`${label} transcript mismatch: expected ${want}, got ${got}`);256}257258const 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"];259const 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"];260const 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"];261const 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"];262263const mismatch = await runRound({ initiator: "browser", mismatch: true });264if (mismatch.android.status === "COMPLETED" || mismatch.browser.status === "completed") throw new Error("intentional message-order mismatch unexpectedly completed");265const androidRound = await runRound({ initiator: "android" });266if (androidRound.android.status !== "COMPLETED" || androidRound.browser.status !== "completed") throw new Error("Android-initiated cross-client round did not complete");267assertTranscript(androidRound.android, androidInitiator, "Android initiator");268assertTranscript(androidRound.browser, browserResponder, "Browser responder");269const browserRound = await runRound({ initiator: "browser" });270if (browserRound.android.status !== "COMPLETED" || browserRound.browser.status !== "completed") throw new Error("Browser-initiated cross-client round did not complete");271assertTranscript(browserRound.browser, browserInitiator, "Browser initiator");272assertTranscript(browserRound.android, androidResponder, "Android responder");273console.log("Cross-client sync process conformance passed (both initiators, manifest negotiation, mismatch rejection).");