@mirrowel/opencode-openshare 0.2.0-dev.2 → 0.2.1

package/README.md

@@ -3,6 +3,8 @@
 The opencode side of [Open(code)Share](../README.md) — session sharing for
 OpenCode v1 and v2, self-hosted on your own worker.
 
+Every plugin config key, its file chain, and the cross-package config surface are inventoried in [../CONFIGURATION.md](../CONFIGURATION.md).
+
 ## Artifacts
 
 | Artifact | What it is | Share mode |

package/ci/README.md

@@ -46,12 +46,23 @@ OPENSHARE_URL_FILE=share-urls.txt   # each share URL appended + stderr line
 
 With no token held, the bundle **enrolls itself** on first contact
 (public servers take anyone; private ones consume the one-time code) and
-persists the token to `~/.config/opencode/openshare.config.json` —
+persists the token to `~/.config/opencode/openshare.config.json` -
 enroll once, then every run just shares. A revoked token re-enrolls the
 same way; if enrollment is impossible the error lands on stderr and
-sharing stops (no retry storms). The bundle also supports **fan-out**:
-multiple `active` servers in the `servers` group each get the session
-(one urlFile line per server).
+sharing stops (no retry storms).
+
+**Ephemeral runners** (GitHub-hosted, containers): do NOT enroll through
+a code - each fresh machine would burn one activation. Ask the hoster
+for a pre-minted registered token (`osk_…`) and pass it via
+`OPENSHARE_CREATE_TOKEN` (or the config's token field) - registered
+tokens skip enrollment entirely and never expire on their own. Point
+`OPENSHARE_CONFIG_DIR` (or mount) the settings home at a cached path
+only if you want the token persisted; env alone is enough. Note:
+revoking that token (when it is the user's last) freezes control of all
+its shares server-side, even ones holding the share secret.
+
+The bundle also supports **fan-out**: multiple `active` servers in the
+`servers` group each get the session (one urlFile line per server).
 
 On OpenCode v2, plugin targets should be directories/packages — wrap this
 file in a folder with a `package.json` exporting it (`{"exports": {".": "./openshare.js"}}`)

package/ci/openshare.js

@@ -19,7 +19,7 @@
 // > code defaults. Keys: servers (multi-server: url -> {token, code,
 // label, active, adminToken}), workerUrl, createToken (legacy pair),
 // shareMode ("all" | "manual"; default = TUI presence), debounceMs,
-// completedDelayMs, modelLabel, ttlDays, openTasksInNewTab,
+// completedDelayMs, modelLabel, ttlDays,
 // authLogin, authPassword, spoolDir, urlFile ("none" = off),
 // announceStderr.
 //
@@ -36,7 +36,6 @@ var DEFAULTS = {
   completedDelayMs: 5000,
   modelLabel: "$Provider/$Model",
   ttlDays: 90,
-  openTasksInNewTab: true,
   authLogin: "",
   authPassword: "",
   spoolDir: "",
@@ -176,7 +175,10 @@ function loadConfig(pluginDir, options) {
           continue;
         cfg[key] = value;
       }
-    } catch {}
+    } catch (e) {
+      if (existsSync(path))
+        console.error(`[openshare] config file ${path} could not be parsed - ignored:`, e?.message ?? e);
+    }
   }
   if (options && typeof options === "object") {
     const serversOpt = normalizeServers(options.servers);
@@ -221,6 +223,14 @@ function loadConfig(pluginDir, options) {
     cfg.shareMode = env.OPENSHARE_SHARE_MODE;
   if (cfg.urlFile.trim().toLowerCase() === URL_FILE_NONE)
     cfg.urlFile = URL_FILE_NONE;
+  if (cfg.workerUrl)
+    cfg.workerUrl = cfg.workerUrl.trim().replace(/\/+$/, "");
+  if (cfg.servers) {
+    const fixed = {};
+    for (const [u, e] of Object.entries(cfg.servers))
+      fixed[u.trim().replace(/\/+$/, "")] = e;
+    cfg.servers = fixed;
+  }
   return cfg;
 }
 function spoolDirFor(cfg) {
@@ -346,7 +356,7 @@ function resolveShareMode(cfg, input) {
 // src/core.ts
 import { appendFileSync, existsSync as existsSync2, mkdirSync, readFileSync as readFileSync2, rmSync, writeFileSync as writeFileSync2 } from "node:fs";
 import { createHash } from "node:crypto";
-import { join as join2 } from "node:path";
+import { isAbsolute, join as join2 } from "node:path";
 
 // src/contract.ts
 function messageTombstone(sessionID, messageID) {
@@ -638,6 +648,7 @@ function shareFlag(info) {
   }
   return { enabled: true, opts: Object.keys(opts).length ? opts : undefined };
 }
+var liveTargets = [];
 function createEngine(deps) {
   let cfg = loadConfig(deps.pluginDir, deps.options);
   const mode = resolveShareMode(cfg, deps);
@@ -669,8 +680,13 @@ function createEngine(deps) {
   log(`share mode: ${mode} (directory: ${deps.directory ?? "?"} worktree: ${deps.worktree ?? "?"})`);
   const resolveTargets = () => {
     const merged = {};
-    if (cfg.workerUrl)
+    const hasServers = !!cfg.servers && Object.keys(cfg.servers).length > 0;
+    const envWorker = !!process.env.OPENSHARE_WORKER_URL;
+    if (cfg.workerUrl && (!hasServers || envWorker))
       merged[cfg.workerUrl] = { token: cfg.createToken || "", active: true };
+    if (cfg.workerUrl && hasServers && !envWorker && !cfg.servers[cfg.workerUrl]) {
+      log(`legacy workerUrl ${cfg.workerUrl} ignored: a servers group is configured - remove one of the two`);
+    }
     if (cfg.servers)
       for (const [u, e] of Object.entries(cfg.servers))
         merged[u] = { ...merged[u], ...e };
@@ -680,6 +696,7 @@ function createEngine(deps) {
     return chosen.map((url) => ({ url, entry: merged[url] }));
   };
   let targets = resolveTargets();
+  liveTargets = targets.map((t) => t.url);
   const credState = new Map;
   const credOf = (url) => {
     let s = credState.get(url);
@@ -853,7 +870,8 @@ function createEngine(deps) {
     badSignal: false,
     lastSentStatus: null,
     closed: false,
-    prefsSent: false,
+    lastError: null,
+    ttlClamped: null,
     binding: null,
     bindingQueried: false,
     optOuts: new Set,
@@ -872,6 +890,7 @@ function createEngine(deps) {
       spoolRoot = spoolDirFor(cfg);
       const before = new Set(targets.map((t) => t.url));
       targets = resolveTargets();
+      liveTargets = targets.map((t) => t.url);
       seedCredentials();
       clampToPolicy();
       if (debugEvents) {
@@ -1045,6 +1064,10 @@ function createEngine(deps) {
     const value = { v: 2, servers, enabled: true };
     if (mode === "manual" && st.opts)
       value.opts = st.opts;
+    if (st.lastError)
+      value.lastError = st.lastError;
+    if (st.ttlClamped)
+      value.ttlClamped = st.ttlClamped;
     st.binding = value;
     st.wroteBinding = true;
     await writeMetadata(st, value);
@@ -1225,7 +1248,7 @@ function createEngine(deps) {
     if (cfg.announceStderr)
       log(`live: ${url}`);
     if (mode === "all" && cfg.urlFile !== URL_FILE_NONE) {
-      const file = cfg.urlFile || join2(deps.directory ?? process.cwd(), "openshare.urls.txt");
+      const file = cfg.urlFile ? isAbsolute(cfg.urlFile) ? cfg.urlFile : join2(deps.directory ?? process.cwd(), cfg.urlFile) : join2(deps.directory ?? process.cwd(), "openshare.urls.txt");
       try {
         appendFileSync(file, url + `
 `);
@@ -1234,15 +1257,43 @@ function createEngine(deps) {
           lastUrlFile = file;
           log(`url file: ${file}`);
         }
-      } catch {}
+      } catch (e) {
+        logError(`url file write failed (${file}):`, e?.message || e);
+      }
     }
   };
+  let halfAuthWarned = false;
   const authFrame = (st) => {
     const login = st.opts?.authLogin ?? cfg.authLogin ?? "";
     const password = st.opts?.authPassword ?? cfg.authPassword ?? "";
+    if (login === "" !== (password === "")) {
+      if (!halfAuthWarned) {
+        halfAuthWarned = true;
+        logError("read auth needs BOTH a login and a password - gate disabled until fixed");
+      }
+      return { authLogin: "", authPassword: "" };
+    }
     return { authLogin: login, authPassword: password };
   };
   const ttlFor = (st) => st.opts?.ttlDays ?? cfg.ttlDays;
+  const applyOpts = (st, opts) => {
+    if (!opts)
+      return;
+    const prev = st.opts ? JSON.stringify(st.opts) : "";
+    st.opts = opts;
+    if (prev === JSON.stringify(opts))
+      return;
+    for (const [url, r] of st.remotes) {
+      if (!r.shareId || !r.secret || !r.wsReady)
+        continue;
+      const attach = { id: r.shareId, secret: r.secret, ...authFrame(st) };
+      if (st.opts?.ttlDays)
+        attach.ttlDays = st.opts.ttlDays;
+      const sent = wsSend(r, { op: "init", attach });
+      if (sent)
+        log(`opts re-synced to ${url.slice(0, 24)}${st.opts?.ttlDays ? ` (ttl ${st.opts.ttlDays}d)` : ""}`);
+    }
+  };
   const deleteAbandoned = (r) => {
     const id = r.shareId;
     const secret = r.secret;
@@ -1326,6 +1377,25 @@ function createEngine(deps) {
         r.announced = false;
         queueConnect(st, r);
       }
+      let rearmed = false;
+      for (const [url, e] of Object.entries(servers)) {
+        if (st.optOuts.has(url) || st.remotes.has(url))
+          continue;
+        const ee = e;
+        if (typeof ee.id !== "string" || typeof ee.secret !== "string" || !ee.id)
+          continue;
+        const r = remoteFor(st, url);
+        r.shareId = ee.id;
+        r.secret = ee.secret;
+        r.ackedRev = typeof ee.rev === "number" ? ee.rev : 0;
+        log(`re-share: re-arming ${url.slice(0, 24)} on share ${ee.id}`);
+        queueConnect(st, r);
+        rearmed = true;
+      }
+      if (rearmed) {
+        st.sentHash.clear();
+        chain = chain.then(() => backfill(st)).catch((e) => logError("re-share backfill error", e?.message || e));
+      }
     } catch {}
   };
   const connect = async (st, r) => {
@@ -1534,6 +1604,8 @@ function createEngine(deps) {
         const err = String(frame.error ?? "");
         if (/frozen/i.test(err)) {
           r.authBlocked = true;
+          st.lastError = `share frozen by the hoster (owner frozen) - contact the server admin`;
+          scheduleBindingWrite(st);
           logError(`${r.url}: share frozen by the hoster (owner frozen) - edits refused; contact the server admin`);
           try {
             r.ws?.close(4000, "frozen");
@@ -1568,6 +1640,8 @@ function createEngine(deps) {
           return;
         }
         if (/limit|too many|rate/i.test(err)) {
+          st.lastError = `create refused: ${frame.error ?? "rate limited"}`;
+          scheduleBindingWrite(st);
           logError(`${r.url}: create refused:`, frame.error, "- retrying with backoff");
           r.connecting = false;
           try {
@@ -1578,6 +1652,8 @@ function createEngine(deps) {
           return;
         }
         logError(`${r.url}: init refused:`, frame.error, "- creating fresh share");
+        st.lastError = `init refused: ${frame.error ?? "unknown"}`;
+        scheduleBindingWrite(st);
         deleteAbandoned(r);
         r.shareId = null;
         r.secret = null;
@@ -1623,6 +1699,18 @@ function createEngine(deps) {
         applyPolicy(frame.policy, r.url);
       r.intentionalClose = false;
       touch(st);
+      if (typeof frame.ttlDays === "number") {
+        const wanted = ttlFor(st);
+        const clamp = wanted != null && frame.ttlDays !== wanted ? { requested: wanted, effective: frame.ttlDays } : null;
+        if (JSON.stringify(clamp) !== JSON.stringify(st.ttlClamped)) {
+          st.ttlClamped = clamp;
+          scheduleBindingWrite(st);
+        }
+      }
+      if (st.lastError) {
+        st.lastError = null;
+        scheduleBindingWrite(st);
+      }
       announceUrl(st, r);
       if (!st.wroteBinding) {
         chain = chain.then(() => writeBinding(st)).catch(() => {});
@@ -2396,10 +2484,6 @@ function createEngine(deps) {
       if (parent) {
         const st = sessions.get(parent);
         if (st?.activated && !st.closed) {
-          if (!st.prefsSent) {
-            st.prefsSent = true;
-            enqueue(st, itemFor("prefs", { openTasksInNewTab: cfg.openTasksInNewTab !== false }, sid));
-          }
           if (info)
             enqueue(st, itemFor("session", redact(info), sid));
         }
@@ -2410,11 +2494,7 @@ function createEngine(deps) {
       if (flag.enabled) {
         if (st?.activated && !st.closed) {
           if (flag.opts)
-            st.opts = flag.opts;
-          if (!st.prefsSent) {
-            st.prefsSent = true;
-            enqueue(st, itemFor("prefs", { openTasksInNewTab: cfg.openTasksInNewTab !== false }, sid));
-          }
+            applyOpts(st, flag.opts);
           if (info)
             enqueue(st, itemFor("session", redact(info), sid));
           if (t === "session.updated")
@@ -2422,11 +2502,6 @@ function createEngine(deps) {
           return;
         }
         activate(sid, flag.opts, info);
-        const fresh = sessions.get(sid);
-        if (fresh && !fresh.prefsSent) {
-          fresh.prefsSent = true;
-          enqueue(fresh, itemFor("prefs", { openTasksInNewTab: cfg.openTasksInNewTab !== false }, sid));
-        }
         return;
       }
       if (st?.activated && !st.closed && t === "session.updated") {
@@ -2472,10 +2547,6 @@ function createEngine(deps) {
     }
     if (!st)
       return;
-    if (!st.prefsSent) {
-      st.prefsSent = true;
-      enqueue(st, itemFor("prefs", { openTasksInNewTab: cfg.openTasksInNewTab !== false }, sid));
-    }
     if (info)
       enqueue(st, itemFor("session", redact(info), sid));
     if (t === "session.updated" && st.activated && !st.closed) {
@@ -2685,6 +2756,21 @@ function createEngine(deps) {
           st.metaTimer = null;
           await writeBinding(st).catch(() => {});
         }
+        const barrierStart = Date.now();
+        while (Date.now() - barrierStart < 5000) {
+          let pendingAnnounce = false;
+          for (const st of sessions.values()) {
+            for (const r of st.remotes.values()) {
+              if (r.authBlocked || r.collided)
+                continue;
+              if (r.shareId && !r.announced || !r.shareId && (r.ws || r.connecting))
+                pendingAnnounce = true;
+            }
+          }
+          if (!pendingAnnounce)
+            break;
+          await new Promise((res) => setTimeout(res, 100));
+        }
         for (const st of sessions.values()) {
           for (const r of st.remotes.values()) {
             try {

package/dist/commands.js

@@ -15,6 +15,7 @@
 // deliberately NOT joined into the shared family palette category).
 import { clearGoneBindingEntries, currentConfig, hostOf, isConfigured, patchSessionBinding, readBindings, resolveRoot, shareWithConsent, verifyShare, } from "./share-flow.js";
 import { onboardingDialog, settingsDialog } from "./settings.js";
+import { engineTargetUrls } from "./core.js";
 import { dbgLog } from "./sidebar.js";
 export const PALETTE_CATEGORY = "OpenShare";
 function finish(host, result) {
@@ -135,7 +136,9 @@ export function buildShareCommand(host, sessionID) {
             dbgLog(`/share run: entered (sid=${sessionID() ?? "none"})`);
             host.ui.dialog.clear();
             const cfg = currentConfig();
-            if (!isConfigured(cfg)) {
+            // engine-aware gate: project-level plugin options can configure
+            // targets the TUI's file chain cannot see - trust the live engine
+            if (!isConfigured(cfg) && !engineTargetUrls().length) {
                 void onboardingDialog(host);
                 return;
             }
@@ -155,12 +158,12 @@ export function buildShareCommand(host, sessionID) {
             // enabled:true; legacy all-mode bindings without the field are live
             // too — only an explicit false is dormant)
             if (all.some((b) => b.url && b.enabled !== false)) {
-                // THE session menu — identical to /openshare → This session by
-                // construction (one surface, no duplicated manager). No
-                // dialog.clear() after: settings owns its chain end-to-end (the
-                // old fire-and-forget menu + immediate clear wiped it instantly —
-                // live-caught as "/share did nothing" on a shared session).
-                await settingsDialog(host, sid);
+                // THE session menu - identical to /openshare  This session by
+                // construction (one surface, no duplicated manager), opened
+                // DIRECTLY (owner: "/share is supposed to be the same menu, not
+                // the settings root one hop away"). No dialog.clear() after:
+                // settings owns its chain end-to-end.
+                await settingsDialog(host, sid, "session");
                 return;
             }
             // everything was just cleared by the gone modal and the user chose

package/dist/config.d.ts

@@ -23,7 +23,6 @@ export type ShareConfig = {
     completedDelayMs: number;
     modelLabel: string;
     ttlDays: number;
-    openTasksInNewTab: boolean;
     authLogin: string;
     authPassword: string;
     spoolDir: string;

package/dist/config.js

@@ -36,7 +36,6 @@ export const DEFAULTS = {
     completedDelayMs: 5000,
     modelLabel: "$Provider/$Model",
     ttlDays: 90,
-    openTasksInNewTab: true,
     authLogin: "",
     authPassword: "",
     spoolDir: "",
@@ -327,7 +326,14 @@ export function loadConfig(pluginDir, options) {
                 cfg[key] = value;
             }
         }
-        catch { }
+        catch (e) {
+            // a malformed config file is a real setup error the user must hear
+            // about - silence here looks like "no share server configured".
+            // (Absent files are normal chain candidates - only broken content
+            // is worth a line.)
+            if (existsSync(path))
+                console.error(`[openshare] config file ${path} could not be parsed - ignored:`, e?.message ?? e);
+        }
     }
     if (options && typeof options === "object") {
         const serversOpt = normalizeServers(options.servers);
@@ -374,6 +380,17 @@ export function loadConfig(pluginDir, options) {
     // normalize the disable sentinel (case-insensitive from any source)
     if (cfg.urlFile.trim().toLowerCase() === URL_FILE_NONE)
         cfg.urlFile = URL_FILE_NONE;
+    // URL hygiene: a trailing slash on a server url becomes
+    // wss://host//api/ws and https://host//s/<id> downstream - strip once,
+    // at the source, so every consumer agrees
+    if (cfg.workerUrl)
+        cfg.workerUrl = cfg.workerUrl.trim().replace(/\/+$/, "");
+    if (cfg.servers) {
+        const fixed = {};
+        for (const [u, e] of Object.entries(cfg.servers))
+            fixed[u.trim().replace(/\/+$/, "")] = e;
+        cfg.servers = fixed;
+    }
     return cfg;
 }
 export function spoolDirFor(cfg) {

package/dist/core.d.ts

@@ -114,4 +114,5 @@ export type Engine = {
     mode: ShareMode;
     config: () => ShareConfig;
 };
+export declare function engineTargetUrls(): string[];
 export declare function createEngine(deps: EngineDeps): Engine;