Give user feedback about download and installation progress

Author: sverhoeven

Desktop/components/JASP/Widgets/ModulesMenu.qml

@@ -372,17 +372,24 @@ FocusScope
 						moduleStore.downloadInProgress = true
 						moduleStore.downloadTotal = request.totalBytes
 						moduleStore.downloadProgress = Qt.binding(function() { return request.receivedBytes; })
+						moduleStore.currentDownloadRequest = request
 						request.accept()
                     }
                     else
                         request.cancel()
                 }
 
                 onDownloadFinished: function(request) {
+					moduleStore.downloadInProgress = false
+					moduleStore.currentDownloadRequest = null
+					if (request.state !== WebEngineDownloadRequest.DownloadCompleted) {
+						console.log("Download interrupted:", request.interruptReasonString)
+						return
+					}
                     console.log("Download finished:", request.downloadFileName)
                     let path = request.downloadDirectory + '/' + request.downloadFileName
+					moduleLibrary.startInstalling()
                     dynamicModules.installJASPModule(path)
-					moduleStore.downloadInProgress = false
                 }
             }
 
@@ -401,6 +408,7 @@ FocusScope
 				property bool	installInProgress: false;
 				property int		downloadProgress;
 				property int		downloadTotal;
+				property var		currentDownloadRequest: null;
 
 				webChannel.registeredObjects:	[ moduleStoreWebChannel ]
 
@@ -441,6 +449,89 @@ FocusScope
 
 		focus: true
 
