@mswjs/interceptors 0.25.3 → 0.25.5

package/lib/node/RemoteHttpInterceptor.js

@@ -3,7 +3,7 @@
 var _chunkUF7QIAQ5js = require('./chunk-UF7QIAQ5.js');
 
 
-var _chunkNCHFM2TBjs = require('./chunk-NCHFM2TB.js');
+var _chunkC3TKZUFLjs = require('./chunk-C3TKZUFL.js');
 
 
 var _chunkJCWVLTP7js = require('./chunk-JCWVLTP7.js');
@@ -24,7 +24,7 @@ var RemoteHttpInterceptor = class extends _chunkUF7QIAQ5js.BatchInterceptor {
     super({
       name: "remote-interceptor",
       interceptors: [
-        new (0, _chunkNCHFM2TBjs.ClientRequestInterceptor)(),
+        new (0, _chunkC3TKZUFLjs.ClientRequestInterceptor)(),
         new (0, _chunkJCWVLTP7js.XMLHttpRequestInterceptor)()
       ]
     });

package/lib/node/RemoteHttpInterceptor.mjs

@@ -3,7 +3,7 @@ import {
 } from "./chunk-UBEFEZXT.mjs";
 import {
   ClientRequestInterceptor
-} from "./chunk-MCO3RLQC.mjs";
+} from "./chunk-4B3HXVWT.mjs";
 import {
   XMLHttpRequestInterceptor
 } from "./chunk-FB53TMYN.mjs";

package/lib/node/{chunk-MCO3RLQC.mjs → chunk-4B3HXVWT.mjs}

@@ -152,6 +152,12 @@ function createRequest(clientRequest) {
       headers.append(headerName, value.toString());
     }
   }
