diff --git a/src/frontend/lib/components/nav/DetailDrawer.tsx b/src/frontend/lib/components/nav/DetailDrawer.tsx index f8edbe2aec..5c1bffabbe 100644 --- a/src/frontend/lib/components/nav/DetailDrawer.tsx +++ b/src/frontend/lib/components/nav/DetailDrawer.tsx @@ -16,6 +16,7 @@ import * as classes from './DetailDrawer.css'; * @param position - drawer position * @param renderContent - function used to render the drawer content * @param urlPrefix - set an additional url segment, useful when multiple drawers are rendered on one page (e.g. "user/") + * @param onBeforeClose - optional callback to intercept closing of the drawer (e.g. to confirm unsaved changes). Call the provided "close" function to actually close the drawer. */ export interface DrawerProps { title: string; @@ -24,6 +25,7 @@ export interface DrawerProps { urlPrefix?: string; size?: UiSizeType; closeOnEscape?: boolean; + onBeforeClose?: (close: () => void) => void; } export function DetailDrawerComponent({ @@ -31,7 +33,8 @@ export function DetailDrawerComponent({ position = 'right', size, closeOnEscape = true, - renderContent + renderContent, + onBeforeClose }: Readonly) { const navigate = useNavigate(); const { id } = useParams(); @@ -43,13 +46,27 @@ export function DetailDrawerComponent({ useShallow((state) => [state.detailDrawerStack, state.addDetailDrawer]) ); + // Run a "close" action, optionally allowing the owner of the drawer to intercept it + const guardedClose = useCallback( + (close: () => void) => { + if (onBeforeClose) { + onBeforeClose(close); + } else { + close(); + } + }, + [onBeforeClose] + ); + return ( { - navigate('../'); - addDetailDrawer(false); - }} + onClose={() => + guardedClose(() => { + navigate('../'); + addDetailDrawer(false); + }) + } position={position} closeOnEscape={closeOnEscape} size={size} @@ -60,10 +77,12 @@ export function DetailDrawerComponent({ {detailDrawerStack > 0 && ( { - navigate(-1); - addDetailDrawer(-1); - }} + onClick={() => + guardedClose(() => { + navigate(-1); + addDetailDrawer(-1); + }) + } > diff --git a/src/frontend/src/components/editors/TemplateEditor/TemplateEditor.tsx b/src/frontend/src/components/editors/TemplateEditor/TemplateEditor.tsx index 803fc331ef..8ca6a462c9 100644 --- a/src/frontend/src/components/editors/TemplateEditor/TemplateEditor.tsx +++ b/src/frontend/src/components/editors/TemplateEditor/TemplateEditor.tsx @@ -14,6 +14,7 @@ import { Stack, Tabs } from '@mantine/core'; +import { useWindowEvent } from '@mantine/hooks'; import { openConfirmModal } from '@mantine/modals'; import { hideNotification, @@ -85,15 +86,78 @@ export type TemplateEditorProps = { template: TemplateI; // Name of the file field on the template model (e.g. 'template' or 'snippet') fileField?: string; + // Populated by the editor with a function to check for unsaved changes + unsavedChangesRef?: UnsavedChangesRef; }; +export type UnsavedChangesRef = React.MutableRefObject< + (() => Promise) | null +>; + +// Compare template code, ignoring differences in line endings +function codeDiffers(a: string, b: string): boolean { + return a.replace(/\r\n/g, '\n') !== b.replace(/\r\n/g, '\n'); +} + +/** + * Guard a drawer which contains a TemplateEditor against accidental closing. + * + * - Pass "unsavedChangesRef" to the TemplateEditor component + * - Pass "onBeforeClose" to the DetailDrawer component + */ +export function useTemplateEditorCloseGuard() { + const unsavedChangesRef: UnsavedChangesRef = useRef(null); + + const onBeforeClose = useCallback((close: () => void) => { + const check = unsavedChangesRef.current; + + if (!check) { + close(); + return; + } + + check() + .then((unsaved) => { + if (!unsaved) { + close(); + return; + } + + openConfirmModal({ + title: t`Unsaved Changes`, + children: ( + } + title={t`The template has unsaved changes`} + > + {t`If you close the editor now, your changes will be lost. Do you want to proceed?`} + + ), + labels: { + confirm: t`Discard Changes`, + cancel: t`Keep Editing` + }, + confirmProps: { + color: 'red' + }, + onConfirm: close + }); + }) + .catch(() => close()); + }, []); + + return { unsavedChangesRef, onBeforeClose }; +} + export function TemplateEditor(props: Readonly) { const { templateUrl, editors, previewAreas, template, - fileField = 'template' + fileField = 'template', + unsavedChangesRef } = props; const editorRef = useRef(null); const previewRef = useRef(null); @@ -115,6 +179,62 @@ export function TemplateEditor(props: Readonly) { const codeRef = useRef(undefined); + // The template code as it is currently stored on the server + const savedCodeRef = useRef(undefined); + + // Check if the code in the editor differs from the code stored on the server + const hasUnsavedChanges = useCallback(async () => { + if (savedCodeRef.current === undefined) return false; + + try { + // An editor which is still initializing (e.g. a plugin editor) cannot provide its code yet: + // fall back to the code which was last handed to the editor + const code = + (await Promise.resolve(editorRef.current?.getCode())) ?? + codeRef.current; + + // The editor content is unknown: err on the side of asking for confirmation + if (code === undefined) return true; + + return codeDiffers(code, savedCodeRef.current); + } catch { + // The editor state is unknown: err on the side of asking for confirmation + return true; + } + }, []); + + // Expose the check to the parent component (e.g. to guard closing of a drawer) + useEffect(() => { + if (!unsavedChangesRef) return; + + unsavedChangesRef.current = hasUnsavedChanges; + + return () => { + unsavedChangesRef.current = null; + }; + }, [unsavedChangesRef, hasUnsavedChanges]); + + // Warn before the page is closed or reloaded with unsaved changes + // Note: this must be synchronous, so editors which provide their code asynchronously are not covered + useWindowEvent('beforeunload', (event) => { + let code: unknown; + + try { + code = editorRef.current?.getCode(); + } catch { + return; + } + + if ( + typeof code === 'string' && + savedCodeRef.current !== undefined && + codeDiffers(code, savedCodeRef.current) + ) { + event.preventDefault(); + event.returnValue = ''; + } + }); + const loadCodeToEditor = useCallback(async (code: string) => { try { return await Promise.resolve(editorRef.current?.setCode(code)); @@ -158,6 +278,8 @@ export function TemplateEditor(props: Readonly) { }) .then((res) => { codeRef.current = res.data; + savedCodeRef.current = + typeof res.data === 'string' ? res.data : undefined; loadCodeToEditor(res.data); }) .catch(() => { @@ -215,15 +337,24 @@ export function TemplateEditor(props: Readonly) { if (code === undefined || !previewItem) return; setIsPreviewLoading(true); - Promise.resolve( - previewRef.current?.updatePreview( - code, - previewItem, - saveTemplate, - props - ) - ) + + const result = previewRef.current?.updatePreview( + code, + previewItem, + saveTemplate, + props + ); + + // Only a returned promise reports whether the template was actually stored + const isConfirmed = typeof (result as any)?.then === 'function'; + + Promise.resolve(result) .then(() => { + if (saveTemplate && isConfirmed) { + // The preview area has stored the template on the server + savedCodeRef.current = code; + } + setRenderingErrors(null); notifications.hide('template-preview'); @@ -274,6 +405,7 @@ export function TemplateEditor(props: Readonly) { api .patch(templateUrl, formData) .then(() => { + savedCodeRef.current = code; hideNotification('template-save'); showNotification({ id: 'template-save', diff --git a/src/frontend/src/components/editors/TemplateEditor/index.tsx b/src/frontend/src/components/editors/TemplateEditor/index.tsx index c896e7d5a9..c675b0d2e6 100644 --- a/src/frontend/src/components/editors/TemplateEditor/index.tsx +++ b/src/frontend/src/components/editors/TemplateEditor/index.tsx @@ -1,3 +1,6 @@ -export { TemplateEditor } from './TemplateEditor'; +export { + TemplateEditor, + useTemplateEditorCloseGuard +} from './TemplateEditor'; export { CodeEditor } from './CodeEditor'; export { PdfPreview } from './PdfPreview'; diff --git a/src/frontend/src/components/plugins/PluginUIFeature.tsx b/src/frontend/src/components/plugins/PluginUIFeature.tsx index 482cbe7cef..5bbd07be9a 100644 --- a/src/frontend/src/components/plugins/PluginUIFeature.tsx +++ b/src/frontend/src/components/plugins/PluginUIFeature.tsx @@ -143,7 +143,19 @@ export const getPluginTemplatePreview = ( ); useImperativeHandle(ref, () => ({ - updatePreview: (...args) => updatePreviewRef.current?.(...args) + updatePreview: (...args) => { + const updatePreview = updatePreviewRef.current; + + if (!updatePreview) { + // The plugin has not registered its handler (yet): + // fail, so that the editor does not assume the template was saved + return Promise.reject( + new Error(t`The template preview is not ready yet.`) + ); + } + + return updatePreview(...args); + } })); useEffect(() => { diff --git a/src/frontend/src/tables/settings/SnippetTable.tsx b/src/frontend/src/tables/settings/SnippetTable.tsx index a31057d741..d11cafaf9e 100644 --- a/src/frontend/src/tables/settings/SnippetTable.tsx +++ b/src/frontend/src/tables/settings/SnippetTable.tsx @@ -25,8 +25,10 @@ import { type ReactNode, useCallback, useMemo, useState } from 'react'; import { useNavigate } from 'react-router-dom'; import { CodeEditor, - TemplateEditor + TemplateEditor, + useTemplateEditorCloseGuard } from '../../components/editors/TemplateEditor'; +import type { UnsavedChangesRef } from '../../components/editors/TemplateEditor/TemplateEditor'; import { AttachmentLink } from '../../components/items/AttachmentLink'; import { DescriptionColumn } from '../../components/tables/ColumnRenderers'; import { InvenTreeTable } from '../../components/tables/InvenTreeTable'; @@ -47,9 +49,11 @@ export type SnippetI = { }; export function SnippetDrawer({ - id + id, + unsavedChangesRef }: Readonly<{ id: string | number; + unsavedChangesRef?: UnsavedChangesRef; }>) { const { instance: snippet, @@ -90,6 +94,7 @@ export function SnippetDrawer({ fileField='snippet' editors={[CodeEditor]} previewAreas={[]} + unsavedChangesRef={unsavedChangesRef} /> ); @@ -98,6 +103,9 @@ export function SnippetDrawer({ export default function SnippetTable() { const table = useTable('report-snippet'); const navigate = useNavigate(); + + // Warn the user before closing the editor with unsaved changes + const closeGuard = useTemplateEditorCloseGuard(); const user = useUserState(); const openDetailDrawer = useCallback((pk: number) => navigate(`${pk}/`), []); @@ -215,8 +223,14 @@ export default function SnippetTable() { title={t`Edit Snippet`} size={'90%'} closeOnEscape={false} + onBeforeClose={closeGuard.onBeforeClose} renderContent={(id) => { - return ; + return ( + + ); }} /> } title={t`Snippets`}> diff --git a/src/frontend/src/tables/settings/TemplateTable.tsx b/src/frontend/src/tables/settings/TemplateTable.tsx index cf5334cb1a..440a7474f7 100644 --- a/src/frontend/src/tables/settings/TemplateTable.tsx +++ b/src/frontend/src/tables/settings/TemplateTable.tsx @@ -23,11 +23,13 @@ import type { TableColumn, TableColumnFilterType } from '@lib/types/Tables'; import { CodeEditor, PdfPreview, - TemplateEditor + TemplateEditor, + useTemplateEditorCloseGuard } from '../../components/editors/TemplateEditor'; import type { Editor, - PreviewArea + PreviewArea, + UnsavedChangesRef } from '../../components/editors/TemplateEditor/TemplateEditor'; import { ApiIcon } from '../../components/items/ApiIcon'; import { AttachmentLink } from '../../components/items/AttachmentLink'; @@ -87,10 +89,12 @@ export interface TemplateProps { export function TemplateDrawer({ id, - templateProps + templateProps, + unsavedChangesRef }: Readonly<{ id: string | number; templateProps: TemplateProps; + unsavedChangesRef?: UnsavedChangesRef; }>) { const { modelType, templateEndpoint, printingEndpoint } = templateProps; @@ -198,6 +202,7 @@ export function TemplateDrawer({ template={template} editors={editors} previewAreas={previews} + unsavedChangesRef={unsavedChangesRef} /> ); @@ -212,6 +217,9 @@ export function TemplateTable({ const table = useTable(`${templateEndpoint}-template`); const navigate = useNavigate(); + + // Warn the user before closing the editor with unsaved changes + const closeGuard = useTemplateEditorCloseGuard(); const user = useUserState(); const openDetailDrawer = useCallback((pk: number) => navigate(`${pk}/`), []); @@ -427,8 +435,15 @@ export function TemplateTable({ title={t`Edit Template`} size={'90%'} closeOnEscape={false} + onBeforeClose={closeGuard.onBeforeClose} renderContent={(id) => { - return ; + return ( + + ); }} />