From 1f59986a87d65d4809d64ff0c297a9272e38eee2 Mon Sep 17 00:00:00 2001
From: Gerard Burns <Ghrehh@users.noreply.github.com>
Date: Wed, 5 Jul 2023 13:49:39 +0100
Subject: [PATCH] Use constant for keeping modal open (#11067)

---
 packages/bbui/src/Modal/ModalContent.svelte          | 10 +++++++---
 packages/bbui/src/index.js                           |  2 +-
 .../backend/DataTable/modals/CreateEditRow.svelte    |  7 +++----
 .../backend/DataTable/modals/CreateEditUser.svelte   |  8 ++++----
 .../backend/DataTable/modals/EditRoles.svelte        |  6 +++---
 .../modals/ImportRestQueriesModal.svelte             |  4 ++--
 .../backend/Datasources/ConfigEditor/index.svelte    |  3 ++-
 .../Datasources/CreateEditRelationship.svelte        |  3 ++-
 .../TableImportSelection/tableSelectionStore.js      |  5 ++---
 .../src/components/settings/APIKeyModal.svelte       | 12 +++++++++---
 .../src/components/start/CreateAppModal.svelte       | 12 +++++++++---
 .../src/components/start/ExportAppModal.svelte       |  5 +++--
 .../CreateExternalDatasourceModal/index.svelte       |  5 ++---
 .../_components/EditDatasourceConfig.svelte          |  6 +++---
 .../panels/Queries/RestImportQueriesModal.svelte     |  5 +++--
 .../users/groups/_components/AppAddModal.svelte      |  6 +++---
 .../groups/_components/CreateEditGroupModal.svelte   |  3 ++-
 .../users/users/_components/AddUserModal.svelte      |  3 ++-
 18 files changed, 62 insertions(+), 43 deletions(-)

diff --git a/packages/bbui/src/Modal/ModalContent.svelte b/packages/bbui/src/Modal/ModalContent.svelte
index 226414ee11..3ca584504c 100644
--- a/packages/bbui/src/Modal/ModalContent.svelte
+++ b/packages/bbui/src/Modal/ModalContent.svelte
@@ -1,3 +1,7 @@
+<script context="module">
+  export const keepOpen = Symbol("keepOpen")
+</script>
+
 <script>
   import "@spectrum-css/dialog/dist/index-vars.css"
   import { getContext } from "svelte"
@@ -30,7 +34,7 @@
 
   async function secondary(e) {
     loading = true
-    if (!secondaryAction || (await secondaryAction(e)) !== false) {
+    if (!secondaryAction || (await secondaryAction(e)) !== keepOpen) {
       hide()
     }
     loading = false
@@ -38,7 +42,7 @@
 
   async function confirm() {
     loading = true
-    if (!onConfirm || (await onConfirm()) !== false) {
+    if (!onConfirm || (await onConfirm()) !== keepOpen) {
       hide()
     }
     loading = false
@@ -46,7 +50,7 @@
 
   async function close() {
     loading = true
-    if (!onCancel || (await onCancel()) !== false) {
+    if (!onCancel || (await onCancel()) !== keepOpen) {
       cancel()
     }
     loading = false
diff --git a/packages/bbui/src/index.js b/packages/bbui/src/index.js
index d26b938dd5..a9d71723f8 100644
--- a/packages/bbui/src/index.js
+++ b/packages/bbui/src/index.js
@@ -42,7 +42,7 @@ export { default as MenuSection } from "./Menu/Section.svelte"
 export { default as MenuSeparator } from "./Menu/Separator.svelte"
 export { default as MenuItem } from "./Menu/Item.svelte"
 export { default as Modal } from "./Modal/Modal.svelte"
-export { default as ModalContent } from "./Modal/ModalContent.svelte"
+export { default as ModalContent, keepOpen } from "./Modal/ModalContent.svelte"
 export { default as NotificationDisplay } from "./Notification/NotificationDisplay.svelte"
 export { default as Notification } from "./Notification/Notification.svelte"
 export { default as SideNavigation } from "./SideNavigation/Navigation.svelte"
diff --git a/packages/builder/src/components/backend/DataTable/modals/CreateEditRow.svelte b/packages/builder/src/components/backend/DataTable/modals/CreateEditRow.svelte
index ebff97e0fc..3643602e22 100644
--- a/packages/builder/src/components/backend/DataTable/modals/CreateEditRow.svelte
+++ b/packages/builder/src/components/backend/DataTable/modals/CreateEditRow.svelte
@@ -1,10 +1,9 @@
 <script>
   import { createEventDispatcher } from "svelte"
   import { tables } from "stores/backend"
-  import { notifications } from "@budibase/bbui"
+  import { ModalContent, keepOpen, notifications } from "@budibase/bbui"
   import RowFieldControl from "../RowFieldControl.svelte"
   import { API } from "api"
-  import { ModalContent } from "@budibase/bbui"
   import { FIELDS } from "constants/backend"
 
   const FORMULA_TYPE = FIELDS.FORMULA.type
@@ -41,8 +40,8 @@
       } else {
         notifications.error(`Failed to save row - ${error.message}`)
       }
-      // Prevent modal closing if there were errors
-      return false
+
+      return keepOpen
     }
   }
 </script>
diff --git a/packages/builder/src/components/backend/DataTable/modals/CreateEditUser.svelte b/packages/builder/src/components/backend/DataTable/modals/CreateEditUser.svelte
index 4c069402a7..01964aed75 100644
--- a/packages/builder/src/components/backend/DataTable/modals/CreateEditUser.svelte
+++ b/packages/builder/src/components/backend/DataTable/modals/CreateEditUser.svelte
@@ -5,7 +5,7 @@
   import { notifications } from "@budibase/bbui"
   import RowFieldControl from "../RowFieldControl.svelte"
   import { API } from "api"
-  import { ModalContent, Select, Link } from "@budibase/bbui"
+  import { keepOpen, ModalContent, Select, Link } from "@budibase/bbui"
   import ErrorsBox from "components/common/ErrorsBox.svelte"
   import { goto } from "@roxi/routify"
 
@@ -51,7 +51,7 @@
       errors = [...errors, { message: "Role is required" }]
     }
     if (errors.length) {
-      return false
+      return keepOpen
     }
 
     try {
@@ -79,8 +79,8 @@
       } else {
         notifications.error("Error saving user")
       }
-      // Prevent closing the modal on errors
-      return false
+
+      return keepOpen
     }
   }
 </script>
diff --git a/packages/builder/src/components/backend/DataTable/modals/EditRoles.svelte b/packages/builder/src/components/backend/DataTable/modals/EditRoles.svelte
index 6a2dd8d913..ad51cbbbbb 100644
--- a/packages/builder/src/components/backend/DataTable/modals/EditRoles.svelte
+++ b/packages/builder/src/components/backend/DataTable/modals/EditRoles.svelte
@@ -1,5 +1,5 @@
 <script>
-  import { ModalContent, Select, Input, Button } from "@budibase/bbui"
+  import { keepOpen, ModalContent, Select, Input, Button } from "@budibase/bbui"
   import { onMount } from "svelte"
   import { API } from "api"
   import { notifications } from "@budibase/bbui"
@@ -76,7 +76,7 @@
       errors.push({ message: "Please choose permissions" })
     }
     if (errors.length) {
-      return false
+      return keepOpen
     }
 
     // Save/create the role
