unify cache refresh: rename option disableCache to refresh

itteco · Sep 9, 2019 · 657b185 · 657b185
1 parent 29c0b53
commit 657b185
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 8 deletions.
diff --git a/lib/cache.js b/lib/cache.js
@@ -103,7 +103,7 @@
             });
         };
 
-        if (options && options.disableCache) {
+        if (options && options.refresh) {
 
             cache_skip_get && cache_skip_get(key);
 

diff --git a/lib/core.js b/lib/core.js
@@ -1367,6 +1367,11 @@
             options.jar = request.jar();
         }
 
+        if ('disableCache' in options) {
+            console.warn('Using options.disableCache in iframely.run() is deprecated. Use options.refresh instead.')
+            options.refresh = options.disableCache;
+        }
+
         generateProviderOptionsFunc(options);
 
         if (options.redirectsCount && options.redirectsCount > (CONFIG.MAX_REDIRECTS || 4)) {

diff --git a/lib/utils.js b/lib/utils.js
@@ -473,7 +473,7 @@ exports.getImageMetadata = function(uri, options, callback){
         ], finish);
 
     }, {
-        disableCache: options.disableCache,
+        refresh: options.refresh,
         doNotWaitFunctionIfNoCache: options.doNotWaitFunctionIfNoCache,
         ttl: CONFIG.IMAGE_META_CACHE_TTL || CONFIG.CACHE_TTL,
         multiCache: options.multiCache
@@ -526,7 +526,7 @@ exports.getUriStatus = function(uri, options, callback) {
         getUriStatus(uri, options, finish);
 
     }, {
-        disableCache: options.disableCache,
+        refresh: options.refresh,
         doNotWaitFunctionIfNoCache: options.doNotWaitFunctionIfNoCache,
         ttl: CONFIG.IMAGE_META_CACHE_TTL || CONFIG.CACHE_TTL,
         multiCache: options.multiCache
@@ -633,7 +633,7 @@ exports.getContentType = function(uriForCache, uriOriginal, options, cb) {
         // Call HEAD.
         makeCall();
 
-    }, {disableCache: options.disableCache}, cb);
+    }, {refresh: options.refresh}, cb);
 };
 
 exports.unifyDuration = function(duration) {

diff --git a/modules/api/views.js b/modules/api/views.js
@@ -133,7 +133,6 @@ module.exports = function(app) {
                     maxWidth: getIntParam(req, 'maxwidth') || getIntParam(req, 'max-width'),
                     promoUri: req.query.promoUri,
                     refresh: getBooleanParam(req, 'refresh'),
-                    disableCache: getBooleanParam(req, 'refresh'),
                     providerOptions: getProviderOptionsFromQuery(req.query)
                 }, cb);
             }
@@ -428,7 +427,6 @@ module.exports = function(app) {
                     filterNonHTML5: getBooleanParam(req, 'html5'),
                     maxWidth: getIntParam(req, 'maxwidth') || getIntParam(req, 'max-width'),
                     refresh: getBooleanParam(req, 'refresh'),
-                    disableCache: getBooleanParam(req, 'refresh'),
                     providerOptions: getProviderOptionsFromQuery(req.query)
                 }, cb);
             }

diff --git a/modules/debug/views.js b/modules/debug/views.js
@@ -13,7 +13,7 @@ module.exports = function(app) {
         res.render('debug',{
             uri: req.query.uri,
             mixAllWithDomainPlugin: !!{"on":1, "true":1}[req.query.mixAllWithDomainPlugin],
-            disableCache: !!{"on":1, "true":1}[req.query.refresh],
+            refresh: !!{"on":1, "true":1}[req.query.refresh],
             DEBUG: DEBUG,
             QUERY: getProviderOptionsQuery(req.query)
         });

diff --git a/views/debug.ejs b/views/debug.ejs
@@ -54,7 +54,7 @@
                                 <input type="checkbox" name="mixAllWithDomainPlugin" <% if (mixAllWithDomainPlugin) { %>checked="checked"<% } %>> Debug with all plugins (disable specific mixins and mixin all available plugins) <a href="/debug?uri=<%= encodeURIComponent(uri) || '' %>&mixAllWithDomainPlugin=<%= !!!mixAllWithDomainPlugin %>" target="_blank">or open in new window with opposite value</a>
                             </label>
                             <label class="checkbox">
-                                <input type="checkbox" name="refresh" <% if (disableCache) { %>checked="checked"<% } %>> Refresh</a>
+                                <input type="checkbox" name="refresh" <% if (refresh) { %>checked="checked"<% } %>> Refresh</a>
                             </label>
                         </div>
                     </div>