openai-api-mock 0.1.13 → 0.1.14

package/main.js

@@ -1,5 +1,9 @@
 const nock = require('nock');
+
+
 const { getChatResponce } = require('./src/chat.js');
+const { createChatStream } = require('./src/chat.stream.js');
+
 const { getImageResponce } = require('./src/image.js');
 
 const OPEN_AI_BASE_URL = 'https://api.openai.com';
@@ -13,6 +17,13 @@ function mockOpenAIResponse(force = false) {
         nock(OPEN_AI_BASE_URL)
             .post(CHAT_COMPLETIONS_ENDPOINT)
             .reply(function (uri, requestBody) {
+                let isSteaming = (requestBody.stream && requestBody.stream == true) ? true : false
+
+                if (isSteaming) {
+                    const stream = createChatStream();
+                    return [200, stream];
+                }
+
                 return [200, getChatResponce(requestBody)];
             });
 

package/main.test.js

@@ -1,4 +1,5 @@
 const { mockOpenAIResponse, stopMocking } = require('./main');
+const { Stream } = require('stream');
 
 const OpenAI = require('openai');
 const openai = new OpenAI({ apiKey: "OPENAI_API_KEY" });
@@ -26,6 +27,24 @@ describe('Mock OpenAI Chat & Image generation API', () => {
         }
     });
 