@@ -85,7 +85,7 @@
       notifications.success("Role saved successfully")
     } catch (error) {
       notifications.error(`Error saving role - ${error.message}`)
-      return false
+      return keepOpen
     }
   }
 
diff --git a/packages/builder/src/components/backend/DatasourceNavigator/modals/ImportRestQueriesModal.svelte b/packages/builder/src/components/backend/DatasourceNavigator/modals/ImportRestQueriesModal.svelte
index 82a2aa8066..9b1f76ba30 100644
--- a/packages/builder/src/components/backend/DatasourceNavigator/modals/ImportRestQueriesModal.svelte
+++ b/packages/builder/src/components/backend/DatasourceNavigator/modals/ImportRestQueriesModal.svelte
@@ -1,6 +1,7 @@
 <script>
   import { goto } from "@roxi/routify"
   import {
+    keepOpen,
     ModalContent,
     notifications,
     Body,
@@ -70,10 +71,9 @@
       }
 
       notifications.success(`Imported successfully.`)
-      return true
     } catch (error) {
       notifications.error("Error importing queries")
-      return false
+      return keepOpen
     }
   }
 </script>
diff --git a/packages/builder/src/components/backend/Datasources/ConfigEditor/index.svelte b/packages/builder/src/components/backend/Datasources/ConfigEditor/index.svelte
index bbb10b41df..14191868b6 100644
--- a/packages/builder/src/components/backend/Datasources/ConfigEditor/index.svelte
+++ b/packages/builder/src/components/backend/Datasources/ConfigEditor/index.svelte
@@ -1,5 +1,6 @@
 <script>
   import {
+    keepOpen,
     Modal,
     notifications,
     Body,
@@ -36,7 +37,7 @@
       })
     }
 
