fix: export resolveWebSocketUrl function (#764)

Author: kettanaito

src/index.ts

@@ -12,3 +12,4 @@ export { getCleanUrl } from './utils/getCleanUrl'
 export { encodeBuffer, decodeBuffer } from './utils/bufferUtils'
 export { FetchResponse } from './utils/fetchUtils'
 export { getRawRequest } from './getRawRequest'
+export { resolveWebSocketUrl } from './utils/resolveWebSocketUrl'

src/interceptors/WebSocket/WebSocketOverride.ts

@@ -3,6 +3,7 @@ import { DeferredPromise } from '@open-draft/deferred-promise'
 import type { WebSocketData } from './WebSocketTransport'
 import { bindEvent } from './utils/bindEvent'
 import { CloseEvent } from './utils/events'
+import { resolveWebSocketUrl } from '../../utils/resolveWebSocketUrl'
 
 export type WebSocketEventListener<
   EventType extends WebSocketEventMap[keyof WebSocketEventMap] = Event,
@@ -249,49 +250,3 @@ function getDataSize(data: WebSocketData): number {
 
   return data.byteLength
 }
-
-/**
- * Resolve potentially relative WebSocket URLs the same way
- * the browser does (replace the protocol, use the origin, etc).
- *
- * @see https://websockets.spec.whatwg.org//#dom-websocket-websocket
- */
-function resolveWebSocketUrl(url: string | URL): string {
-  if (typeof url === 'string') {
-    /**
-     * @note Cast the string to a URL first so the parsing errors
-     * are thrown as a part of the WebSocket constructor, not consumers.
-     */
-    const urlRecord = new URL(
-      url,
-      typeof location !== 'undefined' ? location.href : undefined
-    )
-
-    return resolveWebSocketUrl(urlRecord)
-  }
-
-  if (url.protocol === 'http:') {
-    url.protocol = 'ws:'
-  } else if (url.protocol === 'https:') {
-    url.protocol = 'wss:'
-  }
-
-  if (url.protocol !== 'ws:' && url.protocol !== 'wss:') {
-    /**
-     * @note These errors are modeled after the browser errors.
-     * The exact error messages aren't provided in the specification.
-     * Node.js uses more obscure error messages that I don't wish to replicate.
-     */
-    throw new SyntaxError(
-      `Failed to construct 'WebSocket': The URL's scheme must be either 'http', 'https', 'ws', or 'wss'. '${url.protocol}' is not allowed.`
-    )
-  }
-
-  if (url.hash !== '') {
-    throw new SyntaxError(
-      `Failed to construct 'WebSocket': The URL contains a fragment identifier ('${url.hash}'). Fragment identifiers are not allowed in WebSocket URLs.`
-    )
-  }
-
-  return url.href
-}

src/utils/resolveWebSocketUrl.ts

@@ -0,0 +1,45 @@
+/**
+ * Resolve potentially relative WebSocket URLs the same way
+ * the browser does (replace the protocol, use the origin, etc).
+ *
+ * @see https://websockets.spec.whatwg.org//#dom-websocket-websocket
+ */
+export function resolveWebSocketUrl(url: string | URL): string {
+  if (typeof url === 'string') {
+    /**
+     * @note Cast the string to a URL first so the parsing errors
+     * are thrown as a part of the WebSocket constructor, not consumers.
+     */
+    const urlRecord = new URL(
+      url,
+      typeof location !== 'undefined' ? location.href : undefined
+    )
+
+    return resolveWebSocketUrl(urlRecord)
+  }
+
+  if (url.protocol === 'http:') {
+    url.protocol = 'ws:'
+  } else if (url.protocol === 'https:') {
+    url.protocol = 'wss:'
+  }
+
+  if (url.protocol !== 'ws:' && url.protocol !== 'wss:') {
+    /**
+     * @note These errors are modeled after the browser errors.
+     * The exact error messages aren't provided in the specification.
+     * Node.js uses more obscure error messages that I don't wish to replicate.
+     */
+    throw new SyntaxError(
+      `Failed to construct 'WebSocket': The URL's scheme must be either 'http', 'https', 'ws', or 'wss'. '${url.protocol}' is not allowed.`
+    )
+  }
+
+  if (url.hash !== '') {
+    throw new SyntaxError(
+      `Failed to construct 'WebSocket': The URL contains a fragment identifier ('${url.hash}'). Fragment identifiers are not allowed in WebSocket URLs.`
+    )
+  }
+
+  return url.href
+}