fix(agents): isolate invalid plugin model catalogs (#92564)

tangtaizong666 · web-flow · commit c9f0bfd4764d · 2026-06-13T00:52:52.000-07:00
Keep valid root and plugin models available when one generated plugin catalog is invalid, while retaining and logging the catalog error. Fixes #92553. Co-authored-by: tangtaizong666 <tangtaizhong792@gmail.com>
diff --git a/src/agents/sessions/model-registry.test.ts b/src/agents/sessions/model-registry.test.ts
@@ -25,30 +25,59 @@ function writeModelsJsonWithPluginCatalog(params: {
   root: unknown;
   pluginRelativePath: string;
   pluginCatalog: unknown;
+}): string {
+  return writeModelsJsonWithPluginCatalogs({
+    root: params.root,
+    pluginCatalogs: [
+      {
+        pluginRelativePath: params.pluginRelativePath,
+        pluginCatalog: params.pluginCatalog,
+      },
+    ],
+  });
+}
+
+function writeModelsJsonWithPluginCatalogs(params: {
+  root: unknown;
+  pluginCatalogs: Array<{
+    pluginRelativePath: string;
+    pluginCatalog: unknown;
+  }>;
 }): string {
   const dir = mkdtempSync(join(tmpdir(), "openclaw-model-registry-"));
   tempDirs.push(dir);
   const file = join(dir, "models.json");
-  const pluginFile = join(dir, params.pluginRelativePath);
-  mkdirSync(dirname(pluginFile), { recursive: true });
   writeFileSync(file, JSON.stringify(params.root, null, 2), "utf-8");
-  writeFileSync(pluginFile, JSON.stringify(params.pluginCatalog, null, 2), "utf-8");
+  for (const pluginCatalog of params.pluginCatalogs) {
+    const pluginFile = join(dir, pluginCatalog.pluginRelativePath);
+    mkdirSync(dirname(pluginFile), { recursive: true });
+    writeFileSync(pluginFile, JSON.stringify(pluginCatalog.pluginCatalog, null, 2), "utf-8");
+  }
   return file;
 }
 
 function pluginOwnerSnapshot(providerId: string, pluginId: string, enabled = true) {
+  return pluginOwnerSnapshotEntries([{ providerId, pluginId, enabled }]);
+}
+
+function pluginOwnerSnapshotEntries(
+  entries: Array<{ providerId: string; pluginId: string; enabled?: boolean }>,
+) {
   // The registry only trusts generated provider shards that are still owned by
   // an enabled plugin in the current metadata snapshot.
   return {
     index: {
-      plugins: [{ pluginId, enabled }],
+      plugins: entries.map((entry) => ({
+        pluginId: entry.pluginId,
+        enabled: entry.enabled ?? true,
+      })),
     },
     normalizePluginId: (id: string) => id,
     owners: {
       channels: new Map(),
       channelConfigs: new Map(),
-      providers: new Map([[providerId, [pluginId]]]),
-      modelCatalogProviders: new Map([[providerId, [pluginId]]]),
+      providers: new Map(entries.map((entry) => [entry.providerId, [entry.pluginId]])),
+      modelCatalogProviders: new Map(entries.map((entry) => [entry.providerId, [entry.pluginId]])),
       cliBackends: new Map(),
       setupProviders: new Map(),
       commandAliases: new Map(),
@@ -145,6 +174,64 @@ describe("ModelRegistry models.json auth", () => {
     expect(registry.find("zai", "glm-5.1")?.name).toBe("GLM 5.1");
   });
 
+  it("isolates invalid generated plugin catalog shards from valid models", () => {
+    const modelsPath = writeModelsJsonWithPluginCatalogs({
+      root: {
+        providers: {
+          custom: {
+            baseUrl: "https://models.example/v1",
+            api: "openai-responses",
+            apiKey: "CUSTOM_API_KEY",
+            models: [{ id: "root-model", name: "Root Model" }],
+          },
+        },
+      },
+      pluginCatalogs: [
+        {
+          pluginRelativePath: join("plugins", "google", PLUGIN_MODEL_CATALOG_FILE),
+          pluginCatalog: {
+            generatedBy: PLUGIN_MODEL_CATALOG_GENERATED_BY,
+            providers: {
+              "google-vertex": {
+                baseUrl: "https://us-central1-aiplatform.googleapis.com/v1",
+                apiKey: "GOOGLE_API_KEY",
+                models: [{ id: "gemini-3.1-pro-preview", name: "Gemini 3.1 Pro" }],
+              },
+            },
+          },
+        },
+        {
+          pluginRelativePath: join("plugins", "zai", PLUGIN_MODEL_CATALOG_FILE),
+          pluginCatalog: {
+            generatedBy: PLUGIN_MODEL_CATALOG_GENERATED_BY,
+            providers: {
+              zai: {
+                baseUrl: "https://api.z.ai/api/paas/v4",
+                api: "openai-completions",
+                apiKey: "ZAI_API_KEY",
+                models: [{ id: "glm-5.1", name: "GLM 5.1" }],
+              },
+            },
+          },
+        },
+      ],
+    });
+
+    const registry = ModelRegistry.create(AuthStorage.inMemory(), modelsPath, {
+      pluginMetadataSnapshot: pluginOwnerSnapshotEntries([
+        { providerId: "google-vertex", pluginId: "google" },
+        { providerId: "zai", pluginId: "zai" },
+      ]),
+    });
+
+    expect(registry.getError()).toContain(
+      'Provider google-vertex, model gemini-3.1-pro-preview: no "api" specified',
+    );
+    expect(registry.find("custom", "root-model")?.name).toBe("Root Model");
+    expect(registry.find("zai", "glm-5.1")?.name).toBe("GLM 5.1");
+    expect(registry.find("google-vertex", "gemini-3.1-pro-preview")).toBeUndefined();
+  });
+
   it("preserves model params from generated plugin catalog shards", () => {
     const modelsPath = writeModelsJsonWithPluginCatalog({
       root: { providers: {} },
diff --git a/src/agents/sessions/model-registry.ts b/src/agents/sessions/model-registry.ts
@@ -21,6 +21,7 @@ import type {
 } from "../../llm/types.js";
 import { registerOAuthProvider, resetOAuthProviders } from "../../llm/utils/oauth/index.js";
 import type { OAuthProviderInterface } from "../../llm/utils/oauth/types.js";
+import { createSubsystemLogger } from "../../logging/subsystem.js";
 import { getAgentDir } from "../config.js";
 import { resolveModelPluginMetadataSnapshot } from "../model-discovery-context.js";
 import {
@@ -38,6 +39,8 @@ import {
   resolveHeadersOrThrow,
 } from "./resolve-config-value.js";
 
+const log = createSubsystemLogger("agents/model-registry");
+
 // Schema for OpenRouter routing preferences
 const PercentileCutoffsSchema = Type.Object({
   p50: Type.Optional(Type.Number()),
@@ -355,9 +358,7 @@ export class ModelRegistry {
     }
   }
 
-  /**
-   * Get any error from loading models.json (undefined if no error).
-   */
+  /** Get any root or generated plugin catalog load error. */
   getError(): string | undefined {
     return this.loadError;
   }
@@ -371,7 +372,8 @@ export class ModelRegistry {
 
     if (error) {
       this.loadError = error;
-      // Keep the prior empty/default registry shape when models.json failed to load.
+      log.warn(`model catalog load issue: ${error}`);
+      // Plugin catalog failures can return salvaged models; root failures return empty.
     }
 
     let combined = customModels;
@@ -444,6 +446,7 @@ export class ModelRegistry {
       }
 
       const models = this.parseModels(configForUse);
+      const pluginCatalogErrors: string[] = [];
       if (options.includePluginCatalogs !== false) {
         for (const pluginCatalog of listPluginModelCatalogFiles(dirname(modelsJsonPath))) {
           const pluginResult = this.loadCustomModels(pluginCatalog.path, {
@@ -452,13 +455,14 @@ export class ModelRegistry {
             requireGeneratedCatalog: true,
           });
           if (pluginResult.error) {
-            return pluginResult;
+            pluginCatalogErrors.push(pluginResult.error);
+            continue;
           }
           models.push(...pluginResult.models);
         }
       }
 
-      return { models, error: undefined };
+      return { models, error: pluginCatalogErrors.join("\n\n") || undefined };
     } catch (error) {
       if (error instanceof SyntaxError) {
         if (options.requireGeneratedCatalog === true) {