-    return false
+    return keepOpen
   }
 
   let createVariableModal
diff --git a/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte b/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte
index 4908512515..53fcf56e7f 100644
--- a/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte
+++ b/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte
@@ -1,6 +1,7 @@
 <script>
   import { RelationshipTypes } from "constants/backend"
   import {
+    keepOpen,
     Button,
     Input,
     ModalContent,
@@ -277,7 +278,7 @@
 
   async function saveRelationship() {
     if (!validate()) {
-      return false
+      return keepOpen
     }
     buildRelationships()
     removeExistingRelationship()
diff --git a/packages/builder/src/components/backend/Datasources/TableImportSelection/tableSelectionStore.js b/packages/builder/src/components/backend/Datasources/TableImportSelection/tableSelectionStore.js
index 826d7d84ba..468782b43c 100644
--- a/packages/builder/src/components/backend/Datasources/TableImportSelection/tableSelectionStore.js
+++ b/packages/builder/src/components/backend/Datasources/TableImportSelection/tableSelectionStore.js
@@ -1,5 +1,5 @@
 import { derived, writable, get } from "svelte/store"
-import { notifications } from "@budibase/bbui"
+import { keepOpen, notifications } from "@budibase/bbui"
 import { datasources, ImportTableError } from "stores/backend"
 
 export const createTableSelectionStore = (integration, datasource) => {
@@ -37,8 +37,7 @@ export const createTableSelectionStore = (integration, datasource) => {
         notifications.error("Error fetching tables.")
       }
 
-      // Prevent modal closing
-      return false
+      return keepOpen
     }
   }
 
diff --git a/packages/builder/src/components/settings/APIKeyModal.svelte b/packages/builder/src/components/settings/APIKeyModal.svelte
index a252691ace..06b1d095fc 100644
--- a/packages/builder/src/components/settings/APIKeyModal.svelte
+++ b/packages/builder/src/components/settings/APIKeyModal.svelte
@@ -1,5 +1,11 @@
 <script>
-  import { ModalContent, Body, notifications, CopyInput } from "@budibase/bbui"
+  import {
+    ModalContent,
+    keepOpen,
+    Body,
+    notifications,
+    CopyInput,
+  } from "@budibase/bbui"
   import { auth } from "stores/portal"
   import { onMount } from "svelte"
 
@@ -12,8 +18,8 @@
     } catch (err) {
       notifications.error("Unable to generate new API key")
     }