+    it('should mock the streaming chat completion', async () => {
+        try {
+            const response = await openai.chat.completions.create({
+                model: "gpt-3.5",
+                stream: true,
+                messages: [
+                    { role: 'user', content: "What's the biggest country in the world" },
+                ]
+            });
+
+            for await (const part of response) {
+                console.log(part.choices[0]?.delta?.content || '')
+            }
+        } catch (error) {
+            throw new Error(error);
+        }
+    });
+
     it('should mock the chat completion with function call', async () => {
         try {
             const response = await openai.chat.completions.create({
@@ -90,7 +109,7 @@ describe('Mock OpenAI Chat & Image generation API', () => {
 
 
     it('should mock the chat completion with email function call (tools)', async () => {
-        try{
+        try {
             const response = await openai.chat.completions.create({
                 model: "gpt-3.5",
                 messages: [
@@ -99,23 +118,23 @@ describe('Mock OpenAI Chat & Image generation API', () => {
                 ],
                 tools: [
                     {
-                    type: "function",
-                    function: {
-                        name: 'send_email',
-                        description: 'Send an email to the user with the recipes',
-                        parameters: {
-                            type: "object",
-                            properties: {
-                                email: {
-                                    type: "string",
-                                    description: "The email address of the user",
+                        type: "function",
+                        function: {
+                            name: 'send_email',
+                            description: 'Send an email to the user with the recipes',
+                            parameters: {
+                                type: "object",
+                                properties: {
+                                    email: {
+                                        type: "string",
+                                        description: "The email address of the user",
+                                    }
                                 }
-                            }
-                        },
-                        required: ["email"],
-                    }
+                            },
+                            required: ["email"],
+                        }
 
-                }],
+                    }],
 
                 tool_choice: { name: 'send_email' },
             });
@@ -124,8 +143,8 @@ describe('Mock OpenAI Chat & Image generation API', () => {
             expect(response.choices[0].message.tool_calls[0].function).toHaveProperty('name', 'send_email');
             expect(response.choices[0].message.tool_calls[0].function).toHaveProperty('arguments');
             expect(JSON.parse(response.choices[0].message.tool_calls[0].function.arguments)).toHaveProperty('email');
-         
-        }catch(error){
+
+        } catch (error) {
             throw new Error(error);
         }
 
@@ -133,14 +152,14 @@ describe('Mock OpenAI Chat & Image generation API', () => {
 
 
     it('should mock the chat completion with function call (tools)', async () => {
-            const response = await openai.chat.completions.create({
-                model: "gpt-3.5",
-                messages: [
-                    { role: 'system', content: "You'r an expert chef" },
-                    { role: 'user', content: "Suggest at least 5 recipes" },
-                ],
-                tools: [
-                    {
+        const response = await openai.chat.completions.create({
+            model: "gpt-3.5",
+            messages: [
+                { role: 'system', content: "You'r an expert chef" },
+                { role: 'user', content: "Suggest at least 5 recipes" },
+            ],
+            tools: [
+                {
                     type: "function",
                     function: {
                         name: 'get_recipes',
@@ -183,13 +202,13 @@ describe('Mock OpenAI Chat & Image generation API', () => {
                     }
 
                 }],
-                tool_choice: { name: 'get_recipes' },
-            });
-            expect(response.model).toEqual('gpt-3.5-mock');
-            expect(response.choices[0]).toHaveProperty('finish_reason', 'tool_calls');
-            expect(response.choices[0].message.tool_calls[0].function).toHaveProperty('name', 'get_recipes');
-            expect(response.choices[0].message.tool_calls[0].function).toHaveProperty('arguments');
-            expect(JSON.parse(response.choices[0].message.tool_calls[0].function.arguments)).toHaveProperty('recipes');
+            tool_choice: { name: 'get_recipes' },
+        });
+        expect(response.model).toEqual('gpt-3.5-mock');
+        expect(response.choices[0]).toHaveProperty('finish_reason', 'tool_calls');
+        expect(response.choices[0].message.tool_calls[0].function).toHaveProperty('name', 'get_recipes');
+        expect(response.choices[0].message.tool_calls[0].function).toHaveProperty('arguments');
+        expect(JSON.parse(response.choices[0].message.tool_calls[0].function.arguments)).toHaveProperty('recipes');
     });
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai-api-mock",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "A Node.js module for mocking OpenAI API responses in a development environment",
   "repository": {
     "type": "git",

package/readme.md

@@ -66,7 +66,26 @@ In this example, the `response` constant will contain mock data, simulating a re
       usage: { completion_tokens: 17, prompt_tokens: 57, total_tokens: 74 }
 }
 ```
+The library also supports mocking `stream` responses
 
+```js
+// Call the mockOpenAIResponse function once to set up the mock
+mockOpenAIResponse() 
+// Now, when you call the OpenAI API, it will return a mock response
+const response = await openai.chat.completions.create({
+                model: "gpt-3.5",
+                stream : true,
+                messages: [
+                    { role: 'system', content: "You'r an expert chef" },
+                    { role: 'user', content: "Suggest at least 5 recipes" },
+                ]
+});
+
+// then read it 
+for await (const part of response) {
+    console.log(part.choices[0]?.delta?.content || '')
+}
+```
 
 ## Intercepted URLs
 

package/src/chat.js

@@ -35,6 +35,8 @@ function createDefaultResponse(created) {
   };
 }
 
+
+
 function createFunctionCallingResponse(requestBody, created) {
   const isTool = Boolean(requestBody.tools);
   const functionOrToolCallObject = isTool

package/src/chat.stream.js

@@ -0,0 +1,60 @@
+const { faker } = require("@faker-js/faker");
+const { Readable } = require('stream');
+
+function createChatStream() {
+    const stream = new Readable({
+        read() { }
+    });
+
+    let count = 0;
+    const maxCount = 5;
+
+    function sendData() {
+        setTimeout(() => {
+            if (count < maxCount - 1) {
+                stream.push(`data: ${getSteamChatObject()}\n\n`);
+                count++;
+                sendData(); // Call the function recursively until the last iteration
+            } else if (count === maxCount - 1) {
+                stream.push(`data: [DONE]\n\n`);
+                stream.push(null); // End the stream after sending the data
+            }
+        }, 200);
+    }
+
+    sendData(); // Start sending data
+
+    return stream;
+}
+
+function getSteamChatObject() {
+    const created = Math.floor(Date.now() / 1000);
+
+    let lorem = faker.lorem.paragraph()
+    const loremArray = lorem.split(" ");
+
+    let ob = {
+        id: `chatcmpl-${faker.string.alphanumeric(30)}`,
+        object: 'chat.completion.chunk',
+        created: created,
+        model: "gpt-3.5-mock",
+        system_fingerprint: null,
+        choices: [
+            {
+                index: 0,
+                delta: {
+                    content: loremArray[0]
+                },
+                logprobs: null,
+                finish_reason: null
+            }
+        ]
+    }
+
+    return JSON.stringify(ob);
+}
+
+module.exports = {
+    createChatStream,
+    getSteamChatObject,
+};