@livekit/agents-plugin-deepgram 1.6.4 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/agents-plugin-deepgram",
-  "version": "1.6.4",
+  "version": "1.7.0",
   "description": "Deepgram plugin for LiveKit Agents for Node.js",
   "main": "dist/index.js",
   "require": "dist/index.cjs",
@@ -28,22 +28,22 @@
     "README.md"
   ],
   "devDependencies": {
-    "@livekit/rtc-node": "^0.13.33",
-    "@microsoft/api-extractor": "^7.35.0",
+    "@livekit/rtc-node": "^0.13.34",
+    "@microsoft/api-extractor": "^7.58.12",
     "@types/ws": "^8.5.10",
     "tsup": "^8.3.5",
     "typescript": "^5.0.0",
-    "@livekit/agents": "1.6.4",
-    "@livekit/agents-plugin-openai": "^1.6.4",
-    "@livekit/agents-plugin-silero": "1.6.4",
-    "@livekit/agents-plugins-test": "1.6.4"
+    "@livekit/agents": "1.7.0",
+    "@livekit/agents-plugin-openai": "^1.7.0",
+    "@livekit/agents-plugin-silero": "1.7.0",
+    "@livekit/agents-plugins-test": "1.7.0"
   },
   "dependencies": {
     "ws": "^8.21.0"
   },
   "peerDependencies": {
-    "@livekit/rtc-node": "^0.13.33",
-    "@livekit/agents": "1.6.4"
+    "@livekit/rtc-node": "^0.13.34",
+    "@livekit/agents": "1.7.0"
   },
   "scripts": {
     "build": "tsup --onSuccess \"pnpm build:types\"",

package/src/stt.ts

@@ -551,7 +551,9 @@ export class SpeechStream extends stt.SpeechStream {
                 break;
               }
               default: {
-                this.#logger.child({ msg: json }).warn('received unexpected message from Deepgram');
+                this.#logger
+                  .child({ 'lk.pii.message': json })
+                  .warn('received unexpected message from Deepgram');
                 break;
               }
             }
@@ -560,7 +562,10 @@ export class SpeechStream extends stt.SpeechStream {
               resolve();
             }
           } catch (err) {
-            this.#logger.error(`STT: Error processing message: ${msg}`);
+            this.#logger.error(
+              { error: err, 'lk.pii.message': msg.toString() },
+              'Deepgram STT failed to process message',
+            );
             reject(err);
           }
         });

package/src/stt_logging.test.ts

@@ -0,0 +1,78 @@
+// SPDX-FileCopyrightText: 2026 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+import { log } from '@livekit/agents';
+import { once } from 'node:events';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { type WebSocket, WebSocketServer } from 'ws';
+import { STT } from './stt.js';
+import { STTv2 } from './stt_v2.js';
+
+const servers: WebSocketServer[] = [];
+const streams: Array<{ close(): void }> = [];
+
+async function startServer(onConnection?: (socket: WebSocket) => void): Promise<string> {
+  const server = new WebSocketServer({ host: '127.0.0.1', port: 0 });
+  servers.push(server);
+  await once(server, 'listening');
+  if (onConnection) server.on('connection', onConnection);
+
+  const address = server.address();
+  if (address === null || typeof address === 'string') {
+    throw new Error('expected a TCP address');
+  }
+  return `ws://127.0.0.1:${address.port}`;
+}
+
+afterEach(async () => {
+  for (const stream of streams.splice(0)) stream.close();
+  await Promise.all(
+    servers.splice(0).map(async (server) => {
+      for (const client of server.clients) client.terminate();
+      await new Promise<void>((resolve) => server.close(() => resolve()));
+    }),
+  );
+  vi.restoreAllMocks();
+});
+
+describe('Deepgram STT logging', () => {
+  it('logs invalid messages as text with the parse error', async () => {
+    const errorSpy = vi.spyOn(log(), 'error');
+    const baseUrl = await startServer((socket) => {
+      setTimeout(() => socket.send('not-json'), 10);
+    });
+    const recognizer = new STT({ apiKey: 'test', baseUrl });
+    const stream = recognizer.stream();
+    streams.push(stream);
+
+    await vi.waitFor(() => {
+      expect(errorSpy).toHaveBeenCalledWith(
+        {
+          error: expect.any(SyntaxError),
+          'lk.pii.message': 'not-json',
+        },
+        'Deepgram STT failed to process message',
+      );
+    });
+  });
+
+  it('does not log the v2 connection URL', async () => {
+    const debugSpy = vi.spyOn(log(), 'debug');
+    const baseUrl = await startServer();
+    const recognizer = new STTv2({
+      apiKey: 'test',
+      endpointUrl: `${baseUrl}/v2/listen`,
+      keyterms: ['private-keyterm'],
+    });
+    const stream = recognizer.stream();
+    streams.push(stream);
+
+    await vi.waitFor(() => {
+      const connectionCalls = debugSpy.mock.calls.filter((call) =>
+        call.includes('connecting to Deepgram'),
+      );
+      expect(connectionCalls).toEqual([['connecting to Deepgram']]);
+      expect(JSON.stringify(connectionCalls)).not.toContain('private-keyterm');
+    });
+  });
+});

package/src/stt_v2.ts

@@ -314,7 +314,7 @@ class SpeechStreamv2 extends stt.SpeechStream {
         this.#reconnectEvent.clear();
 
         const url = this.#getDeepgramUrl();
-        this.#logger.debug(`Connecting to Deepgram: ${url}`);
+        this.#logger.debug('connecting to Deepgram');
 
         this.#ws = new WebSocket(url, {
           headers: { Authorization: `Token ${this.#opts.apiKey}` },
@@ -506,7 +506,7 @@ class SpeechStreamv2 extends stt.SpeechStream {
         this.#onEndOfSpeech();
       }
     } else if (data.type === 'Error') {
-      this.#logger.warn('deepgram sent an error', { data });
+      this.#logger.warn({ 'lk.pii.data': data }, 'deepgram sent an error');
       const desc = (data.description as string) || 'unknown error from deepgram';
       throw new Error(`Deepgram API Error: ${desc}`);
     }

package/src/tts.ts

@@ -422,7 +422,7 @@ export class SynthesizeStream extends tts.SynthesizeStream {
               reject(new APIError('Deepgram TTS returned error', { body: message }));
               return;
             } else if (message.type !== 'Metadata') {
-              this.#logger.warn({ message }, 'Unknown Deepgram message type');
+              this.#logger.warn({ 'lk.pii.message': message }, 'Unknown Deepgram message type');
             }
 
             resetMessageTimeout(reject);