fix(twilio-run): handle adding object as header correclty as an error (…

…#526) handle adding object as header correclty as an error
twilio-labs · Dec 11, 2024 · d43ab63 · d43ab63
1 parent ca64521
commit d43ab63
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 0 deletions.
diff --git a/.changeset/three-gifts-smash.md b/.changeset/three-gifts-smash.md
@@ -0,0 +1,6 @@
+---
+'@twilio/runtime-handler': minor
+'twilio-run': minor
+---
+
+handle adding object as header correctly as an error
diff --git a/packages/runtime-handler/__tests__/dev-runtime/internal/response.test.ts b/packages/runtime-handler/__tests__/dev-runtime/internal/response.test.ts
@@ -84,6 +84,17 @@ test('sets headers with string cookies', () => {
   expect(response['headers']).toEqual(expected);
 });
 
+test('object cant be a header', () => {
+  const response = new Response();
+  expect(response['headers']).toEqual({
+    'Set-Cookie': [],
+  });
+
+  expect(() => {
+    response.appendHeader('Access-Control-Allow-Origin', {} as any);
+  }).toThrow('Header value cannot be an object');
+});
+
 test('sets headers with an array of cookies', () => {
   const response = new Response();
   expect(response['headers']).toEqual({

diff --git a/packages/runtime-handler/src/dev-runtime/internal/response.ts b/packages/runtime-handler/src/dev-runtime/internal/response.ts
@@ -70,6 +70,11 @@ export class Response implements TwilioResponse {
   appendHeader(key: string, value: HeaderValue): Response {
     log('Appending header for %s', key, value);
     this.headers = this.headers || {};
+
+    if (typeof value === 'object' && !Array.isArray(value)) {
+      throw new Error('Header value cannot be an object');
+    }
+
     let newHeaderValue: HeaderValue = [];
     if (key.toLowerCase() === COOKIE_HEADER.toLowerCase()) {
       const existingValue = this.headers[COOKIE_HEADER];

diff --git a/packages/twilio-run/__tests__/runtime/internal/response.test.ts b/packages/twilio-run/__tests__/runtime/internal/response.test.ts
@@ -85,6 +85,17 @@ test('appends a new header correctly', () => {
   });
 });
 
+test('object cant be a header', () => {
+  const response = new Response();
+  expect(response['headers']).toEqual({
+    'Set-Cookie': [],
+  });
+
+  expect(() => {
+    response.appendHeader('Access-Control-Allow-Origin', {} as any);
+  }).toThrow('Header value cannot be an object');
+});
+
 test('appends a header correctly with no existing one', () => {
   const response = new Response();
   expect(response['headers']).toEqual({

diff --git a/packages/twilio-run/src/runtime/internal/response.ts b/packages/twilio-run/src/runtime/internal/response.ts
@@ -67,6 +67,9 @@ export class Response implements TwilioResponse {
 
   appendHeader(key: string, value: HeaderValue): Response {
     debug('Appending header for %s', key, value);
+    if (typeof value === 'object' && !Array.isArray(value)) {
+      throw new Error('Header value cannot be an object');
+    }
     this.headers = this.headers || {};
     let newHeaderValue: HeaderValue = [];
     if (key.toLowerCase() === COOKIE_HEADER.toLowerCase()) {