refactored tests and added optional caching

Author: jamesvidler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/content-fetch",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "JavaScript library for the Agility Fetch API (node and browser)",
   "main": "dist/agility-content-fetch.node.js",
   "scripts": {
@@ -34,6 +34,7 @@
     "webpack-cli": "^3.2.3"
   },
   "dependencies": {
-    "axios": "^0.18.0"
+    "axios": "^0.18.0",
+    "axios-cache-adapter": "^2.3.0"
   }
 }

package.json

@@ -1,4 +1,5 @@
 import axios from 'axios'
+import { setupCache } from 'axios-cache-adapter'
 import getSitemapFlat from './methods/getSitemapFlat'
 import getSitemapNested from './methods/getSitemapNested'
 import getContentItem from './methods/getContentItem'
@@ -7,28 +8,61 @@ import getPage from './methods/getPage'
 
 const defaultConfig = {
     fetchBaseUrl: 'https://g5s2z5b3.stackpathcdn.com',
-    previewBaseUrl: 'https://g5s2z5b3.stackpathcdn.com',
+    previewBaseUrl: 'https://e5q8t3m6.stackpathcdn.com',
+    baseUrl: null,
     isPreview: false,
     instanceID: null,
     accessToken: null,
-    languageCode: null
+    languageCode: null,
+    caching: {
+        maxAge: 0 //caching disabled by default
+    }
 };
 
 export default function createClient(userConfig) {
 
-    //merge our config
+    //set default baseUrl
+    if(userConfig.isPreview) {
+        defaultConfig.baseUrl = defaultConfig.previewBaseUrl
+    } else {
+        defaultConfig.baseUrl = defaultConfig.fetchBaseUrl
+    }
+
+    //merge our config - user values will override our defaults
     const config = {
         ...defaultConfig,
         ...userConfig
     };
 
+    let adapter = null;
+
+    //should we turn on caching?
+    if(config.caching.maxAge > 0) {
+        const cache = setupCache({
+            maxAge: config.caching.maxAge
+        });
+        adapter = cache.adapter;
+    }
+
+    //create apply the adapter to our axios instance
+    const api = axios.create({
+        adapter: adapter
+    })
+
+    //the function that actually makes ALL our requests
     function makeRequest(reqConfig) {
-        
-        return axios(reqConfig).then(response => {
-            return response.data;
+        //make the request using our axios instance        
+        return api(reqConfig).then(async (response) => {
+            let data = response.data;
+            //if our response is from cache, inject that property in the data response
+            if(response.request.fromCache) {
+                data['fromCache'] = true;
+            }
+            return data;
         });   
     }
 
+    //export only these properties:
     return {
         config: config,
         makeRequest: makeRequest,

src/api-client.js

@@ -16,24 +16,29 @@
 
 
 import createClient from './api-client'
+import { isHttps } from './utils'
 
 /** 
- * This is the description for create client 
+ * How to create an instance of an an API client for the Agility Content Fetch REST API.
  * @func
  * @name getApi
  * @memberof AgilityFetch
- * @param {Object} config - API intialization params
+ * @param {Object} config - API intialization params.
  * @param {string} config.instanceID - The guid that represents your instance.
  * @param {string} config.accessToken - The secret token that represents your application.
  * @param {boolean} [config.isPreview] - If your access token is for preview, then set this to true.
+ * @param {Object} [config.caching] - Optional Caching options. Caching is disabled by default.
+ * @param {number} [config.caching.maxAge] - In miliseconds. Default value is *0* (disabled). Recommeded value is *180000* (3 mins). Requests are cached in memory only (node or browser).
+ * @param {string} [config.baseUrl] - Optionally override the default API Base Url.
  * @return {AgilityFetch.Client}
  * @example
  * 
  * import agility from '@agility/content-fetch'
  * 
  * const api = agility.getApi({
  *   instanceID: '1234-1234',
- *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg=='
+ *   accessToken: 'fEpTcRnWO3EahHbojDCeY3PwGwAzpw2gveDuPn2l0nuqFbQYVcWrQ+a3/DHcWgCgn7UL2tgbSOS0AqrEOiXkTg==',
+ *   isPreview: false
  * });
  */
 
@@ -45,10 +50,13 @@ function getApi(config) {
 function validateConfigParams(configParams) {
 
     if(!configParams.instanceID || configParams.instanceID.length == 0) {
-        throw new TypeError('You must provide an instanceID');
-    }
-    else if(!configParams.accessToken || configParams.accessToken.length == 0) {
-        throw new TypeError('You must provide an access token');
+        throw new TypeError('You must provide an instanceID.');
+    } else if(!configParams.accessToken || configParams.accessToken.length == 0) {
+        throw new TypeError('You must provide an access token.');
+    } else if(configParams.caching && isNaN(configParams.caching.maxAge)) {
+        throw new TypeError('When specifying a cache maxAge, you must set a number value in miliseconds, i.e. 180000 (3 mins).');
+    } else if(configParams.baseUrl && !isHttps(configParams.baseUrl)) {
+        throw new TypeError(`When specifying a baseUrl (${configParams.baseUrl}), it must be over HTTPs.`);
     } else {
         return;
     }

src/content-fetch.js

@@ -1,4 +1,4 @@
-import utils from '../utils'
+import { buildRequestUrlPath, buildAuthHeader } from '../utils'
 
 /**
  * Gets the details of a content item by their Content ID.
@@ -36,8 +36,8 @@ function getContentItem(requestParams) {
     const req = {
         url: `/item/${requestParams.contentID}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
-        headers: utils.buildAuthHeader(this.config),
+        baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
+        headers: buildAuthHeader(this.config),
         params:{}
     };
 

src/methods/getContentItem.js

@@ -1,4 +1,4 @@
-import utils from '../utils'
+import { buildRequestUrlPath, buildAuthHeader } from '../utils'
 
 /**
  * Retrieves a list of content items by reference name.
@@ -45,8 +45,8 @@ function getContentList(requestParams) {
     const req = {
         url: `/list/${requestParams.referenceName}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
-        headers: utils.buildAuthHeader(this.config),
+        baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
+        headers: buildAuthHeader(this.config),
         params:{}
     };
 

src/methods/getContentList.js

@@ -1,4 +1,4 @@
-import utils from '../utils'
+import { buildRequestUrlPath, buildAuthHeader } from '../utils'
 
 /**
  * Gets the details of a page by its Page ID.
@@ -36,8 +36,8 @@ function getPage(requestParams) {
     const req = {
         url: `/page/${requestParams.pageID}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
-        headers: utils.buildAuthHeader(this.config),
+        baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
+        headers: buildAuthHeader(this.config),
         params:{}
     };
 

src/methods/getPage.js

@@ -1,4 +1,4 @@
-import utils from '../utils'
+import { buildRequestUrlPath, buildAuthHeader } from '../utils'
 
 /**
  * The sitemap, returned in a flat list, where the dictionary key is the page path. This method is ideal for page routing.
@@ -35,8 +35,8 @@ function getSitemapFlat(requestParams) {
     const req = {
         url: `/Sitemap/Flat/${requestParams.channelName}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
-        headers: utils.buildAuthHeader(this.config),
+        baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
+        headers: buildAuthHeader(this.config),
         params:{}
     };
 

src/methods/getSitemapFlat.js

@@ -1,4 +1,4 @@
-import utils from '../utils'
+import { buildRequestUrlPath, buildAuthHeader } from '../utils'
 
 /**
  * Gets the sitemap as an array in a nested format, ideal for generating menus.
@@ -35,8 +35,8 @@ function getSitemapNested(requestParams) {
     const req = {
         url: `/Sitemap/Nested/${requestParams.channelName}`,
         method: 'get',
-        baseURL: utils.buildRequestUrlPath(this.config, requestParams.languageCode),
-        headers: utils.buildAuthHeader(this.config),
+        baseURL: buildRequestUrlPath(this.config, requestParams.languageCode),
+        headers: buildAuthHeader(this.config),
         params:{}
     };
 

src/methods/getSitemapNested.js

@@ -1,11 +1,6 @@
 function buildRequestUrlPath(config, languageCode) {
     let urlPath = null;
-    if(config.isPreview) {
-        urlPath = config.previewBaseUrl
-    } else {
-        urlPath = config.fetchBaseUrl
-    }
-    urlPath = `${urlPath}/${config.instanceID}/${languageCode}`;
+    urlPath = `${config.baseUrl}/${config.instanceID}/${languageCode}`;
     return urlPath;
 }
 
@@ -15,7 +10,16 @@ function buildAuthHeader(config) {
     }
 }
 
-export default {
+function isHttps(url) {
+    if(!url.toLowerCase().startsWith('https://')) {
+        return false;
+    }
+    return true;
+}
+
+
+export {
     buildAuthHeader,
-    buildRequestUrlPath
+    buildRequestUrlPath,
+    isHttps
 }