feat: auto save changes on workbook

frappe · Nov 24, 2024 · ab142ab · ab142ab
1 parent fbf47f8
commit ab142ab
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 4 deletions.
diff --git a/frontend/src2/types/workbook.types.ts b/frontend/src2/types/workbook.types.ts
@@ -22,6 +22,7 @@ export type InsightsWorkbook = {
 	queries: WorkbookQuery[]
 	charts: WorkbookChart[]
 	dashboards: WorkbookDashboard[]
+	enable_auto_save?: boolean
 }
 
 export type WorkbookQuery = {

diff --git a/frontend/src2/workbook/WorkbookNavbarActions.vue b/frontend/src2/workbook/WorkbookNavbarActions.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { Check, PanelRightClose, PanelRightOpen, Share2, Undo2 } from 'lucide-vue-next'
+import { Check, PanelRightClose, PanelRightOpen, Pause, Play, Share2, Undo2 } from 'lucide-vue-next'
 import { inject, ref } from 'vue'
 import { Workbook, workbookKey } from './workbook'
 import WorkbookShareDialog from './WorkbookShareDialog.vue'
@@ -45,6 +45,11 @@ const showShareDialog = ref(false)
 		<Dropdown
 			:button="{ icon: 'more-horizontal', variant: 'outline' }"
 			:options="[
+				{
+					label: workbook.doc.enable_auto_save ? 'Disable Auto Save' : 'Enable Auto Save',
+					icon: workbook.doc.enable_auto_save ? Pause : Play,
+					onClick: () => (workbook.doc.enable_auto_save = !workbook.doc.enable_auto_save),
+				},
 				{
 					label: workbook.showSidebar ? 'Hide Sidebar' : 'Show Sidebar',
 					icon: workbook.showSidebar ? PanelRightOpen : PanelRightClose,

diff --git a/frontend/src2/workbook/workbook.ts b/frontend/src2/workbook/workbook.ts
@@ -1,3 +1,4 @@
+import { watchDebounced } from '@vueuse/core'
 import { call } from 'frappe-ui'
 import { computed, InjectionKey, reactive, toRefs } from 'vue'
 import { useRouter } from 'vue-router'
@@ -24,7 +25,6 @@ export default function useWorkbook(name: string) {
 		const href = window.location.href.replace(name, workbook.doc.name)
 		window.location.replace(href)
 	})
-	workbook.onAfterSave(() => createToast({ title: 'Saved', variant: 'success' }))
 
 	wheneverChanges(
 		() => workbook.doc,
@@ -229,6 +229,24 @@ export default function useWorkbook(name: string) {
 		return linkedQueries
 	}
 
+	let stopAutoSaveWatcher: any
+	wheneverChanges(
+		() => workbook.doc.enable_auto_save,
+		() => {
+			if (!workbook.doc.enable_auto_save && stopAutoSaveWatcher) {
+				stopAutoSaveWatcher()
+				stopAutoSaveWatcher = null
+			}
+			if (workbook.doc.enable_auto_save && !stopAutoSaveWatcher) {
+				stopAutoSaveWatcher = watchDebounced(
+					() => workbook.isdirty,
+					() => workbook.isdirty && workbook.save(),
+					{ immediate: true, debounce: 1000 }
+				)
+			}
+		}
+	)
+
 	return reactive({
 		...toRefs(workbook),
 		canShare,

diff --git a/insights/insights/doctype/insights_workbook/insights_workbook.json b/insights/insights/doctype/insights_workbook/insights_workbook.json
@@ -8,7 +8,8 @@
   "title",
   "queries",
   "charts",
-  "dashboards"
+  "dashboards",
+  "enable_auto_save"
  ],
  "fields": [
   {
@@ -32,11 +33,17 @@
    "fieldname": "dashboards",
    "fieldtype": "JSON",
    "label": "Dashboards"
+  },
+  {
+   "default": "0",
+   "fieldname": "enable_auto_save",
+   "fieldtype": "Check",
+   "label": "Enable Auto Save"
   }
  ],
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2024-11-02 12:44:21.277499",
+ "modified": "2024-11-24 12:36:33.196238",
  "modified_by": "Administrator",
  "module": "Insights",
  "name": "Insights Workbook",

diff --git a/insights/insights/doctype/insights_workbook/insights_workbook.py b/insights/insights/doctype/insights_workbook/insights_workbook.py
@@ -26,6 +26,7 @@ class InsightsWorkbook(Document):
 
         charts: DF.JSON | None
         dashboards: DF.JSON | None
+        enable_auto_save: DF.Check
         name: DF.Int | None
         queries: DF.JSON | None
         title: DF.Data