@pyric/cli 0.1.0-alpha.11 → 0.1.0-alpha.12

package/src/bridge/server.ts

@@ -0,0 +1,28 @@
+/**
+ * `@pyric/cli/bridge` — Node-side entry.
+ *
+ * Resolved by the `node` condition in `package.json`'s exports map.
+ * Exports the bridge core (`createBridge`) and the standalone server
+ * (`startServer`). The Vite integration is the `pyric({ bridge })`
+ * plugin in `@pyric/cli/vite` (the firebase→sandbox swap AND the bridge in
+ * one plugin), not a bridge-only plugin here.
+ *
+ * The browser-side `connectBridge` lives in `./client.ts` and is
+ * resolved by the `browser` condition. Wire format shared by both
+ * lives in `./protocol.ts` (type-only, no runtime imports across the
+ * boundary).
+ */
+
+export type { HealthReport } from './protocol.js';
+export {
+  DEFAULT_BRIDGE_PORT,
+  DEFAULT_HEALTH_PATH,
+  DEFAULT_MCP_PATH,
+  DEFAULT_SANDBOX_PATH,
+} from './protocol.js';
+
+export { createBridge } from './server/bridge.js';
+export type { Bridge, BridgeOptions } from './server/bridge.js';
+
+export { startServer } from './server/standalone.js';
+export type { ServerHandle, StartServerOptions } from './server/standalone.js';

package/src/cli/can-i-use.ts

@@ -0,0 +1,50 @@
+import type { ParsedArgs } from './parse-args.js';
+import { canIUse } from '../conformance/index.js';
+
+/** Query feature support. This is discovery, independent of rules-fixture
+ * verification, so it owns a top-level CLI command. */
+export function runCanIUse(parsed: ParsedArgs): number {
+  for (const [flag, value] of parsed.flags) {
+    const validJsonValue = flag === 'json' && (value === true || value === 'true' || value === 'false');
+    if (!validJsonValue) {
+      const rendered = value === true ? `--${flag}` : `--${flag}=${String(value)}`;
+      process.stderr.write(`pyric can-i-use: unknown option '${rendered}'\n`);
+      return 1;
+    }
+  }
+  const feature = parsed.positional.join(' ');
+  if (!feature.trim()) {
+    process.stderr.write('pyric can-i-use: provide a developer feature name\n');
+    return 1;
+  }
+  const result = canIUse(feature);
+  const jsonFlag = parsed.flags.get('json');
+  if (jsonFlag === true || jsonFlag === 'true') {
+    process.stdout.write(JSON.stringify(result) + '\n');
+    return result.match === 'exact' ? 0 : 1;
+  }
+  if (result.match === 'none') {
+    process.stdout.write(`No conformance feature matched "${feature}".\n`);
+    return 1;
+  }
+  if (result.match === 'suggestions') {
+    process.stdout.write(`No exact conformance feature matched "${feature}". Did you mean:\n`);
+    for (const support of result.supports) process.stdout.write(`  ${support.surface}/${support.feature}\n`);
+    return 1;
+  }
+  if (result.match === 'ambiguous') {
+    process.stdout.write(`"${feature}" matches more than one surface:\n`);
+  }
+  for (const support of result.supports) {
+    process.stdout.write(
+      `${support.feature} (${support.surface})\n` +
+        `  availability: ${support.availability}\n` +
+        `  fidelity: ${support.fidelity}\n` +
+        `  assurance: ${support.assurance}\n` +
+        `  evidence: ${support.evidenceSlug}\n` +
+        `  ${support.summary}\n`,
+    );
+    for (const caveat of support.caveats) process.stdout.write(`  caveat: ${caveat}\n`);
+  }
+  return result.match === 'exact' ? 0 : 1;
+}

package/src/cli/cli.test.ts

