dsh-web-search-plugin 0.4.1 → 0.5.0

package/lib/usage.js

@@ -1,11 +1,11 @@
 /**
  * Local usage cache for Tavily keyed searches and Brave rate-limit headers.
  *
- * Tavily: each keyed search sends `include_usage` and adds those credits to a
- * high-water local counter. A slower `GET /usage` poll supplies plan name /
- * plan_limit and the vendor's own used count. Displayed used is
- * `max(local, remote)`. A drop in remote used, or a plan/limit change, is
- * treated as a new billing cycle (local resets to remote).
+ * Tavily: each keyed search sends `include_usage` and adds those credits to an
+ * in-memory counter for the current credential only. A slower `GET /usage`
+ * poll supplies plan name / plan_limit and the vendor's own used count.
+ * Displayed used is `max(local, remote)`. Switching keys discards the old
+ * account's data; a billing-cycle change resets the local counter.
  *
  * Brave: there is no usage endpoint. Limit / remaining / reset come from
  * `X-RateLimit-*` on each search response and are cached as-is.
@@ -13,14 +13,17 @@
  * @module dsh-web-search-plugin/usage
  */
 import { homedir } from "node:os";
+import { createHash } from "node:crypto";
 import { dirname, join } from "node:path";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { USER_AGENT, resolveApiKey } from "./shared.js";
 
-/** Persist path under `$DSH_HOME/storages`. */
+/** Persist path for Brave rate-limit data under `$DSH_HOME/storages`. */
 export const USAGE_FILE = join(process.env.DSH_HOME || join(homedir(), ".dsh"), "storages", "dsh-web-search-usage.json");
 /** Tavily `/usage` is itself rate-limited (~10 / 10 min); poll slower than that. */
 export const TAVILY_USAGE_POLL_MS = 10 * 60 * 1000;
+/** Keep manual refreshes from exhausting Tavily's `/usage` request budget. */
+export const TAVILY_USAGE_MIN_INTERVAL_MS = 10 * 1000;
 /** Coalesce disk writes. */
 const SAVE_DEBOUNCE_MS = 800;
 
@@ -198,6 +201,8 @@ export class UsageTracker {
 		this.state = emptyState();
 		this.saveTimer = null;
 		this.hydrated = false;
+		this.tavilyKeyFingerprint = null;
+		this.lastTavilyManualAttemptAt = 0;
 	}
 
 	/** Load the previous process's cache; missing file is a first run. */
