Check for extensions updates

Updated design

Check registry at most once a day

Remove updated and uninstalled extensions from update list

Use new icon sprite

Calculate when an actual update should be launched

Calculate updateCompatible for extensions

toggle icon even when registry are downloaded through extension manager

checkForUpdate is now called directly on the startup as it was before

combine the functions

download only if there're no updates available

delete icon that is no longer user

This sorts installed extensions by updateAvailable (#6634)

align = in exports

add an empty line

use localeCompare instead of ifs

use Array instead of array for preferences

do not convert new preferences

move event listener to the bottom of the file

move function to the bottom to make JSLint happy

count only compatible updates for notification icon

add comments

fix tests that were failing after changes to the model.notifyCount

fix issue when update button is disabled but newer compatible version (not latest) exists

add tests for ExtensionManager.getAvailableUpdates() method

add tests for ExtensionManager.cleanAvailableUpdates() method

move new tests

Author: zaggino

src/brackets.js

@@ -296,13 +296,9 @@ define(function (require, exports, module) {
 
         // Check for updates
         if (!params.get("skipUpdateCheck") && !brackets.inBrowser) {
-            // check once a day, plus 2 minutes, 
-            // as the check will skip if the last check was not -24h ago
-            window.setInterval(UpdateNotification.checkForUpdate, 86520000);
-            
-            // Check for updates on App Ready
             AppInit.appReady(function () {
-                UpdateNotification.checkForUpdate();
+                // launches periodic checks for updates cca every 24 hours
+                UpdateNotification.launchAutomaticUpdate();
             });
         }
     }

src/extensibility/ExtensionManager.js

@@ -39,7 +39,8 @@
 define(function (require, exports, module) {
     "use strict";
 
-    var FileUtils        = require("file/FileUtils"),
+    var _                = require("thirdparty/lodash"),
+        FileUtils        = require("file/FileUtils"),
         Package          = require("extensibility/Package"),
         Async            = require("utils/Async"),
         ExtensionLoader  = require("utils/ExtensionLoader"),
@@ -105,13 +106,28 @@ define(function (require, exports, module) {
         }
 
         entry.installInfo.owner = entry.registryInfo.owner;
-        if (entry.installInfo.metadata && entry.installInfo.metadata.version && semver.lt(entry.installInfo.metadata.version, entry.registryInfo.metadata.version)) {
+
+        // Assume false
+        entry.installInfo.updateAvailable   = false;
+        entry.registryInfo.updateAvailable  = false;
+        entry.installInfo.updateCompatible  = false;
+        entry.registryInfo.updateCompatible = false;
+
+        var currentVersion = entry.installInfo.metadata ? entry.installInfo.metadata.version : null;
+        if (currentVersion && semver.lt(currentVersion, entry.registryInfo.metadata.version)) {
             // Note: available update may still be incompatible; we check for this when rendering the Update button in ExtensionManagerView._renderItem()
-            entry.registryInfo.updateAvailable = true;
-            entry.installInfo.updateAvailable = true;
-        } else {
-            entry.installInfo.updateAvailable = false;
-            entry.registryInfo.updateAvailable = false;
+            entry.registryInfo.updateAvailable  = true;
+            entry.installInfo.updateAvailable   = true;
+            // Calculate updateCompatible to check if there's an update for current version of Brackets
+            var lastCompatibleVersionInfo = _.findLast(entry.registryInfo.versions, function (versionInfo) {
+                return semver.satisfies(brackets.metadata.apiVersion, versionInfo.brackets);
+            });
+            if (lastCompatibleVersionInfo && lastCompatibleVersionInfo.version && semver.lt(currentVersion, lastCompatibleVersionInfo.version)) {
+                entry.installInfo.updateCompatible        = true;
+                entry.registryInfo.updateCompatible       = true;
+                entry.installInfo.lastCompatibleVersion   = lastCompatibleVersionInfo.version;
+                entry.registryInfo.lastCompatibleVersion  = lastCompatibleVersionInfo.version;
+            }
         }
 
         $(exports).triggerHandler("registryUpdate", [id]);
@@ -160,6 +176,7 @@ define(function (require, exports, module) {
                     extensions[id].registryInfo = data[id];
                     synchronizeEntry(id);
                 });
+                $(exports).triggerHandler("registryDownload");
                 result.resolve();
             })
             .fail(function () {
@@ -506,39 +523,92 @@ define(function (require, exports, module) {
         );
     }
 
+    /**
+     * Gets an array of extensions that are currently installed and can be updated to a new version
+     * @return {Array} array of objects with properies id,installVersion,registryVersion
+     *                 where id = extensionId
+     *                       installVersion = currently installed version of extension
+     *                       registryVersion = latest version compatible with current Brackets
+     */
+    function getAvailableUpdates() {
+        var result = [];
+        Object.keys(extensions).forEach(function (extensionId) {
+            var extensionInfo = extensions[extensionId];
+            // skip extensions that are not installed or are not in the registry
+            if (!extensionInfo.installInfo || !extensionInfo.registryInfo) {
+                return;
+            }
+            if (extensionInfo.registryInfo.updateCompatible) {
+                result.push({
+                    id: extensionId,
+                    installVersion: extensionInfo.installInfo.metadata.version,
+                    registryVersion: extensionInfo.registryInfo.lastCompatibleVersion
+                });
+            }
+        });
+        return result;
+    }
+
+    /**
+     * Takes array returned from getAvailableUpdates() as an input and removes those entries
+     * that are no longer current - when currently installed version of an extension
+     * is equal or newer than registryVersion returned by getAvailableUpdates().
+     * This function is designed to work without the necessity to download extension registry
+     * @param {Array} previous output of getAvailableUpdates()
+     * @param {Array} filtered input as function description
+     */
+    function cleanAvailableUpdates(updates) {
+        return updates.reduce(function (arr, updateInfo) {
+            var extDefinition = extensions[updateInfo.id];
+            if (!extDefinition || !extDefinition.installInfo) {
+                // extension has been uninstalled in the meantime
+                return arr;
+            }
+
+            var installedVersion = extDefinition.installInfo.metadata.version;
+            if (semver.lt(installedVersion, updateInfo.registryVersion)) {
+                arr.push(updateInfo);
+            }
+
+            return arr;
+        }, []);
+    }
+
     // Listen to extension load and loadFailed events
     $(ExtensionLoader)
         .on("load", _handleExtensionLoad)
         .on("loadFailed", _handleExtensionLoad);
 
     // Public exports
-    exports.downloadRegistry = downloadRegistry;
-    exports.getCompatibilityInfo = getCompatibilityInfo;
-    exports.getExtensionURL = getExtensionURL;
-    exports.remove = remove;
-    exports.update = update;
-    exports.extensions = extensions;
-    exports.cleanupUpdates = cleanupUpdates;
-    exports.markForRemoval = markForRemoval;
-    exports.isMarkedForRemoval = isMarkedForRemoval;
-    exports.unmarkAllForRemoval = unmarkAllForRemoval;
-    exports.hasExtensionsToRemove = hasExtensionsToRemove;
-    exports.updateFromDownload = updateFromDownload;
-    exports.removeUpdate = removeUpdate;
-    exports.isMarkedForUpdate = isMarkedForUpdate;
-    exports.hasExtensionsToUpdate = hasExtensionsToUpdate;
-    exports.removeMarkedExtensions = removeMarkedExtensions;
-    exports.updateExtensions = updateExtensions;
+    exports.downloadRegistry        = downloadRegistry;
+    exports.getCompatibilityInfo    = getCompatibilityInfo;
+    exports.getExtensionURL         = getExtensionURL;
+    exports.remove                  = remove;
+    exports.update                  = update;
+    exports.extensions              = extensions;
+    exports.cleanupUpdates          = cleanupUpdates;
+    exports.markForRemoval          = markForRemoval;
+    exports.isMarkedForRemoval      = isMarkedForRemoval;
+    exports.unmarkAllForRemoval     = unmarkAllForRemoval;
+    exports.hasExtensionsToRemove   = hasExtensionsToRemove;
+    exports.updateFromDownload      = updateFromDownload;
+    exports.removeUpdate            = removeUpdate;
+    exports.isMarkedForUpdate       = isMarkedForUpdate;
+    exports.hasExtensionsToUpdate   = hasExtensionsToUpdate;
+    exports.removeMarkedExtensions  = removeMarkedExtensions;
+    exports.updateExtensions        = updateExtensions;
+    exports.getAvailableUpdates     = getAvailableUpdates;
+    exports.cleanAvailableUpdates   = cleanAvailableUpdates;
 
-    exports.ENABLED = ENABLED;
-    exports.START_FAILED = START_FAILED;
+    exports.ENABLED       = ENABLED;
+    exports.START_FAILED  = START_FAILED;
 
-    exports.LOCATION_DEFAULT = LOCATION_DEFAULT;
-    exports.LOCATION_DEV = LOCATION_DEV;
-    exports.LOCATION_USER = LOCATION_USER;
-    exports.LOCATION_UNKNOWN = LOCATION_UNKNOWN;
+    exports.LOCATION_DEFAULT  = LOCATION_DEFAULT;
+    exports.LOCATION_DEV      = LOCATION_DEV;
+    exports.LOCATION_USER     = LOCATION_USER;
+    exports.LOCATION_UNKNOWN  = LOCATION_UNKNOWN;
 
     // For unit testing only
-    exports._reset = _reset;
-    exports._setExtensions = _setExtensions;
-});
+    exports._reset          = _reset;
+    exports._setExtensions  = _setExtensions;
+});

src/extensibility/ExtensionManagerView.js

@@ -219,7 +219,7 @@ define(function (require, exports, module) {
 
         var isInstalledInUserFolder = (entry.installInfo && entry.installInfo.locationType === ExtensionManager.LOCATION_USER);
         context.allowRemove = isInstalledInUserFolder;
-        context.allowUpdate = context.showUpdateButton && context.isCompatible && context.isCompatibleLatest && isInstalledInUserFolder;
+        context.allowUpdate = context.showUpdateButton && context.isCompatible && context.updateCompatible && isInstalledInUserFolder;
         if (!context.allowUpdate) {
             context.updateNotAllowedReason = isInstalledInUserFolder ? Strings.CANT_UPDATE : Strings.CANT_UPDATE_DEV;
         }
@@ -310,4 +310,4 @@ define(function (require, exports, module) {
     };
 
     exports.ExtensionManagerView = ExtensionManagerView;
-});
+});

src/extensibility/ExtensionManagerViewModel.js

@@ -366,6 +366,13 @@ define(function (require, exports, module) {
      */
     function InstalledViewModel() {
         ExtensionManagerViewModel.call(this);
+
+        // when registry is downloaded, sort extensions again - those with updates will be before others
+        var self = this;
+        $(ExtensionManager).on("registryDownload", function () {
+            self._sortFullSet();
+            self._setInitialFilter();
+        });
     }
 
     InstalledViewModel.prototype = Object.create(ExtensionManagerViewModel.prototype);
@@ -405,17 +412,22 @@ define(function (require, exports, module) {
         var self = this;
 
         this.sortedFullSet = this.sortedFullSet.sort(function (key1, key2) {
+            // before sorting by name, put first extensions that have updates
+            var ua1 = self.extensions[key1].installInfo.updateAvailable,
+                ua2 = self.extensions[key2].installInfo.updateAvailable;
+
+            if (ua1 && !ua2) {
+                return -1;
+            } else if (!ua1 && ua2) {
+                return 1;
+            }
+
             var metadata1 = self.extensions[key1].installInfo.metadata,
                 metadata2 = self.extensions[key2].installInfo.metadata,
                 id1 = (metadata1.title || metadata1.name).toLowerCase(),
                 id2 = (metadata2.title || metadata2.name).toLowerCase();
-            if (id1 < id2) {
-                return -1;
-            } else if (id1 === id2) {
-                return 0;
-            } else {
-                return 1;
-            }
+
+            return id1.localeCompare(id2);
         });
     };
 
@@ -427,7 +439,7 @@ define(function (require, exports, module) {
         var self = this;
         this.notifyCount = 0;
         this.sortedFullSet.forEach(function (key) {
-            if (self.extensions[key].installInfo.updateAvailable) {
+            if (self.extensions[key].installInfo.updateCompatible) {
                 self.notifyCount++;
             }
         });
@@ -483,4 +495,4 @@ define(function (require, exports, module) {
 
     exports.RegistryViewModel = RegistryViewModel;
     exports.InstalledViewModel = InstalledViewModel;
-});
+});

src/styles/brackets.less

@@ -500,7 +500,10 @@ a, img {
 }
 
 #toolbar-extension-manager {
-    .sprite-icon(0, 0, 24px, 24px, "images/topcoat-plugin-20.svg");
+    .sprite-icon(0, 0, 24px, 24px, "images/extension-manager-sprite.svg");
+    &.updatesAvailable {
+        .sprite-icon(0, 24px, 24px, 24px, "images/extension-manager-sprite.svg");
+    }
 }
 
 /* Project panel */