+  if (clientRequest.url.username || clientRequest.url.password) {
+    const auth = `${clientRequest.url.username || ""}:${clientRequest.url.password || ""}`;
+    headers.set("Authorization", `Basic ${btoa(auth)}`);
+    clientRequest.url.username = "";
+    clientRequest.url.password = "";
+  }
   const method = clientRequest.method || "GET";
   return new Request(clientRequest.url, {
     method,
@@ -462,6 +468,7 @@ import {
   Agent as HttpsAgent,
   globalAgent as httpsGlobalAgent
 } from "https";
+import { parse as parseUrl } from "url";
 import { Logger as Logger5 } from "@open-draft/logger";
 
 // src/utils/getRequestOptionsByUrl.ts
@@ -576,7 +583,9 @@ function getUrlByRequestOptions(options) {
   logger3.info("credentials", credentials);
   const authString = credentials ? `${credentials.username}:${credentials.password}@` : "";
   logger3.info("auth string:", authString);
-  const url = new URL(`${protocol}//${authString}${hostname}${path}`);
+  const url = new URL(`${protocol}//${hostname}${path}`);
+  url.username = (credentials == null ? void 0 : credentials.username) || "";
+  url.password = (credentials == null ? void 0 : credentials.password) || "";
   logger3.info("created url:", url);
   return url;
 }
@@ -634,6 +643,17 @@ function resolveRequestOptions(args, url) {
   logger5.info("using an empty object as request options");
   return {};
 }
+function overrideUrlByRequestOptions(url, options) {
+  url.host = options.host || url.host;
+  url.hostname = options.hostname || url.hostname;
+  url.port = options.port ? options.port.toString() : url.port;
+  if (options.path) {
+    const parsedOptionsPath = parseUrl(options.path, false);
+    url.pathname = parsedOptionsPath.pathname || "";
+    url.search = parsedOptionsPath.search || "";
+  }
+  return url;
+}
 function resolveCallback(args) {
   return typeof args[1] === "function" ? args[1] : args[2];
 }
@@ -655,6 +675,9 @@ function normalizeClientRequestArgs(defaultProtocol, ...args) {
   } else if (args[0] instanceof URL) {
     url = args[0];
     logger5.info("first argument is a URL:", url);
+    if (typeof args[1] !== "undefined" && isObject(args[1])) {
+      url = overrideUrlByRequestOptions(url, args[1]);
+    }
     options = resolveRequestOptions(args, url);
     logger5.info("derived request options:", options);
     callback = resolveCallback(args);

package/lib/node/{chunk-NCHFM2TB.js → chunk-C3TKZUFL.js}

@@ -152,6 +152,12 @@ function createRequest(clientRequest) {
       headers.append(headerName, value.toString());
     }
   }
+  if (clientRequest.url.username || clientRequest.url.password) {
+    const auth = `${clientRequest.url.username || ""}:${clientRequest.url.password || ""}`;
+    headers.set("Authorization", `Basic ${btoa(auth)}`);
+    clientRequest.url.username = "";
+    clientRequest.url.password = "";
+  }
   const method = clientRequest.method || "GET";
   return new Request(clientRequest.url, {
     method,
@@ -462,6 +468,7 @@ NodeClientRequest.suppressErrorCodes = [
 
 
 
+var _url = require('url');
 
 
 // src/utils/getRequestOptionsByUrl.ts
@@ -576,7 +583,9 @@ function getUrlByRequestOptions(options) {
   logger3.info("credentials", credentials);
   const authString = credentials ? `${credentials.username}:${credentials.password}@` : "";
   logger3.info("auth string:", authString);
-  const url = new URL(`${protocol}//${authString}${hostname}${path}`);
+  const url = new URL(`${protocol}//${hostname}${path}`);
+  url.username = (credentials == null ? void 0 : credentials.username) || "";
+  url.password = (credentials == null ? void 0 : credentials.password) || "";
   logger3.info("created url:", url);
   return url;
 }
@@ -634,6 +643,17 @@ function resolveRequestOptions(args, url) {
   logger5.info("using an empty object as request options");
   return {};
 }
+function overrideUrlByRequestOptions(url, options) {
+  url.host = options.host || url.host;
+  url.hostname = options.hostname || url.hostname;
+  url.port = options.port ? options.port.toString() : url.port;
+  if (options.path) {
+    const parsedOptionsPath = _url.parse.call(void 0, options.path, false);
+    url.pathname = parsedOptionsPath.pathname || "";
+    url.search = parsedOptionsPath.search || "";
+  }
+  return url;
+}
 function resolveCallback(args) {
   return typeof args[1] === "function" ? args[1] : args[2];
 }
@@ -655,6 +675,9 @@ function normalizeClientRequestArgs(defaultProtocol, ...args) {
   } else if (args[0] instanceof URL) {
     url = args[0];
     logger5.info("first argument is a URL:", url);
+    if (typeof args[1] !== "undefined" && isObject(args[1])) {
+      url = overrideUrlByRequestOptions(url, args[1]);
+    }
     options = resolveRequestOptions(args, url);
     logger5.info("derived request options:", options);
     callback = resolveCallback(args);

package/lib/node/interceptors/ClientRequest/index.js

@@ -1,9 +1,9 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkNCHFM2TBjs = require('../../chunk-NCHFM2TB.js');
+var _chunkC3TKZUFLjs = require('../../chunk-C3TKZUFL.js');
 require('../../chunk-OGN3ZR35.js');
 require('../../chunk-5PTPJLB7.js');
 require('../../chunk-3XFLRXRY.js');
 
 
-exports.ClientRequestInterceptor = _chunkNCHFM2TBjs.ClientRequestInterceptor;
+exports.ClientRequestInterceptor = _chunkC3TKZUFLjs.ClientRequestInterceptor;

package/lib/node/interceptors/ClientRequest/index.mjs

@@ -1,6 +1,6 @@
 import {
   ClientRequestInterceptor
-} from "../../chunk-MCO3RLQC.mjs";
+} from "../../chunk-4B3HXVWT.mjs";
 import "../../chunk-3IYIKC3X.mjs";
 import "../../chunk-YQGTMMOZ.mjs";
 import "../../chunk-GM3YBSM3.mjs";

package/lib/node/presets/node.js

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkNCHFM2TBjs = require('../chunk-NCHFM2TB.js');
+var _chunkC3TKZUFLjs = require('../chunk-C3TKZUFL.js');
 
 
 var _chunkJCWVLTP7js = require('../chunk-JCWVLTP7.js');
@@ -12,7 +12,7 @@ require('../chunk-3XFLRXRY.js');
 
 // src/presets/node.ts
 var node_default = [
-  new (0, _chunkNCHFM2TBjs.ClientRequestInterceptor)(),
+  new (0, _chunkC3TKZUFLjs.ClientRequestInterceptor)(),
   new (0, _chunkJCWVLTP7js.XMLHttpRequestInterceptor)()
 ];
 

package/lib/node/presets/node.mjs

@@ -1,6 +1,6 @@
 import {
   ClientRequestInterceptor
-} from "../chunk-MCO3RLQC.mjs";
+} from "../chunk-4B3HXVWT.mjs";
 import {
   XMLHttpRequestInterceptor
 } from "../chunk-FB53TMYN.mjs";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mswjs/interceptors",
   "description": "Low-level HTTP/HTTPS/XHR/fetch request interception library.",
-  "version": "0.25.3",
+  "version": "0.25.5",
   "main": "./lib/node/index.js",
   "module": "./lib/node/index.mjs",
   "types": "./lib/node/index.d.ts",

package/src/interceptors/ClientRequest/utils/createRequest.test.ts

@@ -83,3 +83,43 @@ it('creates a fetch Request with an empty string body', async () => {
   expect(request.url).toBe('https://api.github.com/')
   expect(request.body).toBe(null)
 })
+
+it('creates a fetch Request with an empty password', async () => {
+  const clientRequest = new NodeClientRequest(
+    [
+      new URL('https://api.github.com'),
+      { auth: 'username:' },
+      () => {},
+    ],
+    {
+      emitter,
+      logger,
+    }
+  )
+  clientRequest.write('')
+
+  const request = createRequest(clientRequest)
+
+  expect(request.headers.get('Authorization')).toBe(`Basic ${btoa('username:')}`)
+  expect(request.url).toBe('https://api.github.com/')
+})
+
+it('creates a fetch Request with an empty username', async () => {
+  const clientRequest = new NodeClientRequest(
+    [
+      new URL('https://api.github.com'),
+      { auth: ':password' },
+      () => {},
+    ],
+    {
+      emitter,
+      logger,
+    }
+  )
+  clientRequest.write('')
+
+  const request = createRequest(clientRequest)
+
+  expect(request.headers.get('Authorization')).toBe(`Basic ${btoa(':password')}`)
+  expect(request.url).toBe('https://api.github.com/')
+})

package/src/interceptors/ClientRequest/utils/createRequest.ts

@@ -20,6 +20,21 @@ export function createRequest(clientRequest: NodeClientRequest): Request {
     }
   }
 
+  /**
+   * Translate the authentication from the request URL to
+   * the request "Authorization" header.
+   * @see https://github.com/mswjs/interceptors/issues/438
+   */
+  if (clientRequest.url.username || clientRequest.url.password) {
+    const auth = `${clientRequest.url.username || ''}:${clientRequest.url.password || ''}`
+    headers.set('Authorization', `Basic ${btoa(auth)}`)
+
+    // Remove the credentials from the URL since you cannot
+    // construct a Request instance with such a URL.
+    clientRequest.url.username = ''
+    clientRequest.url.password = ''
+  }
+
   const method = clientRequest.method || 'GET'
 
   return new Request(clientRequest.url, {

package/src/interceptors/ClientRequest/utils/normalizeClientRequestArgs.test.ts

@@ -212,6 +212,55 @@ it('handles [URL, RequestOptions, callback] input', () => {
   expect(callback?.name).toEqual('cb')
 })
 
+it('handles [URL, RequestOptions] where options have custom "hostname"', () => {
+  const [url, options] = normalizeClientRequestArgs(
+    'http:',
+    new URL('http://example.com/path-from-url'),
+    {
+      hostname: 'host-from-options.com',
+    }
+  )
+  expect(url.href).toBe('http://host-from-options.com/path-from-url')
+  expect(options).toMatchObject({
+    host: 'host-from-options.com',
+    path: '/path-from-url',
+  })
+})
+
+it('handles [URL, RequestOptions] where options contain "host" and "path" and "port"', () => {
+  const [url, options] = normalizeClientRequestArgs(
+    'http:',
+    new URL('http://example.com/path-from-url?a=b&c=d'),
+    {
+      hostname: 'host-from-options.com',
+      path: '/path-from-options',
+      port: 1234,
+    }
+  )
+  // Must remove the query string since it's not specified in "options.path"
+  expect(url.href).toBe('http://host-from-options.com:1234/path-from-options')
+  expect(options).toMatchObject({
+    host: 'host-from-options.com:1234',
+    path: '/path-from-options',
+    port: 1234,
+  })
+})
+
+it('handles [URL, RequestOptions] where options contain "path" with query string', () => {
+  const [url, options] = normalizeClientRequestArgs(
+    'http:',
+    new URL('http://example.com/path-from-url?a=b&c=d'),
+    {
+      path: '/path-from-options?foo=bar&baz=xyz',
+    }
+  )
+  expect(url.href).toBe('http://example.com/path-from-options?foo=bar&baz=xyz')
+  expect(options).toMatchObject({
+    host: 'example.com',
+    path: '/path-from-options?foo=bar&baz=xyz',
+  })
+})
+
 it('handles [RequestOptions, callback] input', () => {
   const initialOptions = {
     method: 'POST',
@@ -371,3 +420,50 @@ it('merges URL-based RequestOptions with the custom RequestOptions', () => {
   expect(options.hostname).toEqual(url.hostname)
   expect(options.path).toEqual(url.pathname)
 })
+
+it('respects custom "options.path" over URL path', () => {
+  const [url, options] = normalizeClientRequestArgs(
+    'http:',
+    new URL('http://example.com/path-from-url'),
+    {
+      path: '/path-from-options',
+    }
+  )
+
+  expect(url.href).toBe('http://example.com/path-from-options')
+  expect(options.protocol).toBe('http:')
+  expect(options.host).toBe('example.com')
+  expect(options.hostname).toBe('example.com')
+  expect(options.path).toBe('/path-from-options')
+})
+
+it('respects custom "options.path" over URL path with query string', () => {
+  const [url, options] = normalizeClientRequestArgs(
+    'http:',
+    new URL('http://example.com/path-from-url?a=b&c=d'),
+    {
+      path: '/path-from-options',
+    }
+  )
+
+  // Must replace both the path and the query string.
+  expect(url.href).toBe('http://example.com/path-from-options')
+  expect(options.protocol).toBe('http:')
+  expect(options.host).toBe('example.com')
+  expect(options.hostname).toBe('example.com')
+  expect(options.path).toBe('/path-from-options')
+})
+
+it('preserves URL query string', () => {
+  const [url, options] = normalizeClientRequestArgs(
+    'http:',
+    new URL('http://example.com/resource?a=b&c=d')
+  )
+
+  expect(url.href).toBe('http://example.com/resource?a=b&c=d')
+  expect(options.protocol).toBe('http:')
+  expect(options.host).toBe('example.com')
+  expect(options.hostname).toBe('example.com')
+  // Query string is a part of the options path.
+  expect(options.path).toBe('/resource?a=b&c=d')
+})

package/src/interceptors/ClientRequest/utils/normalizeClientRequestArgs.ts

@@ -8,7 +8,7 @@ import {
   Agent as HttpsAgent,
   globalAgent as httpsGlobalAgent,
 } from 'https'
-import { Url as LegacyURL } from 'url'
+import { Url as LegacyURL, parse as parseUrl } from 'url'
 import { Logger } from '@open-draft/logger'
 import { getRequestOptionsByUrl } from '../../../utils/getRequestOptionsByUrl'
 import {
@@ -63,6 +63,25 @@ function resolveRequestOptions(
   return {} as RequestOptions
 }
 
+/**
+ * Overrides the given `URL` instance with the explicit properties provided
+ * on the `RequestOptions` object. The options object takes precedence,
+ * and will replace URL properties like "host", "path", and "port", if specified.
+ */
+function overrideUrlByRequestOptions(url: URL, options: RequestOptions): URL {
+  url.host = options.host || url.host
+  url.hostname = options.hostname || url.hostname
+  url.port = options.port ? options.port.toString() : url.port
+
+  if (options.path) {
+    const parsedOptionsPath = parseUrl(options.path, false)
+    url.pathname = parsedOptionsPath.pathname || ''
+    url.search = parsedOptionsPath.search || ''
+  }
+
+  return url
+}
+
 function resolveCallback(
   args: ClientRequestArgs
 ): HttpRequestCallback | undefined {
@@ -112,6 +131,15 @@ export function normalizeClientRequestArgs(
     url = args[0]
     logger.info('first argument is a URL:', url)
 
+    // Check if the second provided argument is RequestOptions.
+    // If it is, check if "options.path" was set and rewrite it
+    // on the input URL.
+    // Do this before resolving options from the URL below
+    // to prevent query string from being duplicated in the path.
+    if (typeof args[1] !== 'undefined' && isObject<RequestOptions>(args[1])) {
+      url = overrideUrlByRequestOptions(url, args[1])
+    }
+
     options = resolveRequestOptions(args, url)
     logger.info('derived request options:', options)
 

package/src/utils/getUrlByRequestOptions.ts

@@ -86,7 +86,14 @@ function getHostByRequestOptions(options: ResolvedRequestOptions): string {
   return host || DEFAULT_HOST
 }
 
-function getAuthByRequestOptions(options: ResolvedRequestOptions) {
+interface RequestAuth {
+  username: string
+  password: string
+}
+
+function getAuthByRequestOptions(
+  options: ResolvedRequestOptions
+): RequestAuth | undefined {
   if (options.auth) {
     const [username, password] = options.auth.split(':')
     return { username, password }
@@ -159,7 +166,10 @@ export function getUrlByRequestOptions(options: ResolvedRequestOptions): URL {
     : ''
   logger.info('auth string:', authString)
 
-  const url = new URL(`${protocol}//${authString}${hostname}${path}`)
+  const url = new URL(`${protocol}//${hostname}${path}`)
+  url.username = credentials?.username || ''
+  url.password = credentials?.password || ''
+
   logger.info('created url:', url)
 
   return url

package/src/utils/isObject.ts

@@ -1,6 +1,6 @@
 /**
  * Determines if a given value is an instance of object.
  */
-export function isObject(value: any): boolean {
+export function isObject<T>(value: any): value is T {
   return Object.prototype.toString.call(value) === '[object Object]'
 }