Remove workarounds for util in non-node environments

lib/__tests__/memoryCookieStore.spec.ts

@@ -1,4 +1,6 @@
+import util from 'node:util'
 import { Cookie } from '../cookie/cookie'
+import { CookieJar } from '../cookie/cookieJar'
 import { MemoryCookieStore } from '../memstore'
 
 describe('MemoryCookieStore', () => {
@@ -27,4 +29,46 @@ describe('MemoryCookieStore', () => {
     expect(memoryCookieStore.removeAllCookies()).toBeInstanceOf(Promise)
     expect(memoryCookieStore.getAllCookies()).toBeInstanceOf(Promise)
   })
+
+  describe('custom inspect matches util.inspect', () => {
+    let memoryStore: MemoryCookieStore
+    let cookieJar: CookieJar
+
+    beforeEach(() => {
+      memoryStore = new MemoryCookieStore()
+      cookieJar = new CookieJar(memoryStore)
+    })
+
+    it('for empty store', () => {
+      expect(memoryStore.inspect()).toEqual(util.inspect(memoryStore))
+    })
+
+    it('for store with single cookie', async () => {
+      await cookieJar.setCookie(
+        'a=1; Domain=example.com; Path=/',
+        'http://example.com/index.html',
+      )
+      expect(memoryStore.inspect()).toEqual(util.inspect(memoryStore))
+    })
+
+    it('for store with multiple cookies', async () => {
+      const url = 'http://example.com/index.html'
+      await cookieJar.setCookie('a=0; Domain=example.com; Path=/', url)
+      await cookieJar.setCookie('b=1; Domain=example.com; Path=/', url)
+      await cookieJar.setCookie('c=2; Domain=example.com; Path=/', url)
+      await cookieJar.setCookie(
+        'd=3; Domain=example.com; Path=/some-path/',
+        url,
+      )
+      await cookieJar.setCookie(
+        'e=4; Domain=example.com; Path=/some-path/',
+        url,
+      )
+      await cookieJar.setCookie(
+        'f=5; Domain=another.com; Path=/',
+        'http://another.com/index.html',
+      )
+      expect(memoryStore.inspect()).toEqual(util.inspect(memoryStore))
+    })
+  })
 })

lib/cookie/cookie.ts

@@ -34,8 +34,7 @@
 
 import * as pubsuffix from '../pubsuffix-psl'
 import * as validators from '../validators'
-import { getCustomInspectSymbol } from '../utilHelper'
-import { inOperator } from '../utils'
+import { inOperator, NODEJS_UTIL_INSPECT_CUSTOM } from '../utils'
 
 import { formatDate } from './formatDate'
 import { parseDate } from './parseDate'
@@ -421,16 +420,12 @@ export class Cookie {
   sameSite: string | undefined
 
   constructor(options: CreateCookieOptions = {}) {
-    // supports inspect if that feature is available in the environment
-    const customInspectSymbol = getCustomInspectSymbol()
-    if (customInspectSymbol) {
-      Object.defineProperty(this, customInspectSymbol, {
-        value: this.inspect.bind(this),
-        enumerable: false,
-        writable: false,
-        configurable: false,
-      })
-    }
+    Object.defineProperty(this, NODEJS_UTIL_INSPECT_CUSTOM, {
+      value: this.inspect.bind(this),
+      enumerable: false,
+      writable: false,
+      configurable: false,
+    })
 
     Object.assign(this, cookieDefaults, options)
     this.creation = options.creation ?? cookieDefaults.creation ?? new Date()

lib/memstore.ts

@@ -33,12 +33,12 @@ import type { Cookie } from './cookie/cookie'
 import { pathMatch } from './pathMatch'
 import { permuteDomain } from './permuteDomain'
 import { Store } from './store'
-import { getCustomInspectSymbol, getUtilInspect } from './utilHelper'
 import {
   Callback,
   createPromiseCallback,
   inOperator,
   ErrorCallback,
+  NODEJS_UTIL_INSPECT_CUSTOM,
 } from './utils'
 
 export type MemoryCookieStoreIndex = {
@@ -57,20 +57,16 @@ export class MemoryCookieStore extends Store {
     super()
     this.synchronous = true
     this.idx = Object.create(null) as MemoryCookieStoreIndex
-    const customInspectSymbol = getCustomInspectSymbol()
-    if (customInspectSymbol) {
-      Object.defineProperty(this, customInspectSymbol, {
-        value: this.inspect.bind(this),
-        enumerable: false,
-        writable: false,
-        configurable: false,
-      })
-    }
+    Object.defineProperty(this, NODEJS_UTIL_INSPECT_CUSTOM, {
+      value: this.inspect.bind(this),
+      enumerable: false,
+      writable: false,
+      configurable: false,
+    })
   }
 
   inspect() {
-    const util = { inspect: getUtilInspect(inspectFallback) }
-    return `{ idx: ${util.inspect(this.idx, false, 2)} }`
+    return `{ idx: ${inspect(this.idx)} }`
   }
 
   override findCookie(
@@ -311,7 +307,8 @@ export class MemoryCookieStore extends Store {
   }
 }
 
-export function inspectFallback(val: unknown): string {
+// Approximates node's util.inspect, so that we can still inspect in non-node environments
+function inspect(val: unknown): string {
   if (typeof val === 'string') {
     return `'${val}'`
   }

lib/utils.ts

@@ -88,3 +88,11 @@ export function inOperator<K extends string, T extends object>(
 ): o is T & Record<K, unknown> {
   return k in o
 }
+
+/**
+ * Symbol used by node.js for custom inspect output.
+ * @see https://nodejs.org/docs/latest-v16.x/api/util.html#utilinspectcustom
+ */
+export const NODEJS_UTIL_INSPECT_CUSTOM = Symbol.for(
+  'nodejs.util.inspect.custom',
+)