Kafka response

packages/core/src/__tests__/create-request-client.test.ts

@@ -1,6 +1,7 @@
 import btoa from 'btoa-lite'
 import createTestServer from 'create-test-server'
 import createRequestClient from '../create-request-client'
+import { Response } from '../fetch'
 
 describe('createRequestClient', () => {
   it('should create a request client instance that has Segment defaults', async () => {
@@ -111,4 +112,25 @@ describe('createRequestClient', () => {
     })
     await server.close()
   })
+
+  it('should emulate an HTTP response if emulateHttpResponse property is set', async () => {
+    const server = await createTestServer()
+    server.get('/', (_request, response) => {
+      response.json({ greeting: 'This is the server response' })
+    })
+
+    const request = createRequestClient()
+
+    const emulateHttpResponse = new Response(JSON.stringify({ hello: 'This is the emulated response' }), {
+      headers: { 'Content-Type': 'application/json' },
+      status: 200,
+      statusText: 'OK'
+    })
+
+    await expect(request(server.url, { method: 'get', emulateHttpResponse })).resolves.toMatchObject({
+      data: expect.objectContaining({ hello: 'This is the emulated response' })
+    })
+
+    await server.close()
+  })
 })

packages/core/src/request-client.ts

@@ -69,6 +69,11 @@ export interface RequestOptions extends Omit<RequestInit, 'headers'> {
    * Uses the provided https.Agent
    */
   agent?: https.Agent
+  /**
+   * Used to emulate an http request.
+   * If set, instead of making a real HTTP request, the provided response will be returned.
+   */
+  emulateHttpResponse?: Response
 }
 
 /**
@@ -357,6 +362,11 @@ class RequestClient {
       }
     }
 
+    // If we have an emulateHttpResponse, return it instead of making a real request
+    if (this.options.emulateHttpResponse) {
+      return Promise.resolve(this.options.emulateHttpResponse)
+    }
+
     if (this.options.timeout === false) {
       return fetch(this.request.clone())
     }