fix: correctly imports commonjs "debug" package (#351)

Fix for #350 Changes the imports, so they handle the CommonJS exports from the "debug" package. --------- Co-authored-by: Artem Zakharchenko <[email protected]>
mswjs · Mar 3, 2023 · 1e2ffd9 · 1e2ffd9
1 parent fdf1e4b
commit 1e2ffd9
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 29 deletions.
diff --git a/src/Interceptor.ts b/src/Interceptor.ts
@@ -1,7 +1,7 @@
-import { Debugger, debug } from 'debug'
 import { Listener } from 'strict-event-emitter'
 import { AsyncEventEmitter } from './utils/AsyncEventEmitter'
 import { nextTick } from './utils/nextTick'
+import { debug, Debugger } from './utils/debug'
 
 export type InterceptorEventMap = Record<string, any>
 export type InterceptorSubscription = () => void

diff --git a/src/interceptors/ClientRequest/NodeClientRequest.test.ts b/src/interceptors/ClientRequest/NodeClientRequest.test.ts
@@ -1,5 +1,4 @@
 import { vi, it, expect, beforeAll, afterAll } from 'vitest'
-import { debug } from 'debug'
 import express from 'express'
 import { IncomingMessage } from 'http'
 import { HttpServer } from '@open-draft/test-server/http'
@@ -10,6 +9,7 @@ import { normalizeClientRequestArgs } from './utils/normalizeClientRequestArgs'
 import { AsyncEventEmitter } from '../../utils/AsyncEventEmitter'
 import { sleep } from '../../../test/helpers'
 import { HttpRequestEventMap } from '../../glossary'
+import { debug } from '../../utils/debug'
 
 interface ErrorConnectionRefused extends NodeJS.ErrnoException {
   address: string

diff --git a/src/interceptors/ClientRequest/http.request.ts b/src/interceptors/ClientRequest/http.request.ts
@@ -1,4 +1,3 @@
-import { debug } from 'debug'
 import { ClientRequest } from 'http'
 import {
   NodeClientOptions,
@@ -9,6 +8,7 @@ import {
   normalizeClientRequestArgs,
   ClientRequestArgs,
 } from './utils/normalizeClientRequestArgs'
+import { debug } from '../../utils/debug'
 
 const log = debug('http request')
 

diff --git a/src/interceptors/ClientRequest/utils/createRequest.test.ts b/src/interceptors/ClientRequest/utils/createRequest.test.ts
@@ -1,9 +1,9 @@
 import { it, expect } from 'vitest'
-import { debug } from 'debug'
 import { HttpRequestEventMap } from '../../..'
 import { AsyncEventEmitter } from '../../../utils/AsyncEventEmitter'
 import { NodeClientRequest } from '../NodeClientRequest'
 import { createRequest } from './createRequest'
+import { debug } from '../../../utils/debug'
 
 const emitter = new AsyncEventEmitter<HttpRequestEventMap>()
 const log = debug('test')

diff --git a/src/interceptors/ClientRequest/utils/getIncomingMessageBody.ts b/src/interceptors/ClientRequest/utils/getIncomingMessageBody.ts
@@ -1,7 +1,7 @@
-import { debug } from 'debug'
 import { IncomingMessage } from 'http'
 import { PassThrough } from 'stream'
 import * as zlib from 'zlib'
+import { debug } from '../../../utils/debug'
 
 const log = debug('http getIncomingMessageBody')
 

diff --git a/src/interceptors/ClientRequest/utils/normalizeClientRequestArgs.ts b/src/interceptors/ClientRequest/utils/normalizeClientRequestArgs.ts
@@ -1,4 +1,3 @@
-import { debug } from 'debug'
 import {
   Agent as HttpAgent,
   globalAgent as httpGlobalAgent,
@@ -17,6 +16,7 @@ import {
 } from '../../../utils/getUrlByRequestOptions'
 import { cloneObject } from '../../../utils/cloneObject'
 import { isObject } from '../../../utils/isObject'
+import { debug } from '../../../utils/debug'
 
 const log = debug('http normalizeClientRequestArgs')
 

diff --git a/src/interceptors/ClientRequest/utils/normalizeClientRequestEndArgs.ts b/src/interceptors/ClientRequest/utils/normalizeClientRequestEndArgs.ts
@@ -1,4 +1,6 @@
-const debug = require('debug')('http normalizeClientRequestEndArgs')
+import { debug } from '../../../utils/debug'
+
+const log = debug('utils getUrlByRequestOptions')
 
 export type ClientRequestEndChunk = string | Buffer
 export type ClientRequestEndCallback = () => void
@@ -22,7 +24,7 @@ type NormalizedHttpRequestEndParams = [
 export function normalizeClientRequestEndArgs(
   ...args: HttpRequestEndArgs
 ): NormalizedHttpRequestEndParams {
-  debug('arguments', args)
+  log('arguments', args)
   const normalizedArgs = new Array(3)
     .fill(null)
     .map((value, index) => args[index] || value)
@@ -46,6 +48,6 @@ export function normalizeClientRequestEndArgs(
     return 0
   })
 
-  debug('normalized args', normalizedArgs)
+  log('normalized args', normalizedArgs)
   return normalizedArgs as NormalizedHttpRequestEndParams
 }
diff --git a/src/interceptors/ClientRequest/utils/normalizeClientRequestWriteArgs.ts b/src/interceptors/ClientRequest/utils/normalizeClientRequestWriteArgs.ts
@@ -1,4 +1,4 @@
-import { debug } from 'debug'
+import { debug } from '../../../utils/debug'
 
 const log = debug('http normalizeWriteArgs')
 

diff --git a/src/utils/AsyncEventEmitter.ts b/src/utils/AsyncEventEmitter.ts
@@ -1,6 +1,6 @@
-import { Debugger, debug } from 'debug'
 import { Emitter, EventMap, Listener } from 'strict-event-emitter'
 import { nextTick } from './nextTick'
+import { debug, Debugger } from './debug'
 
 export interface QueueItem<Args extends Array<unknown>> {
   args: Args

diff --git a/src/utils/cloneObject.ts b/src/utils/cloneObject.ts
@@ -1,25 +1,27 @@
-const debug = require('debug')('cloneObject')
+import { debug } from './debug'
+
+const log = debug('cloneObject')
 
 function isPlainObject(obj?: Record<string, any>): boolean {
-  debug('is plain object?', obj)
+  log('is plain object?', obj)
 
   if (obj == null || !obj.constructor?.name) {
-    debug('given object is undefined, not a plain object...')
+    log('given object is undefined, not a plain object...')
     return false
   }
 
-  debug('checking the object constructor:', obj.constructor.name)
+  log('checking the object constructor:', obj.constructor.name)
   return obj.constructor.name === 'Object'
 }
 
 export function cloneObject<ObjectType extends Record<string, any>>(
   obj: ObjectType
 ): ObjectType {
-  debug('cloning object:', obj)
+  log('cloning object:', obj)
 
   const enumerableProperties = Object.entries(obj).reduce<Record<string, any>>(
     (acc, [key, value]) => {
-      debug('analyzing key-value pair:', key, value)
+      log('analyzing key-value pair:', key, value)
 
       // Recursively clone only plain objects, omitting class instances.
       acc[key] = isPlainObject(value) ? cloneObject(value) : value

diff --git a/src/utils/debug.ts b/src/utils/debug.ts
@@ -0,0 +1,4 @@
+export type { Debugger } from 'debug'
+import debugCjsImport from 'debug'
+
+export const debug = debugCjsImport
diff --git a/src/utils/getUrlByRequestOptions.ts b/src/utils/getUrlByRequestOptions.ts
@@ -1,7 +1,8 @@
 import { Agent } from 'http'
 import { RequestOptions, Agent as HttpsAgent } from 'https'
+import { debug } from './debug'
 
-const debug = require('debug')('utils getUrlByRequestOptions')
+const log = debug('utils getUrlByRequestOptions')
 
 // Request instance constructed by the "request" library
 // has a "self" property that has a "uri" field. This is
@@ -123,43 +124,43 @@ function getHostname(host: string, port?: number): string {
  * Creates a `URL` instance from a given `RequestOptions` object.
  */
 export function getUrlByRequestOptions(options: ResolvedRequestOptions): URL {
-  debug('request options', options)
+  log('request options', options)
 
   if (options.uri) {
-    debug(
+    log(
       'constructing url from explicitly provided "options.uri": %s',
       options.uri
     )
     return new URL(options.uri.href)
   }
 
-  debug('figuring out url from request options...')
+  log('figuring out url from request options...')
 
   const protocol = getProtocolByRequestOptions(options)
-  debug('protocol', protocol)
+  log('protocol', protocol)
 
   const host = getHostByRequestOptions(options)
-  debug('host', host)
+  log('host', host)
 
   const port = getPortByRequestOptions(options)
-  debug('port', port)
+  log('port', port)
 
   const hostname = getHostname(host, port)
-  debug('hostname', hostname)
+  log('hostname', hostname)
 
   const path = options.path || DEFAULT_PATH
-  debug('path', path)
+  log('path', path)
 
   const credentials = getAuthByRequestOptions(options)
-  debug('credentials', credentials)
+  log('credentials', credentials)
 
   const authString = credentials
     ? `${credentials.username}:${credentials.password}@`
     : ''
-  debug('auth string:', authString)
+  log('auth string:', authString)
 
   const url = new URL(`${protocol}//${authString}${hostname}${path}`)
-  debug('created url:', url)
+  log('created url:', url)
 
   return url
 }