fix(twilio-run): correctly serialize JSON Responses (#277)

Author: philnash

packages/runtime-handler/__tests__/dev-runtime/internal/response.test.ts

@@ -69,11 +69,11 @@ test('appends a header correctly with no existing one', () => {
 });
 
 test('calls express response correctly', () => {
-  const mockRes = ({
+  const mockRes = {
     status: jest.fn(),
     set: jest.fn(),
     send: jest.fn(),
-  } as unknown) as ExpressResponse;
+  } as unknown as ExpressResponse;
   const response = new Response();
   response.setBody(`I'm a teapot!`);
   response.setStatusCode(418);
@@ -84,3 +84,31 @@ test('calls express response correctly', () => {
   expect(mockRes.status).toHaveBeenCalledWith(418);
   expect(mockRes.set).toHaveBeenCalledWith({ 'Content-Type': 'text/plain' });
 });
+
+test('serializes a response', () => {
+  const response = new Response();
+  response.setBody("I'm a teapot!");
+  response.setStatusCode(418);
+  response.appendHeader('Content-Type', 'text/plain');
+
+  const serialized = response.serialize();
+
+  expect(serialized.body).toEqual("I'm a teapot!");
+  expect(serialized.statusCode).toEqual(418);
+  expect(serialized.headers).toEqual({ 'Content-Type': 'text/plain' });
+});
+
+test('serializes a response with content type set to application/json', () => {
+  const response = new Response();
+  response.setBody({ url: 'https://dkundel.com' });
+  response.setStatusCode(200);
+  response.appendHeader('Content-Type', 'application/json');
+
+  const serialized = response.serialize();
+
+  expect(serialized.body).toEqual(
+    JSON.stringify({ url: 'https://dkundel.com' })
+  );
+  expect(serialized.statusCode).toEqual(200);
+  expect(serialized.headers).toEqual({ 'Content-Type': 'application/json' });
+});

packages/runtime-handler/src/dev-runtime/internal/response.ts

@@ -58,7 +58,10 @@ export class Response implements TwilioResponse {
   serialize() {
     return {
       statusCode: this.statusCode,
-      body: this.body.toString(),
+      body:
+        this.headers['Content-Type'] === 'application/json'
+          ? JSON.stringify(this.body)
+          : this.body,
       headers: this.headers,
     };
   }

packages/twilio-run/__tests__/runtime/internal/response.test.ts

@@ -69,11 +69,11 @@ test('appends a header correctly with no existing one', () => {
 });
 
 test('calls express response correctly', () => {
-  const mockRes = ({
+  const mockRes = {
     status: jest.fn(),
     set: jest.fn(),
     send: jest.fn(),
-  } as unknown) as ExpressResponse;
+  } as unknown as ExpressResponse;
   const response = new Response();
   response.setBody(`I'm a teapot!`);
   response.setStatusCode(418);
@@ -84,3 +84,31 @@ test('calls express response correctly', () => {
   expect(mockRes.status).toHaveBeenCalledWith(418);
   expect(mockRes.set).toHaveBeenCalledWith({ 'Content-Type': 'text/plain' });
 });
+
+test('serializes a response', () => {
+  const response = new Response();
+  response.setBody("I'm a teapot!");
+  response.setStatusCode(418);
+  response.appendHeader('Content-Type', 'text/plain');
+
+  const serialized = response.serialize();
+
+  expect(serialized.body).toEqual("I'm a teapot!");
+  expect(serialized.statusCode).toEqual(418);
+  expect(serialized.headers).toEqual({ 'Content-Type': 'text/plain' });
+});
+
+test('serializes a response with content type set to application/json', () => {
+  const response = new Response();
+  response.setBody({ url: 'https://dkundel.com' });
+  response.setStatusCode(200);
+  response.appendHeader('Content-Type', 'application/json');
+
+  const serialized = response.serialize();
+
+  expect(serialized.body).toEqual(
+    JSON.stringify({ url: 'https://dkundel.com' })
+  );
+  expect(serialized.statusCode).toEqual(200);
+  expect(serialized.headers).toEqual({ 'Content-Type': 'application/json' });
+});

packages/twilio-run/src/runtime/internal/response.ts

@@ -58,7 +58,10 @@ export class Response implements TwilioResponse {
   serialize() {
     return {
       statusCode: this.statusCode,
-      body: this.body.toString(),
+      body:
+        this.headers['Content-Type'] === 'application/json'
+          ? JSON.stringify(this.body)
+          : this.body,
       headers: this.headers,
     };
   }