✨ Study from Template: Show messages and progress (ITISFoundation#3354)

Author: odeimaiz

services/storage/src/simcore_service_storage/simcore_s3_dsm.py

@@ -416,7 +416,7 @@ async def deep_copy_project_simcore_s3(
         src_project_uuid: ProjectID = ProjectID(src_project["uuid"])
         dst_project_uuid: ProjectID = ProjectID(dst_project["uuid"])
         # Step 1: check access rights (read of src and write of dst)
-        update_task_progress(task_progress, "Checking project access rights...")
+        update_task_progress(task_progress, "Checking study access rights...")
         async with self.engine.acquire() as conn:
             for prj_uuid in [src_project_uuid, dst_project_uuid]:
                 if not await db_projects.project_exists(conn, prj_uuid):
@@ -438,7 +438,7 @@ async def deep_copy_project_simcore_s3(
 
         # Step 2: start copying by listing what to copy
         update_task_progress(
-            task_progress, f"Getting all files of project '{src_project_uuid}'..."
+            task_progress, f"Collecting files of '{src_project['name']}'..."
         )
         async with self.engine.acquire() as conn:
             src_project_files: list[
@@ -455,7 +455,7 @@ async def deep_copy_project_simcore_s3(
         s3_transfered_data_cb = S3TransferDataCB(
             task_progress,
             src_project_total_data_size,
-            task_progress_message_prefix=f"Copying {len(src_project_files)} files of project '{src_project_uuid}'",
+            task_progress_message_prefix=f"Copying {len(src_project_files)} files to '{dst_project['name']}'",
         )
         for src_fmd in src_project_files:
             if not src_fmd.node_id or (src_fmd.location_id != self.location_id):

services/web/client/source/class/osparc/dashboard/StudyBrowser.js

@@ -379,7 +379,7 @@ qx.Class.define("osparc.dashboard.StudyBrowser", {
       const title = osparc.utils.Utils.getUniqueStudyName(templateData.name, this.__studies);
       templateData.name = title;
       this._showLoadingPage(this.tr("Creating ") + (templateData.name || this.tr("Study")));
-      osparc.utils.Study.createStudyFromTemplate(templateData)
+      osparc.utils.Study.createStudyFromTemplate(templateData, this._loadingPage)
         .then(studyId => {
           this._hideLoadingPage();
           this.__getStudyAndStart(studyId);

services/web/client/source/class/osparc/dashboard/TemplateBrowser.js

@@ -227,7 +227,7 @@ qx.Class.define("osparc.dashboard.TemplateBrowser", {
       }
 
       this._showLoadingPage(this.tr("Creating ") + (templateData.name || this.tr("Study")));
-      osparc.utils.Study.createStudyFromTemplate(templateData)
+      osparc.utils.Study.createStudyFromTemplate(templateData, this._loadingPage)
         .then(studyId => {
           this._hideLoadingPage();
           this.__startStudy(studyId, templateData);

services/web/client/source/class/osparc/data/PollTask.js

@@ -39,6 +39,7 @@ qx.Class.define("osparc.data.PollTask", {
   },
 
   events: {
+    "updateReceived": "qx.event.type.Data",
     "resultReceived": "qx.event.type.Data",
     "pollingError": "qx.event.type.Data"
   },
@@ -92,6 +93,7 @@ qx.Class.define("osparc.data.PollTask", {
           const done = response["done"];
           this.setDone(done);
           if (done === false) {
+            this.fireDataEvent("updateReceived", response);
             // keep polling
             setTimeout(() => this.__pollTaskState(), this.getPollInterval());
           }

services/web/client/source/class/osparc/data/model/Node.js

@@ -1155,6 +1155,7 @@ qx.Class.define("osparc.data.model.Node", {
           break;
       }
     },
+
     __nodeState: function() {
       // Check if study is still there
       if (this.getStudy() === null || this.__stopRequestingStatus === true) {
@@ -1174,24 +1175,31 @@ qx.Class.define("osparc.data.model.Node", {
       osparc.data.Resources.fetch("studies", "getNode", params)
         .then(data => this.__onNodeState(data))
         .catch(err => {
-          if ("status" in err && err.status === 503 && this.__unresponsiveRetries > 0) {
-            this.__unresponsiveRetries--;
-            const interval = Math.floor(Math.random() * 5000) + 3000;
-            console.log(this.getNodeId(), "node unresponive, trying again in", interval, this.__unresponsiveRetries);
-            setTimeout(() => this.__nodeState(), interval);
-            return;
-          }
-          const errorMsg = "Error when retrieving " + this.getKey() + ":" + this.getVersion() + " status: " + err;
+          const errorMsg = `Error retrieving ${this.getLabel()} status: ${err}`;
           const errorMsgData = {
             nodeId: this.getNodeId(),
             msg: errorMsg,
             level: "ERROR"
           };
           this.fireDataEvent("showInLogger", errorMsgData);
-          this.getStatus().setInteractive("failed");
-          osparc.component.message.FlashMessenger.getInstance().logAs(this.tr("There was an error while starting the node."), "ERROR");
+          if (this.__unresponsiveRetries > 0) {
+            const retryMsg = `Retrying (${this.__unresponsiveRetries})`;
+            const retryMsgData = {
+              nodeId: this.getNodeId(),
+              msg: retryMsg,
+              level: "ERROR"
+            };
+            this.fireDataEvent("showInLogger", retryMsgData);
+            this.__unresponsiveRetries--;
+            const interval = Math.floor(Math.random() * 5000) + 3000;
+            setTimeout(() => this.__nodeState(), interval);
+          } else {
+            this.getStatus().setInteractive("failed");
+            osparc.component.message.FlashMessenger.getInstance().logAs(this.tr("There was an error while starting the node."), "ERROR");
+          }
         });
     },
+
     __onInteractiveNodeStarted: function(e) {
       let req = e.getTarget();
       const {

services/web/client/source/class/osparc/ui/basic/LoadingPageHandler.js

@@ -23,28 +23,28 @@ qx.Class.define("osparc.ui.basic.LoadingPageHandler", {
   type: "abstract",
 
   members: {
-    __loadingIFrame: null,
+    _loadingPage: null,
 
     _showLoadingPage: function(label) {
       this._hideLoadingPage();
 
       this._showMainLayout(false);
 
-      if (this.__loadingIFrame === null) {
-        this.__loadingIFrame = new osparc.ui.message.Loading(label);
+      if (this._loadingPage === null) {
+        this._loadingPage = new osparc.ui.message.Loading(label);
       } else {
-        this.__loadingIFrame.setHeader(label);
+        this._loadingPage.setHeader(label);
       }
-      this._add(this.__loadingIFrame, {
+      this._add(this._loadingPage, {
         flex: 1
       });
     },
 
     _hideLoadingPage: function() {
-      if (this.__loadingIFrame) {
-        const idx = this._indexOf(this.__loadingIFrame);
+      if (this._loadingPage) {
+        const idx = this._indexOf(this._loadingPage);
         if (idx !== -1) {
-          this._remove(this.__loadingIFrame);
+          this._remove(this._loadingPage);
         }
       }
 

services/web/client/source/class/osparc/ui/message/Loading.js

@@ -75,6 +75,10 @@ qx.Class.define("osparc.ui.message.Loading", {
     "maximize" : "qx.event.type.Event"
   },
 
+  statics: {
+    LOGO_WIDTH: 260
+  },
+
   members: {
     __header: null,
     __messages: null,
@@ -83,7 +87,7 @@ qx.Class.define("osparc.ui.message.Loading", {
 
     __buildLayout: function(showMaximize) {
       const image = new osparc.ui.basic.Logo().set({
-        width: 260,
+        width: this.self().LOGO_WIDTH,
         height: 110
       });
 
@@ -153,6 +157,9 @@ qx.Class.define("osparc.ui.message.Loading", {
       });
     },
 
+    addWidgetToMessages: function(widget) {
+      this.__messages.add(widget);
+    },
 
 
     // from osparc.component.widget.PersistentIframe

services/web/client/source/class/osparc/utils/Study.js

@@ -178,7 +178,7 @@ qx.Class.define("osparc.utils.Study", {
       });
     },
 
-    createStudyFromTemplate: function(templateData) {
+    createStudyFromTemplate: function(templateData, loadingPage) {
       return new Promise((resolve, reject) => {
         const store = osparc.store.Store.getInstance();
         store.getInaccessibleServices(templateData)
@@ -205,6 +205,18 @@ qx.Class.define("osparc.utils.Study", {
             const interval = 1000;
             pollTasks.createPollingTask(fetchPromise, interval)
               .then(task => {
+                task.addListener("updateReceived", e => {
+                  const updateData = e.getData();
+                  if ("task_progress" in updateData && loadingPage) {
+                    const progress = updateData["task_progress"];
+                    loadingPage.setMessages([progress["message"]]);
+                    const pBar = new qx.ui.indicator.ProgressBar(progress["percent"], 1).set({
+                      width: osparc.ui.message.Loading.LOGO_WIDTH,
+                      maxWidth: osparc.ui.message.Loading.LOGO_WIDTH
+                    });
+                    loadingPage.addWidgetToMessages(pBar);
+                  }
+                }, this);
                 task.addListener("resultReceived", e => {
                   const studyData = e.getData();
                   resolve(studyData["uuid"]);

services/web/server/src/simcore_service_webserver/projects/projects_handlers_crud.py

@@ -251,7 +251,7 @@ async def _create_projects(
     new_project = {}
     copy_file_coro = None
     try:
-        task_progress.update(message="creating project document")
+        task_progress.update(message="creating new study...")
         new_project_was_hidden_before_data_was_copied = query_params.hidden
         if query_params.from_study:
             # 1. prepare copy