@nofendian17/opencode-relay-plugin 2.0.3 → 2.0.6

package/README.md

@@ -1,10 +1,16 @@
 # @nofendian17/opencode-relay-plugin (v2)
 
-Route OpenCode **v2** Zen traffic (`https://opencode.ai/zen/*`) through your
-relay endpoint(s), ported from the v1 `relay.js`
-(`@opencode-ai/plugin` → `@opencode/plugin`).
+Route OpenCode **v2** opencode.ai traffic through your relay endpoint(s),
+ported from the v1 `relay.js` (`@opencode-ai/plugin` → `@opencode/plugin`).
 
-Only Zen requests are relayed; other providers already point at direct
+## Scope
+
+Matched by **origin** (`https://opencode.ai`), not by path prefix. This covers
+`/zen/*`, `/inference/*`, and any future path on the same origin. (Before
+v2.0.4 the match was prefix-based on `/zen/*`, so `/inference/*` traffic
+silently went direct — same rate-limit symptom, no relay in the log.)
+
+Only opencode.ai requests are relayed; other providers already point at direct
 gateways and are left untouched (no rewrite, no forced retries).
 
 V1 patched `provider.options.fetch` + `globalThis.fetch`. V2 providers no longer expose `fetch`,
@@ -16,7 +22,7 @@ so this plugin uses the documented v2 interception points:
 - `ctx.session.hook("retry")` — relay network errors never reach `http.response`, so force a
   retry (next attempt picks the next relay); after the pool is exhausted the next attempt goes direct
 - `ctx.session.hook("experimental.ws.handshake")` — no-op (relay is HTTP-only, kept direct)
-- `globalThis.fetch` patch — only for out-of-session `https://opencode.ai/zen/*` traffic (v1 parity)
+- `globalThis.fetch` patch — only for out-of-session `https://opencode.ai/*` traffic (v1 parity)
 - `ctx.provider.transform` — re-enable the built-in `opencode` (Zen) provider if disabled
 
 Reference: https://opencode.ai/v2/docs/plugins/ + migration guide
@@ -59,17 +65,21 @@ Local file (auto-discovered):
 | Option | Env fallback | Description |
 | --- | --- | --- |
 | `url: string \| string[]` | `RELAY_URL` (comma-separated) | Relay endpoint(s), `http(s)` only. Invalid entries are skipped with a warning log; if none remain valid the plugin disables itself. |
-| `debug: boolean` | `RELAY_DEBUG=1` | Verbose per-request logging. When on, log lines are also appended to `/tmp/opencode-relay.log` (plugin `console.log` is not forwarded to opencode logs). |
+| `debug: boolean` | `RELAY_DEBUG=1` | Verbose per-request logging. **Ini opsi plugin** (`plugins[].options.debug`), **bukan** top-level `debug` di `opencode.jsonc` — top-level `debug` tidak mengaktifkan log plugin ini. Baris penting (`init`, `disabled`, `fallback`) selalu ditulis ke file log; baris verbose per-request hanya saat `debug` on. Override path dengan `RELAY_DEBUG_LOG` (dipakai tests untuk isolasi). |
 
 ## Relay protocol (unchanged from v1)
 
 - `<relay-url>` with original method/body/headers plus:
-  - `x-relay-target: https://api.anthropic.com` (origin)
-  - `x-relay-path: /v1/messages?foo=bar` (path + query)
+  - `x-relay-target: https://opencode.ai` (origin)
+  - `x-relay-path: /inference/v1/chat/completions` (path + query)
 - Relay returns the provider response verbatim (status/body/headers).
 - `429` or `>= 500` → try next relay → fall back to direct.
 - Network error → try next relay → fall back to direct.
 
+Retry accounting: attempts `1..N` (pool size) each try the next relay in
+round-robin order; attempt `N+1` goes direct once (per-session flag, consumed
+by the next `http.request`), then the pool is used again.
+
 ## Security
 
 The relay terminates TLS and sees everything it forwards: request bodies and
@@ -79,10 +89,23 @@ access logs as secret-bearing.
 
 ## Verify
 
-1. `RELAY_DEBUG=1` + set `url` to a local echo server, run a prompt, confirm
+1. Set plugin option `debug: true` + `url` ke local echo server, run prompt, confirm
    `x-relay-target` / `x-relay-path` headers arrive.
