fix(extensions): fix an issue with extensions with expired licenses (#2628)

* fix(extensions): fix an issue with extensions with expired licenses * fix(api): fix invalid log call * fix(api): allow to re-enable an extension
2019-01-18 10:00:18 +13:00 · 2019-01-18 10:00:18 +13:00 · 54163e3b92
parent 62eb47b3cb
commit 54163e3b92
12 changed files with 48 additions and 24 deletions
--- a/api/bolt/datastore.go
+++ b/api/bolt/datastore.go
@ -139,6 +139,7 @@ func (store *Store) MigrateData() error {
 			DatabaseVersion:        version,
 			EndpointGroupService:   store.EndpointGroupService,
 			EndpointService:        store.EndpointService,
+			ExtensionService:       store.ExtensionService,
 			ResourceControlService: store.ResourceControlService,
 			SettingsService:        store.SettingsService,
 			StackService:           store.StackService,
--- a/api/bolt/migrator/migrate_dbversion16.go
+++ b/api/bolt/migrator/migrate_dbversion16.go
@ -0,0 +1,19 @@
+package migrator
+
+func (m *Migrator) updateExtensionsToDBVersion17() error {
+	legacyExtensions, err := m.extensionService.Extensions()
+	if err != nil {
+		return err
+	}
+
+	for _, extension := range legacyExtensions {
+		extension.License.Valid = true
+
+		err = m.extensionService.Persist(&extension)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
--- a/api/bolt/migrator/migrator.go
+++ b/api/bolt/migrator/migrator.go
@ -5,6 +5,7 @@ import (
 	"github.com/portainer/portainer"
 	"github.com/portainer/portainer/bolt/endpoint"
 	"github.com/portainer/portainer/bolt/endpointgroup"
+	"github.com/portainer/portainer/bolt/extension"
 	"github.com/portainer/portainer/bolt/resourcecontrol"
 	"github.com/portainer/portainer/bolt/settings"
 	"github.com/portainer/portainer/bolt/stack"
@ -20,6 +21,7 @@ type (
 		db                     *bolt.DB
 		endpointGroupService   *endpointgroup.Service
 		endpointService        *endpoint.Service
+		extensionService       *extension.Service
 		resourceControlService *resourcecontrol.Service
 		settingsService        *settings.Service
 		stackService           *stack.Service
@ -35,6 +37,7 @@ type (
 		DatabaseVersion        int
 		EndpointGroupService   *endpointgroup.Service
 		EndpointService        *endpoint.Service
+		ExtensionService       *extension.Service
 		ResourceControlService *resourcecontrol.Service
 		SettingsService        *settings.Service
 		StackService           *stack.Service
@ -52,6 +55,7 @@ func NewMigrator(parameters *Parameters) *Migrator {
 		currentDBVersion:       parameters.DatabaseVersion,
 		endpointGroupService:   parameters.EndpointGroupService,
 		endpointService:        parameters.EndpointService,
+		extensionService:       parameters.ExtensionService,
 		resourceControlService: parameters.ResourceControlService,
 		settingsService:        parameters.SettingsService,
 		templateService:        parameters.TemplateService,
@ -210,5 +214,12 @@ func (m *Migrator) Migrate() error {
 		}
 	}

+	if m.currentDBVersion < 17 {
+		err := m.updateExtensionsToDBVersion17()
+		if err != nil {
+			return err
+		}
+	}
+
 	return m.versionService.StoreDBVersion(portainer.DBVersion)
 }
--- a/api/cmd/portainer/main.go
+++ b/api/cmd/portainer/main.go
@ -486,7 +486,10 @@ func initExtensionManager(fileService portainer.FileService, extensionService po
 	for _, extension := range extensions {
 		err := extensionManager.EnableExtension(&extension, extension.License.LicenseKey)
 		if err != nil {
-			return nil, err
+			log.Printf("Unable to enable extension: %s [extension: %s]", err.Error(), extension.Name)
+			extension.Enabled = false
+			extension.License.Valid = false
+			extensionService.Persist(&extension)
 		}
 	}

--- a/api/exec/extension.go
+++ b/api/exec/extension.go
@ -113,6 +113,7 @@ func (manager *ExtensionManager) EnableExtension(extension *portainer.Extension,
 		LicenseKey: licenseKey,
 		Company:    licenseDetails[0],
 		Expiration: licenseDetails[1],
+		Valid:      true,
 	}
 	extension.Version = licenseDetails[2]

--- a/api/http/handler/extensions/extension_create.go
+++ b/api/http/handler/extensions/extension_create.go
@ -42,7 +42,7 @@ func (handler *Handler) extensionCreate(w http.ResponseWriter, r *http.Request)
 	}

 	for _, existingExtension := range extensions {
-		if existingExtension.ID == extensionID {
+		if existingExtension.ID == extensionID && existingExtension.Enabled {
 			return &httperror.HandlerError{http.StatusConflict, "Unable to enable extension", portainer.ErrExtensionAlreadyEnabled}
 		}
 	}
--- a/api/http/handler/extensions/extension_list.go
+++ b/api/http/handler/extensions/extension_list.go
@ -42,6 +42,7 @@ func associateExtensionData(definition *portainer.Extension, extensions []portai
 			definition.Enabled = extension.Enabled
 			definition.License.Company = extension.License.Company
 			definition.License.Expiration = extension.License.Expiration
+			definition.License.Valid = extension.License.Valid

 			definitionVersion := semver.New(definition.Version)
 			extensionVersion := semver.New(extension.Version)
--- a/api/portainer.go
+++ b/api/portainer.go
@ -503,6 +503,7 @@ type (
 		LicenseKey string `json:"LicenseKey,omitempty"`
 		Company    string `json:"Company,omitempty"`
 		Expiration string `json:"Expiration,omitempty"`
+		Valid      bool   `json:"Valid,omitempty"`
 	}

 	// CLIService represents a service for managing CLI
@ -780,7 +781,7 @@ const (
 	// APIVersion is the version number of the Portainer API
 	APIVersion = "1.20.0"
 	// DBVersion is the version number of the Portainer database
-	DBVersion = 16
+	DBVersion = 17
 	// AssetsServerURL represents the URL of the Portainer asset server
 	AssetsServerURL = "https://portainer-io-assets.sfo2.digitaloceanspaces.com"
 	// MessageOfTheDayURL represents the URL where Portainer MOTD message can be retrieved
--- a/app/portainer/components/extension-list/extension-item/extensionItem.html
+++ b/app/portainer/components/extension-list/extension-item/extensionItem.html
@ -21,10 +21,10 @@
        </span>
        <span>
          <span class="label label-primary" ng-if="!$ctrl.model.Enabled && !$ctrl.model.Available">coming soon</span>
-          <span class="label label-warning" ng-if="!$ctrl.model.Enabled && $ctrl.model.Deal">deal</span>
-          <span class="label label-danger" ng-if="$ctrl.model.Enabled && $ctrl.model.Expired">expired</span>
-          <span class="label label-success" ng-if="$ctrl.model.Enabled && !$ctrl.model.Expired">enabled</span>
-          <span class="label label-primary" ng-if="$ctrl.model.Enabled && $ctrl.model.UpdateAvailable && !$ctrl.model.Expired">update available</span>
+          <span class="label label-warning" ng-if="!$ctrl.model.Enabled && $ctrl.model.Deal && !$ctrl.model.License.Expiration">deal</span>
+          <span class="label label-danger" ng-if="!$ctrl.model.Enabled && $ctrl.model.License.Expiration && !$ctrl.model.License.Valid">expired</span>
+          <span class="label label-success" ng-if="$ctrl.model.Enabled && $ctrl.model.License.Valid">enabled</span>
+          <span class="label label-primary" ng-if="$ctrl.model.Enabled && $ctrl.model.License.Valid && $ctrl.model.UpdateAvailable">update available</span>
        </span>
      </div>
      <!-- !blocklist-item-line1 -->
--- a/app/portainer/components/extension-list/extension-item/extensionItemController.js
+++ b/app/portainer/components/extension-list/extension-item/extensionItemController.js
@ -3,7 +3,6 @@ angular.module('portainer.app')
    function($state) {

      var ctrl = this;
-      ctrl.$onInit = $onInit;
      ctrl.goToExtensionView = goToExtensionView;

      function goToExtensionView() {
@ -11,10 +10,4 @@ angular.module('portainer.app')
          $state.go('portainer.extensions.extension', { id: ctrl.model.Id });
        }
      }
-
-      function $onInit() {
-        if (ctrl.currentDate === ctrl.model.License.Expiration) {
-          ctrl.model.Expired = true;
-        }
-      }
    }]);
--- a/app/portainer/components/product-list/product-item/productItem.html
+++ b/app/portainer/components/product-list/product-item/productItem.html
@ -3,7 +3,7 @@
  <div class="blocklist-item-box">
    <!-- extension-image -->
    <span class="blocklist-item-logo">
-      <img class="blocklist-item-logo" src="images/support_{{ $ctrl.model.Id }}.png" />
+      <img class="blocklist-item-logo" ng-src="images/support_{{ $ctrl.model.Id }}.png" />
    </span>
    <!-- !extension-image -->
    <!-- extension-details -->
@ -15,11 +15,6 @@
            {{ $ctrl.model.Name }}
          </span>
        </span>
-        <span>
-          <span class="label label-danger" ng-if="$ctrl.model.Enabled && $ctrl.model.Expired">expired</span>
-          <span class="label label-success" ng-if="$ctrl.model.Enabled && !$ctrl.model.Expired">enabled</span>
-          <span class="label label-primary" ng-if="$ctrl.model.Enabled && $ctrl.model.UpdateAvailable && !$ctrl.model.Expired">update available</span>
-        </span>
      </div>
      <!-- !blocklist-item-line1 -->
      <!-- blocklist-item-line2 -->
@ -29,9 +24,6 @@
            {{ $ctrl.model.ShortDescription }}
          </span>
        </span>
-        <span ng-if="$ctrl.model.License.Company">
-          <span class="small text-muted">Licensed to {{ $ctrl.model.License.Company }} - Expires on {{ $ctrl.model.License.Expiration }}</span>
-        </span>
      </div>
      <!-- !blocklist-item-line2 -->
    </span>
--- a/app/portainer/views/extensions/inspect/extension.html
+++ b/app/portainer/views/extensions/inspect/extension.html
@ -36,7 +36,9 @@
            <div class="form-group" style="margin-left: 40px;">

              <div style="font-size: 125%; border-bottom: 2px solid #2d3e63; padding-bottom: 5px;">
-                {{ extension.Enabled ? 'Enabled' : extension.Price }}
+                <span ng-if="extension.Enabled">Enabled</span>
+                <span ng-if="!extension.Enabled && extension.License.Expiration && !extension.License.Valid">Expired</span>
+                <span ng-if="!extension.Enabled && !extension.License.Expiration">{{ extension.Price }}</span>
              </div>

              <div class="small text-muted col-sm-12" style="margin: 15px 0 15px 0;" ng-if="!extension.Enabled">