+		// Progress bar overlay for download and installation
+		Rectangle
+		{
+			id:				progressOverlay
+			anchors.fill:	parent
+			color:			jaspTheme.grayDarker
+			visible:		moduleStore.downloadInProgress || moduleLibrary.isInstalling
+			z:				10
+
+			Column
+			{
+				anchors.centerIn:	parent
+				spacing:			10 * preferencesModel.uiScale
+				width:				300 * preferencesModel.uiScale
+
+				Text
+				{
+					id:					progressText
+					text:				moduleStore.downloadInProgress ? qsTr("Downloading module...") : qsTr("Installing module...")
+					color:				"white"
+					font.pixelSize:		16 * preferencesModel.uiScale
+					anchors.horizontalCenter: parent.horizontalCenter
+				}
+
+				// TODO show progress of installation
+				Rectangle
+				{
+					id:				progressBarBackground
+					width:			parent.width
+					height:			30 * preferencesModel.uiScale
+					color:			jaspTheme.grayDarker
+					border.color:	jaspTheme.uiBorder
+					border.width:	1
+					radius:			3
+					visible:		moduleStore.downloadInProgress
+
+					Rectangle
+					{
+						id:		progressBarFill
+						width:	moduleStore.downloadTotal > 0 ? (parent.width * moduleStore.downloadProgress / moduleStore.downloadTotal) : 0
+						height:	parent.height
+						color:	jaspTheme.blue
+						radius:	parent.radius
+
+						Behavior on width
+						{
+							enabled: preferencesModel.animationsOn
+							PropertyAnimation { duration: 100 }
+						}
+					}
+
+					Text
+					{
+						anchors.centerIn:	parent
+						text:				moduleStore.downloadTotal > 0 ? Math.round((moduleStore.downloadProgress / moduleStore.downloadTotal) * 100) + "%" : "0%"
+						color:				"white"
+						font.pixelSize:		12 * preferencesModel.uiScale
+					}
+				}
+
+				RoundedButton
+				{
+					id:					cancelButton
+					text:				qsTr("Cancel")
+					width:				120 * preferencesModel.uiScale
+					height:				30 * preferencesModel.uiScale
+					anchors.horizontalCenter: parent.horizontalCenter
+					// TODO also allow to cancel installation
+					visible:			moduleStore.downloadInProgress
+
+					onClicked:
+					{
+						if (moduleStore.currentDownloadRequest !== null) {
+							moduleStore.currentDownloadRequest.cancel()
+						}
+						moduleStore.downloadInProgress = false
+						moduleStore.currentDownloadRequest = null
+					}
+					toolTip:			qsTr("Cancel download")
+				}
+			}
+		}
+
 		Item
 		{
 			id:			dropShadow

Desktop/modules/modulelibrary.cpp

@@ -7,6 +7,7 @@
 #include "installedmodules.h"
 #include "dynamicmodules.h"
 #include "dynamicmodule.h"
+#include "engine/enginesync.h"
 #include "utilities/dynamicruntimeinfo.h"
 
 ModuleLibrary * ModuleLibrary::_singleton = nullptr;
@@ -18,12 +19,31 @@ ModuleLibrary::ModuleLibrary(QObject *parent)
 
     if (auto *dynMods = Modules::DynamicModules::dynMods())
     {
-        connect(dynMods, &Modules::DynamicModules::dynamicModuleAdded,      this, [this](Modules::DynamicModule *) { emitEnvironmentInfoChanged(); });
+        connect(dynMods, &Modules::DynamicModules::dynamicModuleAdded,      this, [this](Modules::DynamicModule *) { 
+            emitEnvironmentInfoChanged(); 
+            finishInstalling();
+        });
         connect(dynMods, &Modules::DynamicModules::dynamicModuleChanged,    this, [this](Modules::DynamicModule *) { emitEnvironmentInfoChanged(); });
-        connect(dynMods, &Modules::DynamicModules::dynamicModuleReplaced,   this, [this](Modules::DynamicModule *, Modules::DynamicModule *) { emitEnvironmentInfoChanged(); });
-        // TODO there is a timing issue here, the dynamicModuleUninstalled signal is emitted before the module is fully uninstalled,
-        // causing UI to update too early and show the module as still installed.
-        connect(dynMods, &Modules::DynamicModules::dynamicModuleUninstalled,this, [this](const QString &) { emitEnvironmentInfoChanged(); });
+        connect(dynMods, &Modules::DynamicModules::dynamicModuleReplaced,   this, [this](Modules::DynamicModule *, Modules::DynamicModule *) { emitEnvironmentInfoChanged(); });       
+    }
+    if (auto *engineSync = EngineSync::singleton())
+    {
+        connect(engineSync, &EngineSync::moduleInstallationSucceeded, this, [this]() {
+            emitEnvironmentInfoChanged(); 
+            finishInstalling(); 
+        });
+        connect(engineSync, &EngineSync::moduleInstallationFailed, this, [this](const QString &, const QString &) {
+            emitEnvironmentInfoChanged(); 
+            finishInstalling(); 
+        });
+        connect(engineSync, &EngineSync::moduleUninstallationSucceeded, this, [this]() {
+            emitEnvironmentInfoChanged(); 
+            finishInstalling(); 
+        });
+        connect(engineSync, &EngineSync::moduleUninstallationFailed, this, [this](const QString &, const QString &) {
+            emitEnvironmentInfoChanged(); 
+            finishInstalling(); 
+        });
     }
 
     if (auto *prefs = PreferencesModel::prefs())
@@ -82,3 +102,15 @@ void ModuleLibrary::emitEnvironmentInfoChanged()
 {
     emit environmentInfoChanged(getEnvironmentInfo());
 }
+
+void ModuleLibrary::startInstalling()
+{
+    _isInstalling = true;
+    emit isInstallingChanged();
+}
+
+void ModuleLibrary::finishInstalling()
+{
+    _isInstalling = false;
+    emit isInstallingChanged();
+}

Desktop/modules/modulelibrary.h

@@ -31,6 +31,7 @@ class DynamicModule;
 class ModuleLibrary : public QObject
 {
     Q_OBJECT
+    Q_PROPERTY(bool isInstalling READ isInstalling NOTIFY isInstallingChanged)
 
 public:
     explicit ModuleLibrary(QObject *parent = 0);
@@ -39,16 +40,22 @@ class ModuleLibrary : public QObject
 
     Q_INVOKABLE QVariantMap getEnvironmentInfo() const;
     Q_INVOKABLE void uninstallJASPModule(const QString &moduleName);
+    Q_INVOKABLE void startInstalling();
+    Q_INVOKABLE void finishInstalling();
+
+    bool isInstalling() const { return _isInstalling; }
 
 signals:
     void environmentInfoChanged(const QVariantMap &environmentInfo);
+    void isInstallingChanged();
 
 private:
     QVariantMap installedModulesInfo() const;
     void emitEnvironmentInfoChanged();
 
 private:
     static ModuleLibrary *_singleton;
+    bool _isInstalling = false;
 };
 
 #endif // MODULELIBRARY_H