@billjr99/pi-openai-compat 1.1.13 → 1.1.15

package/README.md

@@ -77,6 +77,15 @@ If pi is already running when you install, type `/reload` first.
 > | **Cloudflare Workers AI** | HTTP 405 (no `GET /v1/models`; real catalog at `/ai/models/search`, id field is `name`, mixed task types) | Live discovery — `modelsUrl: …/ai/models/search`, `modelsIdField: name`, `modelsKeepTask: "Text Generation"` |
 > | **Cloudflare AI Gateway** | HTTP 401 (token missing `AI Gateway: Run`) or HTTP 400 *"Please configure AI Gateway"* (gateway slug doesn't exist, or the upstream isn't configured on it) | Built-in fallback list |
 > | **Hugging Face** | Returns HTML rather than JSON | Built-in fallback list |
+>
+> **Auto-heal for older configs:** if you logged in before live discovery
+> existed, your saved provider is missing these `modelsUrl`/`modelsIdField`/
+> `modelsKeepTask` fields. On startup the extension backfills them from the
+> template whenever it can do so without prompting — i.e. when your saved base
+> URL still matches the template (Cloudflare Workers AI). When the base URL
+> itself changed (e.g. GitHub Models' retired `models.inference.ai.azure.com`
+> host), it can't be migrated silently and you'll get a one-time notice to run
+> `/compat-login`.
 
 ---
 
@@ -302,11 +311,16 @@ parse error.
 **Cloudflare AI Gateway returns 401 Unauthorized**
 Check both: (1) the API token has `AI Gateway: Run` *and* `Workers AI: Read`
 under "Permissions", scoped to the correct account; and (2) the gateway slug
-in the URL actually exists under that account — list with
-`curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai-gateway/gateways
--H "Authorization: Bearer $TOKEN"`. An empty `result` array means the gateway
-isn't there (you may need to create it in **dash.cloudflare.com → AI → AI
-Gateway**, or you're querying the wrong account).
+in the URL actually exists under that account — list them with:
+
+```bash
+curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai-gateway/gateways \
+  -H "Authorization: Bearer $TOKEN"
+```
+
+An empty `result` array means the gateway isn't there (you may need to create it
+in **dash.cloudflare.com → AI → AI Gateway**, or you're querying the wrong
+account).
 
 **No models appear after login**
 For Ollama: pull at least one model first (`ollama pull llama3`).

package/index.ts

@@ -44,6 +44,10 @@ interface ProviderConfig {
   modelsUrl?: string;
   modelsIdField?: string;
   modelsKeepTask?: string;
+  // Set once we've warned the user that this provider's saved baseUrl no longer
+  // matches its template and can't be auto-migrated, so the notice is shown
+  // only once rather than on every session_start while the config stays stale.
+  staleNotified?: boolean;
 }
 
 interface ExtensionConfig {
@@ -349,6 +353,90 @@ function saveConfig(config: ExtensionConfig): void {
   }
 }
 
