@syncular/server-hono 0.0.4-25 → 0.0.6-100

package/README.md

@@ -8,6 +8,12 @@ Hono adapter for `@syncular/server`. Provides push/pull routes, WebSocket wake-u
 npm install @syncular/server-hono hono
 ```
 
+If you want to serve the Console UI with `mountConsoleUi`, also install:
+
+```bash
+npm install @syncular/console
+```
+
 ## Documentation
 
 - Hono adapter: https://syncular.dev/docs/server/hono-adapter
@@ -20,4 +26,3 @@ npm install @syncular/server-hono hono
 - Issues: https://github.com/syncular/syncular/issues
 
 > Status: Alpha. APIs and storage layouts may change between releases.
-

package/dist/console/gateway.d.ts

@@ -1,7 +1,7 @@
 import type { Context } from 'hono';
 import { Hono } from 'hono';
 import type { UpgradeWebSocket } from 'hono/ws';
-import type { ConsoleAuthResult } from './routes';
+import type { ConsoleAuthResult } from './types';
 export interface ConsoleGatewayInstance {
     instanceId: string;
     label?: string;
@@ -10,9 +10,11 @@ export interface ConsoleGatewayInstance {
     enabled?: boolean;
 }
 interface ConsoleGatewayDownstreamSocket {
+    onopen?: ((event: Event) => void) | null;
     onmessage: ((event: MessageEvent) => void) | null;
     onerror: ((event: Event) => void) | null;
     close: () => void;
+    send?: (data: string) => void;
 }
 export interface CreateConsoleGatewayRoutesOptions {
     instances: ConsoleGatewayInstance[];

package/dist/console/gateway.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gateway.d.ts","sourceRoot":"","sources":["../../src/console/gateway.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAGhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AA0DlD,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,8BAA8B;IACtC,SAAS,EAAE,CAAC,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IAClD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,iCAAiC;IAChD,SAAS,EAAE,sBAAsB,EAAE,CAAC;IACpC,YAAY,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;IAChE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,8BAA8B,CAAC;KACnE,CAAC;CACH;AAq9BD,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,iCAAiC,GACzC,IAAI,CA0vEN"}
+{"version":3,"file":"gateway.d.ts","sourceRoot":"","sources":["../../src/console/gateway.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AA2DhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,8BAA8B;IACtC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACzC,SAAS,EAAE,CAAC,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IAClD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,iCAAiC;IAChD,SAAS,EAAE,sBAAsB,EAAE,CAAC;IACpC,YAAY,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;IAChE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,8BAA8B,CAAC;KACnE,CAAC;CACH;AAo8BD,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,iCAAiC,GACzC,IAAI,CAi/EN"}

package/dist/console/gateway.js

@@ -471,28 +471,15 @@ function resolveForwardAuthorization(args) {
     if (header) {
         return header;
     }
-    const queryToken = args.c.req.query('token')?.trim();
-    if (queryToken) {
-        return `Bearer ${queryToken}`;
-    }
     return null;
 }
-function resolveForwardBearerToken(args) {
-    if (args.instance.token) {
-        return args.instance.token;
-    }
-    const authHeader = args.c.req.header('Authorization')?.trim();
-    if (authHeader?.startsWith('Bearer ')) {
-        const token = authHeader.slice(7).trim();
-        if (token.length > 0) {
-            return token;
-        }
-    }
-    const queryToken = args.c.req.query('token')?.trim();
-    if (queryToken) {
-        return queryToken;
+function parseBearerToken(authHeader) {
+    const value = authHeader?.trim();
+    if (!value?.startsWith('Bearer ')) {
+        return null;
     }
-    return null;
+    const token = value.slice(7).trim();
+    return token.length > 0 ? token : null;
 }
 async function fetchDownstreamJson(args) {
     const url = buildConsoleEndpointUrl({
@@ -743,7 +730,15 @@ export function createConsoleGatewayRoutes(options) {
     routes.use('*', cors({
         origin: corsOrigins === '*' ? '*' : corsOrigins,
         allowMethods: ['GET', 'POST', 'DELETE', 'OPTIONS'],
-        allowHeaders: ['Content-Type', 'Authorization'],
+        allowHeaders: [
+            'Content-Type',
+            'Authorization',
+            'X-Syncular-Transport-Path',
+            'Baggage',
+            'Sentry-Trace',
+            'Traceparent',
+            'Tracestate',
+        ],
         credentials: true,
     }));
     routes.get('/instances', describeRoute({
@@ -2087,7 +2082,7 @@ export function createConsoleGatewayRoutes(options) {
             ((url) => new WebSocket(url));
         const liveState = new WeakMap();
         routes.get('/events/live', upgradeWebSocket(async (c) => {
-            const auth = await options.authenticate(c);
+            const initialAuth = await options.authenticate(c);
             const partitionId = c.req.query('partitionId')?.trim() || undefined;
             const replaySince = c.req.query('since')?.trim() || undefined;
             const replayLimitRaw = c.req.query('replayLimit');
@@ -2104,11 +2099,38 @@ export function createConsoleGatewayRoutes(options) {
                     instanceIds: c.req.query('instanceIds') ?? undefined,
                 },
             });
+            const authenticateWithBearer = async (token) => {
+                const trimmedToken = token.trim();
+                if (!trimmedToken) {
+                    return null;
+                }
+                const authContext = {
+                    req: {
+                        header: (name) => name === 'Authorization' ? `Bearer ${trimmedToken}` : undefined,
+                        query: () => undefined,
+                    },
+                };
+                return options.authenticate(authContext);
+            };
+            const closeUnauthenticated = (ws) => {
+                try {
+                    ws.send(JSON.stringify({ type: 'error', message: 'UNAUTHENTICATED' }));
+                }
+                catch {
+                    // no-op
+                }
+                ws.close(4001, 'Unauthenticated');
+            };
             const cleanup = (ws) => {
                 const state = liveState.get(ws);
                 if (!state)
                     return;
-                clearInterval(state.heartbeatInterval);
+                if (state.heartbeatInterval) {
+                    clearInterval(state.heartbeatInterval);
+                }
+                if (state.authTimeout) {
+                    clearTimeout(state.authTimeout);
+                }
                 for (const downstream of state.downstreamSockets) {
                     try {
                         downstream.close();
@@ -2121,11 +2143,6 @@ export function createConsoleGatewayRoutes(options) {
             };
             return {
                 onOpen(_event, ws) {
-                    if (!auth) {
-                        ws.send(JSON.stringify({ type: 'error', message: 'UNAUTHENTICATED' }));
-                        ws.close(4001, 'Unauthenticated');
-                        return;
-                    }
                     if (selectedInstances.length === 0) {
                         ws.send(JSON.stringify({
                             type: 'error',
@@ -2134,16 +2151,171 @@ export function createConsoleGatewayRoutes(options) {
                         ws.close(4004, 'No instances selected');
                         return;
                     }
-                    const downstreamSockets = [];
+                    const state = {
+                        downstreamSockets: [],
+                        heartbeatInterval: null,
+                        authTimeout: null,
+                        isAuthenticated: false,
+                    };
+                    liveState.set(ws, state);
+                    const startAuthenticatedSession = (upstreamBearerToken) => {
+                        if (state.isAuthenticated) {
+                            return;
+                        }
+                        state.isAuthenticated = true;
+                        if (state.authTimeout) {
+                            clearTimeout(state.authTimeout);
+                            state.authTimeout = null;
+                        }
+                        for (const instance of selectedInstances) {
+                            const downstreamQuery = new URLSearchParams();
+                            if (partitionId) {
+                                downstreamQuery.set('partitionId', partitionId);
+                            }
+                            if (replaySince) {
+                                downstreamQuery.set('since', replaySince);
+                            }
+                            downstreamQuery.set('replayLimit', String(replayLimit));
+                            const downstreamUrl = buildConsoleEndpointUrl({
+                                instance,
+                                requestUrl: c.req.url,
+                                path: '/events/live',
+                                query: downstreamQuery,
+                            });
+                            const downstreamSocket = createDownstreamSocket(downstreamUrl);
+                            const downstreamToken = instance.token?.trim() ?? upstreamBearerToken?.trim() ?? null;
+                            if (downstreamToken && downstreamSocket.send) {
+                                downstreamSocket.onopen = () => {
+                                    try {
+                                        downstreamSocket.send?.(JSON.stringify({
+                                            type: 'auth',
+                                            token: downstreamToken,
+                                        }));
+                                    }
+                                    catch {
+                                        // no-op
+                                    }
+                                };
+                            }
+                            downstreamSocket.onmessage = (message) => {
+                                if (typeof message.data !== 'string') {
+                                    return;
+                                }
+                                try {
+                                    const payload = JSON.parse(message.data);
+                                    if (typeof payload.type === 'string' &&
+                                        (payload.type === 'connected' ||
+                                            payload.type === 'heartbeat')) {
+                                        return;
+                                    }
+                                    const payloadData = payload.data &&
+                                        typeof payload.data === 'object' &&
+                                        !Array.isArray(payload.data)
+                                        ? { ...payload.data, instanceId: instance.instanceId }
+                                        : { instanceId: instance.instanceId };
+                                    const event = {
+                                        ...payload,
+                                        data: payloadData,
+                                        instanceId: instance.instanceId,
+                                        timestamp: typeof payload.timestamp === 'string'
+                                            ? payload.timestamp
+                                            : new Date().toISOString(),
+                                    };
+                                    ws.send(JSON.stringify(event));
+                                }
+                                catch {
+                                    // Ignore malformed downstream events
+                                }
+                            };
+                            downstreamSocket.onerror = () => {
+                                try {
+                                    ws.send(JSON.stringify({
+                                        type: 'instance_error',
+                                        instanceId: instance.instanceId,
+                                        timestamp: new Date().toISOString(),
+                                    }));
+                                }
+                                catch {
+                                    // ignore send errors
+                                }
+                            };
+                            state.downstreamSockets.push(downstreamSocket);
+                        }
+                        ws.send(JSON.stringify({
+                            type: 'connected',
+                            timestamp: new Date().toISOString(),
+                            instanceCount: selectedInstances.length,
+                        }));
+                        const heartbeatInterval = setInterval(() => {
+                            try {
+                                ws.send(JSON.stringify({
+                                    type: 'heartbeat',
+                                    timestamp: new Date().toISOString(),
+                                }));
+                            }
+                            catch {
+                                clearInterval(heartbeatInterval);
+                            }
+                        }, heartbeatIntervalMs);
+                        state.heartbeatInterval = heartbeatInterval;
+                    };
+                    if (initialAuth) {
+                        startAuthenticatedSession(parseBearerToken(c.req.header('Authorization')));
+                        return;
+                    }
+                    state.authTimeout = setTimeout(() => {
+                        const current = liveState.get(ws);
+                        if (!current || current.isAuthenticated) {
+                            return;
+                        }
+                        closeUnauthenticated(ws);
+                        cleanup(ws);
+                    }, 5_000);
+                },
+                async onMessage(event, ws) {
+                    const state = liveState.get(ws);
+                    if (!state || state.isAuthenticated) {
+                        return;
+                    }
+                    if (typeof event.data !== 'string') {
+                        closeUnauthenticated(ws);
+                        cleanup(ws);
+                        return;
+                    }
+                    let token = '';
+                    try {
+                        const parsed = JSON.parse(event.data);
+                        if (parsed.type === 'auth' &&
+                            typeof parsed.token === 'string' &&
+                            parsed.token.trim().length > 0) {
+                            token = parsed.token;
+                        }
+                    }
+                    catch {
+                        // Invalid auth message will be handled below.
+                    }
+                    if (!token) {
+                        closeUnauthenticated(ws);
+                        cleanup(ws);
+                        return;
+                    }
+                    const auth = await authenticateWithBearer(token);
+                    const current = liveState.get(ws);
+                    if (!current || current.isAuthenticated) {
+                        return;
+                    }
+                    if (!auth) {
+                        closeUnauthenticated(ws);
+                        cleanup(ws);
+                        return;
+                    }
+                    current.isAuthenticated = true;
+                    if (current.authTimeout) {
+                        clearTimeout(current.authTimeout);
+                        current.authTimeout = null;
+                    }
                     for (const instance of selectedInstances) {
                         const downstreamQuery = new URLSearchParams();
-                        const downstreamToken = resolveForwardBearerToken({
-                            c,
-                            instance,
-                        });
-                        if (downstreamToken) {
-                            downstreamQuery.set('token', downstreamToken);
-                        }
                         if (partitionId) {
                             downstreamQuery.set('partitionId', partitionId);
                         }
@@ -2158,6 +2330,22 @@ export function createConsoleGatewayRoutes(options) {
                             query: downstreamQuery,
                         });
                         const downstreamSocket = createDownstreamSocket(downstreamUrl);
+                        const upstreamToken = token.trim();
+                        const downstreamToken = instance.token?.trim() ||
+                            (upstreamToken.length > 0 ? upstreamToken : null);
+                        if (downstreamToken && downstreamSocket.send) {
+                            downstreamSocket.onopen = () => {
+                                try {
+                                    downstreamSocket.send?.(JSON.stringify({
+                                        type: 'auth',
+                                        token: downstreamToken,
+                                    }));
+                                }
+                                catch {
+                                    // no-op
+                                }
+                            };
+                        }
                         downstreamSocket.onmessage = (message) => {
                             if (typeof message.data !== 'string') {
                                 return;
@@ -2174,7 +2362,7 @@ export function createConsoleGatewayRoutes(options) {
                                     !Array.isArray(payload.data)
                                     ? { ...payload.data, instanceId: instance.instanceId }
                                     : { instanceId: instance.instanceId };
-                                const event = {
+                                const liveEvent = {
                                     ...payload,
                                     data: payloadData,
                                     instanceId: instance.instanceId,
@@ -2182,7 +2370,7 @@ export function createConsoleGatewayRoutes(options) {
                                         ? payload.timestamp
                                         : new Date().toISOString(),
                                 };
-                                ws.send(JSON.stringify(event));
+                                ws.send(JSON.stringify(liveEvent));
                             }
                             catch {
                                 // Ignore malformed downstream events
@@ -2200,7 +2388,7 @@ export function createConsoleGatewayRoutes(options) {
                                 // ignore send errors
                             }
                         };
-                        downstreamSockets.push(downstreamSocket);
+                        current.downstreamSockets.push(downstreamSocket);
                     }
                     ws.send(JSON.stringify({
                         type: 'connected',
@@ -2218,10 +2406,7 @@ export function createConsoleGatewayRoutes(options) {
                             clearInterval(heartbeatInterval);
                         }
                     }, heartbeatIntervalMs);
-                    liveState.set(ws, {
-                        downstreamSockets,
-                        heartbeatInterval,
-                    });
+                    current.heartbeatInterval = heartbeatInterval;
                 },
                 onClose(_event, ws) {
                     cleanup(ws);