Verify error handling on API key incorrect

Author: khorwood-openai

dist/lib/client.d.ts.map

@@ -1,7 +1,3 @@
-/**
- * EventHandler callback
- * @typedef {(event: {[key: string]: any}): void} EventHandlerCallbackType
- */
 /**
  * Inherited class for RealtimeAPI and RealtimeClient
  * Adds basic event handling
@@ -45,6 +41,15 @@ export class RealtimeEventHandler {
      * @returns {true}
      */
     offNext(eventName: string, callback?: EventHandlerCallbackType): true;
+    /**
+     * Waits for next event of a specific type and returns the payload
+     * @param {string} eventName
+     * @param {number|null} [timeout]
+     * @returns {Promise<{[key: string]: any}|null>}
+     */
+    waitForNext(eventName: string, timeout?: number | null): Promise<{
+        [key: string]: any;
+    } | null>;
     /**
      * Executes all events in the order they were added, with .on() event handlers executing before .onNext() handlers
      * @param {string} eventName

dist/lib/event_handler.d.ts

@@ -125,7 +125,7 @@ export class RealtimeAPI extends RealtimeEventHandler {
         },
       );
       ws.on('message', (data) => {
-        const message = JSON.parse(data);
+        const message = JSON.parse(data.toString());
         this.receive(message.type, message);
       });
       return new Promise((resolve, reject) => {

dist/lib/event_handler.d.ts.map

@@ -3,8 +3,6 @@ import { RealtimeAPI } from './api.js';
 import { RealtimeConversation } from './conversation.js';
 import { RealtimeUtils } from './utils.js';
 
-const sleep = (t) => new Promise((r) => setTimeout(() => r(), t));
-
 /**
  * Valid audio formats
  * @typedef {"pcm16"|"g711-ulaw"|"g711-alaw"} AudioFormatType
@@ -648,30 +646,18 @@ export class RealtimeClient extends RealtimeEventHandler {
    * @returns {Promise<{item: ItemType}>}
    */
   async waitForNextItem() {
-    let nextItem;
-    this.onNext('conversation.item.appended', (event) => {
-      const { item } = event;
-      nextItem = item;
-    });
-    while (!nextItem) {
-      await sleep(1);
-    }
-    return { item: nextItem };
+    const event = await this.waitForNext('conversation.item.appended');
+    const { item } = event;
+    return { item };
   }
 
   /**
    * Utility for waiting for the next `conversation.item.completed` event to be triggered by the server
    * @returns {Promise<{item: ItemType}>}
    */
   async waitForNextCompletedItem() {
-    let nextItem;
-    this.onNext('conversation.item.completed', (event) => {
-      const { item } = event;
-      nextItem = item;
-    });
-    while (!nextItem) {
-      await sleep(1);
-    }
-    return { item: nextItem };
+    const event = await this.waitForNext('conversation.item.completed');
+    const { item } = event;
+    return { item };
   }
 }

lib/api.js

@@ -3,6 +3,8 @@
  * @typedef {(event: {[key: string]: any}): void} EventHandlerCallbackType
  */
 
+const sleep = (t) => new Promise((r) => setTimeout(() => r(), t));
+
 /**
  * Inherited class for RealtimeAPI and RealtimeClient
  * Adds basic event handling
@@ -97,6 +99,28 @@ export class RealtimeEventHandler {
     return true;
   }
 
+  /**
+   * Waits for next event of a specific type and returns the payload
+   * @param {string} eventName
+   * @param {number|null} [timeout]
+   * @returns {Promise<{[key: string]: any}|null>}
+   */
+  async waitForNext(eventName, timeout = null) {
+    const t0 = Date.now();
+    let nextEvent;
+    this.onNext(eventName, (event) => (nextEvent = event));
+    while (!nextEvent) {
+      if (timeout) {
+        const t1 = Date.now();
+        if (t1 - t0 > timeout) {
+          return null;
+        }
+      }
+      await sleep(1);
+    }
+    return nextEvent;
+  }
+
   /**
    * Executes all events in the order they were added, with .on() event handlers executing before .onNext() handlers
    * @param {string} eventName

lib/client.js

@@ -7,6 +7,24 @@ export async function run() {
   describe('RealtimeAPI', ({ debug = false } = {}) => {
     let realtime;
 
+    it('Should instantiate the RealtimeAPI with no apiKey', () => {
+      realtime = new RealtimeAPI({
+        debug,
+      });
+
+      expect(realtime).to.exist;
+      expect(realtime.apiKey).to.not.exist;
+    });
+
+    it('Should fail to connect to the RealtimeAPI with no apiKey', async () => {
+      await realtime.connect();
+      const event = await realtime.waitForNext('server.error', 1000);
+
+      expect(event).to.exist;
+      expect(event.error).to.exist;
+      expect(event.error.message).to.contain('Incorrect API key provided');
+    });
+
     it('Should instantiate the RealtimeAPI', () => {
       realtime = new RealtimeAPI({
         apiKey: process.env.OPENAI_API_KEY,

lib/event_handler.js

@@ -82,7 +82,7 @@ export async function run({ debug = false } = {}) {
       expect(serverEvent1.event.type).to.equal('session.created');
     });
 
-    it('Should send an audio file about toronto (.wav)', () => {
+    it('Should send an audio file about toronto (.mp3)', () => {
       const sample = samples['toronto-mp3'].base64;
       const content = [{ type: 'input_audio', audio: sample }];