From f4386fbcbcb32cb8c69d469dbfca9812ca586f01 Mon Sep 17 00:00:00 2001
From: Favour Olayinka <csskfaves@gmail.com>
Date: Wed, 17 Jul 2024 15:07:19 +0100
Subject: [PATCH] 55919 form editor error boundary (#494)

* fix password reset bug

* form editor error boundary

* fix crisp

* fix layout on create and edit pages

---------

Co-authored-by: Julien Nahum <julien@nahum.net>
---
 client/components/global/ErrorBoundary.vue    | 30 ++++++++
 client/components/open/editors/UndoRedo.vue   | 34 +++------
 .../open/forms/components/FormEditor.vue      |  7 +-
 .../components/FormEditorErrorHandler.vue     | 69 +++++++++++++++++++
 client/composables/useCrisp.js                | 27 +++++++-
 client/pages/forms/[slug]/edit.vue            |  2 +-
 client/pages/forms/create/index.vue           |  6 +-
 7 files changed, 145 insertions(+), 30 deletions(-)
 create mode 100644 client/components/global/ErrorBoundary.vue
 create mode 100644 client/components/open/forms/components/FormEditorErrorHandler.vue

diff --git a/client/components/global/ErrorBoundary.vue b/client/components/global/ErrorBoundary.vue
new file mode 100644
index 00000000..0533faf7
--- /dev/null
+++ b/client/components/global/ErrorBoundary.vue
@@ -0,0 +1,30 @@
+<template>
+    <slot v-if="!error" />
+    <slot
+      v-else
+      name="error"
+      :error="error"
+      :clear-error="clearError"
+    />
+  </template>
+  
+  <script setup lang="ts">
+  const error = ref()
+  const emit = defineEmits(['on-error'])
+  function clearError() {
+    error.value = undefined
+  }
+  onErrorCaptured(err => {
+    error.value = err
+    emit('on-error', err)
+    return false
+  })
+  const route = useRoute()
+  watch(
+    () => route.fullPath,
+    () => {
+      error.value = undefined
+    }
+  )
+  </script>
+  
\ No newline at end of file
diff --git a/client/components/open/editors/UndoRedo.vue b/client/components/open/editors/UndoRedo.vue
index 3c42860a..6479fed5 100644
--- a/client/components/open/editors/UndoRedo.vue
+++ b/client/components/open/editors/UndoRedo.vue
@@ -3,7 +3,11 @@
     size="sm"
     orientation="horizontal"
   >
-    <UTooltip text="Undo" :shortcuts="undoShortcut" :popper="{ placement: 'left' }">
+    <UTooltip 
+      text="Undo" 
+      :shortcuts="[metaSymbol,'Z']"
+      :popper="{ placement: 'left' }"
+    >
       <UButton
         :disabled="!canUndo"
         color="white"
@@ -12,7 +16,11 @@
         @click="undo"
       />
     </UTooltip>
-    <UTooltip text="Redo" :shortcuts="redoShortcut" :popper="{ placement: 'right' }">
+    <UTooltip 
+      text="Redo" 
+      :shortcuts="[metaSymbol,'Shift','Z']"
+      :popper="{ placement: 'right' }"
+    >
       <UButton
         :disabled="!canRedo"
         icon="i-material-symbols-redo"
@@ -44,30 +52,10 @@ defineShortcuts({
     }
   }
 })
-
-const undoShortcut = computed(() => {
-  return getOS() == 'macOS' ? ['⌘', 'Z'] : ['Ctrl', 'Z']
-})
-
-const redoShortcut = computed(() => {
-  return getOS() == 'macOS' ? ['⌘', 'Shift', 'Z'] : ['Ctrl', 'Shift', 'Z']
-})
+const { metaSymbol } = useShortcuts()
 
 onMounted(() => {
   setTimeout(() => { clearHistory() }, 500)
 })
 
-const  getOS = ()=> {
-  if (navigator.userAgentData) {
-    // Modern method
-    return navigator.userAgentData.platform;
-  } else {
-    // Fallback for older browsers
-    const userAgent = navigator.userAgent.toLowerCase();
-    if (userAgent.indexOf("mac") > -1) return "macOS";
-    if (userAgent.indexOf("win") > -1) return "Windows";
-    if (userAgent.indexOf("linux") > -1) return "Linux";
-    return "Unknown";
-  }
-}
 </script>
diff --git a/client/components/open/forms/components/FormEditor.vue b/client/components/open/forms/components/FormEditor.vue
index f1dc5f54..d69e8ac9 100644
--- a/client/components/open/forms/components/FormEditor.vue
+++ b/client/components/open/forms/components/FormEditor.vue
@@ -81,6 +81,7 @@
         </v-button>
       </div>
     </div>
+    <FormEditorErrorHandler>
 
     <div class="w-full flex grow overflow-y-scroll relative bg-gray-50">
       <div
@@ -116,6 +117,7 @@
         @close="showFormErrorModal = false"
       />
     </div>
+  </FormEditorErrorHandler>
   </div>
   <div
     v-else
@@ -141,10 +143,12 @@ import FormAccess from "./form-components/FormAccess.vue"
 import { validatePropertiesLogic } from "~/composables/forms/validatePropertiesLogic.js"
 import opnformConfig from "~/opnform.config.js"
 import { captureException } from "@sentry/core"
+import FormEditorErrorHandler from '~/components/open/forms/components/FormEditorErrorHandler.vue'
 
 export default {
   name: "FormEditor",
   components: {
+    FormEditorErrorHandler,
     UndoRedo,
     FormEditorSidebar,
     FormEditorPreview,
@@ -250,9 +254,6 @@ export default {
         },
       ]
     },
