Merge branch 'master' into extract-celery-code

Author: giancarloromeo

.github/copilot-instructions.md

@@ -51,5 +51,5 @@ This document provides guidelines and best practices for using GitHub Copilot in
 
 - [Python Coding Conventions](../docs/coding-conventions.md)
 - [Environment Variables Guide](../docs/env-vars.md)
-- [Steps to Upgrade Python](../docs/steps-to-upgrade-python.md)
 - [Pydantic Annotated fields](../docs/llm-prompts/pydantic-annotated-fields.md)
+- [Steps to Upgrade Python](../docs/steps-to-upgrade-python.md)

.github/prompts/update-user-messages.prompt.md

@@ -0,0 +1,92 @@
+---
+mode: 'edit'
+description: 'Update user messages'
+---
+
+This prompt guide is for updating user-facing messages in ${file} or ${selection}
+
+## What is a User Message?
+
+A user message is any string that will be displayed to end-users of the application.
+In our codebase, these messages are marked with the `user_message` function:
+
+```python
+from common_library.user_messages import user_message
+
+error_msg = user_message("Operation failed. Please try again later.")
+```
+
+## Guidelines for Updating User Messages
+
+When modifying user messages, follow these rules:
+
+1. **Version Tracking**: Every modification to a user message must include an incremented `_version` parameter:
+
+   ```python
+   # Before modification
+   user_message("Error: Unable to connect to the server.")
+
+   # After modification, add _version or increment it if it already exists
+   user_message("Currently unable to establish connection to the server.", _version=1)
+   ```
+
+2. **F-String Preservation**: When modifying messages that use f-strings, preserve all parameters and their formatting:
+
+   ```python
+   # Before
+   user_message(f"Project {project_name} could not be loaded.")
+
+   # After (correct)
+   user_message(f"Unable to load project {project_name}.", _version=1)
+
+   # After (incorrect - lost the parameter)
+   user_message("Unable to load project.", _version=1)
+   ```
+
+3. **Message Style**: Follow *strictly* the guidelines in `${workspaceFolder}/docs/user-messages-guidelines.md`
+
+4. **Preserve Context**: Ensure the modified message conveys the same meaning and context as the original.
+
+5. **Incremental Versioning**: If a message already has a version, increment it by 1:
+
+   ```python
+   # Before
+   user_message("Session expired.", _version=2)
+
+   # After
+   user_message("Your session has expired. Please log in again.", _version=3)
+   ```
+
+## Examples
+
+### Example 1: Simple Message Update
+
+```python
+# Before
+error_dialog(user_message("Failed to save changes."))
+
+# After
+error_dialog(user_message("Unable to save your changes. Please try again.", _version=1))
+```
+
+### Example 2: F-string Message Update
+
+```python
+# Before
+raise ValueError(user_message(f"Invalid input parameter: {param_name}"))
+
+# After
+raise ValueError(user_message(f"The parameter '{param_name}' contains a value that is not allowed.", _version=1))
+```
+
+### Example 3: Already Versioned Message
+
+```python
+# Before
+return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("User not found.", _version=1))
+
+# After
+return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("The requested user could not be found.", _version=2))
+```
+
+Remember: The goal is to improve clarity and helpfulness for end-users while maintaining accurate versioning for tracking changes.

docs/messages-guidelines.md renamed to docs/user-messages-guidelines.md

@@ -1,6 +1,6 @@
-# Error and Warning Message Guidelines
+# User Message Guidelines
 
-These guidelines ensure that messages are user-friendly, clear, and helpful while maintaining a professional tone. 🚀
+These guidelines ensure that error and warnings user-facing messages are user-friendly, clear, and helpful while maintaining a professional tone. 🚀
 
 Some details:
 

packages/common-library/src/common_library/user_messages.py

@@ -0,0 +1,11 @@
+def user_message(msg: str, *, _version: int | None = None) -> str:
+    """Marks a message as user-facing
+
+    Arguments:
+        msg -- human-friendly string that follows docs/user-messages-guidelines.md
+        _version -- version number to track changes to messages; increment when modifying an existing message
+
+    Returns:
+        The original message string, allowing it to be used inline in code
+    """
+    return msg

packages/common-library/tests/test_user_messages.py

@@ -0,0 +1,6 @@
+from common_library.user_messages import user_message
+
+
+def test_user_message() -> None:
+
+    assert user_message("This is a user message") == "This is a user message"

packages/service-library/src/servicelib/aiohttp/rest_middlewares.py

@@ -13,6 +13,7 @@
 from aiohttp.web_response import StreamResponse
 from common_library.error_codes import create_error_code
 from common_library.json_serialization import json_dumps, json_loads
+from common_library.user_messages import user_message
 from models_library.rest_error import ErrorGet, ErrorItemType, LogMessageType
 
 from ..logging_errors import create_troubleshotting_log_kwargs
@@ -31,7 +32,7 @@
 from .web_exceptions_extension import get_http_error_class_or_none
 
 DEFAULT_API_VERSION = "v0"