+// ─────────────────────────────────────────────────────────────────────────────
+// Discovery-field auto-heal
+//
+// Providers saved before model-discovery overrides existed (modelsUrl/
+// modelsIdField/modelsKeepTask) have none on their config, so /compat-refresh
+// and the session_start rehydrate hit the broken default <baseUrl>/models path
+// (e.g. Cloudflare Workers AI's 405). When a provider's saved baseUrl still
+// matches its template — so we can recover any account-id/slug placeholders —
+// we backfill the discovery fields from the template. Providers whose baseUrl
+// no longer matches the template (e.g. GitHub Models' retired Azure host) can't
+// be healed safely and are reported so the user can re-run /compat-login.
+// ─────────────────────────────────────────────────────────────────────────────
+
+/** Placeholders that may appear in a template's baseUrl / modelsUrl. */
+const URL_PLACEHOLDERS = ["YOUR_ACCOUNT_ID", "YOUR_GATEWAY_SLUG", "YOUR_PROVIDER"];
+
+function escapeRegex(s: string): string {
+  return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+/**
+ * Recover placeholder values by matching a saved URL against a template URL.
+ * Returns a map (possibly empty when the template has no placeholders) when the
+ * saved URL is consistent with the template, or null when it isn't — which we
+ * treat as "this provider can't be healed automatically".
+ */
+function recoverPlaceholders(templateUrl: string, savedUrl: string): Record<string, string> | null {
+  // Tolerate trailing-slash differences the same way the rest of the code does
+  // (e.g. baseUrl.replace(/\/+$/, "")), so a saved URL that differs only by a
+  // trailing slash still heals instead of being marked stale.
+  const tpl = templateUrl.replace(/\/+$/, "");
+  const saved = savedUrl.replace(/\/+$/, "");
+  const order: string[] = [];
+  const placeholderRe = new RegExp(URL_PLACEHOLDERS.join("|"), "g");
+  let source = "^";
+  let lastIndex = 0;
+  let m: RegExpExecArray | null;
+  while ((m = placeholderRe.exec(tpl)) !== null) {
+    source += escapeRegex(tpl.slice(lastIndex, m.index)) + "([^/]+)";
+    order.push(m[0]);
+    lastIndex = m.index + m[0].length;
+  }
+  source += escapeRegex(tpl.slice(lastIndex)) + "$";
+
+  const match = new RegExp(source).exec(saved);
+  if (!match) return null;
+  const out: Record<string, string> = {};
+  order.forEach((name, i) => { out[name] = match[i + 1]; });
+  return out;
+}
+
+function applyPlaceholders(url: string, values: Record<string, string>): string {
+  let out = url;
+  for (const [name, value] of Object.entries(values)) out = out.split(name).join(value);
+  return out;
+}
+
+/**
+ * Backfill missing discovery fields on saved providers from their template.
+ * Mutates `config` in place; the caller is responsible for persisting when
+ * `healed` is non-empty. `stale` lists the provider *keys* that need a manual
+ * re-login (the caller resolves display names and dedupes notifications).
+ */
+function migrateDiscoveryFields(config: ExtensionConfig): { healed: string[]; stale: string[] } {
+  const healed: string[] = [];
+  const stale: string[] = [];
+
+  for (const [key, p] of Object.entries(config.providers)) {
+    const tpl = TEMPLATES[key];
+    if (!tpl?.modelsUrl) continue;   // no matching template, or template needs no overrides
+    if (p.modelsUrl) continue;       // already set (fresh login or manual edit) — never clobber
+
+    const values = recoverPlaceholders(tpl.baseUrl, p.baseUrl);
+    if (!values) { stale.push(key); continue; }
+
+    p.modelsUrl = applyPlaceholders(tpl.modelsUrl, values);
+    p.modelsIdField = tpl.modelsIdField;
+    p.modelsKeepTask = tpl.modelsKeepTask;
+    healed.push(p.displayName);
+  }
+
+  return { healed, stale };
+}
+
 // ─────────────────────────────────────────────────────────────────────────────
 // Networking
 // ─────────────────────────────────────────────────────────────────────────────
@@ -415,8 +503,10 @@ async function fetchModels(
     else if (Array.isArray(obj.result)) raw = obj.result as RawModel[];
   }
   if (!raw) {
+    // `url` may be an override (e.g. /catalog/models, /ai/models/search), so
+    // keep the wording generic rather than referring specifically to /models.
     throw new Error(
-      `Unexpected /models payload shape from ${url} ` +
+      `Unexpected model catalog payload shape from ${url} ` +
       `(expected an array or an object with a "data" or "result" array).`
     );
   }
@@ -428,8 +518,14 @@ async function fetchModels(
       return taskName.toLowerCase() === keepTask.toLowerCase();
     })
     .map((m) => {
-      const id = (m as Record<string, unknown>)[idField] as string | undefined;
-      return { id: id ?? "", contextWindow: m.context_window, maxTokens: m.max_tokens };
+      // Coerce the id field defensively: some upstreams expose a numeric id,
+      // and storing a non-string would break the localeCompare sort below.
+      const rawId = (m as Record<string, unknown>)[idField];
+      const id =
+        typeof rawId === "string" ? rawId :
+        typeof rawId === "number" ? String(rawId) :
+        "";
+      return { id, contextWindow: m.context_window, maxTokens: m.max_tokens };
     })
     .filter((m) => Boolean(m.id))
     .sort((a, b) => a.id.localeCompare(b.id));
