@mswjs/interceptors 0.41.9 → 0.42.1

package/src/interceptors/ClientRequest/agents.ts

@@ -1,110 +0,0 @@
-/**
- * Here's how requests are handled in Node.js:
- *
- * 1. http.ClientRequest instance calls `agent.addRequest(request, options, cb)`.
- * 2. Agent creates a new socket: `agent.createSocket(options, cb)`.
- * 3. Agent creates a new connection: `agent.createConnection(options, cb)`.
- */
-import net from 'node:net'
-import http from 'node:http'
-import https from 'node:https'
-import {
-  MockHttpSocket,
-  type MockHttpSocketRequestCallback,
-  type MockHttpSocketResponseCallback,
-} from './MockHttpSocket'
-
-declare module 'node:http' {
-  interface Agent {
-    options?: http.AgentOptions
-    createConnection(options: any, callback: any): net.Socket
-  }
-}
-
-interface MockAgentOptions {
-  customAgent?: http.RequestOptions['agent']
-  onRequest: MockHttpSocketRequestCallback
-  onResponse: MockHttpSocketResponseCallback
-}
-
-export class MockAgent extends http.Agent {
-  private customAgent?: http.RequestOptions['agent']
-  private onRequest: MockHttpSocketRequestCallback
-  private onResponse: MockHttpSocketResponseCallback
-
-  constructor(options: MockAgentOptions) {
-    super()
-    this.customAgent = options.customAgent
-    this.onRequest = options.onRequest
-    this.onResponse = options.onResponse
-  }
-
-  public createConnection(options: any, callback: any): net.Socket {
-    const createConnection =
-      this.customAgent instanceof http.Agent
-        ? this.customAgent.createConnection
-        : super.createConnection
-
-    const createConnectionOptions =
-      this.customAgent instanceof http.Agent
-        ? {
-            ...options,
-            ...this.customAgent.options,
-          }
-        : options
-
-    const socket = new MockHttpSocket({
-      connectionOptions: options,
-      createConnection: createConnection.bind(
-        this.customAgent || this,
-        createConnectionOptions,
-        callback
-      ),
-      onRequest: this.onRequest.bind(this),
-      onResponse: this.onResponse.bind(this),
-    })
-
-    return socket
-  }
-}
-
-export class MockHttpsAgent extends https.Agent {
-  private customAgent?: https.RequestOptions['agent']
-  private onRequest: MockHttpSocketRequestCallback
-  private onResponse: MockHttpSocketResponseCallback
-
-  constructor(options: MockAgentOptions) {
-    super()
-    this.customAgent = options.customAgent
-    this.onRequest = options.onRequest
-    this.onResponse = options.onResponse
-  }
-
-  public createConnection(options: any, callback: any): net.Socket {
-    const createConnection =
-      this.customAgent instanceof http.Agent
-        ? this.customAgent.createConnection
-        : super.createConnection
-
-    const createConnectionOptions =
-      this.customAgent instanceof http.Agent
-        ? {
-            ...options,
-            ...this.customAgent.options,
-          }
-        : options
-
-    const socket = new MockHttpSocket({
-      connectionOptions: options,
-      createConnection: createConnection.bind(
-        this.customAgent || this,
-        createConnectionOptions,
-        callback
-      ),
-      onRequest: this.onRequest.bind(this),
-      onResponse: this.onResponse.bind(this),
-    })
-
-    return socket
-  }
-}

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