-    // need to return false to keep modal open
-    return false
+
+    return keepOpen
   }
 
   onMount(async () => {
diff --git a/packages/builder/src/components/start/CreateAppModal.svelte b/packages/builder/src/components/start/CreateAppModal.svelte
index cf42668add..f29b7067c3 100644
--- a/packages/builder/src/components/start/CreateAppModal.svelte
+++ b/packages/builder/src/components/start/CreateAppModal.svelte
@@ -1,6 +1,12 @@
 <script>
   import { writable, get as svelteGet } from "svelte/store"
-  import { notifications, Input, ModalContent, Dropzone } from "@budibase/bbui"
+  import {
+    notifications,
+    keepOpen,
+    Input,
+    ModalContent,
+    Dropzone,
+  } from "@budibase/bbui"
   import { store, automationStore } from "builderStore"
   import { API } from "api"
   import { apps, admin, auth } from "stores/portal"
@@ -167,7 +173,7 @@
       onConfirm: async () => {
         if (encryptedFile) {
           currentStep = Step.SET_PASSWORD
-          return false
+          return keepOpen
         } else {
           try {
             await createNewApp()
@@ -190,7 +196,7 @@
             message += `: ${lowercase(e.message)}`
           }
           notifications.error(message)
-          return false
+          return keepOpen
         }
       },
       isValid: $encryptionValidation.valid,
diff --git a/packages/builder/src/components/start/ExportAppModal.svelte b/packages/builder/src/components/start/ExportAppModal.svelte
index bc170c47be..e492b6be46 100644
--- a/packages/builder/src/components/start/ExportAppModal.svelte
+++ b/packages/builder/src/components/start/ExportAppModal.svelte
@@ -1,6 +1,7 @@
 <script>
   import {
     ModalContent,
+    keepOpen,
     Toggle,
     Body,
     InlineAlert,
@@ -32,7 +33,7 @@
           exportApp()
         } else {
           currentStep = Step.SET_PASSWORD
-          return false
+          return keepOpen
         }
       },
       isValid: true,
@@ -43,7 +44,7 @@
       onConfirm: async () => {
         await validation.check({ password })
         if (!$validation.valid) {
-          return false
+          return keepOpen
         }
         exportApp(password)
       },
diff --git a/packages/builder/src/pages/builder/app/[application]/data/_components/CreateExternalDatasourceModal/index.svelte b/packages/builder/src/pages/builder/app/[application]/data/_components/CreateExternalDatasourceModal/index.svelte
index 706e1a2015..7bd87dd0f0 100644
--- a/packages/builder/src/pages/builder/app/[application]/data/_components/CreateExternalDatasourceModal/index.svelte
+++ b/packages/builder/src/pages/builder/app/[application]/data/_components/CreateExternalDatasourceModal/index.svelte
@@ -1,5 +1,5 @@
 <script>
-  import { Modal } from "@budibase/bbui"
+  import { Modal, keepOpen } from "@budibase/bbui"
   import { goto } from "@roxi/routify"
   import { IntegrationTypes } from "constants/backend"
   import GoogleAuthPrompt from "./GoogleAuthPrompt.svelte"
@@ -75,8 +75,7 @@
       notifications.error(`Error creating datasource: ${e.message}`)
     }
 
-    // Prevent modal closing
-    return false
+    return keepOpen
   }
 </script>
 
diff --git a/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/EditDatasourceConfig.svelte b/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/EditDatasourceConfig.svelte
index 033b21e44c..db59efd3a9 100644
--- a/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/EditDatasourceConfig.svelte
+++ b/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/EditDatasourceConfig.svelte
@@ -1,5 +1,5 @@
 <script>
-  import { Modal, notifications } from "@budibase/bbui"
+  import { keepOpen, Modal, notifications } from "@budibase/bbui"
   import { integrationForDatasource } from "stores/selectors"
   import { datasources, integrations } from "stores/backend"
   import DatasourceConfigEditor from "components/backend/Datasources/ConfigEditor/index.svelte"
