Improve type safety and error logging in realtime WebSocket handler

[Copilot]

upstreamWs and messageBuffer were typed as any/any[], bypassing type safety, and console.error was used inconsistently instead of the imported logError.

Changes

• Type aliases: Added RealtimeMessage = string | Buffer | ArrayBuffer | Uint8Array for buffer entries
• Typed variables: upstreamWs: NodeWebSocket | null, messageBuffer: RealtimeMessage[]
• Removed any casts: Eliminated new (NodeWebSocket as any)(...) and all (upstreamWs as any).on(...) call sites
• Consistent error logging: Replaced console.error with logError for upstream errors and usage update failures; usage failures now include structured context (error, userApiKey, totalTokens)

// Before
let upstreamWs: any = null;
let messageBuffer: any[] = [];
upstreamWs = new (NodeWebSocket as any)(config.url, { ... });
(upstreamWs as any).on('open', () => { ... });
updateUserTokenUsage(...).catch(err => console.error('Realtime usage update failed', err));

// After
let upstreamWs: NodeWebSocket | null = null;
let messageBuffer: RealtimeMessage[] = [];
upstreamWs = new NodeWebSocket(config.url, { ... });
upstreamWs.on('open', () => { ... });
updateUserTokenUsage(...).catch(err => logError('Realtime usage update failed', { error: err, userApiKey, totalTokens: total }));

Original prompt

Please apply the following diffs and create a pull request.
Once the PR is ready, give it a title based on the messages of the fixes being applied.