@@ -0,0 +1,493 @@
+/**
+ * CLI argument-parsing + dispatch tests.
+ *
+ * Each subcommand handler accepts an injectable `deps` arg so the
+ * tests assert dispatch happens with the right shape without going
+ * near the real Google APIs, real disk reads, or real service-account
+ * loading. The injection seam is the contract — these tests pin it.
+ *
+ * Conventions:
+ *   - `bufferIo()` returns `{ stdout, stderr, getOut, getErr }`
+ *     suitable for handing to any subcommand's `deps`.
+ *   - Argv is parsed via the real `parseArgs` to exercise the CLI's
+ *     flag handling end-to-end (no shortcuts).
+ */
+
+import { describe, it, expect, mock } from 'bun:test';
+
+import { parseArgs } from './parse-args.js';
+import { runRulesLint, runRulesValidate, runRulesSimulate } from './rules.js';
+import {
+  runDatabaseRulesLint,
+  runDatabaseRulesValidate,
+  runDatabaseRulesSimulate,
+  runDatabaseRulesGenerate,
+} from './database-rules.js';
+import { runInit } from './init.js';
+
+// ── Test helpers ──────────────────────────────────────────────────────
+
+function bufferIo() {
+  let outBuf = '';
+  let errBuf = '';
+  return {
+    stdout: { write(s: string): void { outBuf += s; } },
+    stderr: { write(s: string): void { errBuf += s; } },
+    getOut: () => outBuf,
+    getErr: () => errBuf,
+  };
+}
+
+function serviceArgs(argv: string[]) {
+  const parsed = parseArgs(argv);
+  return { ...parsed, positional: parsed.positional.slice(2) };
+}
+
+// ── parseArgs ─────────────────────────────────────────────────────────
+
+describe('parseArgs', () => {
+  it('captures subcommand + positionals + long flags', () => {
+    const p = parseArgs(['verify', 'capture.json', '--project', 'my-proj']);
+    expect(p.subcommand).toBe('verify');
+    expect(p.positional).toEqual(['capture.json']);
+    expect(p.flags.get('project')).toBe('my-proj');
+  });
+
+  it('parses --flag=value syntax', () => {
+    const p = parseArgs(['firestore', 'rules', 'simulate', '--stdin=true']);
+    expect(p.flags.get('stdin')).toBe('true');
+  });
+
+  it('treats a flag without a value as boolean true', () => {
+    const p = parseArgs(['firestore', 'rules', 'simulate', '--stdin']);
+    expect(p.flags.get('stdin')).toBe(true);
+  });
+
+  it('preserves repeated long flags in order', () => {
+    const p = parseArgs([
+      'verify',
+      '--service',
+      'firestore',
+      '--service',
+      'rtdb',
+      '--rules=firestore=firestore.rules',
+      '--rules',
+      'rtdb=database.rules.json',
+    ]);
+    expect(p.flags.get('service')).toEqual(['firestore', 'rtdb']);
+    expect(p.flags.get('rules')).toEqual([
+      'firestore=firestore.rules',
+      'rtdb=database.rules.json',
+    ]);
+  });
+});
+
+// ── rules ─────────────────────────────────────────────────────────────
+
+describe('runRulesLint', () => {
+  it('errors out when no path given', async () => {
+    const io = bufferIo();
+    const code = await runRulesLint(serviceArgs(['firestore', 'rules', 'lint']), { ...io });
+    expect(code).toBe(1);
+    expect(io.getErr()).toContain('missing rules-file path');
+  });
+
+  it('passes the source to the linter and prints JSON', async () => {
+    const io = bufferIo();
+    const lintFn = mock(() => ({ warnings: [], metrics: { sourceSize: 5 } as never }));
+    const code = await runRulesLint(serviceArgs(['firestore', 'rules', 'lint', 'firestore.rules']), {
+      ...io,
+      cwd: '/tmp',
+      readFile: (async () => 'source') as never,
+      lintFirestoreRules: lintFn as never,
+    });
+    expect(code).toBe(0);
+    expect(lintFn).toHaveBeenCalledTimes(1);
+    expect(lintFn).toHaveBeenCalledWith('source');
+    const out = JSON.parse(io.getOut()) as { warnings: unknown[] };
+    expect(out.warnings).toEqual([]);
+  });
+});
+
+describe('runRulesValidate', () => {
+  it('errors out when no path given', async () => {
+    const io = bufferIo();
+    const code = await runRulesValidate(serviceArgs(['firestore', 'rules', 'validate']), { ...io });
+    expect(code).toBe(1);
+  });
+
+  it('reports parse failure with exit 2 on invalid rules', async () => {
+    const io = bufferIo();
+    const code = await runRulesValidate(serviceArgs(['firestore', 'rules', 'validate', 'bad.rules']), {
+      ...io,
+      cwd: '/tmp',
+      readFile: (async () => 'not valid rules at all') as never,
+    });
+    expect(code).toBe(2);
+    expect(io.getErr()).toContain('failed to parse');
+  });
+});
+
+describe('runRulesSimulate', () => {
+  it('runs a sample test against firebase.json rules path', async () => {
+    const io = bufferIo();
+    const simulateFn = mock(() => ({
+      success: true,
+      data: { results: [], passed: 0, failed: 0 },
+    } as never));
+    const code = await runRulesSimulate(serviceArgs(['firestore', 'rules', 'simulate']), {
+      ...io,
+      cwd: '/tmp',
+      readFirebaseJson: async () => ({ firestore: { rules: 'firestore.rules' } }),
+      readFile: (async () => 'rules source') as never,
+      simulate: simulateFn as never,
+    });
+    expect(code).toBe(0);
+    expect(simulateFn).toHaveBeenCalledTimes(1);
+    const callArgs = (simulateFn.mock.calls[0] ?? []) as [string, unknown[]];
+    expect(callArgs[0]).toBe('rules source');
+    expect(callArgs[1]).toHaveLength(1);
+  });
+
+  it('reads request from stdin when --stdin is set', async () => {
+    const io = bufferIo();
+    const simulateFn = mock(() => ({ success: true, data: { results: [], passed: 0, failed: 0 } } as never));
+    const code = await runRulesSimulate(serviceArgs(['firestore', 'rules', 'simulate', '--stdin']), {
+      ...io,
+      cwd: '/tmp',
+      readStdin: async () =>
+        JSON.stringify({
+          source: 'inline rules',
+          testCases: [
+            { description: 't', expectation: 'ALLOW', method: 'get', path: 'x/1', auth: null },
+            { description: 't2', expectation: 'DENY', method: 'get', path: 'x/2', auth: null },
+          ],
+        }),
+      simulate: simulateFn as never,
+    });
+    expect(code).toBe(0);
+    const callArgs = (simulateFn.mock.calls[0] ?? []) as [string, unknown[]];
+    expect(callArgs[0]).toBe('inline rules');
+    expect(callArgs[1]).toHaveLength(2);
+  });
+});
+
+// ── database rules ───────────────────────────────────────────────────
+
+describe('runDatabaseRulesLint', () => {
+  it('errors out when no path given', async () => {
+    const io = bufferIo();
+    const code = await runDatabaseRulesLint(serviceArgs(['database', 'rules', 'lint']), { ...io });
+    expect(code).toBe(1);
+    expect(io.getErr()).toContain('missing rules-file path');
+  });
+
+  it('prints RTDB expression lints as JSON', async () => {
+    const io = bufferIo();
+    const code = await runDatabaseRulesLint(serviceArgs(['database', 'rules', 'lint', 'database.rules.json']), {
+      ...io,
+      cwd: '/tmp',
+      readFile: (async () => '{"rules":{".read":true,".write":false}}') as never,
+    });
+    expect(code).toBe(0);
+    const out = JSON.parse(io.getOut()) as { warnings: Array<{ code: string }> };
+    expect(out.warnings.map((finding) => finding.code).sort()).toEqual([
+      'HARDCODED_FALSE',
+      'HARDCODED_TRUE',
+    ]);
+  });
+});
+
+describe('runDatabaseRulesValidate', () => {
+  it('reports RTDB expression parse errors', async () => {
+    const io = bufferIo();
+    const code = await runDatabaseRulesValidate(serviceArgs(['database', 'rules', 'validate', 'database.rules.json']), {
+      ...io,
+      cwd: '/tmp',
+      readFile: (async () => '{"rules":{".read":"auth.uid =="}}') as never,
+    });
+    expect(code).toBe(0);
+    const out = JSON.parse(io.getOut()) as { errors: Array<{ code: string }> };
+    expect(out.errors.some((finding) => finding.code === 'PARSE_ERROR')).toBe(true);
+  });
+});
+
+describe('runDatabaseRulesSimulate', () => {
+  it('simulates inline RTDB rules from stdin', async () => {
+    const io = bufferIo();
+    const code = await runDatabaseRulesSimulate(serviceArgs(['database', 'rules', 'simulate', '--stdin']), {
+      ...io,
+      readStdin: async () =>
+        JSON.stringify({
+          rulesJson: { rules: { '.read': true } },
+          operation: 'read',
+          path: '/sample',
+          auth: null,
+          mockData: {},
+        }),
+    });
+    expect(code).toBe(0);
+    const result = JSON.parse(io.getOut()) as { success: boolean; data: { allowed: boolean } };
+    expect(result.success).toBe(true);
+    expect(result.data.allowed).toBe(true);
+  });
+});
+
+describe('runDatabaseRulesGenerate', () => {
+  it('loads the constraints module, compiles via toJSON(), and writes the file', async () => {
+    const { defineRtdbRules, allow, deny } = await import('pyric/rules');
+    const doc = defineRtdbRules({
+      paths: { '/': { read: allow(), write: deny() } },
+    });
+
+    const io = bufferIo();
+    const writes: Array<{ path: unknown; contents: unknown }> = [];
+    const code = await runDatabaseRulesGenerate(serviceArgs(['database', 'rules', 'generate']), {
+      ...io,
+      cwd: '/project',
+      loadRulesDocument: (async () => ({ ok: true, document: doc })) as never,
+      readFirebaseJson: (async () => ({ database: { rules: 'database.rules.json' } })) as never,
+      mkdir: (async () => undefined) as never,
+      writeFile: (async (path: unknown, contents: unknown) => {
+        writes.push({ path, contents });
+      }) as never,
+    });
+
+    expect(code).toBe(0);
+    expect(writes).toHaveLength(1);
+    expect(writes[0]?.path).toBe('/project/database.rules.json');
+    expect(writes[0]?.contents).toBe(`${JSON.stringify(doc.toJSON(), null, 2)}\n`);
+    expect(io.getOut()).toContain('/project/database.rules.json');
+  });
+
+  it('reports a clear error when no constraints module is found', async () => {
+    const io = bufferIo();
+    const code = await runDatabaseRulesGenerate(serviceArgs(['database', 'rules', 'generate']), {
+      ...io,
+      cwd: '/project',
+      loadRulesDocument: (async () => ({
+        ok: false,
+        message: 'no constraints module found',
+      })) as never,
+    });
+
+    expect(code).toBe(1);
+    expect(io.getErr()).toContain('no constraints module found');
+  });
+
+  it('honors --config and --out flags', async () => {
+    const { defineRtdbRules, allow, deny } = await import('pyric/rules');
+    const doc = defineRtdbRules({ paths: { '/': { read: deny(), write: deny() } } });
+
+    const io = bufferIo();
+    let loadedPath: string | undefined;
+    const writes: Array<{ path: unknown }> = [];
+    const code = await runDatabaseRulesGenerate(
+      serviceArgs(['database', 'rules', 'generate', '--config', 'rtdb.rules.ts', '--out', 'out/rules.json']),
+      {
+        ...io,
+        cwd: '/project',
+        loadRulesDocument: (async (configPath: string) => {
+          loadedPath = configPath;
+          return { ok: true, document: doc };
+        }) as never,
+        mkdir: (async () => undefined) as never,
+        writeFile: (async (path: unknown) => {
+          writes.push({ path });
+        }) as never,
+      },
+    );
+
+    expect(code).toBe(0);
+    expect(loadedPath).toBe('rtdb.rules.ts');
+    expect(writes[0]?.path).toBe('/project/out/rules.json');
+  });
+});
+
+// ── init ──────────────────────────────────────────────────────────────
+
+describe('runInit', () => {
+  it('writes the full local-first Pyric scaffold when none exist', async () => {
+    const io = bufferIo();
+    const writeFn = mock(async () => undefined);
+    const mkdirFn = mock(async () => undefined);
+    const code = await runInit(parseArgs(['init', '--template=node']), {
+      ...io,
+      cwd: '/tmp/scaffold',
+      writeFile: writeFn as never,
+      mkdir: mkdirFn as never,
+      exists: async () => false,
+    });
+    expect(code).toBe(0);
+    // 9 files: package.json, src/app.ts, .env.example, src/seed.ts,
+    // firestore.rules, firebase.json, firestore.indexes.json, README.md,
+    // .gitignore
+    expect(writeFn).toHaveBeenCalledTimes(9);
+    const paths = writeFn.mock.calls.map((c) => c[0]);
+    expect(paths).toContain('/tmp/scaffold/package.json');
+    expect(paths).toContain('/tmp/scaffold/src/app.ts');
+    expect(paths).toContain('/tmp/scaffold/src/seed.ts');
+    expect(paths).toContain('/tmp/scaffold/firestore.rules');
+    expect(paths).toContain('/tmp/scaffold/firebase.json');
+    expect(paths).toContain('/tmp/scaffold/firestore.indexes.json');
+    expect(paths).toContain('/tmp/scaffold/README.md');
+    expect(paths).toContain('/tmp/scaffold/.gitignore');
+    // src/ dir is mkdir'd before writing into it
+    expect(mkdirFn).toHaveBeenCalledWith('/tmp/scaffold/src', { recursive: true });
+    // package.json uses the directory basename as the project name
+    const pkgCall = writeFn.mock.calls.find((c) => c[0] === '/tmp/scaffold/package.json');
+    expect(pkgCall?.[1]).toContain('"name": "scaffold"');
+    // App template stays canonical; the dev command owns package resolution.
+    const appCall = writeFn.mock.calls.find((c) => c[0] === '/tmp/scaffold/src/app.ts');
+    expect(appCall?.[1]).toContain("from 'firebase/app'");
+    expect(appCall?.[1]).toContain("from 'firebase/firestore'");
+    expect(appCall?.[1]).not.toContain("from 'pyric/");
+    expect(appCall?.[1]).toContain("projectId: process.env.FIREBASE_PROJECT_ID ?? 'pyric-local'");
+    expect(appCall?.[1]).not.toContain('initializeApp({ sandbox:');
+  });
+
+  it('honors --name override for the package name', async () => {
+    const io = bufferIo();
+    const writeFn = mock(async () => undefined);
+    const code = await runInit(parseArgs(['init', '--name=my-app']), {
+      ...io,
+      cwd: '/tmp/scaffold-named',
+      writeFile: writeFn as never,
+      mkdir: mock(async () => undefined) as never,
+      exists: async () => false,
+    });
+    expect(code).toBe(0);
+    const pkgCall = writeFn.mock.calls.find((c) => c[0] === '/tmp/scaffold-named/package.json');
+    expect(pkgCall?.[1]).toContain('"name": "my-app"');
+  });
+
+  it('skips files that already exist (non-package.json)', async () => {
+    const io = bufferIo();
+    const writeFn = mock(async () => undefined);
+    const code = await runInit(parseArgs(['init', '--template=node']), {
+      ...io,
+      cwd: '/tmp/scaffold2',
+      writeFile: writeFn as never,
+      mkdir: mock(async () => undefined) as never,
+      exists: async (p) => p.endsWith('firebase.json'),
+    });
+    expect(code).toBe(0);
+    // 1 package.json + 7 non-package.json files written, firebase.json skipped
+    expect(writeFn).toHaveBeenCalledTimes(8);
+    expect(io.getOut()).toContain('skipped firebase.json');
+  });
+
+  it('merges into an existing package.json — adds missing scripts + deps, never overwrites', async () => {
+    const io = bufferIo();
+    const writeFn = mock(async () => undefined);
+    const existingPkg = JSON.stringify(
+      {
+        name: 'my-existing-app',
+        type: 'module',
+        scripts: { test: 'jest', start: 'node existing.js' },
+        dependencies: { express: '^4.0.0' },
+      },
+      null,
+      2,
+    );
+    const code = await runInit(parseArgs(['init', '--template=node']), {
+      ...io,
+      cwd: '/tmp/merge-test',
+      writeFile: writeFn as never,
+      readFile: mock(async () => existingPkg) as never,
+      mkdir: mock(async () => undefined) as never,
+      // Only package.json exists; all others don't.
+      exists: async (p) => p.endsWith('package.json'),
+    });
+    expect(code).toBe(0);
+    const pkgCall = writeFn.mock.calls.find((c) => c[0] === '/tmp/merge-test/package.json');
+    expect(pkgCall).toBeDefined();
+    const written = JSON.parse(pkgCall![1] as string);
+
+    // User's existing values preserved.
+    expect(written.name).toBe('my-existing-app');
+    expect(written.scripts.test).toBe('jest');
+    expect(written.scripts.start).toBe('node existing.js'); // NOT overwritten
+    expect(written.dependencies.express).toBe('^4.0.0');
+
+    // Missing Pyric development scripts + deps added.
+    expect(written.scripts.bridge).toBe('pyric bridge');
+    expect(written.scripts.dev).toBe('pyric dev --no-open -- node --env-file-if-exists=.env --experimental-strip-types src/app.ts');
+    expect(Object.keys(written.scripts).some((name) => name.startsWith('deploy'))).toBe(false);
+    expect(written.dependencies.firebase).toBe('^12.12.0');
+    expect(written.dependencies.pyric).toBeUndefined();
+    expect(written.devDependencies['@pyric/cli']).toBe('*');
+    expect(written.devDependencies.typescript).toBe('^5.7.0');
+
+    // User-facing report mentions the conflict on `start`.
+    const out = io.getOut();
+    expect(out).toContain('merged package.json');
+    expect(out).toContain('scripts.start');
+    expect(out).toContain('node existing.js');
+  });
+
+  it('reports unchanged when existing package.json already has everything', async () => {
+    const io = bufferIo();
+    const writeFn = mock(async () => undefined);
+    // A package.json that already contains every required field.
+    const completePkg = JSON.stringify(
+      {
+        name: 'complete',
+        type: 'module',
+        private: true,
+        scripts: {
+          start: 'node --env-file-if-exists=.env --experimental-strip-types src/app.ts',
+          dev: 'pyric dev --no-open -- node --env-file-if-exists=.env --experimental-strip-types src/app.ts',
+          bridge: 'pyric bridge',
+        },
+        dependencies: { firebase: '^12.12.0' },
+        devDependencies: { '@pyric/cli': '*', '@types/node': '^22.0.0', typescript: '^5.7.0' },
+      },
+      null,
+      2,
+    );
+    const code = await runInit(parseArgs(['init', '--template=node']), {
+      ...io,
+      cwd: '/tmp/complete',
+      writeFile: writeFn as never,
+      readFile: mock(async () => completePkg) as never,
+      mkdir: mock(async () => undefined) as never,
+      exists: async (p) => p.endsWith('package.json'),
+    });
+    expect(code).toBe(0);
+    // package.json should NOT have been rewritten — 6 other files written.
+    const pkgCall = writeFn.mock.calls.find((c) => c[0] === '/tmp/complete/package.json');
+    expect(pkgCall).toBeUndefined();
+    expect(io.getOut()).toContain('skipped package.json'); // unchanged merge
+  });
+});
+
+describe('scanForInlinedFirebase', () => {
+  it('flags a bundled chunk that inlines real-SDK endpoint hosts', async () => {
+    const { scanForInlinedFirebase } = await import('./serve.js');
+    const { mkdtempSync, mkdirSync, writeFileSync } = await import('node:fs');
+    const { tmpdir } = await import('node:os');
+    const { join } = await import('node:path');
+    const dir = mkdtempSync(join(tmpdir(), 'pyric-inline-scan-'));
+    mkdirSync(join(dir, 'assets'));
+    writeFileSync(
+      join(dir, 'assets', 'index-abc.js'),
+      'fetch("https://identitytoolkit.googleapis.com/v1/projects?key="+k)',
+    );
+    const hits = scanForInlinedFirebase(dir);
+    expect(hits).toEqual(['assets/index-abc.js']);
+  });
+
+  it('stays clean for an unbundled app importing firebase by bare specifier', async () => {
+    const { scanForInlinedFirebase } = await import('./serve.js');
+    const { mkdtempSync, writeFileSync } = await import('node:fs');
+    const { tmpdir } = await import('node:os');
+    const { join } = await import('node:path');
+    const dir = mkdtempSync(join(tmpdir(), 'pyric-inline-clean-'));
+    writeFileSync(
+      join(dir, 'main.js'),
+      "import { getAuth } from 'firebase/auth'; import { getFirestore } from 'firebase/firestore';",
+    );
+    expect(scanForInlinedFirebase(dir)).toEqual([]);
+  });
+});