opencode-search-plugin 2.1.1 → 3.0.0

package/plugins/querit-search.ts

@@ -122,8 +122,12 @@ type SearchResult = ReturnType<typeof toResult>
 //
 //   QUERIT_CACHE_TTL   ms to reuse a response for the same query (0 disables)
 //   QUERIT_COUNT       results per search; Querit's own limit applies
-//   QUERIT_API_KEY     required; from https://querit.ai
+//   QUERIT_TIMEOUT     ms to wait before failing (0 removes the deadline)
+//   OSP_QUERIT_API_KEY     required; from https://querit.ai
 const CACHE_TTL = envInt("QUERIT_CACHE_TTL", 600_000)
+// OpenCode's own providers each bounded themselves at 25s, and the host adds
+// no deadline of its own around `execute`, so this is the only one that exists.
+const SEARCH_TIMEOUT = envInt("QUERIT_TIMEOUT", 25_000)
 const SEARCH_SIZE = envInt("QUERIT_COUNT", 8)
 
 const CACHE_LIMIT = 200
@@ -148,6 +152,14 @@ function writeCache(queryKey: string, results: SearchResult[]): void {
   }
 }
 
+// A hung upstream must not hang the agent: the deadline bounds it, and the
+// thunk's signal carries host cancellation into the socket. `timeout <= 0`
+// removes the deadline but never the cancellation, because
+// `AbortSignal.timeout(0)` aborts instantly rather than "never".
+function timedSignal(signal: AbortSignal, timeout: number): AbortSignal {
+  return timeout > 0 ? AbortSignal.any([signal, AbortSignal.timeout(timeout)]) : signal
+}
+
 export const effect = (ctx: Plugin.Context) =>
   Effect.gen(function* () {
     // Make "Querit" show up in /connect with an API-key method.
@@ -161,7 +173,7 @@ export const effect = (ctx: Plugin.Context) =>
       })
       editor.method.update({
         integrationID: ID,
-        method: { type: "env", names: ["QUERIT_API_KEY"] },
+        method: { type: "env", names: ["OSP_QUERIT_API_KEY"] },
       })
     })
 
@@ -181,7 +193,7 @@ export const effect = (ctx: Plugin.Context) =>
         const credential = connection
           ? yield* soften(ctx.integration.connection.resolve(connection))
           : undefined
-        return credential?.type === "key" ? credential.key : process.env.QUERIT_API_KEY
+        return credential?.type === "key" ? credential.key : process.env.OSP_QUERIT_API_KEY
       })
 
     // Querit is bound to websearch only while a key exists. Deleting the key
@@ -205,12 +217,12 @@ export const effect = (ctx: Plugin.Context) =>
             const key = yield* resolveKey()
             if (!key) {
               return yield* Effect.fail(
-                new Error("Connect Querit in /connect, or set QUERIT_API_KEY"),
+                new Error("Connect Querit in /connect, or set OSP_QUERIT_API_KEY"),
               )
             }
 
             const response = yield* Effect.tryPromise({
-              try: () =>
+              try: (signal) =>
                 fetch("https://api.querit.ai/v1/search", {
                   method: "POST",
                   headers: {
@@ -219,8 +231,14 @@ export const effect = (ctx: Plugin.Context) =>
                     Authorization: "Bearer " + key,
                   },
                   body: JSON.stringify({ query: queryKey, count: SEARCH_SIZE }),
+                  signal: timedSignal(signal, SEARCH_TIMEOUT),
                 }),
-              catch: (error) => new Error("Querit request failed: " + String(error)),
+              // A timeout is its own failure: naming it stops the user hunting
+              // for a key problem that was never there.
+              catch: (error) =>
+                error instanceof Error && error.name === "TimeoutError"
+                  ? new Error("Querit search timed out after " + SEARCH_TIMEOUT + "ms")
+                  : new Error("Querit request failed: " + String(error)),
             })
 
             if (!response.ok) {

package/plugins/serpapi-search.ts

@@ -111,11 +111,15 @@ type SearchResult = ReturnType<typeof toResult>
 //   SERPAPI_GL         country code for results, e.g. "us", "cn"
 //   SERPAPI_HL         language code for results, e.g. "en", "zh-cn"
 //   SERPAPI_TBS        advanced filters, e.g. "qdr:d" (past day), "qdr:y"
-//   SERPAPI_API_KEY    required; from https://serpapi.com
+//   SERPAPI_TIMEOUT    ms to wait before failing (0 removes the deadline)
+//   OSP_SERPAPI_API_KEY    required; from https://serpapi.com
 //
 // There is deliberately no result-count knob: Google withdrew the `num`
 // parameter, so SerpApi cannot honour one and a count would be a lie.
 const CACHE_TTL = envInt("SERPAPI_CACHE_TTL", 600_000)
+// OpenCode's own providers each bounded themselves at 25s, and the host adds
+// no deadline of its own around `execute`, so this is the only one that exists.
+const SEARCH_TIMEOUT = envInt("SERPAPI_TIMEOUT", 25_000)
 const GL = envStr("SERPAPI_GL")
 const HL = envStr("SERPAPI_HL")
 const TBS = envStr("SERPAPI_TBS")
@@ -142,6 +146,14 @@ function writeCache(queryKey: string, results: SearchResult[]): void {
   }
 }
 