-2. Stop the relay → request still succeeds via direct fallback (check `[relay] fallback to direct` log).
+2. Stop the relay → request still succeeds via direct fallback (check
+   `[relay] relay fallback to direct` in the log file — path is printed in the
+   `[relay] init` line as `logFile`).
 3. Unset `url`/`RELAY_URL` → `[relay] disabled` log, traffic goes direct.
+4. Confirm scope: a request to `https://opencode.ai/inference/...` must show
+   `via relay` in the log. If the log only shows
+   `direct fallback (all relays failed previously)` with an
+   `https://opencode.ai/...` URL and zero `via relay` lines, the request never
+   entered the pool — check the origin match in `index.ts`.
+
+Note: the default file is `os.tmpdir()/opencode-relay.log` — on macOS that is
+`$TMPDIR/opencode-relay.log` (e.g. `/var/folders/.../T/`), NOT `/tmp/`.
+Check the `logFile` field in the `[relay] init` line for the exact path.
+Concurrent opencode processes append to the same file. Plugin `console.log`
+is not forwarded to opencode logs, so always check the file, not the TUI.
 
 ## V1 vs V2 notes
 

package/index.ts

@@ -1,8 +1,26 @@
 import { Plugin } from "@opencode/plugin"
-import { appendFile } from "node:fs/promises"
+import { appendFileSync } from "node:fs"
 import { tmpdir } from "node:os"
 import { join } from "node:path"
 
