rechrome 1.25.0 → 1.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rechrome",
-  "version": "1.25.0",
+  "version": "1.26.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/snomiao/rechrome.git"

package/rechrome.js

@@ -5,7 +5,7 @@ import { file } from "bun";
 import yargs from "yargs";
 import { readExtensionTokenFromProfile } from "./extension-token.js";
 import { randomBytes } from "crypto";
-import { mkdirSync, appendFileSync, existsSync, realpathSync, accessSync, cpSync, unlinkSync, readFileSync, readdirSync, constants as fsConstants } from "fs";
+import { mkdirSync, appendFileSync, existsSync, realpathSync, accessSync, cpSync, unlinkSync, readFileSync, readdirSync, renameSync, rmdirSync, constants as fsConstants } from "fs";
 import { hostname, homedir, networkInterfaces } from "os";
 import { isIPv4 } from "net";
 import { join, basename, dirname } from "path";
@@ -16,14 +16,16 @@ import { oxmgrInstallCommand, pickDaemonManager, type DaemonManager } from "./da
 
 export const ENV_KEY = "RECHROME_URL";
 export const DEFAULT_PORT = 13775;
-export const RECH_DIR = join(import.meta.dir, ".rech");
-export const LOG_DIR = join(RECH_DIR, "logs");
-
 // Home dir: HOME on POSIX, USERPROFILE on Windows (handled by os.homedir()).
 export const HOME = homedir();
 
-const RECH_HOME_DIR = join(HOME, ".rechrome");
-const TOKENS_FILE = join(RECH_HOME_DIR, "profiles.yaml");
+// All rechrome state (registry, listeners, extension, logs, daemon output) lives in
+// ~/.rechrome, never next to the code: a bunx/npx install dir is a disposable cache.
+export const RECH_DIR = join(HOME, ".rechrome");
+export const LOG_DIR = join(RECH_DIR, "logs");
+// Before the rename, logs and daemon output lived in <install dir>/.rech.
+export const LEGACY_RECH_DIR = join(import.meta.dir, ".rech");
+const TOKENS_FILE = join(RECH_DIR, "profiles.yaml");
 
 type TokenEntry = { extensionId: string; token: string; profileDir: string; userDataDir?: string; loadExtension?: string };
 
@@ -38,7 +40,7 @@ function validateTokenRegistry(value: unknown): Record<string, TokenEntry> {
   return value as Record<string, TokenEntry>;
 }
 
