File size: 7,410 Bytes
253e783 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | import {
parseRemoteModelCatalogBundle,
validateAndSanitizeRemoteModelCatalogBundle,
type RemoteModelCatalogBundle,
} from "@openclaw/model-catalog-core";
import type { OpenClawConfig } from "../config/types.openclaw.js";
import { compareOpenClawVersions } from "../config/version.js";
import { readResponseWithLimit } from "../infra/http-body.js";
import {
fetchConfiguredLocalOriginWithSsrFGuard,
fetchWithSsrFGuard,
} from "../infra/net/fetch-guard.js";
import type { OpenClawStateDatabaseOptions } from "../state/openclaw-state-db.js";
import { VERSION } from "../version.js";
import { bundledCatalogGeneratedAt } from "./bundled-catalog-stamp.js";
import { isRemoteModelCatalogRefreshEnabled, resolveRemoteCatalogUrl } from "./remote-config.js";
import {
markRemoteModelCatalogChecked,
readRemoteModelCatalog,
writeRemoteModelCatalog,
} from "./remote-store.js";
export const REMOTE_MODEL_CATALOG_TTL_MS = 6 * 60 * 60_000;
const REMOTE_MODEL_CATALOG_TIMEOUT_MS = 15_000;
const REMOTE_MODEL_CATALOG_MAX_BYTES = 4 * 1024 * 1024;
type RefreshCounts = { providers: number; models: number };
type RemoteModelCatalogRefreshResult =
| ({ status: "updated" | "unchanged"; generatedAt: number } & RefreshCounts)
| ({ status: "fresh"; generatedAt: number; nextCheckInMs: number } & RefreshCounts)
| { status: "disabled"; providers: 0; models: 0 }
| { status: "error"; error: string; providers: 0; models: 0 };
function bundleCounts(bundle: RemoteModelCatalogBundle): RefreshCounts {
const providers = Object.values(bundle.providers);
return {
providers: providers.length,
models: providers.reduce((total, provider) => total + provider.models.length, 0),
};
}
function storedCounts(bundleJson: string): RefreshCounts & { generatedAt: number } {
const bundle = parseRemoteModelCatalogBundle(JSON.parse(bundleJson));
return { ...bundleCounts(bundle), generatedAt: bundle.generatedAt };
}
function assertCompatibleMinVersion(bundle: RemoteModelCatalogBundle): void {
if (!bundle.minVersion) {
return;
}
const comparison = compareOpenClawVersions(VERSION, bundle.minVersion);
if (comparison === null) {
throw new Error(`invalid remote catalog minVersion: ${bundle.minVersion}`);
}
if (comparison < 0) {
throw new Error(
`remote catalog requires OpenClaw ${bundle.minVersion} or newer (current ${VERSION})`,
);
}
}
function isExplicitLocalHttpUrl(config: OpenClawConfig, url: string): boolean {
if (!config.models?.catalogRefresh?.url) {
return false;
}
const parsed = new URL(url);
return (
parsed.protocol === "http:" &&
(parsed.hostname === "localhost" ||
parsed.hostname === "127.0.0.1" ||
parsed.hostname === "[::1]")
);
}
export async function refreshRemoteModelCatalog(params: {
config: OpenClawConfig;
force?: boolean;
signal?: AbortSignal;
fetchImpl?: typeof fetch;
databaseOptions?: OpenClawStateDatabaseOptions;
now?: () => number;
bundledGeneratedAt?: () => number | undefined;
}): Promise<RemoteModelCatalogRefreshResult> {
if (!isRemoteModelCatalogRefreshEnabled(params.config)) {
return { status: "disabled", providers: 0, models: 0 };
}
const databaseOptions = params.databaseOptions ?? {};
const now = (params.now ?? Date.now)();
try {
const url = resolveRemoteCatalogUrl(params.config);
const stored = readRemoteModelCatalog(databaseOptions);
const activeStored = stored?.source_url === url ? stored : undefined;
if (
!params.force &&
activeStored &&
now - activeStored.checked_at < REMOTE_MODEL_CATALOG_TTL_MS
) {
return {
status: "fresh",
nextCheckInMs: Math.max(0, REMOTE_MODEL_CATALOG_TTL_MS - (now - activeStored.checked_at)),
...storedCounts(activeStored.bundle_json),
};
}
const headers = new Headers({ Accept: "application/json" });
if (activeStored?.etag) {
headers.set("If-None-Match", activeStored.etag);
}
if (activeStored?.last_modified) {
headers.set("If-Modified-Since", activeStored.last_modified);
}
const fetchParams = {
url,
init: { headers },
timeoutMs: REMOTE_MODEL_CATALOG_TIMEOUT_MS,
signal: params.signal,
fetchImpl: params.fetchImpl,
auditContext: "remote-model-catalog",
} as const;
const explicitOverride = Boolean(params.config.models?.catalogRefresh?.url);
const localHttp = isExplicitLocalHttpUrl(params.config, url);
let guarded: Awaited<ReturnType<typeof fetchWithSsrFGuard>>;
if (explicitOverride) {
const configuredOrigin = new URL(url).origin;
guarded = await fetchConfiguredLocalOriginWithSsrFGuard({
...fetchParams,
configuredLocalOriginBaseUrl: configuredOrigin,
policy: { allowedOrigins: [configuredOrigin] },
requireHttps: !localHttp,
});
} else {
guarded = await fetchWithSsrFGuard({ ...fetchParams, requireHttps: true });
}
try {
if (guarded.response.status === 304) {
if (!activeStored) {
throw new Error("remote catalog returned 304 without a stored bundle");
}
const marked = markRemoteModelCatalogChecked(
now,
{
expected: activeStored,
etag: guarded.response.headers.get("etag") ?? activeStored.etag,
lastModified:
guarded.response.headers.get("last-modified") ?? activeStored.last_modified,
},
databaseOptions,
);
const current = marked ? activeStored : readRemoteModelCatalog(databaseOptions);
return {
status: "unchanged",
...storedCounts(current?.bundle_json ?? activeStored.bundle_json),
};
}
if (!guarded.response.ok) {
throw new Error(`remote catalog request failed: HTTP ${guarded.response.status}`);
}
const body = await readResponseWithLimit(guarded.response, REMOTE_MODEL_CATALOG_MAX_BYTES, {
chunkTimeoutMs: REMOTE_MODEL_CATALOG_TIMEOUT_MS,
});
const bundle = validateAndSanitizeRemoteModelCatalogBundle(
JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(body)),
);
assertCompatibleMinVersion(bundle);
const bundleJson = JSON.stringify(bundle);
const unchanged = activeStored?.bundle_json === bundleJson;
const writeResult = writeRemoteModelCatalog(
{
bundle_json: bundleJson,
generated_at: bundle.generatedAt,
min_version: bundle.minVersion ?? null,
source_url: url,
etag: guarded.response.headers.get("etag"),
last_modified: guarded.response.headers.get("last-modified"),
checked_at: now,
},
databaseOptions,
);
if (writeResult.status === "retained-newer") {
return { status: "unchanged", ...storedCounts(writeResult.row.bundle_json) };
}
const bundledGeneratedAt = (params.bundledGeneratedAt ?? bundledCatalogGeneratedAt)();
return {
status:
unchanged || bundledGeneratedAt === undefined || bundle.generatedAt <= bundledGeneratedAt
? "unchanged"
: "updated",
generatedAt: bundle.generatedAt,
...bundleCounts(bundle),
};
} finally {
await guarded.release();
}
} catch (error) {
return { status: "error", error: String(error), providers: 0, models: 0 };
}
}
|