-    helpUrl() {
-      return this.opnformConfig.links.help
-    },
   },
 
   watch: {},
diff --git a/client/components/open/forms/components/FormEditorErrorHandler.vue b/client/components/open/forms/components/FormEditorErrorHandler.vue
new file mode 100644
index 00000000..2073903e
--- /dev/null
+++ b/client/components/open/forms/components/FormEditorErrorHandler.vue
@@ -0,0 +1,69 @@
+<template>
+    <ErrorBoundary @on-error="onFormEditorError">
+  
+      <template #error="{ error, clearError }">
+        <div class="flex-grow w-full flex items-center justify-center flex-col gap-4">
+          <h1 class="text-blue-800 text-2xl font-medium">Oops! Something went wrong.</h1>
+          <p class="text-gray-500 max-w-lg text-center">It looks like your last action caused an issue on our side. We
+            apologize for
+            the
+            inconvenience.</p>
+          <div class="flex gap-2 mt-4">
+            <UButton icon="i-material-symbols-undo" @click="clearEditorError(error, clearError)">Go back one step
+            </UButton>
+            <UButton variant="outline" icon="i-heroicons-chat-bubble-left-right-16-solid"
+                     @click="onErrorContact(error)">
+              Report this error
+            </UButton>
+          </div>
+        </div>
+      </template>
+  
+      <slot />
+    </ErrorBoundary>
+  </template>
+  
+  <script setup>
+  import { computed } from 'vue'
+  const crisp = useCrisp()
+  const workingFormStore = useWorkingFormStore()
+  const authStore = useAuthStore()
+  const form = storeToRefs(workingFormStore).content
+  const user = computed(() => authStore.user)
+  // Clear error and go back 1 step in history
+  const clearEditorError = (error, clearError) => {
+    crisp.enableChatbot()
+    workingFormStore.undo()
+    clearError()
+  }
+  const onFormEditorError = (error) => {
+    crisp.pauseChatBot()
+    const eventData = {
+      message: error.message,
+      // take first 200 characters
+      stack: error.stack.substring(0, 100)
+    }
+    try {
+      crisp.pushEvent('form-editor-error', eventData)
+    } catch (e) {
+      console.error('Failed to send event to crisp', e, eventData)
+    }
+  }
+  const onErrorContact = (error) => {
+    console.log('Contacting via crisp for an error', error)
+    crisp.pauseChatBot()
+    let errorReport = 'Hi there, I have a technical issue with the form editor.'
+    if (form.value.slug) {
+      errorReport += ` The form I am editing is: \`${form.value.slug}\`.`
+    }
+    errorReport += ` And here are technical details about the error: \`\`\`${error.stack}\`\`\``
+    try {
+      crisp.openAndShowChat(errorReport)
+      crisp.showMessage(`Hi there, we're very sorry to hear you experienced an issue with NoteForms.
+          We'll be in touch about it very soon! In the meantime, I recommend that you try going back one step, and save your changes.`, 2000)
+    } catch (e) {
+      console.error('Crisp error', e)
+    }
+  }
+  </script>
+  
\ No newline at end of file
diff --git a/client/composables/useCrisp.js b/client/composables/useCrisp.js
index 58613246..fb4c98c3 100644
--- a/client/composables/useCrisp.js
+++ b/client/composables/useCrisp.js
@@ -98,6 +98,28 @@ export function useCrisp () {
     crisp.session.setSegments(segments, overwrite)
   }
 
+  // Send message as operator
+  function showMessage (message, delay = 500) {
+    if (!crisp)
+      return
+    setTimeout(() => {
+      crisp.message.show('text', message)
+    }, delay)
+  }
+
+  function pauseChatBot () {
+    if (!crisp)
+      return
+    crisp.session.setData({ 'enum': 'pause_chatbot' })
+  }
+
+  function enableChatbot () {
+    if (!crisp)
+      return
+    crisp.session.setData({ 'enum': 'start_chatbot' })
+  }
+
+
   return {
     crisp,
     onCrispInit,
@@ -111,6 +133,9 @@ export function useCrisp () {
     sendTextMessage,
     pushEvent,
     setSegments,
-    setUser
+    setUser,
+    pauseChatBot,
+    enableChatbot,
+    showMessage
   }
 }
diff --git a/client/pages/forms/[slug]/edit.vue b/client/pages/forms/[slug]/edit.vue
index 09a2a997..b829e635 100644
--- a/client/pages/forms/[slug]/edit.vue
+++ b/client/pages/forms/[slug]/edit.vue
@@ -1,5 +1,5 @@
 <template>
-  <div class="w-full flex flex-col">
+  <div class="w-full flex flex-col flex-grow">
     <form-editor
       v-if="(!formsLoading || form ) && !error "
       ref="editor"
diff --git a/client/pages/forms/create/index.vue b/client/pages/forms/create/index.vue
index 9979b720..f5cb7246 100644
--- a/client/pages/forms/create/index.vue
+++ b/client/pages/forms/create/index.vue
@@ -1,6 +1,8 @@
 <template>
-  <div class="flex flex-wrap flex-col">
-    <div key="2">
+  <div class="flex flex-wrap flex-col flex-grow">
+    <div key="2"
+      class="w-full flex flex-grow flex-col"
+    >
       <create-form-base-modal
         :show="showInitialFormModal"
         @form-generated="formGenerated"