@@ -23,8 +23,8 @@
       )
     } catch (err) {
       notifications.error(err?.message ?? "Error saving datasource")
-      // prevent the modal from closing
-      return false
+
+      return keepOpen
     }
   }
 </script>
diff --git a/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/panels/Queries/RestImportQueriesModal.svelte b/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/panels/Queries/RestImportQueriesModal.svelte
index c11093a0ed..a72359a950 100644
--- a/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/panels/Queries/RestImportQueriesModal.svelte
+++ b/packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/panels/Queries/RestImportQueriesModal.svelte
@@ -1,6 +1,7 @@
 <script>
   import { goto } from "@roxi/routify"
   import {
+    keepOpen,
     ModalContent,
     notifications,
     Body,
@@ -70,10 +71,10 @@
       }
 
       notifications.success("Imported successfully")
-      return true
     } catch (error) {
       notifications.error("Error importing queries")
-      return false
+
+      return keepOpen
     }
   }
 </script>
diff --git a/packages/builder/src/pages/builder/portal/users/groups/_components/AppAddModal.svelte b/packages/builder/src/pages/builder/portal/users/groups/_components/AppAddModal.svelte
index a8f8fd661f..3eb7f5c267 100644
--- a/packages/builder/src/pages/builder/portal/users/groups/_components/AppAddModal.svelte
+++ b/packages/builder/src/pages/builder/portal/users/groups/_components/AppAddModal.svelte
@@ -1,5 +1,5 @@
 <script>
-  import { Body, ModalContent, Select } from "@budibase/bbui"
+  import { keepOpen, Body, ModalContent, Select } from "@budibase/bbui"
   import { apps, groups } from "stores/portal"
   import { roles } from "stores/backend"
   import RoleSelect from "components/common/RoleSelect.svelte"
@@ -20,8 +20,8 @@
     if (!selectingRole) {
       selectingRole = true
       await roles.fetchByAppId(prodAppId)
-      // return false to stop closing modal
-      return false
+
+      return keepOpen
     } else {
       await groups.actions.addApp(group._id, prodAppId, selectedRoleId)
     }
diff --git a/packages/builder/src/pages/builder/portal/users/groups/_components/CreateEditGroupModal.svelte b/packages/builder/src/pages/builder/portal/users/groups/_components/CreateEditGroupModal.svelte
index af1b009dee..2f0d295052 100644
--- a/packages/builder/src/pages/builder/portal/users/groups/_components/CreateEditGroupModal.svelte
+++ b/packages/builder/src/pages/builder/portal/users/groups/_components/CreateEditGroupModal.svelte
@@ -1,5 +1,6 @@
 <script>
   import {
+    keepOpen,
     ColorPicker,
     Body,
     ModalContent,
@@ -17,7 +18,7 @@
   onConfirm={() => {
     if (!group.name?.trim()) {
       nameError = "Group name cannot be empty"
-      return false
+      return keepOpen
     }
     saveGroup(group)
   }}
diff --git a/packages/builder/src/pages/builder/portal/users/users/_components/AddUserModal.svelte b/packages/builder/src/pages/builder/portal/users/users/_components/AddUserModal.svelte
index a4e0ebd4bb..806468021f 100644
--- a/packages/builder/src/pages/builder/portal/users/users/_components/AddUserModal.svelte
+++ b/packages/builder/src/pages/builder/portal/users/users/_components/AddUserModal.svelte
@@ -1,5 +1,6 @@
 <script>
   import {
+    keepOpen,
     Label,
     ActionButton,
     ModalContent,
@@ -73,7 +74,7 @@
       valid = validateInput(input, index) && valid
     })
     if (!valid) {
-      return false
+      return keepOpen
     }
     showOnboardingTypeModal({ users: userData, groups: userGroups })
   }