Merge pull request #7330 from adobe/zaggino/check-for-update

TomMalbran · TomMalbran · commit 180e4cc4320b · 2014-04-22T19:06:40.000-03:00
Check for extensions updates
diff --git a/src/brackets.js b/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();
             });
         }
     }
diff --git a/src/extensibility/ExtensionManager.js b/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,94 @@ define(function (require, exports, module) {
         );
     }
     
+    /**
+     * Gets an array of extensions that are currently installed and can be updated to a new version
+     * @return {Array.<{id: string, installVersion: string, registryVersion: string}>}
+     *     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 the 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.<{id: string, installVersion: string, registryVersion: string}>} updates
+     *     previous output of getAvailableUpdates()
+     * @return {Array.<{id: string, installVersion: string, registryVersion: string}>}
+     *     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;
+});
diff --git a/src/extensibility/ExtensionManagerView.js b/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;
-});
+});
diff --git a/src/extensibility/ExtensionManagerViewModel.js b/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) {
-            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) {
+            // 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 (id1 === id2) {
-                return 0;
-            } else {
+            } else if (!ua1 && ua2) {
                 return 1;
             }
+
+            var metadata1 = self.extensions[key1].installInfo.metadata,
+                metadata2 = self.extensions[key2].installInfo.metadata,
+                id1 = (metadata1.title || metadata1.name).toLocaleLowerCase(),
+                id2 = (metadata2.title || metadata2.name).toLocaleLowerCase();
+
+            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;
-});
+});
diff --git a/src/styles/brackets.less b/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 */
diff --git a/src/styles/images/extension-manager-sprite.svg b/src/styles/images/extension-manager-sprite.svg
@@ -0,0 +1,9 @@
+<svg width="24px" height="120px" viewBox="0 0 24 120" version="1.1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink">
+    <g transform="translate(3.000000, 6.000000)" fill="#BBBBBB">
+        <path d="M7,2.25 C7,0.75 6.532,0 4.971,0 C3.471,0 3,0.812 3,2.25 L3,3 L2,3 C0.44,3 0,3.75 0,5.25 L0,11.25 C0,12.779 0.44,13.042 2,13.042 L16,13.042 C17.563,13.042 18.004,12.779 18.004,11.25 L18.004,5.25 C18.004,3.75 17.563,3 16,3 L15,3 L15,2.25 C15,0.812 14.471,0 12.971,0 C11.409,0 11,0.75 11,2.25 L11,3 L7,3 L7,2.25 L7,2.25 Z"></path>
+    </g>
+    <g transform="translate(3.000000, 28.000000)" fill="#91CC41">
+        <path d="M4.971,2 C3.471,2 3,2.812 3,4.25 L3,5 L2,5 C0.44,5 0,5.75 0,7.25 L0,13.25 C0,14.779 0.44,15.042 2,15.042 L16,15.042 C17.563,15.042 18.004,14.779 18.004,13.25 L18.004,7.25 C18.004,5.75 17.563,5 16,5 L15,5 L15,4.25 C15,2.812 14.471,2 12.971,2 C11.409,2 11,2.75 11,4.25 L11,5 L7,5 L7,4.25 C7,2.75 6.532,2 4.971,2 Z"></path>
+        <path d="M18,4 C19.1045696,4 20,3.10456955 20,2 C20,0.895430446 19.1045696,0 18,0 C16.8954304,0 16,0.895430446 16,2 C16,3.10456955 16.8954304,4 18,4 Z"></path>
+    </g>
+</svg>
diff --git a/src/styles/images/topcoat-plugin-20.svg b/src/styles/images/topcoat-plugin-20.svg
diff --git a/src/utils/UpdateNotification.js b/src/utils/UpdateNotification.js
diff --git a/test/spec/ExtensionManager-test.js b/test/spec/ExtensionManager-test.js

Original file line number	Diff line number	Diff line change
`@@ -500,7 +500,10 @@ a, img {`
`500`	`500`	`}`
`501`	`501`
`502`	`502`	`#toolbar-extension-manager {`
`503`		`- .sprite-icon(0, 0, 24px, 24px, "images/topcoat-plugin-20.svg");`
	`503`	`+ .sprite-icon(0, 0, 24px, 24px, "images/extension-manager-sprite.svg");`
	`504`	`+ &.updatesAvailable {`
	`505`	`+ .sprite-icon(0, 24px, 24px, 24px, "images/extension-manager-sprite.svg");`
	`506`	`+ }`
`504`	`507`	`}`
`505`	`508`
`506`	`509`	`/* Project panel */`