File size: 50,762 Bytes
dcedb25 | 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 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 | import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { EventEmitter } from 'events';
import http from 'http';
import https from 'https';
import {
applyProxyUrl,
applyProxyMode,
applyProxyEnabled,
applyProxyBypass,
getProxyUrl,
getProxyMode,
isProxyEnabled,
getProxyBypassPlatforms,
getNoProxyRules,
isProxyActive,
isSocksProxyUrl,
socksHostnameLookup,
PROXY_SCHEMES,
PROXY_MODES,
proxyFetch,
describeAbort,
withKeyProxy,
probeProxyUrl,
DEFAULT_PROXY_PROBE_TARGET,
parseScutilProxy,
parseRegProxy,
normalizeProxyUrl,
} from '../../lib/proxy.js';
// #838 reads the OS-wide proxy (scutil/reg/gsettings) as a last-resort
// fallback when neither the env nor the DB configures one. A developer
// machine can genuinely have that set (macOS System Settings → Proxies),
// which fails every "no proxy configured" case below for the same reason
// clearProxyEnv() exists — the ambient system, not the code under test.
// '' parses as "no proxy" in every platform branch, so the suite sees a
// clean machine regardless of the host's system settings.
vi.mock('node:child_process', async (importOriginal) => ({
...(await importOriginal<Record<string, unknown>>()),
execFileSync: () => '',
}));
// Every env var the proxy config reads, in both the upper- and lower-case
// spellings the convention allows. Cleared around each test so a developer
// machine that genuinely sits behind a corporate proxy doesn't fail the suite.
// FREEAPI_BLOCK_PRIVATE_PROVIDER_URLS is not a proxy knob, but the local/LAN
// cases below call proxyFetch with platform 'custom', which re-runs the SSRF
// guard — an operator machine that exports it would fail them for the wrong
// reason.
const PROXY_ENV_VARS = [
'PROXY_URL',
'PROXY_MODE',
'ALL_PROXY',
'HTTPS_PROXY',
'HTTP_PROXY',
'NO_PROXY',
'FREEAPI_PROXY_LOCAL_DESTINATIONS',
'FREEAPI_BLOCK_PRIVATE_PROVIDER_URLS',
];
function clearProxyEnv(): void {
for (const name of PROXY_ENV_VARS) {
delete process.env[name];
delete process.env[name.toLowerCase()];
}
}
// Reset module-level proxy state before each test so cases don't bleed into
// each other (the lib keeps a process-wide config + a short dispatcher cache).
beforeEach(() => {
clearProxyEnv();
applyProxyEnabled(true);
applyProxyBypass('');
applyProxyUrl(''); // clears the URL and the dispatcher cache
applyProxyMode('forward');
});
afterEach(() => {
vi.restoreAllMocks();
clearProxyEnv();
});
const okResponse = () => ({ ok: true, status: 200 }) as Response;
describe('proxy config accessors', () => {
it('PROXY_URL env wins over the DB value', () => {
process.env.PROXY_URL = 'http://env-proxy:8080';
applyProxyUrl('http://db-proxy:3128');
expect(getProxyUrl()).toBe('http://env-proxy:8080');
});
it('falls back to the DB value when no env var is set', () => {
applyProxyUrl('http://db-proxy:3128');
expect(getProxyUrl()).toBe('http://db-proxy:3128');
});
it('defaults to forward and accepts an explicit fetch-relay mode', () => {
expect(PROXY_MODES).toEqual(['forward', 'fetch-relay']);
expect(getProxyMode()).toBe('forward');
applyProxyUrl('https://relay.example.test/secret');
applyProxyMode('fetch-relay');
expect(getProxyMode()).toBe('fetch-relay');
});
it('keeps a legacy PROXY_URL in forward mode unless PROXY_MODE is explicit', () => {
process.env.PROXY_URL = 'http://legacy-proxy:8080';
applyProxyUrl('https://saved-relay.example.test');
applyProxyMode('fetch-relay');
expect(getProxyMode()).toBe('forward');
process.env.PROXY_MODE = 'fetch-relay';
applyProxyMode('forward');
expect(getProxyMode()).toBe('fetch-relay');
});
it('parses the comma-separated bypass list', () => {
applyProxyBypass('groq, Google ,, cerebras');
expect(getProxyBypassPlatforms().sort()).toEqual(['cerebras', 'google', 'groq']);
});
it('isProxyActive is false when no proxy URL is configured', () => {
expect(isProxyActive()).toBe(false);
});
it('isProxyActive is true when an HTTP proxy is configured and enabled', () => {
applyProxyUrl('http://proxy:8080');
expect(isProxyActive()).toBe(true);
});
it('isProxyActive is false when a proxy is configured but disabled', () => {
applyProxyUrl('http://proxy:8080');
applyProxyEnabled(false);
expect(isProxyEnabled()).toBe(false);
expect(isProxyActive()).toBe(false);
});
});
// #630: `socks5h://` (and its SOCKS4 sibling `socks4a://`) ask the proxy to
// resolve DNS, which is the whole point for users on DNS-poisoned networks.
// Scheme detection used to be `startsWith('socks5:') || startsWith('socks4:')`,
// so socks5h fell through to the undici ProxyAgent — which has no idea what
// SOCKS is — and every request failed. socks-proxy-agent has understood both
// schemes natively all along.
describe('SOCKS scheme detection (#630)', () => {
it('recognises every SOCKS scheme socks-proxy-agent supports', () => {
expect(isSocksProxyUrl('socks5://127.0.0.1:1080')).toBe(true);
expect(isSocksProxyUrl('socks5h://127.0.0.1:1080')).toBe(true);
expect(isSocksProxyUrl('socks4://127.0.0.1:1080')).toBe(true);
expect(isSocksProxyUrl('socks4a://127.0.0.1:1080')).toBe(true);
});
it('is case-insensitive about the scheme', () => {
expect(isSocksProxyUrl('SOCKS5H://127.0.0.1:1080')).toBe(true);
});
it('does not treat HTTP proxies as SOCKS', () => {
expect(isSocksProxyUrl('http://proxy:8080')).toBe(false);
expect(isSocksProxyUrl('https://proxy:8443')).toBe(false);
expect(isSocksProxyUrl('')).toBe(false);
});
it('exposes the accepted scheme list for the settings validator', () => {
expect(PROXY_SCHEMES).toEqual(
expect.arrayContaining(['http:', 'https:', 'socks4:', 'socks4a:', 'socks5:', 'socks5h:']),
);
});
});
// SOCKS requests never go through global fetch() — they ride http/https.request
// with a SocksProxyAgent. Stubbing https.request lets us assert *which* agent
// the dispatcher picked (and that socks5h parsed into a real SOCKS5 agent)
// without opening a socket.
const fakeRequest = ((_opts: any, cb: any) => {
const req = new EventEmitter() as any;
req.write = () => {};
req.destroy = () => {};
req.end = () => {
const res = new EventEmitter() as any;
res.statusCode = 200;
res.statusMessage = 'OK';
res.headers = {};
res.destroy = () => {};
cb(res);
setImmediate(() => res.emit('end'));
};
return req;
}) as any;
function stubHttpsRequest() {
return vi.spyOn(https, 'request').mockImplementation(fakeRequest);
}
// A plain `http://` destination rides http.request, not https.request — the
// local-endpoint cases (#951) are all http, so both transports need stubbing
// before a test can claim nothing reached the wire.
function stubHttpRequest() {
return vi.spyOn(http, 'request').mockImplementation(fakeRequest);
}
describe('proxyFetch dispatcher selection for SOCKS schemes (#630)', () => {
const cases: Array<[string, number]> = [
['socks5://127.0.0.1:1080', 5],
['socks5h://127.0.0.1:1080', 5],
['socks4://127.0.0.1:1080', 4],
['socks4a://127.0.0.1:1080', 4],
];
for (const [url, socksType] of cases) {
it(`routes ${url} through a SocksProxyAgent, not undici`, async () => {
applyProxyUrl(url);
const fetchSpy = vi.spyOn(global, 'fetch');
const reqSpy = stubHttpsRequest();
const res = await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
expect(res.status).toBe(200);
expect(fetchSpy).not.toHaveBeenCalled();
const agent = (reqSpy.mock.calls[0][0] as any).agent;
expect(agent?.proxy?.type).toBe(socksType);
expect(agent?.proxy?.port).toBe(1080);
});
}
});
// #666: the SOCKS fallback hardcoded a 120s socket timeout, so a user with
// PROVIDER_TIMEOUT_CUSTOM=600000 still lost the request at 120s. The fix only
// ever RAISES that guard — it never lowers it to the caller's timeout, because
// http.request's `timeout` is a socket inactivity timer armed across the whole
// streaming body while timeoutMs is a header deadline disarmed at headers
// (#553/#584 hand mid-stream time to the stall watchdog).
describe('SOCKS socket timeout guard (#666)', () => {
const socketTimeoutOf = (spy: ReturnType<typeof stubHttpsRequest>): unknown =>
(spy.mock.calls[0][0] as any).timeout;
beforeEach(() => {
applyProxyUrl('socks5://127.0.0.1:1080');
});
it('raises the guard past 120s for a long caller timeout, with a grace margin', async () => {
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq', 'chat', 600_000);
// +30s so the caller's own abort deadline always fires first and the
// tagged AbortError survives instead of the bare socket 'timeout'.
expect(socketTimeoutOf(reqSpy)).toBe(630_000);
});
it('never drops below 120s for a platform with a short chat timeout', async () => {
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq', 'chat', 15_000);
// A 15s socket idle timer would kill a healthy stream mid-prefill; the
// ~90s stall watchdog stays the governing mid-stream budget.
expect(socketTimeoutOf(reqSpy)).toBe(120_000);
});
it('keeps the historical 120s guard when no timeout is passed', async () => {
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
expect(socketTimeoutOf(reqSpy)).toBe(120_000);
});
it('disables the socket timer when the caller timeout is 0 (no timeout)', async () => {
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq', 'chat', 0);
expect(socketTimeoutOf(reqSpy)).toBe(0);
});
it('falls back to the 120s guard for malformed timeouts instead of disabling it', async () => {
for (const bad of [NaN, -1, Infinity, '300000' as unknown as number]) {
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq', 'chat', bad);
expect(socketTimeoutOf(reqSpy)).toBe(120_000);
vi.restoreAllMocks();
}
});
});
// socks-proxy-agent resolves the DESTINATION locally for the plain `socks5://`
// and `socks4://` schemes and hands the proxy a bare IP. Rule-based proxy
// clients (Clash and friends) route on the DOMAIN, so a pre-resolved IP loses
// every routing rule the user wrote. socksFetch passes a `lookup` that echoes
// the hostname, which is what makes the SOCKS path behave like socks5h
// regardless of the scheme the user configured.
describe('SOCKS destination hostname reaches the proxy unresolved', () => {
const lookupOf = (spy: ReturnType<typeof stubHttpsRequest>): any =>
(spy.mock.calls[0][0] as any).lookup;
it('returns the hostname it was handed, unchanged', () => {
const seen: unknown[] = [];
socksHostnameLookup('api.example.com', {}, (...args) => seen.push(args));
expect(seen).toEqual([[null, 'api.example.com', 4]]);
});
it('never performs a real DNS resolution', () => {
// A hostname that cannot resolve anywhere still comes straight back out,
// synchronously — proof the override short-circuits dns.lookup entirely.
let address: string | undefined;
socksHostnameLookup('this-host-does-not-exist.invalid', {}, (_e, addr) => { address = addr; });
expect(address).toBe('this-host-does-not-exist.invalid');
});
it('installs the override on every SOCKS scheme, including socks5', async () => {
for (const url of ['socks5://127.0.0.1:1080', 'socks5h://127.0.0.1:1080', 'socks4://127.0.0.1:1080']) {
applyProxyUrl(url);
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
let resolved: string | undefined;
lookupOf(reqSpy)('api.example.com', {}, (_e: unknown, addr: string) => { resolved = addr; });
expect(resolved).toBe('api.example.com');
vi.restoreAllMocks();
}
});
});
// #353: HTTPS_PROXY / HTTP_PROXY / ALL_PROXY / NO_PROXY are the de-facto
// standard for every other CLI on the box. Honouring them means a user who
// already exported them for curl/git gets a working app with no extra config —
// but an explicitly configured dashboard proxy must still win over ambient env.
describe('standard proxy env vars (#353)', () => {
it('PROXY_URL wins over everything, including the dashboard value', () => {
process.env.PROXY_URL = 'http://explicit:8080';
process.env.ALL_PROXY = 'socks5://all:1080';
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
applyProxyUrl('http://db-proxy:3128');
expect(getProxyUrl()).toBe('http://explicit:8080');
});
it('a dashboard-configured proxy beats the ambient standard vars', () => {
process.env.ALL_PROXY = 'socks5://all:1080';
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
process.env.HTTP_PROXY = 'http://http-proxy:3128';
applyProxyUrl('socks5h://db-proxy:1080');
expect(getProxyUrl()).toBe('socks5h://db-proxy:1080');
});
it('falls back to ALL_PROXY when nothing is configured', () => {
process.env.ALL_PROXY = 'socks5://all:1080';
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
process.env.HTTP_PROXY = 'http://http-proxy:3128';
applyProxyUrl('');
expect(getProxyUrl()).toBe('socks5://all:1080');
});
it('prefers HTTPS_PROXY over HTTP_PROXY', () => {
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
process.env.HTTP_PROXY = 'http://http-proxy:3128';
applyProxyUrl('');
expect(getProxyUrl()).toBe('http://https-proxy:3128');
});
it('falls back to HTTP_PROXY last', () => {
process.env.HTTP_PROXY = 'http://http-proxy:3128';
applyProxyUrl('');
expect(getProxyUrl()).toBe('http://http-proxy:3128');
});
it('accepts the lower-case spellings the convention allows', () => {
process.env.https_proxy = 'http://lower:3128';
applyProxyUrl('');
expect(getProxyUrl()).toBe('http://lower:3128');
});
it('ignores blank env values', () => {
process.env.ALL_PROXY = ' ';
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
applyProxyUrl('');
expect(getProxyUrl()).toBe('http://https-proxy:3128');
});
});
describe('proxy source logging (#353)', () => {
it('names the source that won', () => {
const log = vi.spyOn(console, 'log').mockImplementation(() => {});
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
applyProxyUrl('');
expect(log.mock.calls.flat().join(' ')).toContain('HTTPS_PROXY');
});
it('names the dashboard as the source when the DB value wins', () => {
const log = vi.spyOn(console, 'log').mockImplementation(() => {});
process.env.HTTPS_PROXY = 'http://https-proxy:3128';
applyProxyUrl('http://db-proxy:3128');
expect(log.mock.calls.flat().join(' ')).toContain('dashboard');
});
it('never logs credentials embedded in the proxy URL', () => {
const log = vi.spyOn(console, 'log').mockImplementation(() => {});
process.env.ALL_PROXY = 'socks5h://alice:hunter2@proxy.internal:1080';
applyProxyUrl('');
const logged = log.mock.calls.flat().join(' ');
expect(logged).not.toContain('hunter2');
expect(logged).not.toContain('alice');
expect(logged).toContain('***@proxy.internal:1080');
});
it('redacts credentials in the dispatcher-failure log too', async () => {
const err = vi.spyOn(console, 'error').mockImplementation(() => {});
vi.spyOn(console, 'log').mockImplementation(() => {});
// A failed dispatcher falls back to a direct fetch — stub it so the test
// never touches the network.
vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
// A port outside the valid range makes SocksProxyAgent throw on construction.
applyProxyUrl('socks5h://alice:hunter2@proxy.internal:not-a-port');
await proxyFetch('https://api.example.com/v1', undefined, 'groq');
const logged = err.mock.calls.flat().join(' ');
expect(logged).not.toContain('hunter2');
});
it('never logs a Fetch Relay secret path or query string', () => {
const log = vi.spyOn(console, 'log').mockImplementation(() => {});
applyProxyUrl('https://relay.example.test/super-secret-path?token=also-secret');
const logged = log.mock.calls.flat().join(' ');
expect(logged).toContain('https://relay.example.test/[redacted]');
expect(logged).not.toContain('super-secret-path');
expect(logged).not.toContain('also-secret');
});
});
describe('NO_PROXY bypass (#353)', () => {
const dispatcherFor = async (url: string) => {
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch(url, { method: 'POST' }, 'groq');
return (spy.mock.calls[0][1] as any)?.dispatcher;
};
it('parses a comma-separated list, lower-cased', () => {
process.env.NO_PROXY = 'localhost, .Internal.Corp ,, 10.0.0.1';
applyProxyUrl('http://proxy:8080');
expect(getNoProxyRules()).toEqual(['localhost', '.internal.corp', '10.0.0.1']);
});
it('bypasses an exact host match', async () => {
process.env.NO_PROXY = 'api.example.com';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.example.com/v1')).toBeUndefined();
});
it('still proxies hosts that do not match', async () => {
process.env.NO_PROXY = 'api.example.com';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.groq.com/v1')).toBeDefined();
});
it('treats a bare domain as a suffix match on its subdomains', async () => {
process.env.NO_PROXY = 'example.com';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.example.com/v1')).toBeUndefined();
});
it('does not let a suffix rule match an unrelated host that merely ends with it', async () => {
process.env.NO_PROXY = 'example.com';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://notexample.com/v1')).toBeDefined();
});
it('supports the leading-dot spelling', async () => {
process.env.NO_PROXY = '.example.com';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.example.com/v1')).toBeUndefined();
});
it('matches case-insensitively', async () => {
process.env.NO_PROXY = 'API.EXAMPLE.COM';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.example.com/v1')).toBeUndefined();
});
it('ignores a port qualifier on the rule', async () => {
process.env.NO_PROXY = 'api.example.com:443';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.example.com/v1')).toBeUndefined();
});
it('"*" bypasses every host', async () => {
process.env.NO_PROXY = '*';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.groq.com/v1')).toBeUndefined();
});
it('accepts the lower-case spelling', async () => {
process.env.no_proxy = 'api.example.com';
applyProxyUrl('http://proxy:8080');
expect(await dispatcherFor('https://api.example.com/v1')).toBeUndefined();
});
it('leaves the per-platform bypass list untouched', () => {
process.env.NO_PROXY = 'api.example.com';
applyProxyBypass('groq');
applyProxyUrl('http://proxy:8080');
expect(getProxyBypassPlatforms()).toEqual(['groq']);
});
});
describe('proxyFetch routing', () => {
it('passes straight through to fetch when no proxy is configured (default for all users)', async () => {
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch('https://api.example.com/v1', { method: 'POST' });
expect(spy).toHaveBeenCalledTimes(1);
const [, init] = spy.mock.calls[0];
// No dispatcher injected on the direct path.
expect((init as any)?.dispatcher).toBeUndefined();
});
it('routes through the dispatcher for an HTTP proxy', async () => {
applyProxyUrl('http://proxy:8080');
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
expect(spy).toHaveBeenCalledTimes(1);
const [, init] = spy.mock.calls[0];
expect((init as any)?.dispatcher).toBeDefined();
});
it('bypasses the proxy for a platform on the bypass list', async () => {
applyProxyUrl('http://proxy:8080');
applyProxyBypass('groq');
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
const [, init] = spy.mock.calls[0];
expect((init as any)?.dispatcher).toBeUndefined(); // direct, not proxied
});
it('bypasses the proxy globally when disabled', async () => {
applyProxyUrl('http://proxy:8080');
applyProxyEnabled(false);
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch('https://api.example.com/v1', undefined, 'google');
const [, init] = spy.mock.calls[0];
expect((init as any)?.dispatcher).toBeUndefined();
});
});
// #951: a local destination — Ollama/llama.cpp/LM Studio on 127.0.0.1, or on
// the LAN at 192.168.1.20 — is unreachable through a remote proxy, and because
// an IP literal must go on the wire as ATYP 0x01 (an IP) regardless of the
// `socks5h` suffix, it is exactly what makes Tor log "giving Tor only an IP
// address" and may get the connection refused. Loopback and private/LAN
// addresses therefore always bypass the proxy, unless the operator opts out
// with FREEAPI_PROXY_LOCAL_DESTINATIONS.
describe('local and LAN destinations bypass the proxy (#951)', () => {
/** Run one request through the SOCKS-configured proxy and report the route. */
const routeOf = async (url: string): Promise<'direct' | 'proxied'> => {
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const httpsSpy = stubHttpsRequest();
const httpSpy = stubHttpRequest();
await proxyFetch(url, { method: 'POST' }, 'custom');
// A SOCKS route never touches fetch(): it goes out through http/https.request
// with a SocksProxyAgent attached.
if (httpsSpy.mock.calls.length + httpSpy.mock.calls.length > 0) {
expect(fetchSpy).not.toHaveBeenCalled();
return 'proxied';
}
expect(fetchSpy).toHaveBeenCalledTimes(1);
// Direct means no dispatcher was injected either.
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeUndefined();
return 'direct';
};
beforeEach(() => {
applyProxyUrl('socks5h://127.0.0.1:9050');
});
const directCases: Array<[string, string]> = [
['IPv4 loopback', 'http://127.0.0.1:11434/api/chat'],
['the 127/8 range beyond .0.1', 'http://127.0.0.2:11434/api/chat'],
['"this host" 0.0.0.0', 'http://0.0.0.0:11434/api/chat'],
['bracketed IPv6 loopback', 'http://[::1]:11434/api/chat'],
['the localhost name', 'http://localhost:11434/api/chat'],
['a *.localhost subdomain', 'http://ollama.localhost:11434/api/chat'],
['the trailing-dot FQDN form of localhost', 'http://localhost.:11434/api/chat'],
['an RFC1918 LAN address', 'http://192.168.1.20:11434/api/chat'],
['a 10/8 LAN address', 'http://10.0.0.5:11434/api/chat'],
['a 172.16/12 LAN address', 'http://172.16.4.2:11434/api/chat'],
['an IPv6 ULA address', 'http://[fd12:3456::1]:11434/api/chat'],
];
for (const [label, url] of directCases) {
it(`sends ${label} direct`, async () => {
expect(await routeOf(url)).toBe('direct');
});
}
it('still routes a public destination through the SOCKS proxy', async () => {
const fetchSpy = vi.spyOn(global, 'fetch');
const reqSpy = stubHttpsRequest();
await proxyFetch('https://api.openai.com/v1/models', { method: 'GET' }, 'openai');
// Public host still goes through the SOCKS agent (port 9050).
expect(fetchSpy).not.toHaveBeenCalled();
expect((reqSpy.mock.calls[0][0] as any).agent?.proxy?.port).toBe(9050);
});
it('applies to the per-key proxy path too', async () => {
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const httpsSpy = stubHttpsRequest();
const httpSpy = stubHttpRequest();
await withKeyProxy('socks5h://127.0.0.1:9051', () =>
proxyFetch('http://192.168.1.20:11434/api/chat', { method: 'POST' }, 'custom'));
expect(httpsSpy).not.toHaveBeenCalled();
expect(httpSpy).not.toHaveBeenCalled();
expect(fetchSpy).toHaveBeenCalledTimes(1);
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeUndefined();
});
// The `ssh -D` case: the tunnel's far end is where 127.0.0.1:11434 is meant
// to resolve, so the operator can force local destinations back through it.
describe('FREEAPI_PROXY_LOCAL_DESTINATIONS opt-out', () => {
it('routes loopback through the proxy when set', async () => {
process.env.FREEAPI_PROXY_LOCAL_DESTINATIONS = 'true';
applyProxyUrl('socks5h://127.0.0.1:9050');
expect(await routeOf('http://127.0.0.1:11434/api/chat')).toBe('proxied');
});
it('routes a LAN address through the proxy when set', async () => {
process.env.FREEAPI_PROXY_LOCAL_DESTINATIONS = '1';
applyProxyUrl('socks5h://127.0.0.1:9050');
expect(await routeOf('http://192.168.1.20:11434/api/chat')).toBe('proxied');
});
it('is ignored when set to a non-truthy value', async () => {
process.env.FREEAPI_PROXY_LOCAL_DESTINATIONS = 'false';
applyProxyUrl('socks5h://127.0.0.1:9050');
expect(await routeOf('http://127.0.0.1:11434/api/chat')).toBe('direct');
});
it('still honours the global off switch', async () => {
process.env.FREEAPI_PROXY_LOCAL_DESTINATIONS = 'true';
applyProxyUrl('socks5h://127.0.0.1:9050');
applyProxyEnabled(false);
expect(await routeOf('http://127.0.0.1:11434/api/chat')).toBe('direct');
});
});
});
// SSRF guard, request-time half (#440). The save-time check validates the
// literal base_url, but fetch()'s default redirect: 'follow' would re-request
// a 3xx Location target with no re-validation — a public base_url answering
// 302 → http://169.254.169.254/ used to defeat the guard entirely. Custom
// providers therefore never follow redirects; the 3xx becomes an explicit
// error naming the target so the operator can fix base_url.
describe('proxyFetch custom-provider redirect guard', () => {
const redirectResponse = (status: number, location?: string) =>
({ ok: false, status, headers: new Headers(location ? { location } : {}) }) as Response;
it('forces redirect: "manual" on custom-provider requests', async () => {
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch('http://93.184.216.34/v1/chat/completions', { method: 'POST' }, 'custom');
const [, init] = spy.mock.calls[0];
expect((init as any)?.redirect).toBe('manual');
});
it('rejects a custom-provider 302 instead of following it', async () => {
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(
redirectResponse(302, 'http://169.254.169.254/latest/meta-data/'),
);
await expect(proxyFetch('http://93.184.216.34/v1', { method: 'POST' }, 'custom'))
.rejects.toThrow(/redirects are not followed/);
// The Location target is never requested.
expect(spy).toHaveBeenCalledTimes(1);
});
it('rejects every redirect status the same way', async () => {
for (const status of [301, 303, 307, 308]) {
vi.spyOn(global, 'fetch').mockResolvedValue(redirectResponse(status, 'http://10.0.0.1/'));
await expect(proxyFetch('http://93.184.216.34/v1', undefined, 'custom'))
.rejects.toThrow(new RegExp(`redirected \\(${status}\\)`));
}
});
it('names the redirect target in the error so the operator can fix base_url', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue(redirectResponse(301, 'https://api.example.com/v1/'));
await expect(proxyFetch('http://93.184.216.34/v1', undefined, 'custom'))
.rejects.toThrow(/https:\/\/api\.example\.com\/v1\//);
});
it('passes 3xx responses through untouched for built-in platforms', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue(redirectResponse(302, 'https://elsewhere.example.com/'));
const res = await proxyFetch('https://api.example.com/v1', undefined, 'groq');
expect(res.status).toBe(302);
});
it('blocks hex-form IPv4-mapped metadata literals before any fetch happens', async () => {
// new URL() canonicalises [::ffff:169.254.169.254] to [::ffff:a9fe:a9fe].
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await expect(proxyFetch('http://[::ffff:169.254.169.254]/latest/', undefined, 'custom'))
.rejects.toThrow(/metadata/);
expect(spy).not.toHaveBeenCalled();
});
});
// Compact abort-error triage tag formatting. The string written to
// `requests.error` is `The operation was aborted (<platform>, <type>, <N>s)`
// — round-trip what's already on the row so an operator can read the abort
// cause without joining against the columns.
describe('describeAbort', () => {
it('formats platform + type + timeout-in-seconds', () => {
expect(describeAbort('cloudflare', 'chat', 15_000)).toBe('cloudflare, chat, 15s');
expect(describeAbort('opencode', 'embedding', 30_000)).toBe('opencode, embedding, 30s');
expect(describeAbort('nvidia', 'image', 60_000)).toBe('nvidia, image, 60s');
expect(describeAbort('google', 'audio', 60_000)).toBe('google, audio, 60s');
});
it('rounds sub-second milliseconds up to 1s (no "0s")', () => {
expect(describeAbort('x', 'chat', 500)).toBe('x, chat, 1s');
expect(describeAbort('x', 'chat', 0)).toBe('x, chat');
});
it('falls back to "unknown" when platform or type is missing', () => {
expect(describeAbort(undefined, 'chat', 15_000)).toBe('unknown, chat, 15s');
expect(describeAbort(' ', 'chat', 15_000)).toBe('unknown, chat, 15s');
expect(describeAbort('cloudflare', 'unknown', 15_000)).toBe('cloudflare, unknown, 15s');
});
it('omits the timeout suffix when no timeout is provided', () => {
expect(describeAbort('cloudflare', 'chat', undefined)).toBe('cloudflare, chat');
expect(describeAbort('cloudflare', 'chat', 0)).toBe('cloudflare, chat');
});
});
// Regression: previously every abort through proxyFetch surfaced as the bare
// string "The operation was aborted" with no upstream URL or platform context.
// The fix wraps proxyFetch's catch with an enrichAbort() that rewrites the
// DOMException message to `The operation was aborted (<platform>, <type>, <N>s)`
// — no URL, no credentials — so an operator reading the requests.error column
// gets the same triage info as the requests row columns (platform, request_type,
// latency_ms / timeout). The `name: 'AbortError'` is preserved so
// isRetryableError() (which matches the substring "aborted") keeps
// classifying it as retryable.
describe('proxyFetch abort error enrichment', () => {
it('rewrites a native AbortError to include platform, type, and timeout', async () => {
const abortErr = new DOMException('The operation was aborted', 'AbortError');
vi.spyOn(global, 'fetch').mockRejectedValue(abortErr);
await expect(
proxyFetch('https://api.openrouter.ai/api/v1/chat/completions', undefined, 'openrouter', 'chat', 15_000),
).rejects.toMatchObject({
name: 'AbortError',
message: expect.stringContaining('openrouter, chat, 15s'),
});
});
it('does not include any URL or path in the enriched message', async () => {
const abortErr = new DOMException('The operation was aborted', 'AbortError');
vi.spyOn(global, 'fetch').mockRejectedValue(abortErr);
let caught: Error | null = null;
try {
await proxyFetch(
'https://api.openrouter.ai/api/v1/chat/completions',
undefined,
'openrouter',
'chat',
15_000,
);
} catch (e) {
caught = e as Error;
}
expect(caught).not.toBeNull();
expect(caught!.message).not.toContain('api.openrouter.ai');
expect(caught!.message).not.toContain('/v1/chat/completions');
});
it('omits the timeout suffix when none was supplied (older call sites)', async () => {
const abortErr = new DOMException('The operation was aborted', 'AbortError');
vi.spyOn(global, 'fetch').mockRejectedValue(abortErr);
await expect(
proxyFetch('https://api.example.com/v1', undefined, 'groq', 'chat'),
).rejects.toMatchObject({
message: expect.stringContaining('groq, chat)'),
});
});
it('does not rewrite non-AbortError rejections', async () => {
const typeErr = new TypeError('fetch failed');
vi.spyOn(global, 'fetch').mockRejectedValue(typeErr);
await expect(
proxyFetch('https://api.example.com/v1', undefined, 'groq', 'chat', 15_000),
).rejects.toBe(typeErr);
});
});
// Per-key proxy override (#590). The fallback loop wraps each dispatch in
// withKeyProxy(route.proxyUrl, ...), which parks the URL in AsyncLocalStorage;
// dispatchFetch reads it there and prefers it over the global proxy. Providers
// are process singletons, so ALS is what makes "this key exits from there"
// possible without threading a proxy argument through every provider call.
//
// Assertions ride the SOCKS path: the agent handed to https.request carries the
// proxy host/port, so which dispatcher was chosen is directly observable
// (undici's ProxyAgent is opaque by comparison, and the port makes global vs
// per-key unambiguous).
describe('per-key proxy override (#590)', () => {
const agentPortOf = (spy: ReturnType<typeof stubHttpsRequest>, call = 0): unknown =>
((spy.mock.calls[call]?.[0] as any)?.agent)?.proxy?.port;
it('routes the attempt through the key\'s own proxy instead of the global one', async () => {
applyProxyUrl('socks5://127.0.0.1:1080');
const reqSpy = stubHttpsRequest();
await withKeyProxy('socks5://127.0.0.1:1081', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(agentPortOf(reqSpy)).toBe(1081);
});
it('proxies through the key\'s proxy even when no global proxy is configured', async () => {
applyProxyUrl('');
const fetchSpy = vi.spyOn(global, 'fetch');
const reqSpy = stubHttpsRequest();
await withKeyProxy('socks5h://127.0.0.1:1082', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(agentPortOf(reqSpy)).toBe(1082);
expect(fetchSpy).not.toHaveBeenCalled();
});
it('an empty override falls through to the global proxy', async () => {
applyProxyUrl('socks5://127.0.0.1:1080');
const reqSpy = stubHttpsRequest();
await withKeyProxy('', () => proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
await withKeyProxy(undefined, () => proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(agentPortOf(reqSpy, 0)).toBe(1080);
expect(agentPortOf(reqSpy, 1)).toBe(1080);
});
it('the override does not outlive the call it was set for', async () => {
applyProxyUrl('socks5://127.0.0.1:1080');
const reqSpy = stubHttpsRequest();
await withKeyProxy('socks5://127.0.0.1:1083', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
// Next request, no override in scope: back to the global proxy.
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
expect(agentPortOf(reqSpy, 0)).toBe(1083);
expect(agentPortOf(reqSpy, 1)).toBe(1080);
});
it('keeps concurrent attempts on their own key\'s proxy', async () => {
applyProxyUrl('');
const reqSpy = stubHttpsRequest();
await Promise.all([
withKeyProxy('socks5://127.0.0.1:1084', () => proxyFetch('https://a.example.com/v1', undefined, 'groq')),
withKeyProxy('socks5://127.0.0.1:1085', () => proxyFetch('https://b.example.com/v1', undefined, 'groq')),
]);
const ports = reqSpy.mock.calls.map(call => ((call[0] as any).agent)?.proxy?.port).sort();
expect(ports).toEqual([1084, 1085]);
});
it('still honors NO_PROXY for the upstream host', async () => {
process.env.NO_PROXY = 'api.example.com';
applyProxyUrl('socks5://127.0.0.1:1080');
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const reqSpy = stubHttpsRequest();
await withKeyProxy('socks5://127.0.0.1:1086', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(reqSpy).not.toHaveBeenCalled();
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeUndefined();
});
it('still honors the per-platform bypass list', async () => {
applyProxyUrl('socks5://127.0.0.1:1080');
applyProxyBypass('groq');
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const reqSpy = stubHttpsRequest();
await withKeyProxy('socks5://127.0.0.1:1087', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(reqSpy).not.toHaveBeenCalled();
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeUndefined();
});
it('still honors the global proxy off switch', async () => {
applyProxyUrl('socks5://127.0.0.1:1080');
applyProxyEnabled(false);
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const reqSpy = stubHttpsRequest();
await withKeyProxy('socks5://127.0.0.1:1088', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(reqSpy).not.toHaveBeenCalled();
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeUndefined();
});
it('falls back to the global proxy when the key\'s proxy cannot be built, without logging its credentials', async () => {
const errSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
applyProxyUrl('socks5://127.0.0.1:1080');
const reqSpy = stubHttpsRequest();
// A port outside the valid range makes SocksProxyAgent throw on construction.
await withKeyProxy('socks5h://alice:hunter2@proxy.internal:not-a-port', () =>
proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq'));
expect(agentPortOf(reqSpy)).toBe(1080);
const logged = errSpy.mock.calls.flat().join(' ');
expect(logged).toContain('per-key dispatcher');
expect(logged).not.toContain('hunter2');
});
});
// #863: the dashboard "Test" button for the outbound proxy. probeProxyUrl must
// report reachability of a DRAFT proxy URL without persisting anything, fall
// back to the saved URL when the input is empty, and never throw — network
// failures and unbuildable agents come back as structured { ok: false, error }.
describe('probeProxyUrl (#863)', () => {
it('runs direct and reports ok when no proxy URL is configured', async () => {
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const result = await probeProxyUrl(undefined);
expect(result.ok).toBe(true);
expect(result.status).toBe(200);
expect(typeof result.latencyMs).toBe('number');
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeUndefined();
});
it('reports a structured failure instead of throwing when direct fetch fails', async () => {
vi.spyOn(global, 'fetch').mockRejectedValue(new Error('ECONNREFUSED'));
const result = await probeProxyUrl(undefined);
expect(result.ok).toBe(false);
expect(result.error).toContain('ECONNREFUSED');
});
it('prefers the draft URL over the saved value, without persisting it', async () => {
applyProxyUrl('http://saved-proxy:8080');
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
// Draft value wins: an HTTP(S) proxy URL builds an undici dispatcher, so
// the fetch call must carry that dispatcher rather than going direct.
const result = await probeProxyUrl('http://draft-proxy:8080');
expect(result.ok).toBe(true);
const dispatcher = (fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher;
expect(dispatcher).toBeDefined();
// The saved value must be untouched.
expect(getProxyUrl()).toBe('http://saved-proxy:8080');
});
it('falls back to the saved proxy URL when the draft is empty', async () => {
applyProxyUrl('http://saved-proxy:8080');
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const result = await probeProxyUrl('');
expect(result.ok).toBe(true);
expect((fetchSpy.mock.calls[0]?.[1] as any)?.dispatcher).toBeDefined();
});
it('routes SOCKS draft URLs through socksFetch, not undici', async () => {
const fetchSpy = vi.spyOn(global, 'fetch');
const reqSpy = stubHttpsRequest();
const result = await probeProxyUrl('socks5://127.0.0.1:1080');
expect(result.ok).toBe(true);
expect(result.status).toBe(200);
expect(fetchSpy).not.toHaveBeenCalled();
const agent = (reqSpy.mock.calls[0]?.[0] as any)?.agent;
expect(agent?.proxy?.type).toBe(5);
});
it('returns a structured failure when the proxy agent cannot be built', async () => {
const errSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
// ftp:// is not an accepted proxy scheme — the agent constructor throws.
const result = await probeProxyUrl('ftp://127.0.0.1:21');
expect(result.ok).toBe(false);
expect(result.error).toContain('Failed to build a proxy agent');
errSpy.mockRestore();
});
it('treats any HTTP response as a working proxy route, even a 4xx', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue({ ok: false, status: 401 } as Response);
const result = await probeProxyUrl(undefined);
// 401 without a key still proves the proxy connected; only a
// network-level failure counts as a proxy failure.
expect(result.ok).toBe(true);
expect(result.status).toBe(401);
});
// The probe used to be hardcoded to api.openai.com, which made the button
// lie in both directions: an install that never calls OpenAI pinged it on
// every Test, and a network that blocks that host reported a working proxy
// as broken. The caller now names the endpoint.
it('calls the target the caller supplies', async () => {
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const result = await probeProxyUrl(undefined, { targetUrl: 'https://api.groq.com/openai/v1/models' });
expect(String(fetchSpy.mock.calls[0]?.[0])).toBe('https://api.groq.com/openai/v1/models');
expect(result.target).toBe('https://api.groq.com/openai/v1/models');
});
it('falls back to a neutral reachability endpoint, never an AI vendor', async () => {
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const result = await probeProxyUrl(undefined);
expect(String(fetchSpy.mock.calls[0]?.[0])).toBe(DEFAULT_PROXY_PROBE_TARGET);
expect(DEFAULT_PROXY_PROBE_TARGET).not.toContain('openai.com');
expect(result.target).toBe(DEFAULT_PROXY_PROBE_TARGET);
});
it('blank and whitespace targets fall back rather than requesting an empty url', async () => {
const fetchSpy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await probeProxyUrl(undefined, { targetUrl: ' ' });
expect(String(fetchSpy.mock.calls[0]?.[0])).toBe(DEFAULT_PROXY_PROBE_TARGET);
});
it('reports the target it used on a failure too, so the result is readable', async () => {
vi.spyOn(global, 'fetch').mockRejectedValue(new Error('ECONNREFUSED'));
const result = await probeProxyUrl(undefined, { targetUrl: 'https://api.groq.com/openai/v1/models' });
expect(result.ok).toBe(false);
expect(result.target).toBe('https://api.groq.com/openai/v1/models');
});
it('still honours a custom timeout through the options object', async () => {
vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
const result = await probeProxyUrl(undefined, { timeoutMs: 250 });
expect(result.ok).toBe(true);
});
});
describe('system proxy detection parsers (#353)', () => {
it('parses macOS scutil HTTP proxy output', () => {
const out = [
'<dictionary> {',
' HTTPEnable : 1',
' HTTPPort : 7890',
' HTTPProxy : 127.0.0.1',
' SOCKSEnable : 0',
' SOCKSProxy : 127.0.0.1',
' SOCKSPort : 1080',
'}',
].join('\n');
expect(parseScutilProxy(out)).toEqual({ url: '127.0.0.1:7890', source: 'system(macOS)' });
});
it('falls back to macOS SOCKS when HTTP is disabled', () => {
const out = [
'<dictionary> {',
' HTTPEnable : 0',
' HTTPProxy : 127.0.0.1',
' SOCKSEnable : 1',
' SOCKSProxy : 127.0.0.1',
' SOCKSPort : 1080',
'}',
].join('\n');
expect(parseScutilProxy(out)).toEqual({ url: 'socks5://127.0.0.1:1080', source: 'system(macOS)' });
});
it('returns none when macOS proxy is disabled', () => {
const out = ['<dictionary> {', ' HTTPEnable : 0', ' SOCKSEnable : 0', '}'].join('\n');
expect(parseScutilProxy(out)).toEqual({ url: '', source: 'none' });
});
it('parses Windows registry ProxyEnable + bare ProxyServer', () => {
const enable = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyEnable REG_DWORD 0x1\n';
const server = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyServer REG_SZ 127.0.0.1:7890\n';
expect(parseRegProxy(enable, server)).toEqual({ url: '127.0.0.1:7890', source: 'system(Windows)' });
});
it('parses Windows registry per-scheme ProxyServer (http=…;https=…)', () => {
const enable = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyEnable REG_DWORD 0x1\n';
const server = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyServer REG_SZ http=proxy.corp:8080;https=proxy.corp:8443\n';
expect(parseRegProxy(enable, server)).toEqual({ url: 'proxy.corp:8080', source: 'system(Windows)' });
});
it('returns none when Windows proxy is disabled', () => {
const enable = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyEnable REG_DWORD 0x0\n';
const server = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyServer REG_SZ 127.0.0.1:7890\n';
expect(parseRegProxy(enable, server)).toEqual({ url: '', source: 'none' });
});
});
describe('scheme-less proxy values (#1373)', () => {
const REG_ENABLED = 'HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyEnable REG_DWORD 0x1\n';
const regServer = (value: string) =>
`HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\n ProxyServer REG_SZ ${value}\n`;
it('gives a bare host:port an http:// scheme', () => {
expect(normalizeProxyUrl('127.0.0.1:7890')).toBe('http://127.0.0.1:7890');
expect(normalizeProxyUrl(' proxy.corp:8080 ')).toBe('http://proxy.corp:8080');
});
it('leaves a value that already has a scheme alone', () => {
expect(normalizeProxyUrl('http://proxy:8080')).toBe('http://proxy:8080');
expect(normalizeProxyUrl('socks5h://127.0.0.1:1080')).toBe('socks5h://127.0.0.1:1080');
expect(normalizeProxyUrl('')).toBe('');
});
it('uses a scheme-less HTTPS_PROXY instead of dropping it as invalid', () => {
process.env.HTTPS_PROXY = '127.0.0.1:7890';
applyProxyUrl('');
expect(getProxyUrl()).toBe('http://127.0.0.1:7890');
expect(isProxyActive()).toBe(true);
});
it('routes through the dispatcher for a scheme-less dashboard value', async () => {
applyProxyUrl('proxy:8080');
const spy = vi.spyOn(global, 'fetch').mockResolvedValue(okResponse());
await proxyFetch('https://api.example.com/v1', { method: 'POST' }, 'groq');
const [, init] = spy.mock.calls[0];
expect((init as any)?.dispatcher).toBeDefined();
});
it('falls back to the https= entry of a per-scheme Windows ProxyServer', () => {
expect(parseRegProxy(REG_ENABLED, regServer('https=proxy.corp:8443;ftp=proxy.corp:21')))
.toEqual({ url: 'proxy.corp:8443', source: 'system(Windows)' });
});
it('reads a socks-only Windows ProxyServer as SOCKS, not HTTP', () => {
expect(parseRegProxy(REG_ENABLED, regServer('socks=127.0.0.1:1080')))
.toEqual({ url: 'socks5://127.0.0.1:1080', source: 'system(Windows)' });
});
});
describe('fetch failed carries its cause (#1373)', () => {
const fetchFailed = (cause: unknown) => Object.assign(new TypeError('fetch failed'), { cause });
it('names a DNS failure and the host', async () => {
vi.spyOn(global, 'fetch').mockRejectedValue(fetchFailed(Object.assign(new Error('getaddrinfo ENOTFOUND router.huggingface.co'), { code: 'ENOTFOUND' })));
await expect(proxyFetch('https://router.huggingface.co/v1/chat/completions', undefined, 'huggingface'))
.rejects.toThrow('fetch failed (ENOTFOUND router.huggingface.co)');
});
it('names a certificate error', async () => {
vi.spyOn(global, 'fetch').mockRejectedValue(fetchFailed(Object.assign(new Error('self signed certificate in certificate chain'), { code: 'SELF_SIGNED_CERT_IN_CHAIN' })));
await expect(proxyFetch('https://api.groq.com/openai/v1/chat/completions', undefined, 'groq'))
.rejects.toThrow('fetch failed (SELF_SIGNED_CERT_IN_CHAIN api.groq.com)');
});
it('says when the request went through the proxy', async () => {
applyProxyUrl('http://127.0.0.1:7890');
vi.spyOn(global, 'fetch').mockRejectedValue(fetchFailed(Object.assign(new Error('connect ECONNREFUSED 127.0.0.1:7890'), { code: 'ECONNREFUSED' })));
await expect(proxyFetch('https://api.groq.com/v1', undefined, 'groq'))
.rejects.toThrow('fetch failed (ECONNREFUSED api.groq.com via proxy)');
});
it('finds a code nested deeper in the cause chain', async () => {
const inner = Object.assign(new Error('connect ETIMEDOUT'), { code: 'ETIMEDOUT' });
vi.spyOn(global, 'fetch').mockRejectedValue(fetchFailed(new Error('wrapper', { cause: inner })));
await expect(proxyFetch('https://api.example.com/v1')).rejects.toThrow('fetch failed (ETIMEDOUT api.example.com)');
});
it('keeps a bare fetch failed when there is no cause code', async () => {
vi.spyOn(global, 'fetch').mockRejectedValue(fetchFailed(new Error('something odd')));
await expect(proxyFetch('https://api.example.com/v1')).rejects.toThrow(/^fetch failed$/);
});
});
|