Update module informations when db changes (#30)

* Update module informations when db changes
* Better display long ongoing operations (fix #21)
* Asynchrone version loader

Author: domi4484

oqtopus/core/module_version_loader.py

@@ -0,0 +1,42 @@
+from enum import Enum
+
+from qgis.PyQt.QtCore import QThread
+
+
+class ModuleVersionLoaderCanceled(Exception):
+    pass
+
+
+class ModuleVersionLoader(QThread):
+
+    class Mode(Enum):
+        NORMAL = 1
+        DEVELOPMENT = 2
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.__module = None
+        self.__mode = self.Mode.NORMAL
+
+        self.lastError = None
+
+    def start_load_versions(self, module, mode: Mode = Mode.NORMAL):
+        if self.isRunning():
+            self.cancel()
+            self.wait()
+
+        self.__module = module
+        self.__mode = mode
+
+        self.start()
+
+    def run(self):
+        self.lastError = None
+        try:
+            if self.__mode == self.Mode.NORMAL:
+                self.__module.load_versions()
+            elif self.__mode == self.Mode.DEVELOPMENT:
+                self.__module.load_development_versions()
+
+        except Exception as e:
+            self.lastError = e

oqtopus/gui/about_dialog.py

@@ -53,6 +53,9 @@ def __init__(self, parent=None):
         self.qgisMinimumVersionLabel.setText(qgisMinimumVersion)
 
         scaled_logo = QPixmap(PluginUtils.get_plugin_icon_path("oqtopus-logo.png")).scaled(
-            254, 254, aspectRatioMode=1, transformMode=Qt.TransformationMode.SmoothTransformation
+            254,
+            254,
+            aspectRatioMode=Qt.AspectRatioMode.KeepAspectRatio,
+            transformMode=Qt.TransformationMode.SmoothTransformation,
         )
         self.iconLabel.setPixmap(scaled_logo)

oqtopus/gui/module_selection_widget.py

@@ -1,9 +1,13 @@
 from qgis.PyQt.QtCore import Qt, QUrl, pyqtSignal
 from qgis.PyQt.QtGui import QDesktopServices
-from qgis.PyQt.QtWidgets import QFileDialog, QMessageBox, QWidget
+from qgis.PyQt.QtWidgets import QApplication, QFileDialog, QMessageBox, QWidget
 
 from ..core.module import Module
 from ..core.module_package import ModulePackage
+from ..core.module_version_loader import (
+    ModuleVersionLoader,
+    ModuleVersionLoaderCanceled,
+)
 from ..core.package_prepare_task import PackagePrepareTask, PackagePrepareTaskCanceled
 from ..utils.plugin_utils import PluginUtils, logger
 from ..utils.qt_utils import CriticalMessageBox, OverrideCursor, QtUtils
@@ -49,13 +53,19 @@ def __init__(self, modules_config, parent=None):
         self.module_seeChangeLog_pushButton.clicked.connect(self.__seeChangeLogClicked)
         self.module_browseZip_toolButton.clicked.connect(self.__moduleBrowseZipClicked)
 
+        self.__version_loader = ModuleVersionLoader(self)
+        self.__version_loader.finished.connect(self.__loadVersionsFinished)
+
         self.__packagePrepareTask = PackagePrepareTask(self)
         self.__packagePrepareTask.finished.connect(self.__packagePrepareTaskFinished)
         self.__packagePrepareTask.signalPackagingProgress.connect(
             self.__packagePrepareTaskProgress
         )
 
     def close(self):
+        if self.__version_loader.isRunning():
+            self.__version_loader.wait()
+
         if self.__packagePrepareTask.isRunning():
             self.__packagePrepareTask.cancel()
             self.__packagePrepareTask.wait()
@@ -83,64 +93,13 @@ def __moduleChanged(self, index):
         if self.__current_module is None:
             return
 
-        try:
-            with OverrideCursor(Qt.CursorShape.WaitCursor):
-                if self.__current_module.versions == list():
-                    self.__current_module.load_versions()
-
-                for module_package in self.__current_module.versions:
-                    self.module_package_comboBox.addItem(
-                        module_package.display_name(), module_package
-                    )
-
-                if self.__current_module.latest_version is not None:
-                    self.module_latestVersion_label.setText(
-                        f"Latest: {self.__current_module.latest_version.name}"
-                    )
-
-        except Exception as exception:
-            error_message = str(exception)
-            if "rate limit exceeded for url" in error_message.lower():
-                CriticalMessageBox(
-                    self.tr("GitHub API Rate Limit Exceeded"),
-                    self.tr(
-                        "Oqtopus needs to download release data from GitHub to work properly.<br><br>"
-                        "GitHub limits the number of requests that can be made without authentication. "
-                        "You have reached the maximum number of requests allowed for unauthenticated users.<br><br>"
-                        "To continue using this feature, please create a free GitHub personal access token and enter it in the Settings dialog.<br><br>"
-                        "This will increase your request limit.<br><br>"
-                        "<b>How to get a token:</b><br>"
-                        "1. Go to <a href='https://github.com/settings/tokens'>GitHub Personal Access Tokens</a>.<br>"
-                        "2. Click <b>Generate new token</b> and select the <code>repo</code> scope.<br>"
-                        "3. Copy the generated token and paste it in the Settings dialog of this application."
-                    ),
-                    exception,
-                    self,
-                ).exec()
-            else:
-                CriticalMessageBox(
-                    self.tr("Error"), self.tr("Can't load module versions:"), exception, self
-                ).exec()
-            return
-
-        self.module_package_comboBox.insertSeparator(self.module_package_comboBox.count())
-        self.module_package_comboBox.addItem(
-            self.tr("Load from ZIP file"),
-            ModulePackage(
-                module=self.__current_module,
-                organisation=self.__current_module.organisation,
-                repository=self.__current_module.repository,
-                json_payload=None,
-                type=ModulePackage.Type.FROM_ZIP,
-            ),
-        )
-
-        self.module_package_comboBox.insertSeparator(self.module_package_comboBox.count())
-        self.module_package_comboBox.addItem(
-            self.tr("Load development branches"), self.module_package_SPECIAL_LOAD_DEVELOPMENT
-        )
+        self.module_progressBar.setVisible(True)
+        QApplication.processEvents()
 
-        logger.info(f"Versions loaded for module '{self.__current_module.name}'.")
+        if self.__current_module.versions == list():
+            self.__version_loader.start_load_versions(
+                module=self.__current_module, mode=ModuleVersionLoader.Mode.NORMAL
+            )
 
     def __moduleVersionChanged(self, index):
 
@@ -311,3 +270,87 @@ def __seeChangeLogClicked(self):
         changelog_url = self.__current_module_package.html_url
         logger.info(f"Opening changelog URL: {changelog_url}")
         QDesktopServices.openUrl(QUrl(changelog_url))
+
+    def __loadVersionsFinished(self):
+        logger.info("Loading versions finished")
+
+        self.signal_loadingFinished.emit()
+        self.module_progressBar.setVisible(False)
+
+        if isinstance(self.__version_loader.lastError, ModuleVersionLoaderCanceled):
+            logger.info("Load versions task was canceled by user.")
+            self.module_information_label.setText(self.tr("Versions loading canceled."))
+            QtUtils.setForegroundColor(self.module_information_label, PluginUtils.COLOR_WARNING)
+            return
+
+        if self.__version_loader.lastError is not None:
+            error_text = self.tr("Can't load module versions:")
+            CriticalMessageBox(
+                self.tr("Error"), error_text, self.__version_loader.lastError, self
+            ).exec()
+            self.module_information_label.setText(error_text)
+            QtUtils.setForegroundColor(self.module_information_label, PluginUtils.COLOR_WARNING)
+            return
+
+        try:
+            with OverrideCursor(Qt.CursorShape.WaitCursor):
+                QApplication.processEvents()
+
+                if self.__current_module.versions == list():
+                    self.__version_loader.start_load_versions()
+
+                for module_package in self.__current_module.versions:
+                    self.module_package_comboBox.addItem(
+                        module_package.display_name(), module_package
+                    )
+
+                if self.__current_module.latest_version is not None:
+                    self.module_latestVersion_label.setText(
+                        f"Latest: {self.__current_module.latest_version.name}"
+                    )
+
+        except Exception as exception:
+            self.module_progressBar.setVisible(False)
+            error_message = str(exception)
+            if "rate limit exceeded for url" in error_message.lower():
+                CriticalMessageBox(
+                    self.tr("GitHub API Rate Limit Exceeded"),
+                    self.tr(
+                        "Oqtopus needs to download release data from GitHub to work properly.<br><br>"
+                        "GitHub limits the number of requests that can be made without authentication. "
+                        "You have reached the maximum number of requests allowed for unauthenticated users.<br><br>"
+                        "To continue using this feature, please create a free GitHub personal access token and enter it in the Settings dialog.<br><br>"
+                        "This will increase your request limit.<br><br>"
+                        "<b>How to get a token:</b><br>"
+                        "1. Go to <a href='https://github.com/settings/tokens'>GitHub Personal Access Tokens</a>.<br>"
+                        "2. Click <b>Generate new token</b> and select the <code>repo</code> scope.<br>"
+                        "3. Copy the generated token and paste it in the Settings dialog of this application."
+                    ),
+                    exception,
+                    self,
+                ).exec()
+            else:
+                CriticalMessageBox(
+                    self.tr("Error"), self.tr("Can't load module versions:"), exception, self
+                ).exec()
+            return
+
+        self.module_package_comboBox.insertSeparator(self.module_package_comboBox.count())
+        self.module_package_comboBox.addItem(
+            self.tr("Load from ZIP file"),
+            ModulePackage(
+                module=self.__current_module,
+                organisation=self.__current_module.organisation,
+                repository=self.__current_module.repository,
+                json_payload=None,
+                type=ModulePackage.Type.FROM_ZIP,
+            ),
+        )
+
+        self.module_package_comboBox.insertSeparator(self.module_package_comboBox.count())
+        self.module_package_comboBox.addItem(
+            self.tr("Load development branches"), self.module_package_SPECIAL_LOAD_DEVELOPMENT
+        )
+
+        self.module_progressBar.setVisible(False)
+        logger.info(f"Versions loaded for module '{self.__current_module.name}'.")

oqtopus/gui/module_widget.py

@@ -35,9 +35,11 @@ def __init__(self, parent=None):
     def setModulePackage(self, module_package: Module):
         self.__current_module_package = module_package
         self.__packagePrepareGetPUMConfig()
+        self.__updateModuleInfo()
 
     def setDatabaseConnection(self, connection: psycopg.Connection):
         self.__database_connection = connection
+        self.__updateModuleInfo()
 
     def __packagePrepareGetPUMConfig(self):
         package_dir = self.__current_module_package.package_dir
@@ -85,28 +87,6 @@ def __packagePrepareGetPUMConfig(self):
         for demo_data_name, demo_data_file in self.__pum_config.demo_data().items():
             self.db_demoData_comboBox.addItem(demo_data_name, demo_data_file)
 
-        sm = SchemaMigrations(self.__pum_config)
-        migrationVersion = "0.0.0"
-        if not self.__database_connection:
-            self.moduleInfo_label.setText(self.tr("No database connection available"))
-            QtUtils.setForegroundColor(self.moduleInfo_label, PluginUtils.COLOR_WARNING)
-        elif sm.exists(self.__database_connection):
-            baseline_version = sm.baseline(self.__database_connection)
-            self.moduleInfo_label.setText(self.tr(f"Version {baseline_version} found"))
-            QtUtils.resetForegroundColor(self.moduleInfo_label)
-            self.moduleInfo_upgrade_pushButton.setText(self.tr(f"Upgrade to {migrationVersion}"))
-
-            self.moduleInfo_stackedWidget.setCurrentWidget(
-                self.moduleInfo_stackedWidget_pageUpgrade
-            )
-        else:
-            self.moduleInfo_label.setText(self.tr("No module found"))
-            QtUtils.resetForegroundColor(self.moduleInfo_label)
-            self.moduleInfo_install_pushButton.setText(self.tr(f"Install {migrationVersion}"))
-            self.moduleInfo_stackedWidget.setCurrentWidget(
-                self.moduleInfo_stackedWidget_pageInstall
-            )
-
     def __installModuleClicked(self):
 
         if self.__current_module_package is None:
@@ -165,10 +145,55 @@ def __installModuleClicked(self):
             f"Module '{self.__current_module_package.module.name}' version '{self.__current_module_package.name}' has been successfully installed."
         )
 
+        self.__updateModuleInfo()
+
     def __upgradeModuleClicked(self):
         QMessageBox.critical(
             self,
             self.tr("Not implemented"),
             self.tr("Upgrade module is not implemented yet."),
         )
         return
+
+    def __updateModuleInfo(self):
+        if self.__current_module_package is None:
+            self.moduleInfo_label.setText(self.tr("No module package selected"))
+            QtUtils.setForegroundColor(self.moduleInfo_label, PluginUtils.COLOR_WARNING)
+            return
+
+        if self.__database_connection is None:
+            self.moduleInfo_label.setText(self.tr("No database connection available"))
+            QtUtils.setForegroundColor(self.moduleInfo_label, PluginUtils.COLOR_WARNING)
+            return
+
+        if self.__pum_config is None:
+            self.moduleInfo_label.setText(self.tr("No PUM config available"))
+            QtUtils.setForegroundColor(self.moduleInfo_label, PluginUtils.COLOR_WARNING)
+            return
+
+        migrationVersion = self.__pum_config.last_version()
+        sm = SchemaMigrations(self.__pum_config)
+
+        if sm.exists(self.__database_connection):
+            # Case upgrade
+            baseline_version = sm.baseline(self.__database_connection)
+            self.moduleInfo_label.setText(self.tr(f"Version {baseline_version} found"))
+            QtUtils.resetForegroundColor(self.moduleInfo_label)
+            self.moduleInfo_upgrade_pushButton.setText(self.tr(f"Upgrade to {migrationVersion}"))
+
+            self.moduleInfo_stackedWidget.setCurrentWidget(
+                self.moduleInfo_stackedWidget_pageUpgrade
+            )
+
+            logger.info(
+                f"Migration table details: {sm.migration_details(self.__database_connection)}"
+            )
+
+        else:
+            # Case install
+            self.moduleInfo_label.setText(self.tr("No module found"))
+            QtUtils.resetForegroundColor(self.moduleInfo_label)
+            self.moduleInfo_install_pushButton.setText(self.tr(f"Install {migrationVersion}"))
+            self.moduleInfo_stackedWidget.setCurrentWidget(
+                self.moduleInfo_stackedWidget_pageInstall
+            )