fix: cache middleware - OKTA-280090

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Okta Node SDK Changelog
 
+## 4.4.0
+
+- [218](https://github.com/okta/okta-sdk-nodejs/pull/218)
+  - Uses `req.url` as key to cache response
+  - Adds `json()` function to the default cache middleware response
+
 ## 4.3.1
 
 ### Bug Fixes

src/default-cache-middleware.js

@@ -15,15 +15,21 @@ const _ = require('lodash');
 module.exports = function defaultCacheMiddleware(ctx, next) {
   let cacheCheck, cacheHit = false;
   if (ctx.req.method.toLowerCase() === 'get' && !ctx.isCollection) {
-    // TODO: use ctx.req.url as cache key and add json() method to cached result: https://oktainc.atlassian.net/browse/OKTA-280090
-    cacheCheck = ctx.cacheStore.get(ctx.req.uri)
+    cacheCheck = ctx.cacheStore.get(ctx.req.url)
     .then(body => {
       if (body) {
         cacheHit = true;
         ctx.res = {
           status: 200,
           text() {
             return Promise.resolve(body);
+          },
+          json() {
+            try {
+              return Promise.resolve(JSON.parse(body));
+            } catch (err) {
+              return Promise.reject(err);
+            }
           }
         };
       }

src/http.js

@@ -71,7 +71,7 @@ class Http {
 
     let retriedOnAuthError = false;
     const execute = () => {
-      const promise = this.prepareRequest(request)
+      const getRequestPromise = () => this.prepareRequest(request)
         .then(() => this.requestExecutor.fetch(request))
         .then(Http.errorFilter)
         .catch(error => {
@@ -86,11 +86,11 @@ class Http {
         });
 
       if (!this.cacheMiddleware) {
-        return promise;
+        return getRequestPromise();
       }
 
       const ctx = {
-        uri, // TODO: remove unused property. req.url should be the key.
+        uri, // TODO: remove unused property. req.url should be the key. OKTA-351525
         isCollection: context.isCollection,
         resources: context.resources,
         req: request,
@@ -101,7 +101,7 @@ class Http {
           return;
         }
 
-        return promise.then(res => ctx.res = res);
+        return getRequestPromise().then(res => ctx.res = res);
       })
       .then(() => ctx.res);
     };

test/jest/default-request-executor.test.js

@@ -224,7 +224,7 @@ describe('DefaultRequestExecutor', () => {
         requestTimeout: 1
       });
       await expect(requestExecutor.fetch({url: 'https://www.okta.com'})).rejects
-      .toMatchObject({message:'network timeout at: https://www.okta.com'});
+      .toMatchObject({message:'network timeout at: https://www.okta.com/'});
     });
 
     it('sets the node-fetch timeout to requestTimeout for new requests', async () => {

test/jest/http.test.js

@@ -353,8 +353,7 @@ describe('Http class', () => {
     describe('default cache middleware', () => {
       testWithCacheMiddleware();
 
-      // TODO: fix cache middleware: https://oktainc.atlassian.net/browse/OKTA-280090
-      xit('Returns a cached result on subsequent call', () => {
+      it('Returns a cached result on subsequent call', () => {
         const http = new Http({ requestExecutor });
         expect(http.cacheMiddleware).toBeDefined();
         return http.http('http://fakey.local')

test/unit/default-cache-middleware.js

@@ -24,22 +24,19 @@ async function next(ctx, body = '{}') {
   };
 }
 
-// TODO: use request.url per fetch spec: https://developer.mozilla.org/en-US/docs/Web/API/Request
-// https://oktainc.atlassian.net/browse/OKTA-280090
-
 describe('Default cache middleware', () => {
   it('caches GET items with a \'self\' link', async () => {
     const cacheStore = new MemoryStore();
     const ctx = {
       req: {
         method: 'get',
-        uri: 'http://example.com/item'
+        url: 'http://example.com/item'
       },
       cacheStore
     };
     const body = JSON.stringify(_.set({}, '_links.self.href', 'http://example.com/item'));
     await middleware(ctx, () => next(ctx, body));
-    expect(await cacheStore.get(ctx.req.uri)).to.equal(body);
+    expect(await cacheStore.get(ctx.req.url)).to.equal(body);
     // make sure the middleware doesn't flush the stream
     expect(await ctx.res.text()).to.equal(body);
   });
@@ -49,14 +46,16 @@ describe('Default cache middleware', () => {
     const ctx = {
       req: {
         method: 'get',
-        uri: 'http://example.com/item'
+        url: 'http://example.com/item'
       },
       cacheStore
     };
-    const body = JSON.stringify(_.set({}, '_links.self.href', 'http://example.com/item'));
-    await cacheStore.set(ctx.req.uri, body);
+    const bodyObj = _.set({}, '_links.self.href', 'http://example.com/item');
+    const bodyStr = JSON.stringify(bodyObj);
+    await cacheStore.set(ctx.req.url, bodyStr);
     await middleware(ctx, () => next(ctx));
-    expect(await ctx.res.text()).to.equal(body);
+    expect(await ctx.res.json()).to.eql(bodyObj);
+    expect(await ctx.res.text()).to.equal(bodyStr);
   });
 
   it('doesn\'t cache GET items without a \'self\' link', async () => {