fix: Host header with localhost connections (#274)

Author: Gioee

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlitecloud/drivers",
-  "version": "1.0.878",
+  "version": "1.0.880",
   "description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package.json

@@ -98,14 +98,14 @@ export class SQLiteCloudWebsocketConnection extends SQLiteCloudConnection {
         // hostname (eg crvheg7dhk.g4 from crvheg7dhk.g4.sqlite.cloud) to form the gateway host
         // (→ crvheg7dhk.g4.gateway.sqlite.cloud). For local development, pass a `gatewayurl`
         // containing `localhost` — the driver routes TCP to it and injects the tenant Host header
-        // separately so the gateway still tenant-routes correctly.
+        // (with the gateway marker label) so the gateway still tenant-routes correctly.
         const authToken = this.config.apikey || this.config.token
         const ioOpts: Record<string, unknown> = { auth: { token: authToken }, parser: createSocketIOParser(websocketMaxAttachments) }
         let gatewayUrl: string
         if (this.config.gatewayurl?.includes('localhost')) {
           const raw = this.config.gatewayurl
           gatewayUrl = raw.startsWith('ws://') || raw.startsWith('wss://') ? raw : `ws://${raw}`
-          ioOpts.extraHeaders = { Host: this.config.host }
+          ioOpts.extraHeaders = { Host: buildGatewayHost(this.config.host as string) }
           ioOpts.transports = ['websocket']
         } else {
           const gatewayHost = buildGatewayHost(this.config.host as string, this.config.gatewayurl)

src/drivers/connection-ws.ts

@@ -44,6 +44,36 @@ describe('websocket transport helpers', () => {
     expect(decoder.opts?.maxAttachments).toBe(321)
   })
 
+  it('should connect to localhost gateway with the marker-augmented Host header', () => {
+    const socket = {
+      connected: false,
+      on: jest.fn(),
+      removeAllListeners: jest.fn(),
+      close: jest.fn()
+    }
+    const mockedIo = io as jest.MockedFunction<typeof io>
+    mockedIo.mockReturnValue(socket as any)
+
+    const connection = Object.create(SQLiteCloudWebsocketConnection.prototype) as any
+    connection.connectTransport(
+      {
+        connectionstring: 'sqlitecloud://host.sqlite.cloud/database?apikey=secret',
+        host: 'host.sqlite.cloud',
+        apikey: 'secret',
+        gatewayurl: 'ws://localhost:8090'
+      },
+      jest.fn()
+    )
+
+    expect(mockedIo).toHaveBeenCalledWith(
+      'ws://localhost:8090',
+      expect.objectContaining({
+        extraHeaders: { Host: 'host.gateway.sqlite.cloud' },
+        transports: ['websocket']
+      })
+    )
+  })
+
   it('should encode bigint values before sending JSON payloads', () => {
     expect(
       encodeBigIntMarkers({