Merge pull request #49 from sckv/fix-headers-setting

fix(response-headers): fix behavior for response headers `setHeader` …
sckv · Aug 1, 2021 · 791c500 · 791c500
2 parents 1bc7e63 + 6f6884b
commit 791c500
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -345,13 +345,21 @@ Imperatively disables cache, does the same as `disableCache: true` in `RouteOpti
 
 Imperatively sets the cache, does the same as `cache: CacheOptions` in `RouteOptions`
 
+### `addHeader` (Function)
+
+Adds a header outgoing header string as a (key, value) `addHeader(header, value)`. Can **not** overwrite.
+
+### `addHeaders` (Function)
+
+Adds outgoing headers in a "batch", merges provided headers object `{ [header: string]: value }` to already existing headers. Can **not** overwrite.
+
 ### `setHeader` (Function)
 
-Set outgoing header as a (key, value) arguments `setHeader(header, value)`. Can overwrite
+Does the same as `addHeader` but overrides the value.
 
 ### `setHeaders` (Function)
 
-Set outgoing headers in a "batch", merges provided headers object `{ [header: string]: value }` to already existing headers. Can overwrite
+Does the same as `addHeaders` but overrides the value.
 
 ### `status` (Function)
 

diff --git a/src/__tests__/request.test.ts b/src/__tests__/request.test.ts
@@ -85,15 +85,32 @@ test('Sets cache headers for no-store; max-age=0; must-revalidate', () => {
   expect(request.getHeader('Cache-Control')).toBe('no-store, max-age=0, must-revalidate');
 });
 
-test('Sets response header', () => {
+test('Adds a response header', () => {
   const { request } = createRequest();
-  request.setHeader('Vary', 'Origin');
+  request.addHeader('Vary', 'Origin');
 
   expect(request.getHeader('Vary')).toBe('Origin');
 });
-test('Sets multiple response headers', () => {
+
+test('Adds a response header to already existing', () => {
+  const { request } = createRequest();
+  request.addHeader('Vary', 'Origin');
+  request.addHeader('Vary', 'Destination');
+
+  expect(request.getHeader('Vary')).toBe('Origin, Destination');
+});
+
+test('Overwrites a response header to already existing', () => {
+  const { request } = createRequest();
+  request.addHeader('Vary', 'Origin');
+  request.setHeader('Vary', 'Destination');
+
+  expect(request.getHeader('Vary')).toBe('Destination');
+});
+
+test('Adds multiple response headers', () => {
   const { request } = createRequest();
-  request.setHeaders({ Vary: 'Origin', Host: 'http://barehttp.com' });
+  request.addHeaders({ Vary: 'Origin', Host: 'http://barehttp.com' });
 
   expect(request.getHeader('Vary')).toBe('Origin');
   expect(request.getHeader('Host')).toBe('http://barehttp.com');

diff --git a/src/request.ts b/src/request.ts
@@ -81,7 +81,7 @@ export class BareRequest {
     // parsed;
     _originalRequest['flow'] = this; // to receive flow object later on in the route handler
 
-    this.setHeaders({
+    this.addHeaders({
       'Content-Type': 'text/plain; charset=utf-8',
       'X-Request-Id': this.ID.code,
     });
@@ -217,7 +217,7 @@ export class BareRequest {
     if (cacheHeader.length > 0) this.setHeader(directive, cacheHeader);
   }
 
-  setHeader(header: string, value: string | number | string[] | number[]) {
+  addHeader(header: string, value: string | number | string[] | number[]) {
     const old = this.headers[header];
     const parsedVal = Array.isArray(value) ? value.join(', ') : '' + value;
     if (old) {
@@ -227,12 +227,23 @@ export class BareRequest {
     }
   }
 
+  setHeader(header: string, value: string | number | string[] | number[]) {
+    const parsedVal = Array.isArray(value) ? value.join(', ') : '' + value;
+    this.headers[header] = parsedVal;
+  }
+
   setHeaders(headers: { [header: string]: string | number | string[] | number[] }) {
     for (const [header, value] of Object.entries(headers)) {
       this.setHeader(header, value);
     }
   }
 
+  addHeaders(headers: { [header: string]: string | number | string[] | number[] }) {
+    for (const [header, value] of Object.entries(headers)) {
+      this.addHeader(header, value);
+    }
+  }
+
   status(status: StatusCodesUnion) {
     this.statusToSend = status;
     return this;

diff --git a/src/server.ts b/src/server.ts
@@ -283,7 +283,7 @@ export class BareServer<A extends IP> {
 
   private registerReport() {
     this.setRoute('GET', '/_report', false, (flow) => {
-      flow.setHeader('content-type', 'text/html');
+      flow.setHeader('Content-Type', 'text/html');
       flow.send(generateReport(this.#routes));
     });
   }