Spaces:
Sleeping
Sleeping
File size: 15,694 Bytes
cd6720a | 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 | import { Logger } from "@open-draft/logger";
import { Emitter } from "strict-event-emitter";
import { DeferredPromise } from "@open-draft/deferred-promise";
import { invariant } from "outvariant";
//#region src/Interceptor.ts
/**
* Request header name to detect when a single request
* is being handled by nested interceptors (XHR -> ClientRequest).
* Obscure by design to prevent collisions with user-defined headers.
* Ideally, come up with the Interceptor-level mechanism for this.
* @see https://github.com/mswjs/interceptors/issues/378
*/
const INTERNAL_REQUEST_ID_HEADER_NAME = "x-interceptors-internal-request-id";
function getGlobalSymbol(symbol) {
return globalThis[symbol] || void 0;
}
function setGlobalSymbol(symbol, value) {
globalThis[symbol] = value;
}
function deleteGlobalSymbol(symbol) {
delete globalThis[symbol];
}
let InterceptorReadyState = /* @__PURE__ */ function(InterceptorReadyState$1) {
InterceptorReadyState$1["INACTIVE"] = "INACTIVE";
InterceptorReadyState$1["APPLYING"] = "APPLYING";
InterceptorReadyState$1["APPLIED"] = "APPLIED";
InterceptorReadyState$1["DISPOSING"] = "DISPOSING";
InterceptorReadyState$1["DISPOSED"] = "DISPOSED";
return InterceptorReadyState$1;
}({});
var Interceptor = class {
constructor(symbol) {
this.symbol = symbol;
this.readyState = InterceptorReadyState.INACTIVE;
this.emitter = new Emitter();
this.subscriptions = [];
this.logger = new Logger(symbol.description);
this.emitter.setMaxListeners(0);
this.logger.info("constructing the interceptor...");
}
/**
* Determine if this interceptor can be applied
* in the current environment.
*/
checkEnvironment() {
return true;
}
/**
* Apply this interceptor to the current process.
* Returns an already running interceptor instance if it's present.
*/
apply() {
const logger = this.logger.extend("apply");
logger.info("applying the interceptor...");
if (this.readyState === InterceptorReadyState.APPLIED) {
logger.info("intercepted already applied!");
return;
}
if (!this.checkEnvironment()) {
logger.info("the interceptor cannot be applied in this environment!");
return;
}
this.readyState = InterceptorReadyState.APPLYING;
const runningInstance = this.getInstance();
if (runningInstance) {
logger.info("found a running instance, reusing...");
this.on = (event, listener) => {
logger.info("proxying the \"%s\" listener", event);
runningInstance.emitter.addListener(event, listener);
this.subscriptions.push(() => {
runningInstance.emitter.removeListener(event, listener);
logger.info("removed proxied \"%s\" listener!", event);
});
return this;
};
this.readyState = InterceptorReadyState.APPLIED;
return;
}
logger.info("no running instance found, setting up a new instance...");
this.setup();
this.setInstance();
this.readyState = InterceptorReadyState.APPLIED;
}
/**
* Setup the module augments and stubs necessary for this interceptor.
* This method is not run if there's a running interceptor instance
* to prevent instantiating an interceptor multiple times.
*/
setup() {}
/**
* Listen to the interceptor's public events.
*/
on(event, listener) {
const logger = this.logger.extend("on");
if (this.readyState === InterceptorReadyState.DISPOSING || this.readyState === InterceptorReadyState.DISPOSED) {
logger.info("cannot listen to events, already disposed!");
return this;
}
logger.info("adding \"%s\" event listener:", event, listener);
this.emitter.on(event, listener);
return this;
}
once(event, listener) {
this.emitter.once(event, listener);
return this;
}
off(event, listener) {
this.emitter.off(event, listener);
return this;
}
removeAllListeners(event) {
this.emitter.removeAllListeners(event);
return this;
}
/**
* Disposes of any side-effects this interceptor has introduced.
*/
dispose() {
const logger = this.logger.extend("dispose");
if (this.readyState === InterceptorReadyState.DISPOSED) {
logger.info("cannot dispose, already disposed!");
return;
}
logger.info("disposing the interceptor...");
this.readyState = InterceptorReadyState.DISPOSING;
if (!this.getInstance()) {
logger.info("no interceptors running, skipping dispose...");
return;
}
this.clearInstance();
logger.info("global symbol deleted:", getGlobalSymbol(this.symbol));
if (this.subscriptions.length > 0) {
logger.info("disposing of %d subscriptions...", this.subscriptions.length);
for (const dispose of this.subscriptions) dispose();
this.subscriptions = [];
logger.info("disposed of all subscriptions!", this.subscriptions.length);
}
this.emitter.removeAllListeners();
logger.info("destroyed the listener!");
this.readyState = InterceptorReadyState.DISPOSED;
}
getInstance() {
const instance = getGlobalSymbol(this.symbol);
this.logger.info("retrieved global instance:", instance?.constructor?.name);
return instance;
}
setInstance() {
setGlobalSymbol(this.symbol, this);
this.logger.info("set global instance!", this.symbol.description);
}
clearInstance() {
deleteGlobalSymbol(this.symbol);
this.logger.info("cleared global instance!", this.symbol.description);
}
};
//#endregion
//#region src/InterceptorError.ts
var InterceptorError = class InterceptorError extends Error {
constructor(message) {
super(message);
this.name = "InterceptorError";
Object.setPrototypeOf(this, InterceptorError.prototype);
}
};
//#endregion
//#region src/RequestController.ts
var RequestController = class RequestController {
static {
this.PENDING = 0;
}
static {
this.PASSTHROUGH = 1;
}
static {
this.RESPONSE = 2;
}
static {
this.ERROR = 3;
}
constructor(request, source) {
this.request = request;
this.source = source;
this.readyState = RequestController.PENDING;
this.handled = new DeferredPromise();
}
get #handled() {
return this.handled;
}
/**
* Perform this request as-is.
*/
async passthrough() {
invariant.as(InterceptorError, this.readyState === RequestController.PENDING, "Failed to passthrough the \"%s %s\" request: the request has already been handled", this.request.method, this.request.url);
this.readyState = RequestController.PASSTHROUGH;
await this.source.passthrough();
this.#handled.resolve();
}
/**
* Respond to this request with the given `Response` instance.
*
* @example
* controller.respondWith(new Response())
* controller.respondWith(Response.json({ id }))
* controller.respondWith(Response.error())
*/
respondWith(response) {
invariant.as(InterceptorError, this.readyState === RequestController.PENDING, "Failed to respond to the \"%s %s\" request with \"%d %s\": the request has already been handled (%d)", this.request.method, this.request.url, response.status, response.statusText || "OK", this.readyState);
this.readyState = RequestController.RESPONSE;
this.#handled.resolve();
/**
* @note Although `source.respondWith()` is potentially asynchronous,
* do NOT await it for backward-compatibility. Awaiting it will short-circuit
* the request listener invocation as soon as a listener responds to a request.
* Ideally, that's what we want, but that's not what we promise the user.
*/
this.source.respondWith(response);
}
/**
* Error this request with the given reason.
*
* @example
* controller.errorWith()
* controller.errorWith(new Error('Oops!'))
* controller.errorWith({ message: 'Oops!'})
*/
errorWith(reason) {
invariant.as(InterceptorError, this.readyState === RequestController.PENDING, "Failed to error the \"%s %s\" request with \"%s\": the request has already been handled (%d)", this.request.method, this.request.url, reason?.toString(), this.readyState);
this.readyState = RequestController.ERROR;
this.source.errorWith(reason);
this.#handled.resolve();
}
};
//#endregion
//#region src/createRequestId.ts
/**
* Generate a random ID string to represent a request.
* @example
* createRequestId()
* // "f774b6c9c600f"
*/
function createRequestId() {
return Math.random().toString(16).slice(2);
}
//#endregion
//#region src/utils/canParseUrl.ts
/**
* Returns a boolean indicating whether the given URL string
* can be parsed into a `URL` instance.
* A substitute for `URL.canParse()` for Node.js 18.
*/
function canParseUrl(url) {
try {
new URL(url);
return true;
} catch (_error) {
return false;
}
}
//#endregion
//#region src/utils/getValueBySymbol.ts
/**
* Returns the value behind the symbol with the given name.
*/
function getValueBySymbol(symbolName, source) {
const symbol = Object.getOwnPropertySymbols(source).find((symbol$1) => {
return symbol$1.description === symbolName;
});
if (symbol) return Reflect.get(source, symbol);
}
//#endregion
//#region src/utils/fetchUtils.ts
var FetchRequest = class FetchRequest extends Request {
static #resolveProperty(input, init = {}, key) {
return init[key] ?? (input instanceof Request ? input[key] : void 0);
}
/**
* Check if the given request method is configurable.
* @see https://fetch.spec.whatwg.org/#methods
*/
static isConfigurableMethod(method) {
return method !== "CONNECT" && method !== "TRACE" && method !== "TRACK";
}
static isMethodWithBody(method) {
return method !== "HEAD" && method !== "GET" && FetchRequest.isConfigurableMethod(method);
}
/**
* Check if the given request `mode` is configurable.
* @see https://fetch.spec.whatwg.org/#concept-request-mode
*/
static isConfigurableMode(mode) {
return mode !== "navigate" && mode !== "websocket" && mode !== "webtransport";
}
constructor(input, init) {
const method = FetchRequest.#resolveProperty(input, init, "method") || "GET";
const safeMethod = FetchRequest.isConfigurableMethod(method) ? method : "GET";
const hasExplicitBody = init != null && "body" in init;
/**
* Only include `body` in the super init when it needs to be overridden.
* When `input` is a Request and no explicit body is in `init`, let the
* Request constructor handle body transfer naturally so it properly
* marks the original request's body as consumed (bodyUsed = true).
*/
const bodyInit = !FetchRequest.isMethodWithBody(method) ? { body: void 0 } : hasExplicitBody ? { body: init.body } : {};
const mode = FetchRequest.#resolveProperty(input, init, "mode") ?? void 0;
const safeMode = FetchRequest.isConfigurableMode(mode) ? mode : void 0;
super(input, {
...init || {},
method: safeMethod,
mode: safeMode,
duplex: init?.duplex ?? (FetchRequest.isMethodWithBody(method) ? "half" : void 0),
...bodyInit
});
if (method !== safeMethod) this.#setInternalProperty("method", method);
if (method === "CONNECT") {
const url = new URL(input instanceof Request ? input.url : input);
let authority;
/**
* @note Node.js has a bug parsing raw CONNECT requests URLs like
* "http://127.0.0.1:1337/localhost:80". It would treat "localhost:" as a protocol.
*/
if (url.protocol === "localhost:") authority = url.href;
else authority = url.pathname.replace(/^\/+/, "");
/**
* @note Define "url" as a getter because Undici uses their own
* logic to resolve the "request.url" property. Simply reassigning
* its value doesn't do anything. This is a destructive action
* but it's safe because "CONNECT" requests are forbidden per fetch.
*/
Object.defineProperty(this, "url", {
get: () => authority,
enumerable: true,
configurable: true
});
}
if (mode != null && mode !== safeMode) this.#setInternalProperty("mode", mode);
}
#setInternalProperty(key, value) {
const internalState = getValueBySymbol("state", this);
if (internalState) Reflect.set(internalState, key, value);
else Object.defineProperty(this, key, {
value,
enumerable: true,
configurable: true,
writable: false
});
}
};
const kStatus = Symbol("kStatus");
const kUrl = Symbol("kUrl");
var FetchResponse = class FetchResponse extends Response {
static {
this.STATUS_CODES_WITHOUT_BODY = [
101,
103,
204,
205,
304
];
}
static {
this.STATUS_CODES_WITH_REDIRECT = [
301,
302,
303,
307,
308
];
}
static isConfigurableStatusCode(status) {
return status >= 200 && status <= 599;
}
static isRedirectResponse(status) {
return FetchResponse.STATUS_CODES_WITH_REDIRECT.includes(status);
}
/**
* Returns a boolean indicating whether the given response status
* code represents a response that can have a body.
*/
static isResponseWithBody(status) {
return !FetchResponse.STATUS_CODES_WITHOUT_BODY.includes(status);
}
static setStatus(status, response) {
/**
* @note Undici keeps an internal "Symbol(state)" that holds
* the actual value of response status. Update that in Node.js.
*/
const internalState = getValueBySymbol("state", response);
if (internalState) internalState.status = status;
else Object.defineProperty(response, "status", {
value: status,
enumerable: true,
configurable: true,
writable: false
});
Object.defineProperty(response, kStatus, {
value: status,
enumerable: false
});
}
static setUrl(url, response) {
if (!url || url === "about:" || !canParseUrl(url)) return;
const state = getValueBySymbol("state", response);
if (state) state.urlList.push(new URL(url));
else Object.defineProperty(response, "url", {
value: url,
enumerable: true,
configurable: true,
writable: false
});
Object.defineProperty(response, kUrl, {
value: url,
enumerable: false
});
}
/**
* Parses the given raw HTTP headers into a Fetch API `Headers` instance.
*/
static parseRawHeaders(rawHeaders) {
const headers = new Headers();
for (let line = 0; line < rawHeaders.length; line += 2) headers.append(rawHeaders[line], rawHeaders[line + 1]);
return headers;
}
/**
* Safely clones the given `Response`.
* Coerces response clone exceptions into 500 mocked responses.
* Handy in the environments that introduce arbitrary response
* cloning restrictions, like "101 Switching Protocols" cloning
* in "miniflare".
*/
static clone(response) {
try {
return response.clone();
} catch (error) {
return Response.json(error instanceof Error ? {
name: error.name,
message: error.message,
stack: error.stack
} : {}, {
status: 500,
statusText: "Unclonable Response"
});
}
}
constructor(body, init = {}) {
const status = init.status ?? 200;
const safeStatus = FetchResponse.isConfigurableStatusCode(status) ? status : 200;
const finalBody = FetchResponse.isResponseWithBody(status) ? body : null;
super(finalBody, {
status: safeStatus,
statusText: init.statusText,
headers: init.headers
});
/**
* Since Node.js v24, Undici stores the Response state in an inaccessible field "#state".
* Forward the modified status/URL to the cloned response manually.
* @see https://github.com/nodejs/undici/blob/f734c87280e626c75f59aad55b65eb6a89cef392/lib/web/fetch/response.js#L242
*/
if (status !== safeStatus) FetchResponse.setStatus(status, this);
FetchResponse.setUrl(init.url, this);
}
clone() {
const clonedResponse = super.clone();
const customStatus = Reflect.get(this, kStatus);
if (customStatus) FetchResponse.setStatus(customStatus, clonedResponse);
const customUrl = Reflect.get(this, kUrl);
if (customUrl) FetchResponse.setUrl(customUrl, clonedResponse);
return clonedResponse;
}
};
//#endregion
export { RequestController as a, Interceptor as c, getGlobalSymbol as d, createRequestId as i, InterceptorReadyState as l, FetchResponse as n, InterceptorError as o, canParseUrl as r, INTERNAL_REQUEST_ID_HEADER_NAME as s, FetchRequest as t, deleteGlobalSymbol as u };
//# sourceMappingURL=fetchUtils-BKJ1XmiO.mjs.map |