@@ -1,54 +0,0 @@
-import { it, expect } from 'vitest'
-import { IncomingMessage } from 'http'
-import { Socket } from 'net'
-import * as zlib from 'zlib'
-import { getIncomingMessageBody } from './getIncomingMessageBody'
-
-it('returns utf8 string given a utf8 response body', async () => {
-  const utfBuffer = Buffer.from('one')
-  const message = new IncomingMessage(new Socket())
-
-  const pendingResponseBody = getIncomingMessageBody(message)
-  message.emit('data', utfBuffer)
-  message.emit('end')
-
-  expect(await pendingResponseBody).toEqual('one')
-})
-
-it('returns utf8 string given a gzipped response body', async () => {
-  const utfBuffer = zlib.gzipSync(Buffer.from('two'))
-  const message = new IncomingMessage(new Socket())
-  message.headers = {
-    'content-encoding': 'gzip',
-  }
-
-  const pendingResponseBody = getIncomingMessageBody(message)
-  message.emit('data', utfBuffer)
-  message.emit('end')
-
-  expect(await pendingResponseBody).toEqual('two')
-})
-
-it('returns utf8 string given a gzipped response body with incorrect "content-length"', async () => {
-  const utfBuffer = zlib.gzipSync(Buffer.from('three'))
-  const message = new IncomingMessage(new Socket())
-  message.headers = {
-    'content-encoding': 'gzip',
-    'content-length': '500',
-  }
-
-  const pendingResponseBody = getIncomingMessageBody(message)
-  message.emit('data', utfBuffer)
-  message.emit('end')
-
-  expect(await pendingResponseBody).toEqual('three')
-})
-
-it('returns empty string given an empty body', async () => {
-  const message = new IncomingMessage(new Socket())
-
-  const pendingResponseBody = getIncomingMessageBody(message)
-  message.emit('end')
-
-  expect(await pendingResponseBody).toEqual('')
-})

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

@@ -1,45 +0,0 @@
-import { IncomingMessage } from 'http'
-import { PassThrough } from 'stream'
-import * as zlib from 'zlib'
-import { Logger } from '@open-draft/logger'
-
-const logger = new Logger('http getIncomingMessageBody')
-
-export function getIncomingMessageBody(
-  response: IncomingMessage
-): Promise<string> {
-  return new Promise((resolve, reject) => {
-    logger.info('cloning the original response...')
-
-    // Pipe the original response to support non-clone
-    // "response" input. No need to clone the response,
-    // as we always have access to the full "response" input,
-    // either a clone or an original one (in tests).
-    const responseClone = response.pipe(new PassThrough())
-    const stream =
-      response.headers['content-encoding'] === 'gzip'
-        ? responseClone.pipe(zlib.createGunzip())
-        : responseClone
-
-    const encoding = response.readableEncoding || 'utf8'
-    stream.setEncoding(encoding)
-    logger.info('using encoding:', encoding)
-
-    let body = ''
-
-    stream.on('data', (responseBody) => {
-      logger.info('response body read:', responseBody)
-      body += responseBody
-    })
-
-    stream.once('end', () => {
-      logger.info('response body end')
-      resolve(body)
-    })
-
-    stream.once('error', (error) => {
-      logger.info('error while reading response body:', error)
-      reject(error)
-    })
-  })
-}

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