+// Bun runtime: node:fs/promises appendFile fails silently. Use sync API.
+function safeAppendFile(path: string, data: string): void {
+  try {
+    appendFileSync(path, data)
+  } catch {
+    // Fallback: try Bun.write if available
+    try {
+      // @ts-ignore - Bun global may not exist in Node
+      if (typeof Bun !== "undefined") {
+        // @ts-ignore
+        Bun.write(path, data, { mode: "append" })
+      }
+    } catch {
+      // All failed - ignore
+    }
+  }
+}
+
 interface RelayOptions {
   url?: string | string[]
   debug?: boolean
@@ -10,7 +28,7 @@ interface RelayOptions {
 
 const DEBUG_LOG = join(tmpdir(), "opencode-relay.log")
 
-const ZEN_PREFIX = "https://opencode.ai/zen/"
+const OPENCODE_ORIGIN = "https://opencode.ai"
 
 type Logger = (message: string, extra?: Record<string, unknown>) => void
 
@@ -149,7 +167,7 @@ type RelayFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Resp
  * `x-relay-target` / `x-relay-path` (original method preserved),
  * round-robin across the pool, fail over on 429/5xx + network errors,
  * fall back to direct.
- * Used for out-of-session traffic (global fetch patch for Zen).
+ * Used for out-of-session traffic (global fetch patch for opencode.ai).
  */
 function createRelayFetch(
   relays: readonly string[],
@@ -198,15 +216,28 @@ function createRelayFetch(
   }
 }
 
+function parseDebug(value: unknown): boolean | undefined {
+  if (value === undefined) return undefined
+  if (typeof value === "boolean") return value
+  if (typeof value === "number") return value !== 0
+  if (typeof value === "string") {
+    const v = value.trim().toLowerCase()
+    if (["1", "true", "yes", "on", "debug"].includes(v)) return true
+    if (["0", "false", "no", "off", ""].includes(v)) return false
+    return true
+  }
+  return Boolean(value)
+}
+
 function parseOptions(options: Record<string, unknown> | undefined): {
   relays: string[]
   debug: boolean
 } {
   const url = options?.["url"] as string | string[] | undefined
-  const debugOpt = options?.["debug"] as boolean | undefined
+  const envDebug = process.env.RELAY_DEBUG
   return {
     relays: normalizeRelays(url),
-    debug: debugOpt ?? process.env.RELAY_DEBUG === "1",
+    debug: parseDebug(options?.["debug"]) ?? parseDebug(envDebug) ?? false,
   }
 }
 
@@ -219,26 +250,26 @@ export default Plugin.define({
     const debug = parsed.debug
     const prefix = "[relay]"
     // console output from v2 plugins is not forwarded to opencode logs,
-    // so when debug is on, mirror everything to a file in /tmp as well.
-    // Async fire-and-forget: logging never breaks requests.
-    let warnedLogFile = false
-    const fileLog: Logger | undefined = debug
-      ? (message, extra) => {
-          const line =
-            `${new Date().toISOString()} ${prefix} ${message}` +
-            (extra ? ` ${JSON.stringify(extra)}` : "") +
-            "\n"
-          appendFile(DEBUG_LOG, line).catch((e: unknown) => {
-            if (!warnedLogFile) {
-              warnedLogFile = true
-              console.log(prefix, "debug log write failed", DEBUG_LOG, String(e))
-            }
-          })
-        }
-      : undefined
+    // so mirror important events to a file unconditionally and verbose
+    // per-request lines only when debug is on.
+    // NOTE: this is the plugin option `plugins[].options.debug`
+    // (or RELAY_DEBUG=1), NOT the top-level opencode `debug` flag.
+    // RELAY_DEBUG_LOG overrides the path (tests use an isolated file so a
+    // live opencode process appending to the default never interferes).
+    // Default path is os.tmpdir() — on macOS that is NOT /tmp but
+    // $TMPDIR (e.g. /var/folders/.../T/opencode-relay.log).
+    // Logging never breaks requests.
+    const logFile = process.env.RELAY_DEBUG_LOG ?? DEBUG_LOG
+    const fileLog: Logger = (message, extra) => {
+      const line =
+        `${new Date().toISOString()} ${prefix} ${message}` +
+        (extra ? ` ${JSON.stringify(extra)}` : "") +
+        "\n"
+      safeAppendFile(logFile, line)
+    }
     const emit: Logger = (message, extra) => {
       console.log(prefix, message, extra ? JSON.stringify(extra) : "")
-      fileLog?.(message, extra)
+      fileLog(message, extra)
     }
     const log: Logger = (message, extra) => {
       if (debug) emit(message, extra)
@@ -259,14 +290,14 @@ export default Plugin.define({
       }
     }
 
-    emit("init", { debug, relayCount: relays.length })
+    emit("init", { debug, relayCount: relays.length, logFile })
 
     if (relays.length === 0) {
       emit("disabled: no relays configured (set plugin option `url` or RELAY_URL)", {})
       return
     }
 
-    log("relay pool loaded", { relays })
+    log("relay pool loaded", { relays, logFile })
 
     const rawFetch = globalThis.fetch
     const g = globalThis as Record<string, unknown>
@@ -280,15 +311,15 @@ export default Plugin.define({
     const relayOrigins = buildRelayOrigins(relays)
     const relayFetch = createRelayFetch(relays, pickIndex, directFetch, debug, log, emit)
 
-    // --- Global fetch patch for out-of-session Zen traffic (v1 parity) ---
+    // --- Global fetch patch for out-of-session opencode.ai traffic (v1 parity) ---
     // Session model traffic is covered by hooks below; this covers anything
-    // else that calls fetch("https://opencode.ai/zen/...") directly.
+    // else that calls fetch("https://opencode.ai/...") directly.
     if (!g[PATCH_MARKER]) {
       g[PATCH_MARKER] = originalForPatch
       globalThis.fetch = (async (input: RequestInfo | URL, init?: RequestInit) => {
         const urlStr =
           typeof input === "string" ? input : input instanceof URL ? input.href : input.url
-        if (typeof urlStr === "string" && urlStr.startsWith(ZEN_PREFIX)) {
+        if (typeof urlStr === "string" && urlStr.startsWith(OPENCODE_ORIGIN)) {
           try {
             if (!relayOrigins.has(new URL(urlStr).origin)) return relayFetch(input, init)
           } catch {
@@ -347,9 +378,10 @@ export default Plugin.define({
       // Avoid relaying the relay itself (loop).
       if (relayOrigins.has(url.origin)) return
 
-      // Scope: only the Zen endpoint goes through the relay. Other
+      // Scope: only opencode.ai endpoints go through the relay (zen,
+      // inference, and any future path on the same origin). Other
       // providers already point at direct gateways and are left untouched.
-      if (!url.href.startsWith(ZEN_PREFIX)) return
+      if (url.origin !== OPENCODE_ORIGIN) return
 
       // Buffer body (streams are one-shot).
       let bodyBuf: ArrayBuffer | undefined

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nofendian17/opencode-relay-plugin",
-  "version": "2.0.3",
+  "version": "2.0.6",
   "description": "Route OpenCode v2 Zen (opencode.ai) traffic through relay endpoint(s) with round-robin, failover, and direct fallback. Other providers are left untouched.",
   "type": "module",
   "main": "./index.ts",
@@ -26,8 +26,8 @@
     "@opencode/plugin": "^2"
   },
   "devDependencies": {
-    "@opencode/plugin": "^2.0.24",
-    "@types/node": "^26.6.4",
+    "@opencode/plugin": "^2.0.28",
+    "@types/node": "^26.6.5",
     "typescript": "^5.9.3"
   }
 }