Spaces:
Running
Running
File size: 25,574 Bytes
ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 e759542 ccc76d6 | 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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 | import { randomUUID } from "node:crypto";
import { basename } from "node:path";
import debug from "debug";
const fileName = basename(import.meta.url);
const printMessage = debug(fileName);
printMessage.enabled = true;
const MCP_PROTOCOL_VERSION = "2025-06-18";
// Bounds the whole cascade, not each request: a fallback that hangs longer
// than this keeps the 502 the operator already gets from SearXNG waiting for
// a second source that is only there to soften the outage.
const FALLBACK_TIMEOUT_MS = 15_000;
const MAX_SNIPPET_LENGTH = 400;
// Excerpts arrive with navigation crumbs ("Skip to main content", menu items)
// that are sentences of their own; a real excerpt paragraph never runs this
// short, so length is the cheapest way to drop them without a stoplist.
const MIN_SNIPPET_LINE_LENGTH = 40;
// You.com's acceptable use policy can suspend a client that keeps calling
// through 429s, so a provider that sends one is left alone for the time it
// asks for. A missing or unreadable Retry-After gets a minute, and no answer
// may box a provider for longer than an hour or shorter than a second.
const DEFAULT_RATE_LIMIT_PAUSE_MS = 60_000;
const MAX_RATE_LIMIT_PAUSE_MS = 3_600_000;
const MIN_RATE_LIMIT_PAUSE_MS = 1_000;
// One per server process: Parallel uses it for free-tier rate limiting and
// one MiniSearch instance is one client, so a fresh one per request would shed
// the rate limit instead of sharing it.
const SESSION_ID = randomUUID();
interface JsonRpcMessage {
id?: number;
error?: { code?: unknown };
result?: {
isError?: boolean;
content?: { type?: string; text?: string }[];
};
}
interface ParallelSearchResult {
url?: string;
title?: string | null;
publish_date?: string | null;
excerpts?: string[];
}
interface ParallelSearchDocument {
results?: ParallelSearchResult[];
}
// You.com's tool output: the web results sit one level deeper, under
// `results.web`, and each result carries a plain description plus, when the
// query matched the page, query-relevant highlights.
interface YoucomWebResult {
url?: string;
title?: string | null;
description?: string | null;
contents?: { highlights?: string[] } | null;
}
interface YoucomSearchDocument {
results?: { web?: YoucomWebResult[] };
}
type TextualResult = [title: string, content: string, url: string];
type ProviderName = "parallel" | "youcom";
interface MappedResults {
results: TextualResult[];
received: number;
}
interface FallbackProvider {
name: ProviderName;
apiKeyVariable: string;
endpointUrl: (apiKey: string) => string;
toolCall: (
query: string,
limit: number,
) => { name: string; arguments: Record<string, unknown> };
mapResults: (document: object, limit: number) => MappedResults;
}
const PROVIDERS: readonly FallbackProvider[] = [
{
name: "parallel",
apiKeyVariable: "SEARCH_FALLBACK_PARALLEL_API_KEY",
endpointUrl: () => "https://search.parallel.ai/mcp",
// No `model_name`: this is a search, not a completion, and the tool does
// not need a client that claims to be a model.
toolCall: (query) => ({
name: "web_search",
arguments: {
objective: query,
search_queries: [query],
session_id: SESSION_ID,
},
}),
mapResults: (document, limit) =>
mapParallelResults(document as ParallelSearchDocument, limit),
},
{
name: "youcom",
apiKeyVariable: "SEARCH_FALLBACK_YOUCOM_API_KEY",
// The free profile needs no key at all, and the key, when present,
// selects the authenticated endpoint instead.
endpointUrl: (apiKey) =>
apiKey
? "https://api.you.com/mcp"
: "https://api.you.com/mcp?profile=free",
toolCall: (query, limit) => ({
name: "you-search",
arguments: { query, count: limit },
}),
mapResults: (document, limit) =>
mapYoucomResults(document as YoucomSearchDocument, limit),
},
];
const PROVIDER_NAMES = PROVIDERS.map((provider) => provider.name);
// Each removed variable and what replaced it: an operator upgrading with the
// old names set would otherwise lose the key without a word and fall back to
// the keyless tiers.
const REMOVED_VARIABLES: readonly [variable: string, replacement: string][] = [
["SEARCH_FALLBACK_PROVIDER", "SEARCH_FALLBACK_PROVIDERS"],
[
"SEARCH_FALLBACK_API_KEY",
"SEARCH_FALLBACK_PARALLEL_API_KEY or SEARCH_FALLBACK_YOUCOM_API_KEY",
],
];
interface ProviderCounters {
served: number;
empty: number;
failed: number;
rateLimited: number;
skippedWhilePaused: number;
}
const providerCounters = new Map<ProviderName, ProviderCounters>(
PROVIDER_NAMES.map((name) => [
name,
{ served: 0, empty: 0, failed: 0, rateLimited: 0, skippedWhilePaused: 0 },
]),
);
const pausedUntil = new Map<ProviderName, number>();
class RateLimitedError extends Error {
readonly retryAfter: string | null;
constructor(retryAfter: string | null) {
super("The fallback search endpoint rate-limited the request (status 429)");
this.retryAfter = retryAfter;
}
}
/**
* Whether the operator opted into the second text-search source. Off unless
* `SEARCH_FALLBACK_ENABLED` is `true` or `1`, read at call time so tests can
* toggle it.
*/
export function isSearchFallbackEnabled(): boolean {
const value = (process.env.SEARCH_FALLBACK_ENABLED ?? "")
.trim()
.toLowerCase();
return value === "true" || value === "1";
}
/**
* Checks the fallback configuration and throws on the first thing wrong with
* it: a removed variable that is still set, an unknown provider name, a
* provider list with no names in it, or a key with a control character in it.
* Meant for server start, so a bad value stops the server instead of failing
* every search that reaches the fallback.
*/
export function assertSearchFallbackConfiguration(): void {
readConfiguredProviders();
}
/**
* The providers the operator listed in `SEARCH_FALLBACK_PROVIDERS`, or every
* built-in provider when it is unset or blank, as a fresh array the caller may
* reorder. The listed order carries no meaning, since every call shuffles it.
* Read at call time so tests can switch it.
*/
function readConfiguredProviders(): FallbackProvider[] {
const stillSet = REMOVED_VARIABLES.filter(
([variable]) => (process.env[variable] ?? "").trim() !== "",
);
if (stillSet.length > 0) {
throw new Error(
stillSet
.map(
([variable, replacement]) =>
`${variable} is no longer read; set ${replacement} instead.`,
)
.join(" "),
);
}
// undici quotes an invalid header value in full in its error, so a key with
// a line break inside it would reach the log as `Bearer <key>`. Refused
// here, by variable name only, so it fails at start instead.
const keyWithControlCharacter = PROVIDERS.find(({ apiKeyVariable }) =>
// biome-ignore lint/suspicious/noControlCharactersInRegex: matching them is the point.
/[\u0000-\u001f\u007f]/.test((process.env[apiKeyVariable] ?? "").trim()),
);
if (keyWithControlCharacter) {
throw new Error(
`${keyWithControlCharacter.apiKeyVariable} contains a control character; set it to the key alone.`,
);
}
const value = process.env.SEARCH_FALLBACK_PROVIDERS ?? "";
if (value.trim() === "") return [...PROVIDERS];
const names = value
.split(",")
.map((name) => name.trim().toLowerCase())
.filter((name) => name !== "");
if (names.length === 0) {
throw new Error(
`SEARCH_FALLBACK_PROVIDERS lists no provider; valid names: ${PROVIDER_NAMES.join(", ")}.`,
);
}
const unknown = names.filter(
(name) => !PROVIDER_NAMES.includes(name as ProviderName),
);
if (unknown.length > 0) {
throw new Error(
`SEARCH_FALLBACK_PROVIDERS has unknown provider names: ${unknown.join(", ")}; valid names: ${PROVIDER_NAMES.join(", ")}.`,
);
}
return PROVIDERS.filter((provider) => names.includes(provider.name));
}
/**
* Per-provider counters since the last restart, for `/status`, and how much
* longer each provider stays paused after a 429 (0 when it is not paused).
* `rateLimited` is a subset of `failed`. Provider names are configured
* infrastructure rather than anything a search supplied, so they are safe to
* publish.
*/
export function getFallbackProviderStats(): Record<
string,
ProviderCounters & { pausedForMs: number }
> {
const now = Date.now();
return Object.fromEntries(
PROVIDER_NAMES.map((name) => [
name,
{
...(providerCounters.get(name) as ProviderCounters),
pausedForMs: Math.max(0, (pausedUntil.get(name) ?? 0) - now),
},
]),
);
}
/**
* Runs a text search against the fallback providers when SearXNG has already
* failed, and returns the same `[title, snippet, url]` tuples the SearXNG path
* produces, so the caller can rank and render them unchanged.
*
* Every configured provider is a candidate, tried one at a time in a fresh
* random order on each call, so the load spreads across them and no single
* provider's outage or rate limit decides the outcome. A provider paused by
* an earlier 429 is skipped without a request. The first non-empty answer
* wins; an empty answer or an error moves on to the next provider.
*
* `timeoutMs` is the time the caller can still afford, measured from its own
* start: the cascade is bounded by this and by the module's own cap, whichever
* is shorter, and each attempt gets an equal share of what is left, so a
* provider that hangs cannot spend the time the next one needs.
*
* Returns an empty array when at least one provider answered and none had
* anything usable. Throws when every provider that was tried failed, with
* each one's name and error, or when none could be tried at all: the caller
* has to decide between a degraded answer and the 502 it would have sent
* anyway, and it has to be able to count the decision.
*/
export async function fetchFallbackTextResults(
query: string,
limit: number,
timeoutMs: number,
): Promise<TextualResult[]> {
const deadline = Date.now() + Math.min(FALLBACK_TIMEOUT_MS, timeoutMs);
const candidates = shuffle(readConfiguredProviders());
const failures: string[] = [];
const notTried: string[] = [];
let answered = false;
for (const [index, provider] of candidates.entries()) {
const remainingMs = deadline - Date.now();
if (remainingMs <= 0) {
notTried.push(...candidates.slice(index).map(({ name }) => name));
break;
}
// Checked again before every attempt, not once up front: another search
// can pause a provider while this one waits on an earlier attempt, and a
// paused provider must not get a new exchange. An exchange already under
// way runs to its end, which costs at most two more requests.
if (isPaused(provider.name)) {
countFor(provider.name).skippedWhilePaused++;
printMessage(`Fallback provider ${provider.name} skipped while paused.`);
continue;
}
const eligibleCount = candidates
.slice(index)
.filter((candidate) => !isPaused(candidate.name)).length;
const attemptMs = Math.ceil(remainingMs / eligibleCount);
try {
const results = await searchWithProvider(
provider,
query,
limit,
AbortSignal.timeout(attemptMs),
);
answered = true;
if (results.length > 0) {
countFor(provider.name).served++;
printMessage(`Fallback search served by ${provider.name}.`);
return results;
}
countFor(provider.name).empty++;
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
countFor(provider.name).failed++;
if (error instanceof RateLimitedError) {
countFor(provider.name).rateLimited++;
const pauseMs = rateLimitPauseMs(error.retryAfter);
// Never shortens a pause already in place: a concurrent search may
// have been told to stay away for longer.
pausedUntil.set(
provider.name,
Math.max(pausedUntil.get(provider.name) ?? 0, Date.now() + pauseMs),
);
printMessage(
`Fallback provider ${provider.name} paused for ${pauseMs} ms after a 429.`,
);
}
printMessage(`Fallback provider ${provider.name} failed: ${message}`);
failures.push(`${provider.name}: ${message}`);
}
}
if (answered) return [];
if (failures.length > 0) {
// A provider the budget ran out before is named as such, so the log does
// not read as if it had been asked and failed.
throw new Error(
notTried.length > 0
? `No fallback search provider served the search (${failures.join("; ")}; not tried, the time budget ran out: ${notTried.join(", ")})`
: `Every fallback search provider failed (${failures.join("; ")})`,
);
}
throw new Error(
"No fallback search provider could be tried: all are paused after a rate limit, or the time budget ran out",
);
}
function isPaused(name: ProviderName): boolean {
return (pausedUntil.get(name) ?? 0) > Date.now();
}
function countFor(name: ProviderName): ProviderCounters {
return providerCounters.get(name) as ProviderCounters;
}
function shuffle<Item>(items: Item[]): Item[] {
for (let index = items.length - 1; index > 0; index--) {
const swapIndex = Math.floor(Math.random() * (index + 1));
[items[index], items[swapIndex]] = [items[swapIndex], items[index]];
}
return items;
}
// RFC 9110's IMF-fixdate. Date.parse alone is too lenient: V8 turns strings
// such as "1.5" or "-1" into dates in 2001, which would clamp to the minimum
// pause instead of the default an unreadable value gets. The two obsolete
// HTTP-date formats also fall to the default, which is the cautious side.
const IMF_FIXDATE =
/^[A-Za-z]{3}, \d{2} [A-Za-z]{3} \d{4} \d{2}:\d{2}:\d{2} GMT$/;
/**
* Reads Retry-After as delta-seconds or an IMF-fixdate HTTP-date, and clamps
* the result to the bounds the module allows.
*/
function rateLimitPauseMs(retryAfter: string | null): number {
const value = retryAfter?.trim() ?? "";
let pauseMs = DEFAULT_RATE_LIMIT_PAUSE_MS;
if (/^\d+$/.test(value)) {
pauseMs = Number(value) * 1000;
} else if (IMF_FIXDATE.test(value)) {
const retryAt = Date.parse(value);
if (!Number.isNaN(retryAt)) pauseMs = retryAt - Date.now();
}
return Math.min(
MAX_RATE_LIMIT_PAUSE_MS,
Math.max(MIN_RATE_LIMIT_PAUSE_MS, pauseMs),
);
}
/**
* Throws the error the cascade pauses a provider on. Checked on every request
* of the exchange, since any of them can be the one the limit lands on.
*/
async function rejectIfRateLimited(response: Response): Promise<void> {
if (response.status !== 429) return;
await response.body?.cancel();
throw new RateLimitedError(response.headers.get("retry-after"));
}
/**
* Runs one provider's MCP exchange: initialize, the initialized notification
* when the endpoint opened a session, and the tool call. The session is
* optional: with no session id on the initialize reply the endpoint is
* stateless, so the notification and the session id are skipped, since there
* is no session to acknowledge. The protocol version still goes on every
* request after initialize.
*/
async function searchWithProvider(
provider: FallbackProvider,
query: string,
limit: number,
signal: AbortSignal,
): Promise<TextualResult[]> {
const apiKey = (process.env[provider.apiKeyVariable] ?? "").trim();
const endpointUrl = provider.endpointUrl(apiKey);
const headers: Record<string, string> = {
"Content-Type": "application/json",
Accept: "application/json, text/event-stream",
...(apiKey ? { Authorization: `Bearer ${apiKey}` } : {}),
};
const initializeResponse = await fetch(endpointUrl, {
method: "POST",
headers,
body: JSON.stringify({
jsonrpc: "2.0",
id: 1,
method: "initialize",
params: {
protocolVersion: MCP_PROTOCOL_VERSION,
capabilities: {},
clientInfo: { name: "MiniSearch", version: "1" },
},
}),
signal,
});
await rejectIfRateLimited(initializeResponse);
const sessionId = initializeResponse.headers.get("mcp-session-id");
// An unread body keeps undici's socket out of the pool until it is GC'd, so
// both outcomes have to discard it before they part ways with the response.
await initializeResponse.body?.cancel();
if (!initializeResponse.ok) {
throw new Error(
`The fallback search endpoint did not answer the initialize request (status ${initializeResponse.status})`,
);
}
// The MCP transport spec requires the version header on every request after
// initialize, with or without a session; only the session id is optional.
const postInitializeHeaders = {
"MCP-Protocol-Version": MCP_PROTOCOL_VERSION,
...(sessionId ? { "Mcp-Session-Id": sessionId } : {}),
};
if (sessionId) {
// A notification, so there is no reply body to read: the session is only
// usable once the endpoint has acknowledged it, and `ok` is the whole
// acknowledgement.
const initializedResponse = await fetch(endpointUrl, {
method: "POST",
headers: { ...headers, ...postInitializeHeaders },
body: JSON.stringify({
jsonrpc: "2.0",
method: "notifications/initialized",
}),
signal,
});
await rejectIfRateLimited(initializedResponse);
await initializedResponse.body?.cancel();
if (!initializedResponse.ok) {
throw new Error(
`The fallback search endpoint rejected the initialized notification (status ${initializedResponse.status})`,
);
}
}
const callResponse = await fetch(endpointUrl, {
method: "POST",
headers: { ...headers, ...postInitializeHeaders },
body: JSON.stringify({
jsonrpc: "2.0",
id: 2,
method: "tools/call",
params: provider.toolCall(query, limit),
}),
signal,
});
await rejectIfRateLimited(callResponse);
if (!callResponse.ok) {
await callResponse.body?.cancel();
throw new Error(
`The fallback search tool call failed with status ${callResponse.status}`,
);
}
const document = await readSearchDocument<object>(callResponse, 2);
const { results, received } = provider.mapResults(document, limit);
printMessage(
`Fallback search usable text results from ${provider.name}: ${results.length} of ${received}.`,
);
return results;
}
/**
* Reads the JSON-RPC reply to `requestId`. The endpoint answers either one
* JSON message or an SSE stream of them, and which of them belongs to this
* request is decided by the id, not by position: the stream can carry
* notifications the client never asked for.
*/
async function readSearchDocument<SearchDocument>(
response: Response,
requestId: number,
): Promise<SearchDocument> {
const contentType = response.headers.get("content-type") ?? "";
const body = await response.text();
const messages = contentType.includes("text/event-stream")
? parseEventStream(body)
: parseJsonBody(body);
const reply = messages.find((message) => message.id === requestId);
if (!reply) {
throw new Error(
`The fallback search endpoint sent no reply to request ${requestId}`,
);
}
// Only a numeric code: an upstream error message is free-form text from a
// third party, and a non-numeric code is upstream data just the same, so
// neither may reach the log or a thrown error.
if (reply.error) {
throw new Error(
typeof reply.error.code === "number"
? `The fallback search endpoint returned a JSON-RPC error (code ${reply.error.code})`
: "The fallback search endpoint returned a JSON-RPC error",
);
}
if (reply.result?.isError) {
throw new Error(
"The fallback search endpoint reported the search as failed",
);
}
const payload = (reply.result?.content ?? [])
.flatMap((item) =>
item.type === "text" && typeof item.text === "string" ? [item.text] : [],
)
.join("\n");
try {
const parsed: unknown = JSON.parse(payload);
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
throw new Error();
}
return parsed as SearchDocument;
} catch {
throw new Error(
"The fallback search endpoint returned tool output that is not JSON",
);
}
}
function parseJsonBody(body: string): JsonRpcMessage[] {
let parsed: unknown;
try {
parsed = JSON.parse(body);
} catch {
// A raw SyntaxError quotes the offending snippet, which would carry the
// upstream response into the thrown error and from there into the log.
throw new Error(
"The fallback search endpoint sent a reply that is not JSON",
);
}
if (Array.isArray(parsed)) return parsed as JsonRpcMessage[];
return [parsed as JsonRpcMessage];
}
/**
* SSE blocks are separated by a blank line and each `data:` line holds a
* fragment of one JSON message. A block that is not JSON is a keep-alive or an
* event this client did not ask for, so it is skipped rather than failing a
* reply that may be perfectly good.
*/
function parseEventStream(body: string): JsonRpcMessage[] {
return body.split(/\r?\n\r?\n/).flatMap((block) => {
const data = block
.split(/\r?\n/)
.filter((line) => line.startsWith("data:"))
.map((line) => line.slice("data:".length).trimStart())
.join("\n");
if (!data) return [];
try {
const parsed: unknown = JSON.parse(data);
if (Array.isArray(parsed)) return parsed as JsonRpcMessage[];
return [parsed as JsonRpcMessage];
} catch {
return [];
}
});
}
function mapParallelResults(
document: ParallelSearchDocument,
limit: number,
): MappedResults {
if (!Array.isArray(document.results)) {
throw new Error(
"The fallback search endpoint returned a document without a results array",
);
}
return {
results: mapEntries(document.results, limit, (result) =>
buildSnippet(result.excerpts),
),
received: document.results.length,
};
}
/**
* Maps You.com's `results.web` array by the same rules the Parallel path
* follows, so the tuples reach ranking and rendering unchanged.
*/
function mapYoucomResults(
document: YoucomSearchDocument,
limit: number,
): MappedResults {
if (!Array.isArray(document.results?.web)) {
throw new Error(
"The fallback search endpoint returned a document without a web results array",
);
}
return {
results: mapEntries(document.results.web, limit, buildYoucomSnippet),
received: document.results.web.length,
};
}
function mapEntries<Entry extends { url?: string; title?: string | null }>(
entries: Entry[],
limit: number,
snippetOf: (entry: Entry) => string,
): TextualResult[] {
const seenUrls = new Set<string>();
const mapped: TextualResult[] = [];
for (const entry of entries) {
if (mapped.length >= limit) break;
// Upstream data, so one malformed entry must not fail the whole search: a
// result that is not an object, or whose url or title is not a string, is
// skipped rather than left to throw on `.trim()`.
if (
!entry ||
typeof entry !== "object" ||
typeof entry.url !== "string" ||
!entry.url ||
seenUrls.has(entry.url)
) {
continue;
}
const title = typeof entry.title === "string" ? entry.title.trim() : "";
if (!title) continue;
const snippet = snippetOf(entry);
if (!snippet) continue;
seenUrls.add(entry.url);
mapped.push([title, snippet, entry.url]);
}
return mapped;
}
/**
* You.com returns a plain description for every result, and, when the query
* matched the page, query-relevant highlights as well. The description is the
* curated summary, so it is used as-is β it is not passed through the excerpt
* length filter, which would drop a short but complete sentence β and the
* highlights take over only when the description is empty, through the same
* filter the Parallel path applies to its excerpts.
*/
function buildYoucomSnippet(result: YoucomWebResult): string {
const description =
typeof result.description === "string"
? result.description.replace(/\s+/g, " ").trim()
: "";
if (description) return truncateSnippet(description);
return buildSnippet(result.contents?.highlights);
}
/**
* Turns the endpoint's markdown excerpts into the plain, single-line snippet
* the SearXNG path hands to ranking.
*/
function buildSnippet(excerpts: string[] | undefined): string {
if (!Array.isArray(excerpts) || excerpts.length === 0) return "";
const snippet = excerpts
.join("\n")
.split("\n")
.map(stripMarkdown)
.filter((line) => line.length >= MIN_SNIPPET_LINE_LENGTH)
.join(" ")
.replace(/\s+/g, " ")
.trim();
return truncateSnippet(snippet);
}
/**
* Caps a finished snippet at the length the ranking path expects. Cuts at a
* word boundary: a mid-word stump reads as a rendering bug, and the ellipsis
* is what tells the reader the sentence was cut, not finished.
*/
function truncateSnippet(snippet: string): string {
if (snippet.length <= MAX_SNIPPET_LENGTH) return snippet;
const cut = snippet.slice(0, MAX_SNIPPET_LENGTH);
const lastSpace = cut.lastIndexOf(" ");
return `${(lastSpace > 0 ? cut.slice(0, lastSpace) : cut).trimEnd()}β¦`;
}
function stripMarkdown(line: string): string {
return line
.replace(/^(?:#{1,6}\s+|[-*+]\s+|\d+[.)]\s+|>\s+)/, "")
.replace(/\[([^\]]*)\]\([^)]*\)/g, "$1")
.trim();
}
|