+// A hung upstream must not hang the agent: the deadline bounds it, and the
+// thunk's signal carries host cancellation into the socket. `timeout <= 0`
+// removes the deadline but never the cancellation, because
+// `AbortSignal.timeout(0)` aborts instantly rather than "never".
+function timedSignal(signal: AbortSignal, timeout: number): AbortSignal {
+  return timeout > 0 ? AbortSignal.any([signal, AbortSignal.timeout(timeout)]) : signal
+}
+
 export const effect = (ctx: Plugin.Context) =>
   Effect.gen(function* () {
     // Make "SerpApi" show up in /connect with an API-key method.
@@ -155,7 +167,7 @@ export const effect = (ctx: Plugin.Context) =>
       })
       editor.method.update({
         integrationID: ID,
-        method: { type: "env", names: ["SERPAPI_API_KEY"] },
+        method: { type: "env", names: ["OSP_SERPAPI_API_KEY"] },
       })
     })
 
@@ -175,7 +187,7 @@ export const effect = (ctx: Plugin.Context) =>
         const credential = connection
           ? yield* soften(ctx.integration.connection.resolve(connection))
           : undefined
-        return credential?.type === "key" ? credential.key : process.env.SERPAPI_API_KEY
+        return credential?.type === "key" ? credential.key : process.env.OSP_SERPAPI_API_KEY
       })
 
     // SerpApi is bound to websearch only while a key exists. Deleting the key
@@ -199,7 +211,7 @@ export const effect = (ctx: Plugin.Context) =>
             const key = yield* resolveKey()
             if (!key) {
               return yield* Effect.fail(
-                new Error("Connect SerpApi in /connect, or set SERPAPI_API_KEY"),
+                new Error("Connect SerpApi in /connect, or set OSP_SERPAPI_API_KEY"),
               )
             }
 