-_FMSG_INTERNAL_ERROR_USER_FRIENDLY = (
+_FMSG_INTERNAL_ERROR_USER_FRIENDLY = user_message(
     "We apologize for the inconvenience. "
     "The issue has been recorded, please report it if it persists."
 )

services/static-webserver/client/source/class/osparc/dashboard/ResourceDetails.js

@@ -57,6 +57,11 @@ qx.Class.define("osparc.dashboard.ResourceDetails", {
           case "template":
           case "tutorial":
           case "hypertool":
+            // when getting the latest study data, the debt information was lost
+            if (osparc.study.Utils.isInDebt(this.__resourceData)) {
+              const mainStore = osparc.store.Store.getInstance();
+              this.__resourceData["debt"] = mainStore.getStudyDebt(this.__resourceData["uuid"]);
+            }
             osparc.store.Services.getStudyServicesMetadata(latestResourceData)
               .finally(() => {
                 this.__resourceModel = new osparc.data.model.Study(latestResourceData);
@@ -89,6 +94,7 @@ qx.Class.define("osparc.dashboard.ResourceDetails", {
     "updateService": "qx.event.type.Data",
     "updateHypertool": "qx.event.type.Data",
     "publishTemplate": "qx.event.type.Data",
+    "closeWindow": "qx.event.type.Event",
   },
 
 
@@ -107,6 +113,9 @@ qx.Class.define("osparc.dashboard.ResourceDetails", {
         width: this.WIDTH,
         height: this.HEIGHT,
       });
+      resourceDetails.addListener("closeWindow", () => {
+        win.close();
+      });
       return win;
     },
 
@@ -479,6 +488,9 @@ qx.Class.define("osparc.dashboard.ResourceDetails", {
             const enabled = osparc.study.Utils.canBeOpened(resourceData);
             page.openButton.setEnabled(enabled);
           })
+          billingSettings.addListener("closeWindow", () => {
+            this.fireEvent("closeWindow");
+          }, this);
           const billingScroll = new qx.ui.container.Scroll(billingSettings);
           page.addToContent(billingScroll);
         }

services/static-webserver/client/source/class/osparc/desktop/StudyEditor.js

@@ -179,20 +179,7 @@ qx.Class.define("osparc.desktop.StudyEditor", {
           if ("status" in err && err["status"]) {
             if (err["status"] == 402) {
               msg = err["message"];
-              // The backend might have thrown a 402 because the wallet was negative
-              const match = msg.match(/last transaction of\s([-]?\d+(\.\d+)?)\sresulted/);
-              let debt = null;
-              if ("debtAmount" in err) {
-                // the study has some debt that needs to be paid
-                debt = err["debtAmount"];
-              } else if (match) {
-                // the study has some debt that needs to be paid
-                debt = parseFloat(match[1]); // Convert the captured string to a number
-              }
-              if (debt) {
-                // if get here, it means that the 402 was thrown due to the debt
-                osparc.store.Store.getInstance().setStudyDebt(study.getUuid(), debt);
-              }
+              osparc.study.Utils.extractDebtFromError(study.getUuid(), err);
             } else if (err["status"] == 409) { // max_open_studies_per_user
               msg = err["message"];
             } else if (err["status"] == 423) { // Locked

services/static-webserver/client/source/class/osparc/share/RequestServiceAccess.js

@@ -58,17 +58,17 @@ qx.Class.define("osparc.share.RequestServiceAccess", {
 
       // Populate the grid with the cantReadServicesData
       cantReadServicesData.forEach((cantReadServiceData, idx) => {
-        const group = osparc.store.Groups.getInstance().getGroup(cantReadServiceData["owner"]);
-        if (group) {
-          const username = new qx.ui.basic.Label(group.getLabel()).set({
+        const userGroupId = cantReadServiceData["owner"];
+        if (userGroupId) {
+          const username = new qx.ui.basic.Label().set({
             rich: true,
             selectable: true,
           });
           layout.add(username, {
             row: idx+1,
             column: 0
           });
-          const email = new qx.ui.basic.Label(group.getEmail()).set({
+          const email = new qx.ui.basic.Label().set({
             rich: true,
             selectable: true,
           });
@@ -85,6 +85,16 @@ qx.Class.define("osparc.share.RequestServiceAccess", {
             row: idx+1,
             column: 2
           });
+
+          osparc.store.Users.getInstance().getUser(userGroupId)
+            .then(user => {
+              username.setValue(user ? user.getLabel() : this.tr("Unknown user"));
+              email.setValue(user ? user.getEmail() : "Unknown email");
+            })
+            .catch(() => {
+              username.setValue(this.tr("Unknown user"));
+              email.setValue("Unknown email");
+            });
         }
       });
     }

services/static-webserver/client/source/class/osparc/store/Store.js

@@ -253,6 +253,8 @@ qx.Class.define("osparc.store.Store", {
   },
 
   members: {
+    __studiesInDebt: null,
+
     // fetch resources that do not require log in
     preloadCalls: async function() {
       await osparc.data.Resources.get("config");
@@ -454,6 +456,16 @@ qx.Class.define("osparc.store.Store", {
     },
 
     setStudyDebt: function(studyId, debt) {
+      // init object if it does not exist
+      if (this.__studiesInDebt === null) {
+        this.__studiesInDebt = {};
+      }
+      if (debt) {
+        this.__studiesInDebt[studyId] = debt;
+      } else {
+        delete this.__studiesInDebt[studyId];
+      }
+
       const studiesWStateCache = this.getStudies();
       const idx = studiesWStateCache.findIndex(studyWStateCache => studyWStateCache["uuid"] === studyId);
       if (idx !== -1) {
@@ -470,6 +482,17 @@ qx.Class.define("osparc.store.Store", {
       });
     },
 
+    getStudyDebt: function(studyId) {
+      if (this.__studiesInDebt && studyId in this.__studiesInDebt) {
+        return this.__studiesInDebt[studyId];
+      }
+      return null;
+    },
+
+    isStudyInDebt: function(studyId) {
+      return Boolean(this.getStudyDebt(studyId));
+    },
+
     trashStudy: function(studyId) {
       const params = {
         url: {