@@ -1,427 +0,0 @@
-import { it, expect } from 'vitest'
-import { parse } from 'url'
-import { globalAgent as httpGlobalAgent, RequestOptions } from 'http'
-import { Agent as HttpsAgent, globalAgent as httpsGlobalAgent } from 'https'
-import { getUrlByRequestOptions } from '../../../utils/getUrlByRequestOptions'
-import { normalizeClientRequestArgs } from './normalizeClientRequestArgs'
-
-it('handles [string, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    'https://mswjs.io/resource',
-    function cb() {},
-  ])
-
-  // URL string must be converted to a URL instance.
-  expect(url.href).toEqual('https://mswjs.io/resource')
-
-  // Request options must be derived from the URL instance.
-  expect(options).toHaveProperty('method', 'GET')
-  expect(options).toHaveProperty('protocol', 'https:')
-  expect(options).toHaveProperty('hostname', 'mswjs.io')
-  expect(options).toHaveProperty('path', '/resource')
-
-  // Callback must be preserved.
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [string, RequestOptions, callback] input', () => {
-  const initialOptions = {
-    headers: {
-      'Content-Type': 'text/plain',
-    },
-  }
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    'https://mswjs.io/resource',
-    initialOptions,
-    function cb() {},
-  ])
-
-  // URL must be created from the string.
-  expect(url.href).toEqual('https://mswjs.io/resource')
-
-  // Request options must be preserved.
-  expect(options).toHaveProperty('headers', initialOptions.headers)
-
-  // Callback must be preserved.
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [URL, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    new URL('https://mswjs.io/resource'),
-    function cb() {},
-  ])
-
-  // URL must be preserved.
-  expect(url.href).toEqual('https://mswjs.io/resource')
-
-  // Request options must be derived from the URL instance.
-  expect(options.method).toEqual('GET')
-  expect(options.protocol).toEqual('https:')
-  expect(options.hostname).toEqual('mswjs.io')
-  expect(options.path).toEqual('/resource')
-
-  // Callback must be preserved.
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [Absolute Legacy URL, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    parse('https://cherry:durian@mswjs.io:12345/resource?apple=banana'),
-    function cb() {},
-  ])
-
-  // URL must be preserved.
-  expect(url.toJSON()).toEqual(
-    new URL(
-      'https://cherry:durian@mswjs.io:12345/resource?apple=banana'
-    ).toJSON()
-  )
-
-  // Request options must be derived from the URL instance.
-  expect(options.method).toEqual('GET')
-  expect(options.protocol).toEqual('https:')
-  expect(options.hostname).toEqual('mswjs.io')
-  expect(options.path).toEqual('/resource?apple=banana')
-  expect(options.port).toEqual(12345)
-  expect(options.auth).toEqual('cherry:durian')
-
-  // Callback must be preserved.
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [Relative Legacy URL, RequestOptions without path set, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('http:', [
-    parse('/resource?apple=banana'),
-    { host: 'mswjs.io' },
-    function cb() {},
-  ])
-
-  // Correct WHATWG URL generated.
-  expect(url.toJSON()).toEqual(
-    new URL('http://mswjs.io/resource?apple=banana').toJSON()
-  )
-
-  // No path in request options, so legacy url path is copied-in.
-  expect(options.protocol).toEqual('http:')
-  expect(options.host).toEqual('mswjs.io')
-  expect(options.path).toEqual('/resource?apple=banana')
-
-  // Callback must be preserved.
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [Relative Legacy URL, RequestOptions with path set, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('http:', [
-    parse('/resource?apple=banana'),
-    { host: 'mswjs.io', path: '/other?cherry=durian' },
-    function cb() {},
-  ])
-
-  // Correct WHATWG URL generated.
-  expect(url.toJSON()).toEqual(
-    new URL('http://mswjs.io/other?cherry=durian').toJSON()
-  )
-
-  // Path in request options, so that path is preferred.
-  expect(options.protocol).toEqual('http:')
-  expect(options.host).toEqual('mswjs.io')
-  expect(options.path).toEqual('/other?cherry=durian')
-
-  // Callback must be preserved.
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [Relative Legacy URL, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('http:', [
-    parse('/resource?apple=banana'),
-    function cb() {},
-  ])
-
-  // Correct WHATWG URL generated.
-  expect(url.toJSON()).toMatch(
-    getUrlByRequestOptions({ path: '/resource?apple=banana' }).toJSON()
-  )
-
-  // Check path is in options.
-  expect(options.protocol).toEqual('http:')
-  expect(options.path).toEqual('/resource?apple=banana')
-
-  // Callback must be preserved.
-  expect(callback).toBeTypeOf('function')
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [Relative Legacy URL] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('http:', [
-    parse('/resource?apple=banana'),
-  ])
-
-  // Correct WHATWG URL generated.
-  expect(url.toJSON()).toMatch(
-    getUrlByRequestOptions({ path: '/resource?apple=banana' }).toJSON()
-  )
-
-  // Check path is in options.
-  expect(options.protocol).toEqual('http:')
-  expect(options.path).toEqual('/resource?apple=banana')
-
-  // Callback must be preserved.
-  expect(callback).toBeUndefined()
-})
-
-it('handles [URL, RequestOptions, callback] input', () => {
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    new URL('https://mswjs.io/resource'),
-    {
-      agent: false,
-      headers: {
-        'Content-Type': 'text/plain',
-      },
-    },
-    function cb() {},
-  ])
-
-  // URL must be preserved.
-  expect(url.href).toEqual('https://mswjs.io/resource')
-
-  // Options must be preserved.
-  // `urlToHttpOptions` from `node:url` generates additional
-  // ClientRequest options, some of which are not legally allowed.
-  expect(options).toMatchObject<RequestOptions>({
-    agent: false,
-    _defaultAgent: httpsGlobalAgent,
-    protocol: url.protocol,
-    method: 'GET',
-    headers: {
-      'Content-Type': 'text/plain',
-    },
-    hostname: url.hostname,
-    path: url.pathname,
-  })
-
-  // Callback must be preserved.
-  expect(callback).toBeTypeOf('function')
-  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({
-    hostname: '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<RequestOptions>({
-    hostname: 'host-from-options.com',
-    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<RequestOptions>({
-    hostname: 'example.com',
-    path: '/path-from-options?foo=bar&baz=xyz',
-  })
-})
-
-it('handles [RequestOptions, callback] input', () => {
-  const initialOptions = {
-    method: 'POST',
-    protocol: 'https:',
-    host: 'mswjs.io',
-    /**
-     * @see https://github.com/mswjs/msw/issues/705
-     */
-    origin: 'https://mswjs.io',
-    path: '/resource',
-    headers: {
-      'Content-Type': 'text/plain',
-    },
-  }
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    initialOptions,
-    function cb() {},
-  ])
-
-  // URL must be derived from request options.
-  expect(url.href).toEqual('https://mswjs.io/resource')
-
-  // Request options must be preserved.
-  expect(options).toMatchObject(initialOptions)
-
-  // Callback must be preserved.
-  expect(callback).toBeTypeOf('function')
-  expect(callback?.name).toEqual('cb')
-})
-
-it('handles [Empty RequestOptions, callback] input', () => {
-  const [_, options, callback] = normalizeClientRequestArgs('https:', [
-    {},
-    function cb() {},
-  ])
-
-  expect(options.protocol).toEqual('https:')
-
-  // Callback must be preserved
-  expect(callback?.name).toEqual('cb')
-})
-
-/**
- * @see https://github.com/mswjs/interceptors/issues/19
- */
-it('handles [PartialRequestOptions, callback] input', () => {
-  const initialOptions = {
-    method: 'GET',
-    port: '50176',
-    path: '/resource',
-    host: '127.0.0.1',
-    ca: undefined,
-    key: undefined,
-    pfx: undefined,
-    cert: undefined,
-    passphrase: undefined,
-    agent: false,
-  }
-  const [url, options, callback] = normalizeClientRequestArgs('https:', [
-    initialOptions,
-    function cb() {},
-  ])
-
-  // URL must be derived from request options.
-  expect(url.toJSON()).toEqual(
-    new URL('https://127.0.0.1:50176/resource').toJSON()
-  )
-
-  // Request options must be preserved.
-  expect(options).toMatchObject(initialOptions)
-
-  // Options protocol must be inferred from the request issuing module.
-  expect(options.protocol).toEqual('https:')
-
-  // Callback must be preserved.
-  expect(callback).toBeTypeOf('function')
-  expect(callback?.name).toEqual('cb')
-})
-
-it('sets the default Agent for HTTP request', () => {
-  const [, options] = normalizeClientRequestArgs('http:', [
-    'http://github.com',
-    {},
-  ])
-
-  expect(options._defaultAgent).toEqual(httpGlobalAgent)
-})
-
-it('sets the default Agent for HTTPS request', () => {
-  const [, options] = normalizeClientRequestArgs('https:', [
-    'https://github.com',
-    {},
-  ])
-
-  expect(options._defaultAgent).toEqual(httpsGlobalAgent)
-})
-
-it('preserves a custom default Agent when set', () => {
-  const [, options] = normalizeClientRequestArgs('https:', [
-    'https://github.com',
-    {
-      /**
-       * @note Intentionally incorrect Agent for HTTPS request.
-       */
-      _defaultAgent: httpGlobalAgent,
-    },
-  ])
-
-  expect(options._defaultAgent).toEqual(httpGlobalAgent)
-})
-
-it('merges URL-based RequestOptions with the custom RequestOptions', () => {
-  const [url, options] = normalizeClientRequestArgs('https:', [
-    'https://github.com/graphql',
-    {
-      method: 'GET',
-      pfx: 'PFX_KEY',
-    },
-  ])
-
-  expect(url.href).toEqual('https://github.com/graphql')
-
-  // Original request options must be preserved.
-  expect(options.method).toEqual('GET')
-  expect(options.pfx).toEqual('PFX_KEY')
-
-  // Other options must be inferred from the URL.
-  expect(options.protocol).toEqual(url.protocol)
-  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.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.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:8080/resource?a=b&c=d'),
-  ])
-
-  expect(url.href).toBe('http://example.com:8080/resource?a=b&c=d')
-  expect(options.protocol).toBe('http:')
-  // expect(options.host).toBe('example.com:8080')
-  expect(options.hostname).toBe('example.com')
-  // Query string is a part of the options path.
-  expect(options.path).toBe('/resource?a=b&c=d')
-  expect(options.port).toBe(8080)
-})