@@ -212,13 +224,19 @@ export const effect = (ctx: Plugin.Context) =>
             if (TBS) url.searchParams.set("tbs", TBS)
 
             const response = yield* Effect.tryPromise({
-              try: () =>
+              try: (signal) =>
                 fetch(url, {
                   headers: {
                     Accept: "application/json",
                   },
+                  signal: timedSignal(signal, SEARCH_TIMEOUT),
                 }),
-              catch: (error) => new Error("SerpApi request failed: " + String(error)),
+              // A timeout is its own failure: naming it stops the user hunting
+              // for a key problem that was never there.
+              catch: (error) =>
+                error instanceof Error && error.name === "TimeoutError"
+                  ? new Error("SerpApi search timed out after " + SEARCH_TIMEOUT + "ms")
+                  : new Error("SerpApi request failed: " + String(error)),
             })
 
             if (!response.ok) {

package/plugins/serper-search.ts

@@ -112,8 +112,12 @@ type SearchResult = ReturnType<typeof toResult>
 //   SERPER_HL          language code for results, e.g. "en", "zh-cn"
 //   SERPER_TBS         time filter: "qdr:h" (hour) "qdr:d" (day) "qdr:w" (week)
 //                      "qdr:m" (month) "qdr:y" (year)
-//   SERPER_API_KEY     required; from https://serper.dev
+//   SERPER_TIMEOUT     ms to wait before failing (0 removes the deadline)
+//   OSP_SERPER_API_KEY     required; from https://serper.dev
 const CACHE_TTL = envInt("SERPER_CACHE_TTL", 600_000)
+// OpenCode's own providers each bounded themselves at 25s, and the host adds
+// no deadline of its own around `execute`, so this is the only one that exists.
+const SEARCH_TIMEOUT = envInt("SERPER_TIMEOUT", 25_000)
 const SEARCH_SIZE = Math.min(Math.max(envInt("SERPER_NUM", 10), 1), 100)
 const GL = envStr("SERPER_GL")
 const HL = envStr("SERPER_HL")
@@ -141,6 +145,14 @@ function writeCache(queryKey: string, results: SearchResult[]): void {
   }
 }
 
+// A hung upstream must not hang the agent: the deadline bounds it, and the
+// thunk's signal carries host cancellation into the socket. `timeout <= 0`
+// removes the deadline but never the cancellation, because
+// `AbortSignal.timeout(0)` aborts instantly rather than "never".
+function timedSignal(signal: AbortSignal, timeout: number): AbortSignal {
+  return timeout > 0 ? AbortSignal.any([signal, AbortSignal.timeout(timeout)]) : signal
+}
+
 export const effect = (ctx: Plugin.Context) =>
   Effect.gen(function* () {
     // Make "Serper" show up in /connect with an API-key method.
@@ -154,7 +166,7 @@ export const effect = (ctx: Plugin.Context) =>
       })
       editor.method.update({
         integrationID: ID,
-        method: { type: "env", names: ["SERPER_API_KEY"] },
+        method: { type: "env", names: ["OSP_SERPER_API_KEY"] },
       })
     })
 
@@ -174,7 +186,7 @@ export const effect = (ctx: Plugin.Context) =>
         const credential = connection
           ? yield* soften(ctx.integration.connection.resolve(connection))
           : undefined
-        return credential?.type === "key" ? credential.key : process.env.SERPER_API_KEY
+        return credential?.type === "key" ? credential.key : process.env.OSP_SERPER_API_KEY
       })
 
     // Serper is bound to websearch only while a key exists. Deleting the key
@@ -198,12 +210,12 @@ export const effect = (ctx: Plugin.Context) =>
             const key = yield* resolveKey()
             if (!key) {
               return yield* Effect.fail(
-                new Error("Connect Serper in /connect, or set SERPER_API_KEY"),
+                new Error("Connect Serper in /connect, or set OSP_SERPER_API_KEY"),
               )
             }
 
             const response = yield* Effect.tryPromise({
-              try: () =>
+              try: (signal) =>
                 fetch("https://google.serper.dev/search", {
                   method: "POST",
                   headers: {
@@ -218,8 +230,14 @@ export const effect = (ctx: Plugin.Context) =>
                     ...(HL ? { hl: HL } : {}),
                     ...(TBS ? { tbs: TBS } : {}),
                   }),
+                  signal: timedSignal(signal, SEARCH_TIMEOUT),
                 }),
-              catch: (error) => new Error("Serper request failed: " + String(error)),
+              // A timeout is its own failure: naming it stops the user hunting
+              // for a key problem that was never there.
+              catch: (error) =>
+                error instanceof Error && error.name === "TimeoutError"
+                  ? new Error("Serper search timed out after " + SEARCH_TIMEOUT + "ms")
+                  : new Error("Serper request failed: " + String(error)),
             })
 
             if (!response.ok) {

package/plugins/youcom-search.ts

@@ -140,8 +140,12 @@ type SearchResult = ReturnType<typeof toResult>
 //   YOUCOM_LANGUAGE      result language, e.g. "EN", "ZH-HANS"
 //   YOUCOM_COUNTRY       geographic focus, e.g. "US", "CN"
 //   YOUCOM_FRESHNESS     "day" | "week" | "month" | "year" or "YYYY-MM-DDtoYYYY-MM-DD"
-//   YDC_API_KEY          required; You.com's canonical env var, shared with its SDKs
+//   YOUCOM_TIMEOUT       ms to wait before failing (0 removes the deadline)
+//   OSP_YDC_API_KEY          required; You.com's canonical env var, shared with its SDKs
 const CACHE_TTL = envInt("YOUCOM_CACHE_TTL", 600_000)
+// OpenCode's own providers each bounded themselves at 25s, and the host adds
+// no deadline of its own around `execute`, so this is the only one that exists.
+const SEARCH_TIMEOUT = envInt("YOUCOM_TIMEOUT", 25_000)
 const SEARCH_SIZE = Math.min(Math.max(envInt("YOUCOM_COUNT", 10), 1), 100)
 const EXTRACTION = ["none", "highlights", "full_page"].includes(envStr("YOUCOM_EXTRACTION"))
   ? envStr("YOUCOM_EXTRACTION")
@@ -172,6 +176,14 @@ function writeCache(queryKey: string, results: SearchResult[]): void {
   }
 }
 
