Plugin search by modified date (#409)

* add function to check plugin uri match

* use `pluginMatchesUrl` to find plugin match

`hasNewPluginForUri` - finds newest plugin for cache invalidation

* export `hasNewPluginForUri`

* cache: better search plugin by uri for cache invalidation

Author: nleush

lib/core.js

@@ -403,10 +403,7 @@
 
         } else {
 
-            var domain = uri.split('/')[2]
-                // Skip www. for domain search.
-                .replace(/^www\./i, "")
-                .toLowerCase();
+            const domain = pluginLoader.getDomainForPlugin(uri);
 
             var pluginMatchesByDomains = {};
 
@@ -426,48 +423,15 @@
                 for(var i = 0; i < pluginsList.length; i++) {
                     var plugin = pluginsList[i];
 
-                    if (plugin.domain) {
+                    var match = plugin.pluginMatchesUrl(domain, uri);
 
-                        // Match only by regexp. Used in specific cases where domain changes (like national domain).
-
-                        var match = null, j = 0, res = plugin.re;
-                        while (!match && j < res.length) {
-                            match = uri.match(res[j]);
-                            j++;
-                        }
-                        if (match) {
-                            // Store match for plugin.
+                    if (match) {
+                        if (match === true) {
+                            // Match without regexp.
+                            registerDomainPlugin(plugin, null);
+                        } else {
                             registerDomainPlugin(plugin, match);
                             pluginsUrlMatches[plugin.id] = match;
-                            continue;
-                        } else if (res.length) {
-                            // Skip plugin with unmatched re.
-                            continue;
-                        }
-
-                        // Straight match by domain.
-
-                        // Positive match on plugin.domain="domain.com", domain="sub.domain.com"
-                        // Positive match on plugin.domain="domain.com", domain="domain.com"
-                        var idx = domain.indexOf(plugin.domain);
-
-                        if (idx === -1 || ((idx > 0) && domain.charAt(idx - 1) !== '.')) {
-                            // Break if not found, or not dot separation.
-                            continue;
-                        }
-
-                        if (idx > 0) {
-                            var subdomain = domain.substring(0, idx - 1);
-                            if (subdomain === 'blog') {
-                                // Skip "blog.*.*" blog page for domain plugin without re.
-                                continue;
-                            }
-                        }
-
-                        var match = (idx + plugin.domain.length) === domain.length;
-
-                        if (match) {
-                            registerDomainPlugin(plugin, null);
                         }
                     }
                 }
@@ -488,8 +452,8 @@
                 addAllGeneric();
             }
 
-            for(var domain in pluginMatchesByDomains) {
-                var domainPlugins = pluginMatchesByDomains[domain];
+            for(var d in pluginMatchesByDomains) {
+                var domainPlugins = pluginMatchesByDomains[d];
 
                 var matchedPluginsNames = [];
 

lib/loader/pluginLoader.js

@@ -31,6 +31,8 @@
         pluginsList = [],
         postPluginsList = [],
         pluginsByDomain = {};
+    
+    var pluginsListSortedByModifiedTime;
 
     export {
         plugins as _plugins,
@@ -98,6 +100,19 @@
         }
     }
 
+    function fillModifiedDate() {
+        for(var i = 0; i < pluginsList.length; i++) {
+            var plugin = pluginsList[i];
+            plugin.modifiedWithMixins = plugin.getPluginLastModifiedDate();
+        }
+
+        pluginsListSortedByModifiedTime = [...pluginsList];
+        pluginsListSortedByModifiedTime.sort((p1, p2) => {
+            // Sort desc by modified date.
+            return p2.modifiedWithMixins - p1.modifiedWithMixins;
+        });
+    }
+
     function getFileName(filenameWithExt) {
         return filenameWithExt.replace(/\.(js|ejs)$/i, "");
     }
@@ -304,6 +319,7 @@
             var stat = fs.statSync(pluginPath);
             pluginDeclaration.modified = new Date(stat.mtime);
             pluginDeclaration.getPluginLastModifiedDate = getPluginLastModifiedDate;
+            pluginDeclaration.pluginMatchesUrl = pluginMatchesUrl;
 
             // If no mixins - mark domain plugin 'asks to mixin all generic plugins'.
             if (plugin.mixins) {
@@ -445,6 +461,84 @@
         return record;
     };
 
+    export function getDomainForPlugin(uri) {
+        return uri.split('/')[2]
+            // Skip www. for domain search.
+            .replace(/^www\./i, "")
+            .toLowerCase();
+    }
+
+    export function hasNewPluginForUri(timeAfter, uri) {
+        if (typeof timeAfter !== 'number') {
+            return;
+        }
+
+        var i = 0,
+            plugin, match;
+
+        const domain = getDomainForPlugin(uri);
+
+        while (i < pluginsListSortedByModifiedTime.length
+                && (plugin = pluginsListSortedByModifiedTime[i])
+                // Dot not check next plugins if older, because they are all older (SortedByModifiedTime desc).
+                && plugin.modifiedWithMixins > timeAfter
+                // Find first plugin match (newest).
+                && !(match = plugin.pluginMatchesUrl(domain, uri))) {
+
+                    i++;
+        }
+
+        // Return plugin if match found.
+        return match && plugin;
+    };
+
+    function pluginMatchesUrl(domain, uri) {
+        const plugin = this;
+        if (plugin.domain) {
+
+            // Match only by regexp. Used in specific cases where domain changes (like national domain).
+
+            var match = null, j = 0, res = plugin.re;
+            while (!match && j < res.length) {
+                match = uri.match(res[j]);
+                j++;
+            }
+            if (match) {
+                // Store match for plugin.
+                return match;
+            } else if (res.length) {
+                // Skip plugin with unmatched re.
+                return;
+            }
+
+            // Straight match by domain.
+
+            // Positive match on plugin.domain="domain.com", domain="sub.domain.com"
+            // Positive match on plugin.domain="domain.com", domain="domain.com"
+            var idx = domain.indexOf(plugin.domain);
+
+            if (idx === -1 || ((idx > 0) && domain.charAt(idx - 1) !== '.')) {
+                // Break if not found, or not dot separation.
+                return;
+            }
+
+            if (idx > 0) {
+                var subdomain = domain.substring(0, idx - 1);
+                if (subdomain === 'blog') {
+                    // Skip "blog.*.*" blog page for domain plugin without re.
+                    return;
+                }
+            }
+
+            var match = (idx + plugin.domain.length) === domain.length;
+
+            if (match) {
+                // TODO: use `true` as `null`.
+                return true;
+            }
+        }
+    }
+
     async function scanModulesForPlugins() {
 
         // Scan node_modules dir.
@@ -513,6 +607,8 @@
             }
         }
 
+        fillModifiedDate();
+
         console.log('Iframely plugins loaded:')
         console.log('   - custom domains:', pluginsList.filter(function(p) { return p.domain; }).length);
         console.log('   - generic & meta:', pluginsList.filter(function(p) { return !p.domain && !p.custom; }).length);

utils.js

@@ -87,9 +87,10 @@
             result += new Date(whitelistRecord.date).getTime();
         }
 
-        var plugin = pluginLoader.findDomainPlugin(uri);
+        // `0` to search all plugins.
+        var plugin = pluginLoader.hasNewPluginForUri(0, uri);
         if (plugin) {
-            result += plugin.getPluginLastModifiedDate().getTime();
+            result += plugin.modifiedWithMixins.getTime();
         }
 
         if (result) {