Merge pull request #5653 from adobe/pflynn/latest-compatible-ext

dangoor · dangoor · commit 33a9f05053f1 · 2013-10-24T19:57:18.000-07:00
Allow installing older version of extension if latest not compatible
diff --git a/src/extensibility/ExtensionManager.js b/src/extensibility/ExtensionManager.js
@@ -106,6 +106,7 @@ 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)) {
+            // 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 {
@@ -246,18 +247,20 @@ define(function (require, exports, module) {
     }
         
     /**
-     * Returns information about whether the given entry is compatible with the given Brackets API version.
-     * @param {Object} entry The registry entry to check.
-     * @param {string} apiVersion The Brackets API version to check against.
-     * @return {{isCompatible: boolean, requiresNewer}} Result contains an
-     *      "isCompatible" member saying whether it's compatible. If not compatible, then
-     *      "requiresNewer" says whether it requires an older or newer version of Brackets.
+     * Determines if the given versions[] entry is compatible with the given Brackets API version, and if not
+     * specifies why.
+     * @param {Object} extVersion
+     * @param {string} apiVersion
+     * @return {{isCompatible: boolean, requiresNewer: ?boolean, compatibleVersion: ?string}}
      */
-    function getCompatibilityInfo(entry, apiVersion) {
-        var requiredVersion = entry.metadata.engines && entry.metadata.engines.brackets,
+    function getCompatibilityInfoForVersion(extVersion, apiVersion) {
+        var requiredVersion = (extVersion.brackets || (extVersion.engines && extVersion.engines.brackets)),
             result = {};
         result.isCompatible = !requiredVersion || semver.satisfies(apiVersion, requiredVersion);
-        if (!result.isCompatible) {
+        if (result.isCompatible) {
+            result.compatibleVersion = extVersion.version;
+        } else {
+            // Find out reason for incompatibility
             if (requiredVersion.charAt(0) === '<') {
                 result.requiresNewer = false;
             } else if (requiredVersion.charAt(0) === '>') {
@@ -277,6 +280,47 @@ define(function (require, exports, module) {
         return result;
     }
     
+    /**
+     * Finds the newest version of the entry that is compatible with the given Brackets API version, if any.
+     * @param {Object} entry The registry entry to check.
+     * @param {string} apiVersion The Brackets API version to check against.
+     * @return {{isCompatible: boolean, requiresNewer: ?boolean, compatibleVersion: ?string, isLatestVersion: boolean}}
+     *      Result contains an "isCompatible" member saying whether it's compatible. If compatible, "compatibleVersion"
+     *      specifies the newest version that is compatible and "isLatestVersion" indicates if this is the absolute
+     *      latest version of the extension or not. If !isCompatible or !isLatestVersion, "requiresNewer" says whether
+     *      the latest version is incompatible due to requiring a newer (vs. older) version of Brackets.
+     */
+    function getCompatibilityInfo(entry, apiVersion) {
+        if (!entry.versions) {
+            var fallback = getCompatibilityInfoForVersion(entry.metadata, apiVersion);
+            if (fallback.isCompatible) {
+                fallback.isLatestVersion = true;
+            }
+            return fallback;
+        }
+        
+        var i = entry.versions.length - 1,
+            latestInfo = getCompatibilityInfoForVersion(entry.versions[i], apiVersion);
+        
+        if (latestInfo.isCompatible) {
+            latestInfo.isLatestVersion = true;
+            return latestInfo;
+        } else {
+            // Look at earlier versions (skipping very latest version since we already checked it)
+            for (i--; i >= 0; i--) {
+                var compatInfo = getCompatibilityInfoForVersion(entry.versions[i], apiVersion);
+                if (compatInfo.isCompatible) {
+                    compatInfo.isLatestVersion = false;
+                    compatInfo.requiresNewer = latestInfo.requiresNewer;
+                    return compatInfo;
+                }
+            }
+            
+            // No version is compatible, so just return info for the latest version
+            return latestInfo;
+        }
+    }
+    
     /**
      * Given an extension id and version number, returns the URL for downloading that extension from
      * the repository. Does not guarantee that the extension exists at that URL.
diff --git a/src/extensibility/ExtensionManagerView.js b/src/extensibility/ExtensionManagerView.js
@@ -29,6 +29,7 @@ define(function (require, exports, module) {
     "use strict";
     
     var Strings                   = require("strings"),
+        StringUtils               = require("utils/StringUtils"),
         NativeApp                 = require("utils/NativeApp"),
         ExtensionManager          = require("extensibility/ExtensionManager"),
         registry_utils            = require("extensibility/registry_utils"),
@@ -193,19 +194,30 @@ define(function (require, exports, module) {
         context.failedToStart = (entry.installInfo && entry.installInfo.status === ExtensionManager.START_FAILED);
         context.hasVersionInfo = !!info.versions;
                 
-        var compatInfo = ExtensionManager.getCompatibilityInfo(info, brackets.metadata.apiVersion);
-        context.isCompatible = compatInfo.isCompatible;
+        if (entry.registryInfo) {
+            var latestVerCompatInfo = ExtensionManager.getCompatibilityInfo(entry.registryInfo, brackets.metadata.apiVersion);
+            context.isCompatible = latestVerCompatInfo.isCompatible;
+            context.requiresNewer = latestVerCompatInfo.requiresNewer;
+            context.isCompatibleLatest = latestVerCompatInfo.isLatestVersion;
+            if (!context.isCompatibleLatest) {
+                var installWarningBase = context.requiresNewer ? Strings.EXTENSION_LATEST_INCOMPATIBLE_NEWER : Strings.EXTENSION_LATEST_INCOMPATIBLE_OLDER;
+                context.installWarning = StringUtils.format(installWarningBase, entry.registryInfo.versions[entry.registryInfo.versions.length - 1].version, latestVerCompatInfo.compatibleVersion);
+            }
+        } else {
+            // We should only get here when viewing the Installed tab and some extensions don't exist in the registry
+            // (or registry is offline). These flags *should* always be ignored in that scenario, but just in case...
+            context.isCompatible = context.isCompatibleLatest = true;
+        }
+        
         context.isMarkedForRemoval = ExtensionManager.isMarkedForRemoval(info.metadata.name);
         context.isMarkedForUpdate = ExtensionManager.isMarkedForUpdate(info.metadata.name);
-        context.requiresNewer = compatInfo.requiresNewer;
         
         context.showInstallButton = (this.model.source === this.model.SOURCE_REGISTRY) && !context.updateAvailable;
         context.showUpdateButton = context.updateAvailable && !context.isMarkedForUpdate && !context.isMarkedForRemoval;
 
         context.allowInstall = context.isCompatible && !context.isInstalled;
         context.allowRemove = (entry.installInfo && entry.installInfo.locationType === ExtensionManager.LOCATION_USER);
-        context.allowUpdate = context.isCompatible && context.isInstalled &&
-            !context.isMarkedForUpdate && !context.isMarkedForRemoval;
+        context.allowUpdate = context.showUpdateButton && context.isCompatible && context.isCompatibleLatest;
 
         context.removalAllowed = this.model.source === "installed" &&
             !context.failedToStart && !context.isMarkedForUpdate && !context.isMarkedForRemoval;
@@ -272,9 +284,10 @@ define(function (require, exports, module) {
     ExtensionManagerView.prototype._installUsingDialog = function (id, _isUpdate) {
         var entry = this.model.extensions[id];
         if (entry && entry.registryInfo) {
-            var url = ExtensionManager.getExtensionURL(id, entry.registryInfo.metadata.version);
+            var compatInfo = ExtensionManager.getCompatibilityInfo(entry.registryInfo, brackets.metadata.apiVersion),
+                url = ExtensionManager.getExtensionURL(id, compatInfo.compatibleVersion);
+            
             // TODO: this should set .done on the returned promise
-
             if (_isUpdate) {
                 InstallExtensionDialog.updateUsingDialog(url).done(ExtensionManager.updateFromDownload);
             } else {
diff --git a/src/htmlContent/extension-manager-view-item.html b/src/htmlContent/extension-manager-view-item.html
@@ -10,12 +10,22 @@
         {{/hasVersionInfo}}
     </td>
     <td class="ext-desc">
-        {{^isCompatible}}
-            <div class="alert warning">
-                {{#requiresNewer}}{{Strings.EXTENSION_INCOMPATIBLE_NEWER}}{{/requiresNewer}}
-                {{^requiresNewer}}{{Strings.EXTENSION_INCOMPATIBLE_OLDER}}{{/requiresNewer}}
-            </div>
-        {{/isCompatible}}
+        {{#showInstallButton}}
+            <!-- Warnings when trying to install extension where latest/all versions not compatible -->
+            {{^isCompatible}}
+                <div class="alert warning">
+                    {{#requiresNewer}}{{Strings.EXTENSION_INCOMPATIBLE_NEWER}}{{/requiresNewer}}
+                    {{^requiresNewer}}{{Strings.EXTENSION_INCOMPATIBLE_OLDER}}{{/requiresNewer}}
+                </div>
+            {{/isCompatible}}
+            {{#isCompatible}}
+                {{^isCompatibleLatest}}
+                    <div class="alert warning">
+                        {{installWarning}}
+                    </div>
+                {{/isCompatibleLatest}}
+            {{/isCompatible}}
+        {{/showInstallButton}}
         {{metadata.description}}
         {{^metadata.description}}
             <p class="muted"><em>{{Strings.EXTENSION_NO_DESCRIPTION}}</em></p>
diff --git a/test/spec/ExtensionManager-test.js b/test/spec/ExtensionManager-test.js
