Spaces:
Running
Running
File size: 8,687 Bytes
6ace587 | 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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | import { basename } from "node:path";
import debug from "debug";
import { convert as convertHtmlToPlainText } from "html-to-text";
import { strip as stripEmojis } from "node-emoji";
import { CircuitBreaker } from "./utils/circuitBreaker.ts";
const fileName = basename(import.meta.url);
const printMessage = debug(fileName);
printMessage.enabled = true;
const SERVICE_HOST = "127.0.0.1";
const SERVICE_PORT = 8888;
const SERVICE_BASE_URL = `http://${SERVICE_HOST}:${SERVICE_PORT}`;
const MAX_RETRIES = 3;
const BASE_RETRY_DELAY = 1000;
// successThreshold: 1 preserves the previous breaker's single-success reset:
// once resetTimeout elapses, one healthy request closes the circuit again.
const searxngCircuitBreaker = new CircuitBreaker({
failureThreshold: 5,
resetTimeout: 60_000,
successThreshold: 1,
});
type SearchType = "text" | "images";
interface SearxngSearchResult {
title: string;
url: string;
content?: string;
category?: string;
template?: string;
engine?: string;
img_src?: string;
iframe_src?: string;
thumbnail?: string;
thumbnail_src?: string;
}
interface SearxngSearchResponse {
results?: SearxngSearchResult[];
number_of_results?: number;
unresponsive_engines?: unknown[];
}
const defaultSearchParams = {
lang: "auto",
safesearch: "1",
format: "json",
} as const;
export async function startWebSearchService() {
printMessage("Preparing service...");
const maxAttempts = 30;
const checkInterval = 1000;
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
const isReady = await getWebSearchStatus();
if (isReady) {
printMessage("Service ready!");
return;
}
if (attempt === maxAttempts) {
printMessage("Service not available!");
return;
}
await new Promise((resolve) => setTimeout(resolve, checkInterval));
}
}
export async function getWebSearchStatus() {
try {
const response = await fetch(`${SERVICE_BASE_URL}/healthz`);
const responseText = await response.text();
return responseText.trim() === "OK";
} catch {
return false;
}
}
function buildSearchUrl(query: string, searchType: SearchType) {
const params = new URLSearchParams(defaultSearchParams);
params.set("q", query);
params.set("categories", searchType === "text" ? "general" : "images,videos");
return `${SERVICE_BASE_URL}/search?${params.toString()}`;
}
/**
* Extracts a concise, human-readable reason from SearXNG's `unresponsive_engines`
* field. SearXNG reports each failed engine as a `[engine, reason]` pair (e.g.
* `["google", "Timeout"]`, `["bing", "Suspended: Access denied"]`). This is the
* only failure signal available to MiniSearch, since SearXNG's own (very verbose)
* stdout/stderr is intentionally discarded to keep the server logs clean.
*
* @returns A summary string, or null when no engine errors were reported.
*/
export function describeUnresponsiveEngines(
unresponsiveEngines: unknown,
): string | null {
if (!Array.isArray(unresponsiveEngines) || unresponsiveEngines.length === 0) {
return null;
}
return unresponsiveEngines
.map((entry) => {
if (Array.isArray(entry)) {
const [engine, reason] = entry;
return reason ? `${engine} (${reason})` : String(engine);
}
return String(entry);
})
.join(", ");
}
async function performSearch(
query: string,
searchType: SearchType,
): Promise<SearxngSearchResult[]> {
const searchUrl = buildSearchUrl(query, searchType);
for (let attempt = 0; attempt <= MAX_RETRIES; attempt++) {
if (attempt > 0) {
const delay = BASE_RETRY_DELAY * 2 ** (attempt - 1);
printMessage(
`SearXNG returned 500, retrying in ${delay}ms (attempt ${attempt}/${MAX_RETRIES})`,
);
await new Promise((resolve) => setTimeout(resolve, delay));
}
const response = await fetch(searchUrl, {
headers: { Accept: "application/json" },
});
if (!response.ok) {
if (response.status === 500 && attempt < MAX_RETRIES) {
continue;
}
throw new Error(`SearXNG request failed with status ${response.status}`);
}
const data = (await response.json()) as SearxngSearchResponse;
const results = Array.isArray(data.results) ? data.results : [];
if (results.length === 0) {
const reason = describeUnresponsiveEngines(data.unresponsive_engines);
printMessage(
reason
? `No results returned from SearXNG for query: ${query}. Unresponsive engines: ${reason}`
: `No results returned from SearXNG for query: ${query}. No engine errors were reported; all engines returned zero results.`,
);
}
return results;
}
throw new Error(
`SearXNG request failed with status 500 after ${MAX_RETRIES} retries`,
);
}
async function processSearchResults(
query: string,
searchType: SearchType,
limit: number,
breaker: CircuitBreaker,
) {
const results = await breaker.execute("searxng", () =>
performSearch(query, searchType),
);
const deduplicatedResults = deduplicateResults(results);
if (searchType === "text") {
const textualResults = await Promise.all(
deduplicatedResults.slice(0, limit).map(processTextualResult),
);
return reportDiscardedResults(
filterNullResults(textualResults),
results.length,
query,
searchType,
);
}
const graphicalResults = await Promise.all(
deduplicatedResults.slice(0, limit).map(processGraphicalResult),
);
return reportDiscardedResults(
filterNullResults(graphicalResults),
results.length,
query,
searchType,
);
}
/**
* Logs when SearXNG returned results but every one was dropped during processing
* (e.g. missing title, snippet, or media source). Without this, the discarded
* batch surfaces to the user as an opaque "Search failed" with no server-side
* trace of why the non-empty response yielded nothing usable.
*/
function reportDiscardedResults<T>(
filteredResults: T[],
rawResultCount: number,
query: string,
searchType: SearchType,
): T[] {
if (rawResultCount > 0 && filteredResults.length === 0) {
printMessage(
`All ${rawResultCount} ${searchType} result(s) from SearXNG for query: ${query} were discarded during processing (missing title, snippet, or media source).`,
);
}
return filteredResults;
}
export async function fetchSearXNG(
query: string,
searchType: SearchType,
limit = 30,
breaker: CircuitBreaker = searxngCircuitBreaker,
) {
try {
return await processSearchResults(query, searchType, limit, breaker);
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
printMessage(`Search failed: ${errorMessage}`);
return [];
}
}
async function processGraphicalResult(result: SearxngSearchResult) {
const thumbnailSource =
result.category === "videos" ? result.thumbnail : result.thumbnail_src;
const sourceUrl =
result.category === "videos"
? result.iframe_src || result.url
: result.img_src;
try {
return [result.title, result.url, thumbnailSource, sourceUrl] as [
title: string,
url: string,
thumbnailSource: string,
sourceUrl: string,
];
} catch (error) {
console.warn(
`Failed to process ${result.category} result: ${result.url}`,
error instanceof Error ? error.message : error,
);
return null;
}
}
function processSnippet(snippet: string): string {
const processedSnippet = stripEmojis(
convertHtmlToPlainText(snippet, { wordwrap: false }).trim(),
{ preserveSpaces: true },
);
if (processedSnippet.startsWith("[data:image")) return "";
return processedSnippet;
}
async function processTextualResult(result: SearxngSearchResult) {
try {
if (!result.content) return null;
const title = convertHtmlToPlainText(result.title, {
wordwrap: false,
}).trim();
const snippet = processSnippet(result.content);
if (!title || !snippet) return null;
return [title, snippet, result.url] as [
title: string,
content: string,
url: string,
];
} catch (error) {
console.warn(
`Failed to process textual result: ${result.url}`,
error instanceof Error ? error.message : error,
);
return null;
}
}
function deduplicateResults(
results: SearxngSearchResult[],
): SearxngSearchResult[] {
const urls = new Set<string>();
return results.filter((result) => {
if (urls.has(result.url)) return false;
urls.add(result.url);
return true;
});
}
function filterNullResults<T>(results: (T | null)[]): T[] {
return results.filter((result): result is T => result !== null);
}
|