fix: not found cache handling

Author: hugocortes

lib/Auth/index.js

@@ -49,7 +49,8 @@ class Auth {
         drop: 'drop',
         get: 'get',
         set: 'set'
-      }
+      },
+      status: 'cached'
     };
 
     /** @type CoreError */
@@ -145,7 +146,7 @@ class Auth {
    * @param {Object}  [opts.cache=false]
    * @param {String}  opts.cache.key
    * @param {String}  opts.cache.action
-   * @param {Boolean} opts.cache.onError
+   * @param {Boolean} opts.cache.onNotFound
    * @param {Number}  retry                 Allow retries in case of expired token
    *
    * @returns {Promise<{} | Array<{}>>}
@@ -174,25 +175,23 @@ class Auth {
 
       let status;
       let body;
-
       if (this.isCacheEnabled && opts.cache) {
         if (opts.cache.action === this.cache.actions.drop) {
           await this.executeCacheOp(opts.cache);
         }
         if (opts.cache.action === this.cache.actions.get) {
           body = await this.executeCacheOp(opts.cache);
-          status = body || body === false ? 'cached' : null;
+          status = body || body === false ? this.cache.status : null;
         }
       }
 
-      if (!opts.isPublic) {
-        const clientToken = await this.getApplicationToken();
-        opts.headers.authorization = `Bearer ${clientToken}`;
-      }
-
-      begin = new Date().getTime();
-
       if (!body && body !== false) {
+        if (!opts.isPublic) {
+          const clientToken = await this.getApplicationToken();
+          opts.headers.authorization = `Bearer ${clientToken}`;
+        }
+
+        begin = new Date().getTime();
         ({ status, body } = await superagent(method, url)
           .set(opts.headers)
           .query(opts.query)
@@ -211,27 +210,31 @@ class Auth {
         }
       }
 
+      if (this.isCacheEnabled && body === false) {
+        throw CoreError.CachedNotFound();
+      }
+
       this.log(
         `${service} ${method}, code: ${status}, t: ${this.timeDelta(
           begin
         )} ms -> url: ${url}, query: ${JSON.stringify(opts.query || {})}`
       );
 
-      // cached as false, throw an error
-      if (this.isCacheEnabled && body === false) {
-        throw new CoreError(new Error('Not found'), { statusCode: 404 });
-      }
-
       return body;
     } catch (error) {
       if (
         this.isCacheEnabled &&
         opts.cache &&
         opts.cache.action === this.cache.actions.get &&
-        opts.cache.onError &&
-        error.status === 404
+        opts.cache.onNotFound &&
+        error.status === 404 &&
+        error.typeof !== CoreError.CachedNotFound
       ) {
-        await this.executeCacheOp({ value: false, ...opts.cache });
+        await this.executeCacheOp({
+          value: false,
+          ...opts.cache,
+          ...{ action: this.cache.actions.set }
+        });
       }
 
       if (

lib/CoreError.js

@@ -59,6 +59,12 @@ class CoreError extends Boom {
     });
   }
 
+  static CachedNotFound() {
+    return this.notFound(this.CachedNotFound.name, {
+      ctr: this.CachedNotFound
+    });
+  }
+
   /**
    * Overrides Boom static to create under Core instance
    * @param {String} fnName
@@ -80,5 +86,6 @@ class CoreError extends Boom {
 }
 
 CoreError.override('unauthorized');
+CoreError.override('notFound');
 
 module.exports = CoreError;

lib/Services/cayenne.js

@@ -309,11 +309,12 @@ class Cayenne {
   /**
    * Gets a device's meta data by device type id
    * @param {String}  deviceTypeId
-   * @param {Objet}   [opts={}]             Additional options
-   * @param {Boolean} [opts.useCache=false] If cached result should be retrieved
+   * @param {Objet}   [opts={}]                    Additional options
+   * @param {Boolean} [opts.useCache=false]        If cached result should be retrieved
+   * @param {Boolean} [opts.cacheOnNotFound=false] Whether to cache if a 404 error is returned
    */
   getDeviceTypeMeta(deviceTypeId, opts) {
-    opts = { useCache: false, ...opts };
+    opts = { useCache: false, cacheOnNotFound: false, ...opts };
 
     const url = `${this.url}/things/types/${deviceTypeId}/meta`;
     return this.auth.send(this.service, 'GET', url, {
@@ -325,7 +326,7 @@ class Cayenne {
               ...arguments
             ),
             action: this.auth.cache.actions.get,
-            onError: false
+            onNotFound: opts.cacheOnNotFound
           }
         : false
     });
@@ -335,11 +336,12 @@ class Cayenne {
    * Gets a device's meta data by device type id
    * @param {String}  deviceTypeId
    * @param {String}  key
-   * @param {Objet}   [opts={}]             Additional options
-   * @param {Boolean} [opts.useCache=false] If cached result should be retrieved
+   * @param {Objet}   [opts={}]                    Additional options
+   * @param {Boolean} [opts.useCache=false]        If cached result should be retrieved
+   * @param {Boolean} [opts.cacheOnNotFound=false] Whether to cache if a 404 error is returned
    */
   getDeviceTypeMetaByKey(deviceTypeId, key, opts = {}) {
-    opts = { useCache: false, ...opts };
+    opts = { useCache: false, cacheOnNotFound: false, ...opts };
 
     const url = `${this.url}/things/types/${deviceTypeId}/meta/${key}`;
 
@@ -352,7 +354,7 @@ class Cayenne {
               ...arguments
             ),
             action: this.auth.cache.actions.get,
-            onError: false
+            onNotFound: opts.cacheOnNotFound
           }
         : false
     });