@@ -205,11 +210,8 @@ export class UsageTracker {
 		try {
 			const raw = JSON.parse(await readFile(USAGE_FILE, "utf8"));
 			if (raw && typeof raw === "object") {
-				this.state = {
-					version: 1,
-					tavily: { ...emptyState().tavily, ...(raw.tavily && typeof raw.tavily === "object" ? raw.tavily : {}) },
-					brave: { ...emptyState().brave, ...(raw.brave && typeof raw.brave === "object" ? raw.brave : {}) }
-				};
+				this.state.brave = { ...emptyState().brave, ...(raw.brave && typeof raw.brave === "object" ? raw.brave : {}) };
+				if (Object.hasOwn(raw, "tavily")) this.scheduleSave();
 			}
 		} catch {
 			/* first run */
@@ -257,9 +259,27 @@ export class UsageTracker {
 		};
 	}
 
-	recordTavilyCredits(credits) {
+	activateTavilyKey(apiKey, baseURL) {
+		const fingerprint = createHash("sha256").update(baseURL).update("\0").update(apiKey).digest("hex");
+		if (fingerprint !== this.tavilyKeyFingerprint) {
+			this.tavilyKeyFingerprint = fingerprint;
+			this.state.tavily = emptyState().tavily;
+			this.lastTavilyManualAttemptAt = 0;
+		}
+		return fingerprint;
+	}
+
+	async recordTavilyCredits(credits, apiKey) {
+		if (typeof apiKey !== "string" || apiKey.length === 0) return;
+		let options;
+		try {
+			options = this.getTavilyOptions?.();
+			if (options?.mode !== "keyed" || await resolveApiKey(options, undefined, "Tavily usage has no API key") !== apiKey) return;
+		} catch {
+			return;
+		}
+		this.activateTavilyKey(apiKey, options.baseURL);
 		this.state.tavily = mergeTavilyCredits(this.state.tavily, credits);
-		this.scheduleSave();
 	}
 
 	recordBraveHeaders(headers) {
@@ -279,18 +299,27 @@ export class UsageTracker {
 		const options = this.getTavilyOptions?.();
 		if (options == null || options.mode !== "keyed") return this.snapshot();
 		if (!URL.canParse(options.baseURL)) return this.snapshot();
-		const last = this.state.tavily.fetchedAt || 0;
-		const hasIdentity = this.state.tavily.plan != null || this.state.tavily.limit != null;
-		const interval = hasIdentity ? TAVILY_USAGE_POLL_MS : 60_000;
-		if (!force && last > 0 && (Date.now() - last) < interval) return this.snapshot();
 		let apiKey;
 		try {
 			apiKey = await resolveApiKey(options, signal, "Tavily usage has no API key");
 		} catch (error) {
-			this.state.tavily = { ...this.state.tavily, error: String(error?.message ?? error), fetchedAt: Date.now() };
-			this.scheduleSave();
+			this.tavilyKeyFingerprint = null;
+			this.state.tavily = { ...emptyState().tavily, error: String(error?.message ?? error), fetchedAt: Date.now() };
 			return this.snapshot();
 		}
+		const fingerprint = this.activateTavilyKey(apiKey, options.baseURL);
+		const now = Date.now();
+		if (force && this.lastTavilyManualAttemptAt > 0 && now - this.lastTavilyManualAttemptAt < TAVILY_USAGE_MIN_INTERVAL_MS) return this.snapshot();
+		const last = this.state.tavily.fetchedAt || 0;
+		const hasIdentity = this.state.tavily.plan != null || this.state.tavily.limit != null;
+		const interval = hasIdentity ? TAVILY_USAGE_POLL_MS : 60_000;
+		if (!force && last > 0 && now - last < interval) return this.snapshot();
+		if (force) this.lastTavilyManualAttemptAt = now;
+		const isCurrent = () => fingerprint === this.tavilyKeyFingerprint;
+		const fail = (message) => {
+			if (isCurrent()) this.state.tavily = { ...this.state.tavily, error: message, fetchedAt: Date.now() };
+			return this.snapshot();
+		};
 		const endpoint = `${options.baseURL.replace(/\/+$/u, "")}/usage`;
 		let response;
 		try {
@@ -305,30 +334,24 @@ export class UsageTracker {
 				...signal !== void 0 ? { signal } : {}
 			});
 		} catch (error) {
-			this.state.tavily = { ...this.state.tavily, error: String(error?.message ?? error), fetchedAt: Date.now() };
-			this.scheduleSave();
-			return this.snapshot();
+			return fail(String(error?.message ?? error));
 		}
 		if (!response.ok) {
-			this.state.tavily = { ...this.state.tavily, error: `Tavily /usage HTTP ${response.status}`, fetchedAt: Date.now() };
-			this.scheduleSave();
-			return this.snapshot();
+			return fail(`Tavily /usage HTTP ${response.status}`);
 		}
 		let body;
 		try {
 			body = await response.json();
 		} catch (error) {
-			this.state.tavily = { ...this.state.tavily, error: String(error?.message ?? error), fetchedAt: Date.now() };
-			this.scheduleSave();
-			return this.snapshot();
+			return fail(String(error?.message ?? error));
 		}
+		if (!isCurrent()) return this.snapshot();
 		const remote = parseTavilyUsageBody(body);
 		if (remote === null) {
 			this.state.tavily = { ...this.state.tavily, error: "Tavily /usage returned an unreadable body", fetchedAt: Date.now() };
 		} else {
 			this.state.tavily = mergeTavilyRemote(this.state.tavily, remote);
 		}
-		this.scheduleSave();
 		return this.snapshot();
 	}
 
@@ -336,7 +359,7 @@ export class UsageTracker {
 		if (this.saveTimer !== null) return;
 		this.saveTimer = setTimeout(() => {
 			this.saveTimer = null;
-			const payload = JSON.stringify(this.state);
+			const payload = JSON.stringify({ version: 1, brave: this.state.brave });
 			mkdir(dirname(USAGE_FILE), { recursive: true })
 				.then(() => writeFile(USAGE_FILE, payload))
 				.catch(() => { /* in-memory cache still serves the UI */ });

package/locale/en.json

@@ -0,0 +1,6 @@
+{
+  "meta": {
+    "title": "Web search",
+    "description": "Unified web search for the DeepSeek Harness seam (ctx.web): DeepSeek (official), Tavily, Brave, Serper, SerpApi, Exa, SearXNG, Scavio, and Firecrawl. Switch engines from settings."
+  }
+}

package/locale/zh.json

@@ -0,0 +1,6 @@
+{
+  "meta": {
+    "title": "网页搜索",
+    "description": "为 DeepSeek Harness 接缝（ctx.web）提供统一网页搜索：DeepSeek（官方）、Tavily、Brave、Serper、SerpApi、Exa、SearXNG、Scavio、Firecrawl，可在设置中切换引擎。"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-web-search-plugin",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Unified web search for the DeepSeek Harness seam (ctx.web): DeepSeek (official), Tavily, Brave, Serper, SerpApi, Exa, SearXNG, Scavio, and Firecrawl backends",
   "keywords": [
     "dsh-plugin",
@@ -18,6 +18,7 @@
   "main": "lib/index.js",
   "files": [
     "lib",
+    "locale",
     "cordis.patch.yml",
     "CHANGELOG.md",
     "README.md",
@@ -34,6 +35,7 @@
       "default": "./lib/client.js"
     },
     "./cordis.patch.yml": "./cordis.patch.yml",
+    "./locale/*.json": "./locale/*.json",
     "./package.json": "./package.json"
   },
   "dsh": {
@@ -51,18 +53,19 @@
     }
   },
   "scripts": {
-    "check": "node --check lib/index.js && node --check lib/client.js && node --check lib/shared.js && node --check lib/providers.js && node --check lib/rest.js && node --check lib/tavily.js && node --check lib/brave.js && node --check lib/deepseek.js && node --check lib/usage.js"
+    "check": "node --check lib/index.js && node --check lib/client.js && node --check lib/shared.js && node --check lib/providers.js && node --check lib/rest.js && node --check lib/tavily.js && node --check lib/brave.js && node --check lib/deepseek.js && node --check lib/usage.js",
+    "test": "node --experimental-vm-modules --test test/*.test.mjs"
   },
   "dependencies": {
     "undici": "^6.21.0"
   },
   "peerDependencies": {
-    "@deepseek-ai/dsh-web": "^0.1.5-rc.1",
-    "@deepseek-ai/dsh-credentials": "^0.1.5-rc.1",
-    "@deepseek-ai/dsh-settings": "^0.1.5-rc.1",
-    "@deepseek-ai/dsh-launch-environment": "^0.1.5-rc.1",
-    "@deepseek-ai/schemastery": "^3.18.2",
-    "@deepseek-ai/cordis": "^4.0.2"
+    "@deepseek-ai/dsh-web": "^0.2.0-rc.2",
+    "@deepseek-ai/dsh-credentials": "^0.2.0-rc.2",
+    "@deepseek-ai/dsh-settings": "^0.2.0-rc.2",
+    "@deepseek-ai/dsh-launch-environment": "^0.2.0-rc.2",
+    "@deepseek-ai/schemastery": "~3.18.4",
+    "@deepseek-ai/cordis": "~4.0.4"
   },
   "license": "MIT",
   "repository": {