[{"message":"The upstreamWs variable is typed as 'any', which bypasses type safety. Consider creating a proper type definition for the upstream WebSocket or using NodeWebSocket type to improve type safety and maintainability.","fixFiles":[{"filePath":"apps/api/ws/realtime.ts","diff":"diff --git a/apps/api/ws/realtime.ts b/apps/api/ws/realtime.ts\n--- a/apps/api/ws/realtime.ts\n+++ b/apps/api/ws/realtime.ts\n@@ -83,7 +83,7 @@\n \n export function attachRealtimeWebSocket(app: { ws: (path: string, handler: (ws: WSWrapper, req: RequestContext) => void) => void }) {\n     app.ws('/v1/realtime', (clientWs: WSWrapper, req: RequestContext) => {\n-        let upstreamWs: any = null;\n+        let upstreamWs: NodeWebSocket | null = null;\n         let isAuthenticated = false;\n         let userId: string | null = null;\n         let userApiKey: string | null = null;\n"}]},{"message":"The messageBuffer is typed as 'any[]', which reduces type safety. Consider defining a more specific type such as 'Array<Buffer | ArrayBuffer | string>' to match the actual data types being stored.","fixFiles":[{"filePath":"apps/api/ws/realtime.ts","diff":"diff --git a/apps/api/ws/realtime.ts b/apps/api/ws/realtime.ts\n--- a/apps/api/ws/realtime.ts\n+++ b/apps/api/ws/realtime.ts\n@@ -11,6 +11,8 @@\n     model: string;\n }\n \n+type RealtimeMessage = string | Buffer | ArrayBuffer | Uint8Array;\n+\n function isOpenAIHost(urlStr?: string | null): boolean {\n     if (!urlStr) return false;\n     try {\n@@ -87,7 +89,7 @@\n         let isAuthenticated = false;\n         let userId: string | null = null;\n         let userApiKey: string | null = null;\n-        let messageBuffer: any[] = []; // Buffer messages until upstream connects\n+        let messageBuffer: RealtimeMessage[] = []; // Buffer messages until upstream connects\n \n         // 1. Authenticate Client\n         // Query param 'api-key' or Header 'Authorization' (or 'api-key')\n"}]},{"message":"Casting NodeWebSocket to 'any' to bypass type checks suggests a typing issue. Consider properly typing the WebSocket instance or using the correct constructor signature from the @types/ws package to maintain type safety.","fixFiles":[{"filePath":"apps/api/ws/realtime.ts","diff":"diff --git a/apps/api/ws/realtime.ts b/apps/api/ws/realtime.ts\n--- a/apps/api/ws/realtime.ts\n+++ b/apps/api/ws/realtime.ts\n@@ -143,23 +143,22 @@\n             }\n \n             try {\n-                // Use 'any' cast to bypass strict DOM WebSocket constructor checks\n-                upstreamWs = new (NodeWebSocket as any)(config.url, {\n+                upstreamWs = new NodeWebSocket(config.url, {\n                     headers: {\n                         'Authorization': `Bearer ${config.apiKey}`,\n                         'OpenAI-Beta': 'realtime=v1',\n                     }\n                 });\n \n-                (upstreamWs as any).on('open', () => {\n+                upstreamWs.on('open', () => {\n                     // Flush buffer\n                     for (const msg of messageBuffer) {\n-                        (upstreamWs as any)?.send(msg);\n+                        upstreamWs.send(msg);\n                     }\n                     messageBuffer = [];\n                 });\n \n-                (upstreamWs as any).on('message', async (data: any) => {\n+                upstreamWs.on('message', async (data: any) => {\n                     // Forward to client\n                     // uWS send expects string or ArrayBuffer\n                     // WebSocket data is Buffer | ArrayBuffer | Buffer[]\n@@ -195,13 +182,13 @@\n                     }\n                 });\n \n-                (upstreamWs as any).on('error', (err: any) => {\n+                upstreamWs.on('error', (err: any) => {\n                     console.error('Realtime Upstream Error:', err);\n                     clientWs.send(JSON.stringify({ type: 'error', error: { type: 'server_error', message: 'Upstream connection error.' } }));\n                     clientWs.close();\n                 });\n \n-                (upstreamWs as any).on('close', () => {\n+                upstreamWs.on('close', () => {\n                     clientWs.close();\n                 });\n \n"}]},{"message":"The error message 'Realtime usage update failed' is not informative enough. Consider including additional context such as the user ID, token count, or error details to aid in debugging production issues. Also consider using the logError function that is imported but not used here for consistent error logging.","fixFiles":[{"filePath":"apps/api/ws/realtime.ts","diff":"diff --git a/apps/api/ws/realtime.ts b/apps/api/ws/realtime.ts\n--- a/apps/api/ws/realtime.ts\n+++ b/apps/api/ws/realtime.ts\n@@ -181,7 +181,13 @@\n                                 const usage = event.response.usage;\n             ...

---

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

[Copilot]

Pull request overview

This PR tightens TypeScript types in the realtime WebSocket proxy and aims to standardize error logging by replacing ad-hoc console.error usage with the shared logError utility.

Changes:

• Introduces a RealtimeMessage union type and applies it to the buffered message queue.
• Types upstreamWs as NodeWebSocket | null and removes any casts around WS construction and event handlers.
• Replaces console.error calls with logError for upstream errors and usage-update failures.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

logError is being called with a message string as the first argument and a context object as the second, but logError’s signature is logError(error, request?). As written, the context object will be treated as the (optional) request and the actual error/context won’t be captured. Consider passing a single structured object (e.g., with message and the caught error/details) as the first argument and, if available, the WS req as the second. Also avoid logging the raw API key in details—redact or hash it before including it in any logged context.

[Copilot]

logError('Realtime Upstream Error', err) passes the message string as the error and the actual err as the request parameter, which drops the upstream error details in logs. Update this to log the actual error (and optionally include a message via a structured error object), and make sure to handle the returned promise (await it or attach a .catch) to avoid unhandled rejections.

Suggested change

	logError('Realtime Upstream Error', err);
	logError({ message: 'Realtime Upstream Error', error: err }).catch(() => {
	// Swallow logging errors to avoid unhandled rejections in the WebSocket error handler
	});