Switch indexedDb document serialized struct from camelCase to snake_case

Author: Keavon

desktop/wrapper/src/intercept_frontend_message.rs

@@ -71,9 +71,9 @@ pub(super) fn intercept_frontend_message(dispatcher: &mut DesktopWrapperMessageD
 			dispatcher.respond(DesktopFrontendMessage::PersistenceWriteDocument {
 				id: document_id,
 				document: Document {
+					content: document,
 					name: details.name,
 					path: details.path,
-					content: document,
 					is_saved: details.is_saved,
 				},
 			});

editor/src/messages/frontend/utility_types.rs

@@ -15,9 +15,9 @@ pub struct OpenDocument {
 pub struct DocumentDetails {
 	pub name: String,
 	pub path: Option<PathBuf>,
-	#[serde(rename = "isSaved")]
+	#[serde(alias = "isSaved")]
 	pub is_saved: bool,
-	#[serde(rename = "isAutoSaved")]
+	#[serde(alias = "isAutoSaved")]
 	pub is_auto_saved: bool,
 }
 

frontend/src/components/window/PanelSubdivision.svelte

@@ -4,6 +4,7 @@
 	import LayoutRow from "/src/components/layout/LayoutRow.svelte";
 	import Panel from "/src/components/window/Panel.svelte";
 	import type { PortfolioStore } from "/src/stores/portfolio";
+	import { savedStatus } from "/src/utility-functions/persistence";
 	import type { EditorWrapper, OpenDocument, PanelGroupState, PanelLayoutSubdivision } from "/wrapper/pkg/graphite_wasm_wrapper";
 
 	const MIN_PANEL_SIZE = 100;
@@ -33,7 +34,7 @@
 	$: resolvedSizes = subdivision && "Split" in subdivision ? subdivision.Split.children.map((child, index) => sizeOverrides[index] ?? child.size) : [];
 	$: documentTabLabels = $portfolio.documents.map((doc: OpenDocument) => {
 		const name = doc.details.name;
-		const unsaved = !doc.details.isSaved;
+		const unsaved = !savedStatus(doc.details).isSaved;
 		if (!editor.inDevelopmentMode()) return { name, unsaved };
 
 		const tooltipDescription = `Document ID: ${doc.id}`;

frontend/src/utility-functions/input.ts

@@ -5,6 +5,7 @@ import { toggleFullscreen } from "/src/stores/fullscreen";
 import type { PortfolioStore } from "/src/stores/portfolio";
 import { pasteFile } from "/src/utility-functions/files";
 import { makeKeyboardModifiersBitfield, textInputCleanup, getLocalizedScanCode } from "/src/utility-functions/keyboard-entry";
+import { savedStatus } from "/src/utility-functions/persistence";
 import { operatingSystem } from "/src/utility-functions/platform";
 import type { EditorWrapper } from "/wrapper/pkg/graphite_wasm_wrapper";
 
@@ -247,15 +248,15 @@ export function onModifyInputField(e: CustomEvent) {
 
 export async function onBeforeUnload(e: BeforeUnloadEvent, editor: EditorWrapper, portfolioStore: PortfolioStore) {
 	const activeDocument = get(portfolioStore).documents[get(portfolioStore).activeDocumentIndex];
-	if (activeDocument && !activeDocument.details.isAutoSaved) editor.triggerAutoSave(activeDocument.id);
+	if (activeDocument && !savedStatus(activeDocument.details).isAutoSaved) editor.triggerAutoSave(activeDocument.id);
 
 	// Skip the message if the editor crashed, since work is already lost
 	if (await editor.hasCrashed()) return;
 
 	// Skip the message during development, since it's annoying when testing
 	if (await editor.inDevelopmentMode()) return;
 
-	const allDocumentsSaved = get(portfolioStore).documents.reduce((acc, doc) => acc && doc.details.isSaved, true);
+	const allDocumentsSaved = get(portfolioStore).documents.reduce((acc, doc) => acc && savedStatus(doc.details).isSaved, true);
 	if (!allDocumentsSaved) {
 		e.returnValue = "Unsaved work will be lost if the web browser tab is closed. Close anyway?";
 		e.preventDefault();

frontend/src/utility-functions/persistence.ts

@@ -1,7 +1,7 @@
 import { get } from "svelte/store";
 import type { PortfolioStore } from "/src/stores/portfolio";
 import type { MessageBody } from "/src/subscriptions-router";
-import type { EditorWrapper } from "/wrapper/pkg/graphite_wasm_wrapper";
+import type { DocumentDetails, EditorWrapper } from "/wrapper/pkg/graphite_wasm_wrapper";
 
 const PERSISTENCE_DB = "graphite";
 const PERSISTENCE_STORE = "store";
@@ -72,13 +72,13 @@ export async function loadFirstDocument(editor: EditorWrapper) {
 
 	if (currentDocumentId !== undefined && String(currentDocumentId) in previouslySavedDocuments) {
 		const doc = previouslySavedDocuments[String(currentDocumentId)];
-		editor.openAutoSavedDocument(doc.documentId, doc.details.name, doc.details.isSaved, doc.document, false);
+		editor.openAutoSavedDocument(doc.documentId, doc.details.name, savedStatus(doc.details).isSaved, doc.document, false);
 		editor.selectDocument(currentDocumentId);
 	} else {
 		const len = orderedSavedDocuments.length;
 		if (len > 0) {
 			const doc = orderedSavedDocuments[len - 1];
-			editor.openAutoSavedDocument(doc.documentId, doc.details.name, doc.details.isSaved, doc.document, false);
+			editor.openAutoSavedDocument(doc.documentId, doc.details.name, savedStatus(doc.details).isSaved, doc.document, false);
 			editor.selectDocument(doc.documentId);
 		}
 	}
@@ -108,13 +108,11 @@ export async function loadRestDocuments(editor: EditorWrapper) {
 	if (currentIndex !== -1 && currentDocumentId !== undefined) {
 		for (let i = currentIndex - 1; i >= 0; i--) {
 			const { documentId, document, details } = orderedSavedDocuments[i];
-			const { name, isSaved } = details;
-			editor.openAutoSavedDocument(documentId, name, isSaved, document, true);
+			editor.openAutoSavedDocument(documentId, details.name, savedStatus(details).isSaved, document, true);
 		}
 		for (let i = currentIndex + 1; i < orderedSavedDocuments.length; i++) {
 			const { documentId, document, details } = orderedSavedDocuments[i];
-			const { name, isSaved } = details;
-			editor.openAutoSavedDocument(documentId, name, isSaved, document, false);
+			editor.openAutoSavedDocument(documentId, details.name, savedStatus(details).isSaved, document, false);
 		}
 
 		editor.selectDocument(currentDocumentId);
@@ -125,8 +123,7 @@ export async function loadRestDocuments(editor: EditorWrapper) {
 
 		for (let i = length - 2; i >= 0; i--) {
 			const { documentId, document, details } = orderedSavedDocuments[i];
-			const { name, isSaved } = details;
-			editor.openAutoSavedDocument(documentId, name, isSaved, document, true);
+			editor.openAutoSavedDocument(documentId, details.name, savedStatus(details).isSaved, document, true);
 		}
 
 		if (length > 0) editor.selectDocument(orderedSavedDocuments[length - 1].documentId);
@@ -236,3 +233,13 @@ async function databaseUpdate<T>(key: string, updater: (existing: T | undefined)
 		transaction.onerror = () => reject(transaction.error);
 	});
 }
+
+// TODO: Eventually remove this document upgrade code
+export function savedStatus(details: DocumentDetails): { isSaved: boolean; isAutoSaved: boolean } {
+	const unknownDetails: unknown = details;
+	if (typeof unknownDetails === "object" && unknownDetails !== null && "isSaved" in unknownDetails && "isAutoSaved" in unknownDetails) {
+		return { isSaved: Boolean(unknownDetails.isSaved), isAutoSaved: Boolean(unknownDetails.isAutoSaved) };
+	}
+
+	return { isSaved: details.is_saved, isAutoSaved: details.is_auto_saved };
+}