mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-04 01:20:24 +00:00
refactor(plugins): tighten web fetch provider boundary (#59646)
* refactor(plugins): tighten web fetch provider boundary * fix(config): sync fetch secret parity and baseline * fix(ci): enforce web fetch boundary guard
This commit is contained in:
66
extensions/firecrawl/api.ts
Normal file
66
extensions/firecrawl/api.ts
Normal file
@@ -0,0 +1,66 @@
|
||||
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime";
|
||||
import { runFirecrawlScrape } from "./src/firecrawl-client.js";
|
||||
|
||||
export type FetchFirecrawlContentParams = {
|
||||
url: string;
|
||||
extractMode: "markdown" | "text";
|
||||
apiKey: string;
|
||||
baseUrl: string;
|
||||
onlyMainContent: boolean;
|
||||
maxAgeMs: number;
|
||||
proxy: "auto" | "basic" | "stealth";
|
||||
storeInCache: boolean;
|
||||
timeoutSeconds: number;
|
||||
maxChars?: number;
|
||||
};
|
||||
|
||||
export type FetchFirecrawlContentResult = {
|
||||
text: string;
|
||||
title?: string;
|
||||
finalUrl?: string;
|
||||
status?: number;
|
||||
warning?: string;
|
||||
};
|
||||
|
||||
export async function fetchFirecrawlContent(
|
||||
params: FetchFirecrawlContentParams,
|
||||
): Promise<FetchFirecrawlContentResult> {
|
||||
const cfg: OpenClawConfig = {
|
||||
plugins: {
|
||||
entries: {
|
||||
firecrawl: {
|
||||
enabled: true,
|
||||
config: {
|
||||
webFetch: {
|
||||
apiKey: params.apiKey,
|
||||
baseUrl: params.baseUrl,
|
||||
onlyMainContent: params.onlyMainContent,
|
||||
maxAgeMs: params.maxAgeMs,
|
||||
timeoutSeconds: params.timeoutSeconds,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const result = await runFirecrawlScrape({
|
||||
cfg,
|
||||
url: params.url,
|
||||
extractMode: params.extractMode,
|
||||
maxChars: params.maxChars,
|
||||
proxy: params.proxy,
|
||||
storeInCache: params.storeInCache,
|
||||
onlyMainContent: params.onlyMainContent,
|
||||
maxAgeMs: params.maxAgeMs,
|
||||
timeoutSeconds: params.timeoutSeconds,
|
||||
});
|
||||
|
||||
return {
|
||||
text: typeof result.text === "string" ? result.text : "",
|
||||
title: typeof result.title === "string" ? result.title : undefined,
|
||||
finalUrl: typeof result.finalUrl === "string" ? result.finalUrl : undefined,
|
||||
status: typeof result.status === "number" ? result.status : undefined,
|
||||
warning: typeof result.warning === "string" ? result.warning : undefined,
|
||||
};
|
||||
}
|
||||
@@ -29,13 +29,17 @@ vi.mock("./firecrawl-client.js", () => ({
|
||||
|
||||
describe("firecrawl tools", () => {
|
||||
const priorFetch = global.fetch;
|
||||
let fetchFirecrawlContent: typeof import("../api.js").fetchFirecrawlContent;
|
||||
let createFirecrawlWebSearchProvider: typeof import("./firecrawl-search-provider.js").createFirecrawlWebSearchProvider;
|
||||
let createFirecrawlWebFetchProvider: typeof import("./firecrawl-fetch-provider.js").createFirecrawlWebFetchProvider;
|
||||
let createFirecrawlSearchTool: typeof import("./firecrawl-search-tool.js").createFirecrawlSearchTool;
|
||||
let createFirecrawlScrapeTool: typeof import("./firecrawl-scrape-tool.js").createFirecrawlScrapeTool;
|
||||
let firecrawlClientTesting: typeof import("./firecrawl-client.js").__testing;
|
||||
|
||||
beforeAll(async () => {
|
||||
vi.resetModules();
|
||||
({ fetchFirecrawlContent } = await import("../api.js"));
|
||||
({ createFirecrawlWebFetchProvider } = await import("./firecrawl-fetch-provider.js"));
|
||||
({ createFirecrawlWebSearchProvider } = await import("./firecrawl-search-provider.js"));
|
||||
({ createFirecrawlSearchTool } = await import("./firecrawl-search-tool.js"));
|
||||
({ createFirecrawlScrapeTool } = await import("./firecrawl-scrape-tool.js"));
|
||||
@@ -199,6 +203,62 @@ describe("firecrawl tools", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("keeps the compare-helper fetch facade owned by the Firecrawl extension", async () => {
|
||||
await fetchFirecrawlContent({
|
||||
url: "https://docs.openclaw.ai",
|
||||
extractMode: "markdown",
|
||||
apiKey: "firecrawl-key",
|
||||
baseUrl: "https://api.firecrawl.dev",
|
||||
onlyMainContent: false,
|
||||
maxAgeMs: 5000,
|
||||
proxy: "stealth",
|
||||
storeInCache: false,
|
||||
timeoutSeconds: 22,
|
||||
maxChars: 1500,
|
||||
});
|
||||
|
||||
expect(runFirecrawlScrape).toHaveBeenCalledWith({
|
||||
cfg: {
|
||||
plugins: {
|
||||
entries: {
|
||||
firecrawl: {
|
||||
enabled: true,
|
||||
config: {
|
||||
webFetch: {
|
||||
apiKey: "firecrawl-key",
|
||||
baseUrl: "https://api.firecrawl.dev",
|
||||
onlyMainContent: false,
|
||||
maxAgeMs: 5000,
|
||||
timeoutSeconds: 22,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
url: "https://docs.openclaw.ai",
|
||||
extractMode: "markdown",
|
||||
maxChars: 1500,
|
||||
proxy: "stealth",
|
||||
storeInCache: false,
|
||||
onlyMainContent: false,
|
||||
maxAgeMs: 5000,
|
||||
timeoutSeconds: 22,
|
||||
});
|
||||
});
|
||||
|
||||
it("applies minimal provider-selection config for fetch providers", () => {
|
||||
const provider = createFirecrawlWebFetchProvider();
|
||||
if (!provider.applySelectionConfig) {
|
||||
throw new Error("Expected applySelectionConfig to be defined");
|
||||
}
|
||||
const applied = provider.applySelectionConfig({});
|
||||
|
||||
expect(provider.id).toBe("firecrawl");
|
||||
expect(provider.credentialPath).toBe("plugins.entries.firecrawl.config.webFetch.apiKey");
|
||||
expect(applied.plugins?.entries?.firecrawl?.enabled).toBe(true);
|
||||
});
|
||||
|
||||
it("passes proxy and storeInCache through the fetch provider tool", async () => {
|
||||
const { createFirecrawlWebFetchProvider } = await import("./firecrawl-fetch-provider.js");
|
||||
const provider = createFirecrawlWebFetchProvider();
|
||||
|
||||
Reference in New Issue
Block a user