Issue 26 custom headers (#27)

Adds optional custom headers to config

Also adds tests for custom headers.

Author: Shelco

src/@episerver/content-delivery/lib/apiClient.js

@@ -12,6 +12,11 @@ export declare type ContentDeliveryConfig = {
      * requests to the Content Delivery API.
      */
     getAccessToken?: (path?: string) => Promise<string>;
+    /**
+     * Function to call to include custom headers in
+     * requests to the Content Delivery API.
+     */
+    getHeaders?: (path?: string) => Promise<Record<string, any>>;
     /**
      * Select all properties by default, unless otherwise
      * specified in each request to the Content Delivery API.

src/@episerver/content-delivery/lib/apiClient.js.map

@@ -175,6 +175,17 @@ async function getHeaders(path: string, headers: ApiHeaders = {}, config: Conten
     }
   }
 
+  if (config.getHeaders) {
+    const configHeaders = await config.getHeaders(path);
+    if (configHeaders) {
+      for (const name in configHeaders) {
+        if (configHeaders[name] !== undefined) {
+          result.set(name, configHeaders[name])
+        }
+      }
+    }
+  }
+
   if (config.getAccessToken) {
     const accessToken = await config.getAccessToken(path);
     if (accessToken) {

src/@episerver/content-delivery/lib/config.d.ts

@@ -14,6 +14,12 @@ export type ContentDeliveryConfig = {
    */
   getAccessToken?: (path?: string) => Promise<string>,
 
+  /**
+   * Function to call to include custom headers in
+   * requests to the Content Delivery API.
+   */
+  getHeaders?: (path?: string) => Promise<Record<string, any>>,
+
   /**
    * Select all properties by default, unless otherwise
    * specified in each request to the Content Delivery API.

src/@episerver/content-delivery/lib/config.d.ts.map

@@ -319,4 +319,17 @@ describe('ContentLoader', () => {
       });
     });
   });
+
+  describe("with custom headers", () => {
+    it("should pass custom headers in request when applied", async () => {
+      const customHeaderValue = "CustomHeaderValue";
+      var cl = new ContentLoader({
+        getHeaders: () =>
+          Promise.resolve({ CustomHeaderName: customHeaderValue }),
+      });
+      const content = await cl.getContent(startPageId);
+
+      content.customHeader.should.equal(customHeaderValue);
+    });
+  });
 });

src/@episerver/content-delivery/lib/config.js.map

@@ -150,4 +150,17 @@ describe('ContentResolver', () => {
       });
     });
   });
+
+  describe("with custom headers", () => {
+    it("should pass custom headers in request when applied", async () => {
+      const customHeaderValue = "CustomHeaderValue";
+      var cr = new ContentResolver({
+        getHeaders: () =>
+          Promise.resolve({ CustomHeaderName: customHeaderValue }),
+      });
+      var result = await cr.resolveContent(baseUrl, true);
+
+      result.content.customHeader.should.equal(customHeaderValue);
+    });
+  });
 });

src/@episerver/content-delivery/src/apiClient.ts

@@ -0,0 +1,26 @@
+using EPiServer.ContentApi.Core.Serialization;
+using EPiServer.ContentApi.Core.Serialization.Internal;
+using EPiServer.ContentApi.Core.Serialization.Models;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Primitives;
+
+namespace Backend
+{
+    public class CustomHeaderContentApiFilter : ContentApiModelFilter<ContentApiModel>
+    {
+        private readonly IHttpContextAccessor _httpContextAccessor;
+
+        public CustomHeaderContentApiFilter(IHttpContextAccessor httpContextAccessor)
+        {
+            _httpContextAccessor = httpContextAccessor;
+        }
+
+        public override void Filter(ContentApiModel contentApiModel, ConverterContext converterContext)
+        {
+            if (_httpContextAccessor.HttpContext.Request.Headers.ContainsKey("CustomHeaderName"))
+            {
+                contentApiModel.Properties.Add("customHeader", _httpContextAccessor.HttpContext.Request.Headers["CustomHeaderName"][0]);
+            }
+        }
+    }
+}