Added meaning full error message based on platform (#12074)

* fix: fixed 'Database unexpectedly closed' is a bad error message (#25948) * Added deviceType condition check for web and desktop * Added Error description for web and desktop * Changed 'error_database_closed_title' Title to '%(brand)s stopped working' Signed-off-by: Pankaj Singh <[email protected]> * refactor(platform): replace UA parsing with Platform for platform detection Signed-off-by: Pankaj Singh <[email protected]> * refactor(platform-test): added getHumanReadableName function in testcase Signed-off-by: Pankaj Singh <[email protected]> * refactor(platform): added %brand argument for description Signed-off-by: Pankaj Singh <[email protected]> * refactor by linter Signed-off-by: Pankaj Singh <[email protected]> * refactor(linter): used prettier for linter * Enable `A thread with a redacted unread is still read after restart` (#12083) * [create-pull-request] automated change (#12085) Co-authored-by: github-merge-queue <[email protected]> * Allow element-web hash to be specified when calling playwright tests workflow (#12087) * add link to issue for disabled test * [create-pull-request] automated change (#12093) Co-authored-by: github-merge-queue <[email protected]> * Add tests about room list order (#12088) --------- Signed-off-by: Pankaj Singh <[email protected]> Co-authored-by: Florian Duros <[email protected]> Co-authored-by: ElementRobot <[email protected]> Co-authored-by: github-merge-queue <[email protected]> Co-authored-by: Michael Telatynski <[email protected]> Co-authored-by: Richard van der Hoff <[email protected]>
matrix-org · Jan 2, 2024 · 773b03e · 773b03e
1 parent 176237e
commit 773b03e
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 7 deletions.
diff --git a/src/MatrixClientPeg.ts b/src/MatrixClientPeg.ts
@@ -51,6 +51,7 @@ import MatrixClientBackedController from "./settings/controllers/MatrixClientBac
 import ErrorDialog from "./components/views/dialogs/ErrorDialog";
 import PlatformPeg from "./PlatformPeg";
 import { formatList } from "./utils/FormattingUtils";
+import SdkConfig from "./SdkConfig";
 
 export interface IMatrixClientCreds {
     homeserverUrl: string;
@@ -212,12 +213,21 @@ class MatrixClientPegClass implements IMatrixClientPeg {
             // If the user is not a guest then prompt them to reload rather than doing it for them
             // For guests this is likely to happen during e-mail verification as part of registration
 
-            const { finished } = Modal.createDialog(ErrorDialog, {
-                title: _t("error_database_closed_title"),
-                description: _t("error_database_closed_description"),
+            const brand = SdkConfig.get().brand;
+            const platform = PlatformPeg.get()?.getHumanReadableName();
+
+            // Determine the description based on the platform
+            const description =
+                platform === "Web Platform"
+                    ? _t("error_database_closed_description|for_web", { brand })
+                    : _t("error_database_closed_description|for_desktop");
+
+            const [reload] = await Modal.createDialog(ErrorDialog, {
+                title: _t("error_database_closed_title", { brand }),
+                description,
                 button: _t("action|reload"),
-            });
-            const [reload] = await finished;
+            }).finished;
+
             if (!reload) return;
         }
 

diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
@@ -1063,8 +1063,11 @@
     "error_app_open_in_another_tab": "Switch to the other tab to connect to %(brand)s. This tab can now be closed.",
     "error_app_open_in_another_tab_title": "%(brand)s is connected in another tab",
     "error_app_opened_in_another_window": "%(brand)s is open in another window. Click \"%(label)s\" to use %(brand)s here and disconnect the other window.",
-    "error_database_closed_description": "This may be caused by having the app open in multiple tabs or due to clearing browser data.",
-    "error_database_closed_title": "Database unexpectedly closed",
+    "error_database_closed_description": {
+        "for_desktop": "Your disk may be full. Please clear up some space and reload.",
+        "for_web": "If you cleared browsing data then this message is expected. %(brand)s may also be open in another tab, or your disk is full. Please clear up some space and reload"
+    },
+    "error_database_closed_title": "%(brand)s stopped working",
     "error_dialog": {
         "copy_room_link_failed": {
             "description": "Unable to copy a link to the room to the clipboard.",

diff --git a/test/MatrixClientPeg-test.ts b/test/MatrixClientPeg-test.ts
@@ -155,6 +155,8 @@ describe("MatrixClientPeg", () => {
         it("should show error modal when store database closes", async () => {
             testPeg.safeGet().isGuest = () => false;
             const emitter = new EventEmitter();
+            const platform: any = { getHumanReadableName: jest.fn() };
+            PlatformPeg.set(platform);
             testPeg.safeGet().store.on = emitter.on.bind(emitter);
             const spy = jest.spyOn(Modal, "createDialog");
             await testPeg.assign();