fix(WebSocketHandler): add public test() method (#2727)

kettanaito · web-flow · commit 3da7048e05fa · 2026-04-24T17:46:56.000+02:00
diff --git a/src/core/handlers/WebSocketHandler.test.ts b/src/core/handlers/WebSocketHandler.test.ts
@@ -125,3 +125,61 @@ describe('parse', () => {
     })
   })
 })
+
+describe('test', () => {
+  it('returns true for a matching string', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test('ws://localhost/ws'),
+    ).toBe(true)
+  })
+
+  it('returns false for a non-matching string', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test('ws://localhost/other'),
+    ).toBe(false)
+  })
+
+  it('returns true for a relative matching string', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test('/ws', {
+        baseUrl: 'ws://localhost',
+      }),
+    ).toBe(true)
+  })
+
+  it('returns false for a relative non-matching string', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test('/other', {
+        baseUrl: 'ws://localhost',
+      }),
+    ).toBe(false)
+  })
+
+  it('returns true for a matching URL', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test(
+        new URL('ws://localhost/ws'),
+      ),
+    ).toBe(true)
+  })
+
+  it('returns false for a non-matching URL', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test(
+        new URL('ws://localhost/other'),
+      ),
+    ).toBe(false)
+  })
+
+  it('returns true for a matching HTTP url string', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test('http://localhost/ws'),
+    ).toBe(true)
+  })
+
+  it('returns false for a non-matching HTTP url string', () => {
+    expect(
+      new WebSocketHandler('ws://localhost/ws').test('http://localhost/other'),
+    ).toBe(false)
+  })
+})
diff --git a/src/core/handlers/WebSocketHandler.ts b/src/core/handlers/WebSocketHandler.ts
@@ -57,7 +57,7 @@ export class WebSocketHandler {
   }
 
   public parse(args: {
-    url: URL
+    url: string | URL
     resolutionContext?: WebSocketResolutionContext
   }): WebSocketHandlerParsedResult {
     const clientUrl = new URL(args.url)
@@ -90,22 +90,26 @@ export class WebSocketHandler {
   }
 
   public predicate(args: {
-    url: URL
+    url: string | URL
     parsedResult: WebSocketHandlerParsedResult
   }): boolean {
     return args.parsedResult.match.matches
   }
 
+  public test(
+    url: string | URL,
+    resolutionContext?: WebSocketResolutionContext & { strict?: boolean },
+  ): boolean {
+    return this.#match(url, resolutionContext) != null
+  }
+
   public async run(
     connection: WebSocketConnectionData,
     resolutionContext?: WebSocketResolutionContext,
   ): Promise<WebSocketHandlerConnection | null> {
-    const parsedResult = this.parse({
-      url: connection.client.url,
-      resolutionContext,
-    })
+    const parsedResult = this.#match(connection.client.url, resolutionContext)
 
-    if (!this.predicate({ url: connection.client.url, parsedResult })) {
+    if (parsedResult == null) {
       return null
     }
 
@@ -125,6 +129,31 @@ export class WebSocketHandler {
     return resolvedConnection
   }
 
+  #match(
+    url: string | URL,
+    resolutionContext?: WebSocketResolutionContext & { strict?: boolean },
+  ): WebSocketHandlerParsedResult | null {
+    const resolvedUrl = this.#resolveWebSocketUrl(
+      url.toString(),
+      resolutionContext?.baseUrl,
+    )
+    const parsedResult = this.parse({
+      url: resolvedUrl,
+      resolutionContext,
+    })
+
+    if (
+      this.predicate({
+        url,
+        parsedResult,
+      })
+    ) {
+      return parsedResult
+    }
+
+    return null
+  }
+
   protected [kConnect](connection: WebSocketHandlerConnection): boolean {
     // Support `event.stopPropagation()` for various client/server events.
     connection.client.addEventListener(