@@ -472,6 +568,11 @@ function registerProvider(pi: ExtensionAPI, key: string, p: ProviderConfig): voi
 export default async function (pi: ExtensionAPI) {
   let config = loadConfig();
 
+  // Self-heal older configs: backfill discovery fields (modelsUrl/idField/
+  // keepTask) we can derive from the template without prompting. Persist once
+  // so /compat-refresh and the session_start rehydrate use the fixed values.
+  if (migrateDiscoveryFields(config).healed.length > 0) saveConfig(config);
+
   // Register all saved providers immediately using cached model lists.
   // The factory is async, so pi waits for this to finish before startup
   // continues — providers are visible in /model from the very first render.
@@ -487,6 +588,11 @@ export default async function (pi: ExtensionAPI) {
   pi.on("session_start", async (_event, ctx) => {
     config = loadConfig();
 
+    // Self-heal what we can (silently), and collect providers whose saved
+    // baseUrl no longer matches the template — those need a manual re-login.
+    const { healed, stale } = migrateDiscoveryFields(config);
+    if (healed.length > 0) saveConfig(config);
+
     const registered: string[] = [];
     const failed: string[] = [];
 
@@ -527,6 +633,20 @@ export default async function (pi: ExtensionAPI) {
         "warning"
       );
     }
+    // Warn about stale providers only once: re-notifying on every session_start
+    // while the config stays stale would be noise. Persist the flag so the
+    // notice survives restarts.
+    const toNotify = stale.filter((key) => !config.providers[key]?.staleNotified);
+    if (toNotify.length > 0) {
+      const names = toNotify.map((key) => config.providers[key].displayName);
+      ctx.ui.notify(
+        `OpenAI-compat: ${names.join(", ")} ${names.length === 1 ? "has" : "have"} an out-of-date ` +
+        `base URL — run /compat-login to update (its endpoint changed and can't be migrated automatically).`,
+        "warning"
+      );
+      for (const key of toNotify) config.providers[key].staleNotified = true;
+      saveConfig(config);
+    }
   });
 
   // ── model_select ───────────────────────────────────────────────────────────
@@ -712,10 +832,17 @@ export default async function (pi: ExtensionAPI) {
         keys = providerKeys;
       } else {
         const ALL = "All providers";
-        const labels = [ALL, ...providerKeys.map((k) => config.providers[k].displayName)];
+        // Embed the internal provider key in each label so duplicate
+        // displayNames (or a provider literally named "All providers") can't
+        // collide with each other or the special "All providers" option.
+        const options = providerKeys.map((k) => ({
+          key: k,
+          label: `${config.providers[k].displayName} [${k}]`,
+        }));
+        const labels = [ALL, ...options.map((o) => o.label)];
         const chosen = await ctx.ui.select("Refresh which provider?", labels);
         if (!chosen) { ctx.ui.notify("Cancelled.", "info"); return; }
-        keys = chosen === ALL ? providerKeys : [providerKeys[labels.indexOf(chosen) - 1]];
+        keys = chosen === ALL ? providerKeys : [options[labels.indexOf(chosen) - 1].key];
       }
 
       const refreshed: string[] = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@billjr99/pi-openai-compat",
-  "version": "1.1.13",
+  "version": "1.1.15",
   "description": "pi-coding-agent extension: OpenAI-compatible endpoint support (OpenRouter, NVIDIA NIM, Nous Portal, Ollama, custom)",
   "author": "Bill Mongan <https://github.com/BillJr99>",
   "license": "MIT",