+// A hung upstream must not hang the agent: the deadline bounds it, and the
+// thunk's signal carries host cancellation into the socket. `timeout <= 0`
+// removes the deadline but never the cancellation, because
+// `AbortSignal.timeout(0)` aborts instantly rather than "never".
+function timedSignal(signal: AbortSignal, timeout: number): AbortSignal {
+  return timeout > 0 ? AbortSignal.any([signal, AbortSignal.timeout(timeout)]) : signal
+}
+
 export const effect = (ctx: Plugin.Context) =>
   Effect.gen(function* () {
     // Make "You.com" show up in /connect with an API-key method.
@@ -185,7 +197,7 @@ export const effect = (ctx: Plugin.Context) =>
       })
       editor.method.update({
         integrationID: ID,
-        method: { type: "env", names: ["YDC_API_KEY"] },
+        method: { type: "env", names: ["OSP_YDC_API_KEY"] },
       })
     })
 
@@ -205,7 +217,7 @@ export const effect = (ctx: Plugin.Context) =>
         const credential = connection
           ? yield* soften(ctx.integration.connection.resolve(connection))
           : undefined
-        return credential?.type === "key" ? credential.key : process.env.YDC_API_KEY
+        return credential?.type === "key" ? credential.key : process.env.OSP_YDC_API_KEY
       })
 
     // You.com is bound to websearch only while a key exists. Deleting the key
@@ -229,7 +241,7 @@ export const effect = (ctx: Plugin.Context) =>
             const key = yield* resolveKey()
             if (!key) {
               return yield* Effect.fail(
-                new Error("Connect You.com in /connect, or set YDC_API_KEY"),
+                new Error("Connect You.com in /connect, or set OSP_YDC_API_KEY"),
               )
             }
 
@@ -244,7 +256,7 @@ export const effect = (ctx: Plugin.Context) =>
                   : undefined
 
             const response = yield* Effect.tryPromise({
-              try: () =>
+              try: (signal) =>
                 fetch("https://ydc-index.io/v1/search", {
                   method: "POST",
                   headers: {
@@ -260,8 +272,14 @@ export const effect = (ctx: Plugin.Context) =>
                     ...(FRESHNESS ? { freshness: FRESHNESS } : {}),
                     ...(extraction ? { extraction } : {}),
                   }),
+                  signal: timedSignal(signal, SEARCH_TIMEOUT),
                 }),
-              catch: (error) => new Error("You.com request failed: " + String(error)),
+              // A timeout is its own failure: naming it stops the user hunting
+              // for a key problem that was never there.
+              catch: (error) =>
+                error instanceof Error && error.name === "TimeoutError"
+                  ? new Error("You.com search timed out after " + SEARCH_TIMEOUT + "ms")
+                  : new Error("You.com request failed: " + String(error)),
             })
 
             if (!response.ok) {