Merge pull request #72 from agility/revert-64-remove-cache-adapter

Revert "removed cache adapter"
agility · Mar 9, 2021 · 890db6b · 890db6b
2 parents 7ce1dbc + d8f65bb
commit 890db6b
Show file tree

Hide file tree

Showing 9 changed files with 86 additions and 15 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@agility/content-fetch",
-  "version": "1.1.0",
+  "version": "1.0.3",
   "description": "JavaScript library for the Agility Fetch API (node and browser)",
   "main": "dist/agility-content-fetch.node.js",
   "scripts": {
@@ -38,6 +38,7 @@
     "webpack-cli": "^3.2.3"
   },
   "dependencies": {
-    "axios": "^0.21.1"
+    "axios": "^0.21.1",
+    "axios-cache-adapter": "^2.4.1"
   }
 }
diff --git a/src/api-client.js b/src/api-client.js
@@ -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'
@@ -93,6 +94,14 @@ export default function createClient(userConfig) {
 
     let adapter = null;
 
+    //should we turn on caching?
+    if (config.caching.maxAge > 0) {
+        const cache = setupCache({
+            maxAge: config.caching.maxAge,
+            exclude: { query: false }
+        });
+        adapter = cache.adapter;
+    }
 
 	const https= require("https")
 
@@ -103,11 +112,14 @@ export default function createClient(userConfig) {
 		api = axios.create({
 			httpsAgent: new https.Agent({
 				rejectUnauthorized: false
-			})
+			}),
+			adapter: adapter,
 		})
 	} else {
 		//we can't use the https.Agent
-		api = axios.create({})
+		api = axios.create({
+			adapter: adapter,
+		})
 	}
 
 
@@ -123,12 +135,17 @@ export default function createClient(userConfig) {
         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;
 
 
         })
             .catch(async (error) => {
-                logError(`AgilityCMS Fetch API ERROR: Request failed for ${reqConfig.baseURL}${reqConfig.url} ... ${error}.`)
+                logError(`AgilityCMS Fetch API ERROR: Request failed for ${reqConfig.baseURL}${reqConfig.url} ... ${error} ... Does the item exist?`)
             });
     }
 

diff --git a/src/content-fetch.js b/src/content-fetch.js
@@ -49,6 +49,8 @@ import { isHttps } from './utils'
  * @param {string} config.guid - The guid that represents your instance.
  * @param {string} config.apiKey - 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
@@ -69,14 +71,12 @@ function getApi(config) {
 
 function validateConfigParams(configParams) {
 
-    if(configParams.caching) {
-        console.warn('The built-in caching has been deprecated from @agility/content-fetch as of version `1.1.0`. The `caching` parameter will have no effect.');
-    }
-
     if(!configParams.guid || configParams.guid.length == 0) {
         throw new TypeError('You must provide an guid.');
     } else if(!configParams.apiKey || configParams.apiKey.length == 0) {
-        throw new TypeError('You must provide an access token.');  
+        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 {

diff --git a/test/apiClients.config.js b/test/apiClients.config.js
@@ -22,6 +22,17 @@ function createApiClientWithNewCdn() {
     return api;
 }
 
+function createCachedApiClient() {
+    var api = agility.getApi({
+        guid: guid,
+        apiKey: apiKeyFetch,
+        caching: {
+            maxAge: 5 * 60 * 1000 //==5mins
+        }
+    });
+    return api;
+}
+
 function createPreviewApiClient() {
     var api = agility.getApi({
         guid: guid,
@@ -33,6 +44,7 @@ function createPreviewApiClient() {
 
 export {
     createApiClient,
+    createCachedApiClient,
     createPreviewApiClient,
     createApiClientWithNewCdn
 }
diff --git a/test/getContentItem.tests.js b/test/getContentItem.tests.js
@@ -5,6 +5,7 @@ const expect = chai.expect;
 import {
     createApiClient,
     createPreviewApiClient,
+    createCachedApiClient,
     createApiClientWithNewCdn
 } from './apiClients.config'
 
@@ -49,6 +50,32 @@ describe('getContentItem:', function() {
         .catch(done);
     })
 
+    it('should retrieve a content item in live/fetch mode, then subsequent requests are returned from cache (memory)', function(done) {
+        var api = createCachedApiClient();
+        api.getContentItem({
+            contentID: ref.updatesMadeToPublishedContentItemID,
+            languageCode: 'en-us'
+        })
+        .then(function(contentItem) {
+
+            assert.strictEqual(contentItem.contentID, ref.updatesMadeToPublishedContentItemID, 'retrieved content item we asked for');
+            assert.notExists(contentItem.fromCache, 'content item should not be served from cache on first request')
+
+            api.getContentItem({
+                contentID: ref.updatesMadeToPublishedContentItemID,
+                languageCode: 'en-us'
+            })
+            .then(function(contentItem2) {
+
+                assert.strictEqual(contentItem2.contentID, ref.updatesMadeToPublishedContentItemID, 'retrieved content item we asked for');
+                assert.strictEqual(contentItem2.fromCache, true, 'content item was retrieved from memory cache')
+                done();
+            })
+            .catch(done)
+
+        })
+        .catch(done);
+    })
 
     it('should throw error if contentID not passed as argument for getContentItem', function(done) {
         expect(function() {

diff --git a/test/getContentList.tests.js b/test/getContentList.tests.js
@@ -4,6 +4,7 @@ const expect = chai.expect;
 import {
     createApiClient,
     createPreviewApiClient,
+    createCachedApiClient,
     createApiClientWithNewCdn
 } from './apiClients.config'
 

diff --git a/test/getSyncContentItems.tests.js b/test/getSyncContentItems.tests.js
@@ -2,7 +2,7 @@ import chai from 'chai'
 const assert = chai.assert;
 const expect = chai.expect;
 
-import { createApiClient, createPreviewApiClient } from './apiClients.config'
+import { createApiClient, createPreviewApiClient, createCachedApiClient } from './apiClients.config'
 import { SSL_OP_SSLEAY_080_CLIENT_DH_BUG } from 'constants';
 
 /*

diff --git a/test/getSyncPageItems.tests.js b/test/getSyncPageItems.tests.js
@@ -2,7 +2,7 @@ import chai from 'chai'
 const assert = chai.assert;
 const expect = chai.expect;
 
-import { createApiClient, createPreviewApiClient } from './apiClients.config'
+import { createApiClient, createPreviewApiClient, createCachedApiClient } from './apiClients.config'
 import { SSL_OP_SSLEAY_080_CLIENT_DH_BUG } from 'constants';
 
 /*