-export async function writeTokenRegistry(registry: Record<string, TokenEntry>, directory = RECH_HOME_DIR): Promise<void> {
+export async function writeTokenRegistry(registry: Record<string, TokenEntry>, directory = RECH_DIR): Promise<void> {
   validateTokenRegistry(registry);
   await mkdir(directory, { recursive: true });
   const path = join(directory, "profiles.yaml");
@@ -51,7 +53,7 @@ export async function writeTokenRegistry(registry: Record<string, TokenEntry>, d
   }
 }
 
-export async function readTokenRegistry(directory = RECH_HOME_DIR): Promise<Record<string, TokenEntry>> {
+export async function readTokenRegistry(directory = RECH_DIR): Promise<Record<string, TokenEntry>> {
   const path = join(directory, "profiles.yaml");
   let raw: string;
   try { raw = await readFile(path, "utf8"); }
@@ -74,7 +76,7 @@ export async function readTokenRegistry(directory = RECH_HOME_DIR): Promise<Reco
 }
 
 async function saveTokenEntry(profileEmail: string, entry: TokenEntry): Promise<void> {
-  mkdirSync(RECH_HOME_DIR, { recursive: true });
+  mkdirSync(RECH_DIR, { recursive: true });
   const registry = await readTokenRegistry();
   registry[profileEmail] = entry;
   await writeTokenRegistry(registry);
@@ -241,6 +243,31 @@ export function log(msg: string) {
   appendFileSync(logFile, line);
 }
 
+/**
+ * Move logs and daemon output from the legacy <install dir>/.rech into RECH_DIR, entry by
+ * entry. An entry already present in RECH_DIR is kept and the legacy copy left in place,
+ * so nothing is overwritten. Best effort: a cross-device rename just leaves the old copy.
+ */
+export function migrateLegacyDataDir(legacy = LEGACY_RECH_DIR, target = RECH_DIR): string[] {
+  const moved: string[] = [];
+  if (!existsSync(legacy)) return moved;
+  mkdirSync(target, { recursive: true });
+  if (realpathSync(legacy) === realpathSync(target)) return moved;
+  for (const sub of ["logs", "output"]) {
+    const from = join(legacy, sub);
+    if (!existsSync(from)) continue;
+    mkdirSync(join(target, sub), { recursive: true });
+    for (const entry of readdirSync(from)) {
+      const to = join(target, sub, entry);
+      if (existsSync(to)) continue;
+      try { renameSync(join(from, entry), to); moved.push(`${sub}/${entry}`); } catch { /* keep the legacy copy */ }
+    }
+  }
+  // Remove only directories left empty (the unused tls/ included); rmdir refuses non-empty ones.
+  for (const dir of ["logs", "output", "tls", ""]) { try { rmdirSync(join(legacy, dir)); } catch { /* not empty */ } }
+  return moved;
+}
+
 export function parseUrl(raw: string) {
   const u = new URL(raw);
   const fragment = new URLSearchParams(u.hash.slice(1).replace(/^\?/, ""));
@@ -482,7 +509,15 @@ export function deriveIdentity(opts: {
   return { key, label };
 }
 
-async function getClientIdentity(): Promise<{ key: string; label: string; profile?: string }> {
+/**
+ * A project's own rechrome folder: <root>/.rechrome, where root is the same one the session
+ * key uses (the worktree root, submodules rolled up), or cwd in `cwd` mode / outside git.
+ */
+export function projectDataDir(opts: { mode: string; cwd: string; root?: string | null }): string {
+  return join(opts.mode === "cwd" ? opts.cwd : opts.root || opts.cwd, ".rechrome");
+}
+
+async function getClientIdentity(): Promise<{ key: string; label: string; dataDir: string; profile?: string }> {
   const cwd = realpathSafe(process.cwd());
   const mode = (process.env.RECH_IDENTITY || "worktree").toLowerCase();
   let root: string | null = null;
@@ -508,7 +543,7 @@ async function getClientIdentity(): Promise<{ key: string; label: string; profil
     if (remoteUrl) remote = normalizeRemote(remoteUrl);
   }
 
-  return deriveIdentity({ mode, cwd, host: hostname(), root, remote, branch });
+  return { ...deriveIdentity({ mode, cwd, host: hostname(), root, remote, branch }), dataDir: projectDataDir({ mode, cwd, root }) };
 }
 
 // Profile precedence: an explicit `?profile=` in RECHROME_URL is authoritative; the
@@ -902,7 +937,8 @@ async function callServe(
   const res = await fetch(serviceUrl(url, "run"), {
     method: "POST",
     headers: { "Content-Type": "application/json", Authorization: `Bearer ${key}` },
-    body: JSON.stringify({ args, identity, env }),
+    // dataDir is a client-local path; the daemon (possibly remote) only needs the session identity.
+    body: JSON.stringify({ args, identity: { key: identity.key, label: identity.label, profile: identity.profile }, env }),
     signal: AbortSignal.timeout(70_000),
   }).catch(async (e) => {
     if (throwOnFailure) throw new Error("Cannot reach the rechrome daemon. Check that it is running.");
@@ -1018,9 +1054,11 @@ async function run(url: string, args: string[], overrideEnv?: Record<string, str
   if (stdout) process.stdout.write(stdout);
 
   if (files?.length) {
-    const dlDir = join(process.cwd(), ".playwright-cli-multi-tab");
+    // Saved files belong to the project: <project>/.rechrome/output. The folder also holds
+    // .env.local (secrets), so it is git-ignored as a whole when first created.
+    const dlDir = join(identity.dataDir, "output");
     mkdirSync(dlDir, { recursive: true });
-    const gitignorePath = join(dlDir, ".gitignore");
+    const gitignorePath = join(identity.dataDir, ".gitignore");
     if (!existsSync(gitignorePath)) await Bun.write(gitignorePath, "*\n");
     for (const name of files) {
       const fileRes = await fetch(serviceUrl(url, `files/${name}`), {
@@ -1467,7 +1505,7 @@ async function daemonUninstall(): Promise<void> {
 // locate the binary and launch it detached (singleton via a pidfile).
 // `rech tray hide` / the menu "Hide" item both kill the process;
 // `rech tray show` starts a fresh one.
-const TRAY_PID_FILE = join(RECH_HOME_DIR, "tray.pid");
+const TRAY_PID_FILE = join(RECH_DIR, "tray.pid");
 
 // A desktop GUI must be present. Linux needs an X11/Wayland display; a headless
 // box (SSH, CI, container) has neither, so the tray is skipped. macOS/Windows
@@ -1729,7 +1767,7 @@ async function provisionProfile(name: string, opts: { headed?: boolean } = {}):
     process.exit(1);
   }
   const dist = await ensureExtensionDistInstalled();
-  const userDataDir = join(RECH_HOME_DIR, "profiles", name);
+  const userDataDir = join(RECH_DIR, "profiles", name);
   const token = randomBytes(32).toString("base64url");
 
   console.log(`\n[1/3] Provisioning managed profile "${name}"`);

package/rechrome.ts

@@ -5,7 +5,7 @@ import { file } from "bun";
 import yargs from "yargs";
 import { readExtensionTokenFromProfile } from "./extension-token.ts";
 import { randomBytes } from "crypto";
-import { mkdirSync, appendFileSync, existsSync, realpathSync, accessSync, cpSync, unlinkSync, readFileSync, readdirSync, constants as fsConstants } from "fs";
+import { mkdirSync, appendFileSync, existsSync, realpathSync, accessSync, cpSync, unlinkSync, readFileSync, readdirSync, renameSync, rmdirSync, constants as fsConstants } from "fs";
 import { hostname, homedir, networkInterfaces } from "os";
 import { isIPv4 } from "net";
 import { join, basename, dirname } from "path";
@@ -16,14 +16,16 @@ import { oxmgrInstallCommand, pickDaemonManager, type DaemonManager } from "./da
 
 export const ENV_KEY = "RECHROME_URL";
 export const DEFAULT_PORT = 13775;
-export const RECH_DIR = join(import.meta.dir, ".rech");
-export const LOG_DIR = join(RECH_DIR, "logs");
-
 // Home dir: HOME on POSIX, USERPROFILE on Windows (handled by os.homedir()).
 export const HOME = homedir();
 
-const RECH_HOME_DIR = join(HOME, ".rechrome");
-const TOKENS_FILE = join(RECH_HOME_DIR, "profiles.yaml");
+// All rechrome state (registry, listeners, extension, logs, daemon output) lives in
+// ~/.rechrome, never next to the code: a bunx/npx install dir is a disposable cache.
+export const RECH_DIR = join(HOME, ".rechrome");
+export const LOG_DIR = join(RECH_DIR, "logs");
+// Before the rename, logs and daemon output lived in <install dir>/.rech.
+export const LEGACY_RECH_DIR = join(import.meta.dir, ".rech");
+const TOKENS_FILE = join(RECH_DIR, "profiles.yaml");
 
 type TokenEntry = { extensionId: string; token: string; profileDir: string; userDataDir?: string; loadExtension?: string };
 
@@ -38,7 +40,7 @@ function validateTokenRegistry(value: unknown): Record<string, TokenEntry> {
   return value as Record<string, TokenEntry>;
 }
 
-export async function writeTokenRegistry(registry: Record<string, TokenEntry>, directory = RECH_HOME_DIR): Promise<void> {
+export async function writeTokenRegistry(registry: Record<string, TokenEntry>, directory = RECH_DIR): Promise<void> {
   validateTokenRegistry(registry);
   await mkdir(directory, { recursive: true });
   const path = join(directory, "profiles.yaml");
@@ -51,7 +53,7 @@ export async function writeTokenRegistry(registry: Record<string, TokenEntry>, d
   }
 }
 
-export async function readTokenRegistry(directory = RECH_HOME_DIR): Promise<Record<string, TokenEntry>> {
+export async function readTokenRegistry(directory = RECH_DIR): Promise<Record<string, TokenEntry>> {
   const path = join(directory, "profiles.yaml");
   let raw: string;
   try { raw = await readFile(path, "utf8"); }
@@ -74,7 +76,7 @@ export async function readTokenRegistry(directory = RECH_HOME_DIR): Promise<Reco
 }
 
 async function saveTokenEntry(profileEmail: string, entry: TokenEntry): Promise<void> {
-  mkdirSync(RECH_HOME_DIR, { recursive: true });
+  mkdirSync(RECH_DIR, { recursive: true });
   const registry = await readTokenRegistry();
   registry[profileEmail] = entry;
   await writeTokenRegistry(registry);
@@ -241,6 +243,31 @@ export function log(msg: string) {
   appendFileSync(logFile, line);
 }
 
+/**
+ * Move logs and daemon output from the legacy <install dir>/.rech into RECH_DIR, entry by
+ * entry. An entry already present in RECH_DIR is kept and the legacy copy left in place,
+ * so nothing is overwritten. Best effort: a cross-device rename just leaves the old copy.
+ */
+export function migrateLegacyDataDir(legacy = LEGACY_RECH_DIR, target = RECH_DIR): string[] {
+  const moved: string[] = [];
+  if (!existsSync(legacy)) return moved;
+  mkdirSync(target, { recursive: true });
+  if (realpathSync(legacy) === realpathSync(target)) return moved;
+  for (const sub of ["logs", "output"]) {
+    const from = join(legacy, sub);
+    if (!existsSync(from)) continue;
+    mkdirSync(join(target, sub), { recursive: true });
+    for (const entry of readdirSync(from)) {
+      const to = join(target, sub, entry);
+      if (existsSync(to)) continue;
+      try { renameSync(join(from, entry), to); moved.push(`${sub}/${entry}`); } catch { /* keep the legacy copy */ }
+    }
+  }
+  // Remove only directories left empty (the unused tls/ included); rmdir refuses non-empty ones.
+  for (const dir of ["logs", "output", "tls", ""]) { try { rmdirSync(join(legacy, dir)); } catch { /* not empty */ } }
+  return moved;
+}
+
 export function parseUrl(raw: string) {
   const u = new URL(raw);
   const fragment = new URLSearchParams(u.hash.slice(1).replace(/^\?/, ""));
@@ -482,7 +509,15 @@ export function deriveIdentity(opts: {
   return { key, label };
 }
 
-async function getClientIdentity(): Promise<{ key: string; label: string; profile?: string }> {
+/**
+ * A project's own rechrome folder: <root>/.rechrome, where root is the same one the session
+ * key uses (the worktree root, submodules rolled up), or cwd in `cwd` mode / outside git.
+ */
+export function projectDataDir(opts: { mode: string; cwd: string; root?: string | null }): string {
+  return join(opts.mode === "cwd" ? opts.cwd : opts.root || opts.cwd, ".rechrome");
+}
+
+async function getClientIdentity(): Promise<{ key: string; label: string; dataDir: string; profile?: string }> {
   const cwd = realpathSafe(process.cwd());
   const mode = (process.env.RECH_IDENTITY || "worktree").toLowerCase();
   let root: string | null = null;
@@ -508,7 +543,7 @@ async function getClientIdentity(): Promise<{ key: string; label: string; profil
     if (remoteUrl) remote = normalizeRemote(remoteUrl);
   }
 
-  return deriveIdentity({ mode, cwd, host: hostname(), root, remote, branch });
+  return { ...deriveIdentity({ mode, cwd, host: hostname(), root, remote, branch }), dataDir: projectDataDir({ mode, cwd, root }) };
 }
 
 // Profile precedence: an explicit `?profile=` in RECHROME_URL is authoritative; the
@@ -902,7 +937,8 @@ async function callServe(
   const res = await fetch(serviceUrl(url, "run"), {
     method: "POST",
     headers: { "Content-Type": "application/json", Authorization: `Bearer ${key}` },
-    body: JSON.stringify({ args, identity, env }),
+    // dataDir is a client-local path; the daemon (possibly remote) only needs the session identity.
+    body: JSON.stringify({ args, identity: { key: identity.key, label: identity.label, profile: identity.profile }, env }),
     signal: AbortSignal.timeout(70_000),
   }).catch(async (e) => {
     if (throwOnFailure) throw new Error("Cannot reach the rechrome daemon. Check that it is running.");
@@ -1018,9 +1054,11 @@ async function run(url: string, args: string[], overrideEnv?: Record<string, str
   if (stdout) process.stdout.write(stdout);
 
   if (files?.length) {
-    const dlDir = join(process.cwd(), ".playwright-cli-multi-tab");
+    // Saved files belong to the project: <project>/.rechrome/output. The folder also holds
+    // .env.local (secrets), so it is git-ignored as a whole when first created.
+    const dlDir = join(identity.dataDir, "output");
     mkdirSync(dlDir, { recursive: true });
-    const gitignorePath = join(dlDir, ".gitignore");
+    const gitignorePath = join(identity.dataDir, ".gitignore");
     if (!existsSync(gitignorePath)) await Bun.write(gitignorePath, "*\n");
     for (const name of files) {
       const fileRes = await fetch(serviceUrl(url, `files/${name}`), {
@@ -1467,7 +1505,7 @@ async function daemonUninstall(): Promise<void> {
 // locate the binary and launch it detached (singleton via a pidfile).
 // `rech tray hide` / the menu "Hide" item both kill the process;
 // `rech tray show` starts a fresh one.
-const TRAY_PID_FILE = join(RECH_HOME_DIR, "tray.pid");
+const TRAY_PID_FILE = join(RECH_DIR, "tray.pid");
 
 // A desktop GUI must be present. Linux needs an X11/Wayland display; a headless
 // box (SSH, CI, container) has neither, so the tray is skipped. macOS/Windows
@@ -1729,7 +1767,7 @@ async function provisionProfile(name: string, opts: { headed?: boolean } = {}):
     process.exit(1);
   }
   const dist = await ensureExtensionDistInstalled();
-  const userDataDir = join(RECH_HOME_DIR, "profiles", name);
+  const userDataDir = join(RECH_DIR, "profiles", name);
   const token = randomBytes(32).toString("base64url");
 
   console.log(`\n[1/3] Provisioning managed profile "${name}"`);

package/serve.js

@@ -9,6 +9,8 @@ import {
   getOrCreateUrl,
   authCheck,
   RECH_DIR,
+  LEGACY_RECH_DIR,
+  migrateLegacyDataDir,
   HOME,
   PASSTHROUGH_ENV_KEYS,
   resolvePlaywrightCli,
@@ -263,11 +265,14 @@ export function shouldExitOrphanedServe(opts: {
 }
 
 export async function serve() {
+  // The daemon owns logs/ and output/, so it migrates them before writing anything.
+  const migrated = migrateLegacyDataDir();
   const url = await getOrCreateUrl();
   const { key, port } = parseUrl(url);
 
   const workDir = join(RECH_DIR, "output");
   mkdirSync(workDir, { recursive: true });
+  if (migrated.length) log(`Moved ${migrated.length} legacy entries from ${LEGACY_RECH_DIR} to ${RECH_DIR}`);
 
   // Foreground/orphan self-exit: a serve whose parent has been re-parented to init
   // (ppid 1) is a leaked foreground serve. Poll for that, track the last real /run,
@@ -656,7 +661,7 @@ export async function serve() {
           outputFiles.push(f);
         } else {
           const basename = f.split("/").pop()!;
-          for (const subdir of [".playwright-cli", ".rech-multi-tab"]) {
+          for (const subdir of [".playwright-cli", ".playwright-cli-multi-tab"]) {
             // Forward-slash for the wire: join() would use "\" on the Windows daemon, which
             // a POSIX client can't treat as a separator (it builds a literal-backslash path).
             const subpath = `${subdir}/${basename}`;

package/serve.ts

@@ -9,6 +9,8 @@ import {
   getOrCreateUrl,
   authCheck,
   RECH_DIR,
+  LEGACY_RECH_DIR,
+  migrateLegacyDataDir,
   HOME,
   PASSTHROUGH_ENV_KEYS,
   resolvePlaywrightCli,
@@ -263,11 +265,14 @@ export function shouldExitOrphanedServe(opts: {
 }
 
 export async function serve() {
+  // The daemon owns logs/ and output/, so it migrates them before writing anything.
+  const migrated = migrateLegacyDataDir();
   const url = await getOrCreateUrl();
   const { key, port } = parseUrl(url);
 
   const workDir = join(RECH_DIR, "output");
   mkdirSync(workDir, { recursive: true });
+  if (migrated.length) log(`Moved ${migrated.length} legacy entries from ${LEGACY_RECH_DIR} to ${RECH_DIR}`);
 
   // Foreground/orphan self-exit: a serve whose parent has been re-parented to init
   // (ppid 1) is a leaked foreground serve. Poll for that, track the last real /run,
@@ -656,7 +661,7 @@ export async function serve() {
           outputFiles.push(f);
         } else {
           const basename = f.split("/").pop()!;
-          for (const subdir of [".playwright-cli", ".rech-multi-tab"]) {
+          for (const subdir of [".playwright-cli", ".playwright-cli-multi-tab"]) {
             // Forward-slash for the wire: join() would use "\" on the Windows daemon, which
             // a POSIX client can't treat as a separator (it builds a literal-backslash path).
             const subpath = `${subdir}/${basename}`;