Fix test

* master:
  Increase retries
  Temp fix for vite bug
  Update sk
  Update Browserslist
  chore(deps): bump node from 18.7.0 to 18.8.0
  chore(deps-dev): bump @typescript-eslint/eslint-plugin
  chore(deps-dev): bump typescript from 4.7.4 to 4.8.2
  Update svelteKit
  chore(deps): bump daisyui from 2.22.0 to 2.24.0

.vscode/settings.json

@@ -1,4 +1,7 @@
 {
 	"editor.formatOnSave": true,
-	"cSpell.words": ["pako", "Serde", "serdes"]
+	"cSpell.words": ["pako", "Serde", "serdes"],
+	"vitest.commandLine": "yarn test:unit",
+	"vitest.enable": true,
+	"testing.autoRun.mode": "rerun"
 }

cypress/e2e/actions.spec.ts

@@ -1,4 +1,4 @@
-import { disableDebounce } from './util';
+import { disableDebounce, verifyFileSize } from './util';
 describe('Check actions', () => {
 	beforeEach(() => {
 		cy.clearLocalStorage();
@@ -27,28 +27,22 @@ describe('Check actions', () => {
 
 	it('should download png and svg', () => {
 		cy.clock(new Date(2022, 0, 1).getTime());
-		const downloadsFolder = Cypress.config('downloadsFolder');
 
-		const verifyFileSize = (fileType: string, size: number) => {
-			cy.get(`#download${fileType.toUpperCase()}`).click();
-			const fileName = `mermaid-diagram-2022-01-01-000000.${fileType}`;
-			const filePath = `${downloadsFolder}/${fileName}`;
-			cy.verifyDownload(fileName);
-			cy.readFile(filePath, null, {
-				log: false
-			}).then((buffer) => expect((buffer as ArrayBuffer).byteLength).to.be.gt(size));
-			cy.task('deleteFile', filePath);
-		};
+		cy.get(`#downloadPNG`).click();
+		verifyFileSize('diagram', 'png', 21_000);
 
-		verifyFileSize('png', 21_000);
-		verifyFileSize('svg', 11_000);
+		cy.get(`#downloadSVG`).click();
+		verifyFileSize('diagram', 'svg', 10_000);
 
 		// Verify downloaded file is different for different diagrams
 		cy.contains('Sample Diagrams').click();
 		cy.contains('ER Diagram').click();
 
-		verifyFileSize('png', 46_000);
-		verifyFileSize('svg', 12_000);
+		cy.get(`#downloadPNG`).click();
+		verifyFileSize('diagram', 'png', 46_000);
+
+		cy.get(`#downloadSVG`).click();
+		verifyFileSize('diagram', 'svg', 12_000);
 
 		cy.clock().invoke('restore');
 	});

cypress/e2e/history.spec.ts

@@ -1,8 +1,8 @@
-import { getEditor, disableDebounce } from './util';
+import { getEditor, disableDebounce, verifyFileSnapshot } from './util';
 
 describe('Save History', () => {
 	beforeEach(() => {
-		cy.clock();
+		cy.clock(new Date(2022, 0, 1).getTime());
 		cy.clearLocalStorage();
 		cy.visit('/edit');
 		disableDebounce();
@@ -10,6 +10,38 @@ describe('Save History', () => {
 		cy.contains('History').click();
 	});
 
+	afterEach(() => {
+		cy.clock().invoke('restore');
+	});
+
+	it('should load history from localstorage', () => {
+		cy.setLocalStorage(
+			'manualHistoryStore',
+			'[{"state":{"code":"graph TD\\n    A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"manual","id":"d7ea820e-21dd-418a-b984-fd58acde09df","name":"hollow-art"},{"state":{"code":"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"b749ffc6-522b-4a44-86cf-7c1ffc3146b3","name":"helpful-ocean"}]'
+		);
+		cy.setLocalStorage(
+			'autoHistoryStore',
+			'[{"state":{"code":"graph TD\\n    A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"auto","id":"69ea820e-522b-4a44-86cf-fd58acde09df","name":"barking-dog"},{"state":{"code":"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"x749ffc6-21dd-418a-b984-7c1ffc3146b3","name":"needy-mosquito"}]'
+		);
+		cy.reload();
+		cy.contains('Actions').click();
+		cy.contains('History').click();
+		cy.get('#historyList').find('li').should('have.length', 2);
+		cy.get('#historyList').find('No items in History').should('not.exist');
+		cy.get('#historyList').contains('helpful-ocean');
+		cy.get('#historyList').contains('hollow-art');
+		cy.contains('Restore').click();
+		cy.contains('Halloween');
+		cy.contains('Timeline').click();
+
+		cy.get('#historyList').find('li').should('have.length', 2);
+		cy.get('#historyList').find('No items in History').should('not.exist');
+		cy.get('#historyList').contains('needy-mosquito');
+		cy.get('#historyList').contains('barking-dog');
+		cy.contains('Restore').click();
+		cy.contains('New Year');
+	});
+
 	it('should save when clicked', () => {
 		cy.get('#historyList').find('li').should('have.length', 0);
 		cy.get('#historyList').contains('No items in History');
@@ -64,4 +96,10 @@ describe('Save History', () => {
 		}
 		cy.get('#historyList').find('li').should('have.length', 30);
 	});
+
+	it('should download history', () => {
+		cy.get('#saveHistory').click();
+		cy.get(`#downloadHistory`).click();
+		verifyFileSnapshot('history', 'json', 'A[Christmas] -->|Get money| B(Go shopping)');
+	});
 });

cypress/e2e/util.ts

@@ -9,3 +9,35 @@ export const getEditor = ({ bottom = true, newline = false } = {}) =>
 		.type(`${newline ? '{enter}' : cmd}`);
 
 export const disableDebounce = () => cy.setLocalStorage('noDebounce', 'true');
+
+const downloadsFolder = Cypress.config('downloadsFolder');
+
+export const verifyFileSize = (
+	fileType: 'history' | 'diagram',
+	extension: string,
+	size: number
+) => {
+	const fileName = `mermaid-${fileType}-2022-01-01-000000.${extension}`;
+	const filePath = `${downloadsFolder}/${fileName}`;
+	cy.verifyDownload(fileName);
+	cy.readFile(filePath, null, {
+		log: false
+	}).then((buffer) => expect((buffer as ArrayBuffer).byteLength).to.be.gt(size));
+	cy.task('deleteFile', filePath);
+};
+
+export const verifyFileSnapshot = (
+	fileType: 'history' | 'diagram',
+	extension: string,
+	content: string
+) => {
+	const fileName = `mermaid-${fileType}-2022-01-01-000000.${extension}`;
+	const filePath = `${downloadsFolder}/${fileName}`;
+	cy.verifyDownload(fileName);
+	cy.readFile(filePath, null, {
+		log: false
+	}).then((buffer) =>
+		expect(new TextDecoder('utf-8').decode(buffer as ArrayBuffer)).to.contain(content)
+	);
+	cy.task('deleteFile', filePath);
+};

cypress/snapshots.js

@@ -16,7 +16,7 @@ module.exports = {
       "1": "{\"code\":\"graph TD\\n    A[Party] -->|Get money| B(Go shopping!!)\\n    \",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"forest\\\",\\n  \\\"test\\\": \\\"hello world\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"files\",\"config\":{\"codeURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/code.mmd\",\"configURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/config.json\"}}}"
     }
   },
-  "__version": "10.4.0",
+  "__version": "10.6.0",
   "Auto sync tests": {
     "should dim diagram when code is edited": {
       "1": "{\"code\":\"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)\\n    B --> C{Let me think}\\n    C -->|One| D[Laptop]\\n    C -->|Two| E[iPhone]\\n    C -->|Three| F[fa:fa-car Car]\\n    C --> Test\",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":false,\"autoSync\":false,\"updateDiagram\":false}"

package.json

@@ -27,6 +27,7 @@
 		"@testing-library/svelte": "3.2.1",
 		"@types/mermaid": "8.2.9",
 		"@types/pako": "1.0.3",
+		"@types/uuid": "^8.3.4",
 		"@typescript-eslint/eslint-plugin": "5.35.1",
 		"@typescript-eslint/parser": "5.34.0",
 		"@vitest/ui": "0.22.1",
@@ -75,7 +76,8 @@
 		"monaco-mermaid": "1.0.6",
 		"pako": "2.0.4",
 		"random-word-slugs": "0.1.6",
-		"svg-pan-zoom": "^3.6.1"
+		"svg-pan-zoom": "^3.6.1",
+		"uuid": "^8.3.2"
 	},
 	"lint-staged": {
 		"*.{ts,svelte,js,css,md,json}": [

src/lib/components/history/history.svelte

@@ -7,12 +7,15 @@
 		clearHistoryData,
 		getPreviousState,
 		historyStore,
-		loaderHistoryStore
+		loaderHistoryStore,
+		restoreHistory
 	} from './history';
 	import { notify, prompt } from '$lib/util/notify';
 	import { onMount } from 'svelte';
+	import { get } from 'svelte/store';
 	import moment from 'moment';
 	import type { HistoryType, State, Tab } from '$lib/types';
+	import { logEvent } from '$lib/util/stats';
 
 	const HISTORY_SAVE_INTERVAL = 60000;
 
@@ -32,6 +35,39 @@
 		}
 	];
 
+	const downloadHistory = () => {
+		const data = get(historyStore);
+		const blob = new Blob([JSON.stringify(data)], { type: 'application/json' });
+		const url = URL.createObjectURL(blob);
+		const a = document.createElement('a');
+		a.href = url;
+		a.download = `mermaid-history-${moment().format('YYYY-MM-DD-HHmmss')}.json`;
+		a.click();
+		URL.revokeObjectURL(url);
+		logEvent('history', {
+			action: 'download'
+		});
+	};
+
+	const uploadHistory = () => {
+		const input = document.createElement('input');
+		input.type = 'file';
+		input.accept = 'application/json';
+		input.addEventListener('change', ({ target }: Event) => {
+			const file = (<HTMLInputElement>target).files[0];
+			if (!file) {
+				return;
+			}
+			const reader = new FileReader();
+			reader.onload = (e) => {
+				const data = JSON.parse(e.target.result as string);
+				restoreHistory(data);
+			};
+			reader.readAsText(file);
+		});
+		input.click();
+	};
+
 	const saveHistory = (auto = false) => {
 		const currentState: string = getStateString();
 		const previousState: string = getPreviousState(auto);
@@ -46,14 +82,14 @@
 		}
 	};
 
-	const clearHistory = (date?: number): void => {
-		if (!date && !prompt('Clear all saved items?')) {
+	const clearHistory = (id?: string): void => {
+		if (!id && !prompt('Clear all saved items?')) {
 			return;
 		}
-		clearHistoryData(date);
+		clearHistoryData(id);
 	};
 
-	const restoreHistory = (state: State): void => {
+	const restoreHistoryItem = (state: State): void => {
 		inputStateStore.set({ ...state, updateEditor: true, updateDiagram: true });
 	};
 
@@ -88,6 +124,19 @@
 
 <Card on:select={tabSelectHandler} bind:isOpen {tabs} title="History">
 	<div slot="actions">
+		<button
+			id="uploadHistory"
+			class="btn btn-xs btn-secondary w-12"
+			on:click|stopPropagation={() => uploadHistory()}
+			title="Upload history"><i class="fa fa-upload" /></button>
+		{#if $historyStore.length > 0}
+			<button
+				id="downloadHistory"
+				class="btn btn-xs btn-secondary w-12"
+				on:click|stopPropagation={() => downloadHistory()}
+				title="Download history"><i class="fa fa-download" /></button>
+		{/if}
+		|
 		<button
 			id="saveHistory"
 			class="btn btn-xs btn-success w-12"
@@ -103,7 +152,7 @@
 	</div>
 	<ul class="p-2 space-y-2 overflow-auto h-56" id="historyList">
 		{#if $historyStore.length > 0}
-			{#each $historyStore as { state, time, name, url, type }}
+			{#each $historyStore as { id, state, time, name, url, type }}
 				<li class="rounded p-2 shadow flex-col">
 					<div class="flex">
 						<div class="flex-1">
@@ -121,10 +170,10 @@
 							</div>
 						</div>
 						<div class="flex gap-2 content-center">
-							<button class="btn btn-success" on:click={() => restoreHistory(state)}
+							<button class="btn btn-success" on:click={() => restoreHistoryItem(state)}
 								><i class="fas fa-undo mr-1" />Restore</button>
 							{#if type !== 'loader'}
-								<button class="btn btn-error" on:click={() => clearHistory(time)}
+								<button class="btn btn-error" on:click={() => clearHistory(id)}
 									><i class="fas fa-trash-alt mr-1" />Delete</button>
 							{/if}
 						</div>

src/lib/components/history/history.test.ts

@@ -0,0 +1,120 @@
+import type { HistoryEntry } from '$lib/types';
+import { describe, it, expect } from 'vitest';
+import {
+	addHistoryEntry,
+	injectHistoryIDs,
+	clearHistoryData,
+	historyModeStore,
+	historyStore
+} from './history';
+import { defaultState } from '../../util/state';
+import { get } from 'svelte/store';
+
+describe('history', () => {
+	it('should handle saving individual history entry', () => {
+		expect(window.localStorage.getItem('manualHistoryStore')).toBe('[]');
+		expect(window.localStorage.getItem('autoHistoryStore')).toBe('[]');
+
+		addHistoryEntry({
+			state: defaultState,
+			time: 12345,
+			type: 'manual'
+		});
+
+		const [manualEntry]: HistoryEntry[] = JSON.parse(
+			window.localStorage.getItem('manualHistoryStore')
+		);
+
+		expect(manualEntry.time).toBe(12345);
+		expect(manualEntry.type).toBe('manual');
+		expect(manualEntry.name).not.toBeNull();
+		expect(manualEntry.state).not.toBeNull();
+
+		addHistoryEntry({
+			state: defaultState,
+			time: 54321,
+			type: 'auto'
+		});
+
+		const [autoEntry]: HistoryEntry[] = JSON.parse(window.localStorage.getItem('autoHistoryStore'));
+
+		expect(autoEntry.time).toBe(54321);
+		expect(autoEntry.type).toBe('auto');
+		expect(autoEntry.name).not.toBeNull();
+		expect(autoEntry.state).not.toBeNull();
+
+		historyModeStore.set('manual');
+		clearHistoryData();
+		historyModeStore.set('auto');
+		clearHistoryData();
+		expect(window.localStorage.getItem('manualHistoryStore')).toBe('[]');
+		expect(window.localStorage.getItem('autoHistoryStore')).toBe('[]');
+	});
+
+	it('should clear history entries', () => {
+		addHistoryEntry({
+			state: defaultState,
+			time: 12345,
+			type: 'manual'
+		});
+		addHistoryEntry({
+			state: { ...defaultState, code: 'graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)' },
+			time: 123456,
+			type: 'manual'
+		});
+
+		historyModeStore.set('manual');
+		const store: HistoryEntry[] = get(historyStore);
+		expect(store.length).toBe(2);
+		clearHistoryData(store[1].id);
+		expect(get(historyStore).length).toBe(1);
+		clearHistoryData();
+		expect(get(historyStore).length).toBe(0);
+
+		historyModeStore.set('auto');
+		addHistoryEntry({
+			state: defaultState,
+			time: 54321,
+			type: 'auto'
+		});
+		addHistoryEntry({
+			state: { ...defaultState, code: 'graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)' },
+			time: 654321,
+			type: 'auto'
+		});
+		expect(get(historyStore).length).toBe(2);
+		clearHistoryData();
+		expect(get(historyStore).length).toBe(0);
+		// Test calling when history is empty
+		clearHistoryData();
+		expect(get(historyStore).length).toBe(0);
+	});
+});
+
+describe('history migration', () => {
+	it('should inject history IDs as migration', () => {
+		window.localStorage.setItem(
+			'manualHistoryStore',
+			'[{"state":{"code":"graph TD\\n    A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"manual","name":"hollow-art"},{"state":{"code":"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"helpful-ocean"}]'
+		);
+		window.localStorage.setItem(
+			'autoHistoryStore',
+			'[{"state":{"code":"graph TD\\n    A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"auto","name":"barking-dog"},{"state":{"code":"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"needy-mosquito"}]'
+		);
+		let manualHistoryStore: HistoryEntry[] = JSON.parse(
+			window.localStorage.getItem('manualHistoryStore')
+		);
+		let autoHistoryStore: HistoryEntry[] = JSON.parse(
+			window.localStorage.getItem('autoHistoryStore')
+		);
+		expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
+		expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
+
+		injectHistoryIDs();
+
+		manualHistoryStore = JSON.parse(window.localStorage.getItem('manualHistoryStore'));
+		autoHistoryStore = JSON.parse(window.localStorage.getItem('autoHistoryStore'));
+		expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
+		expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
+	});
+});

src/lib/components/history/history.ts

@@ -2,7 +2,9 @@ import { derived, writable, get } from 'svelte/store';
 import type { Readable, Writable } from 'svelte/store';
 import { persist, localStorage } from '@macfja/svelte-persistent-store';
 import { generateSlug } from 'random-word-slugs';
-import type { HistoryEntry, HistoryType } from '$lib/types';
+import type { HistoryEntry, HistoryType, Optional } from '$lib/types';
+import { v4 as uuidV4 } from 'uuid';
+import { logEvent } from '$lib/util/stats';
 
 const MAX_AUTO_HISTORY_LENGTH = 30;
 
@@ -41,28 +43,39 @@ export const historyStore: Readable<HistoryEntry[]> = derived(
 	}
 );
 
-export const addHistoryEntry = (entry: HistoryEntry): void => {
+export const addHistoryEntry = (entryToAdd: Optional<HistoryEntry, 'id'>): void => {
+	const entry: HistoryEntry = {
+		...entryToAdd,
+		id: uuidV4()
+	};
+
 	if (entry.type === 'loader') {
 		loaderHistoryStore.update((entries) => [entry, ...entries]);
 		return;
 	}
+
+	if (!entry.name) {
 		entry.name = generateSlug(2);
-	if (entry.type !== 'auto') {
-		manualHistoryStore.update((entries) => [entry, ...entries]);
-		return;
 	}
+
+	if (entry.type === 'auto') {
 		autoHistoryStore.update((entries) => {
-		if (entries.length === MAX_AUTO_HISTORY_LENGTH) {
-			entries.pop();
+			if (entries.length >= MAX_AUTO_HISTORY_LENGTH) {
+				entries = entries.slice(0, MAX_AUTO_HISTORY_LENGTH - 1);
 			}
 			return [entry, ...entries];
 		});
+	} else if (entry.type === 'manual') {
+		manualHistoryStore.update((entries) => [entry, ...entries]);
+		logEvent('history', { action: 'save' });
+	}
 };
 
-export const clearHistoryData = (time?: number): void => {
+export const clearHistoryData = (idToClear?: string): void => {
 	(get(historyModeStore) === 'auto' ? autoHistoryStore : manualHistoryStore).update((entries) => {
 		if (get(historyModeStore) !== 'loader') {
-			entries = entries.filter((entry) => time && entry.time != time);
+			entries = entries.filter(({ id }) => idToClear && id != idToClear);
+			logEvent('history', { action: 'clear', type: idToClear ? 'single' : 'all' });
 		}
 		return entries;
 	});
@@ -75,3 +88,54 @@ export const getPreviousState = (auto: boolean): string => {
 	}
 	return '';
 };
+
+export const restoreHistory = (data: HistoryEntry[]) => {
+	const entries = data.filter(validateEntry);
+	const invalidEntryCount = data.length - entries.length;
+	if (invalidEntryCount > 0) {
+		console.error(`${invalidEntryCount} invalid history entries were removed.`);
+		console.error(data);
+	}
+	if (entries.length > 0) {
+		let entryCount = 0;
+		(entries[0].type === 'auto' ? autoHistoryStore : manualHistoryStore).update((existing) => {
+			const existingIDs = new Set(existing.map(({ id }) => id));
+			const newEntries = entries.filter(({ id }) => !existingIDs.has(id));
+			entryCount = newEntries.length;
+			const combined = [...existing, ...newEntries];
+			combined.sort((a, b) => b.time - a.time);
+			return combined;
+		});
+
+		alert(
+			`${entryCount} entries restored. ${invalidEntryCount} invalid, ${
+				entries.length - entryCount
+			} duplicates.`
+		);
+		logEvent('history', {
+			action: 'restore',
+			success: entryCount,
+			invalid: invalidEntryCount,
+			duplicates: entries.length - entryCount
+		});
+	} else {
+		alert('No valid entries found.');
+	}
+};
+
+export const injectHistoryIDs = (): void => {
+	const setIDs = (entries: HistoryEntry[]) => {
+		for (const entry of entries) {
+			if (!entry.id) {
+				entry.id = uuidV4();
+			}
+		}
+		return entries;
+	};
+	autoHistoryStore.update(setIDs);
+	manualHistoryStore.update(setIDs);
+};
+
+const validateEntry = (entry: HistoryEntry): boolean => {
+	return entry.type && entry.state && entry.time && true;
+};

src/lib/types.d.ts

@@ -68,13 +68,16 @@ export interface LoaderConfig {
 	config: GistLoaderConfig | FileLoaderConfig;
 }
 export type HistoryType = 'auto' | 'manual' | 'loader';
-export interface HistoryEntry {
-	state: State;
-	time: number;
-	name?: string;
-	type: HistoryType;
-	url?: string;
+export type HistoryEntry = { id: string; state: State; time: number; url?: string } & (
+	| {
+			type: 'loader';
+			name: string;
 	  }
+	| {
+			type: HistoryType;
+			name?: string;
+	  }
+);
 
 export interface DocConfig {
 	[key: string]: {
@@ -84,3 +87,4 @@ export interface DocConfig {
 }
 
 export type Loader = (url: string) => Promise<State>;
+export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;

src/lib/util/migrations.test.ts

@@ -0,0 +1,34 @@
+import type { HistoryEntry } from '$lib/types';
+import { describe, it, expect, beforeEach } from 'vitest';
+
+describe('migrations', () => {
+	beforeEach(() => {
+		window.localStorage.setItem(
+			'manualHistoryStore',
+			'[{"state":{"code":"graph TD\\n    A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"manual","name":"hollow-art"},{"state":{"code":"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"helpful-ocean"}]'
+		);
+		window.localStorage.setItem(
+			'autoHistoryStore',
+			'[{"state":{"code":"graph TD\\n    A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"auto","name":"barking-dog"},{"state":{"code":"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n  \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"needy-mosquito"}]'
+		);
+	});
+
+	it('should migrate from v0 to v1', async () => {
+		const { applyMigrations } = await import('./migrations');
+		let manualHistoryStore: HistoryEntry[] = JSON.parse(
+			window.localStorage.getItem('manualHistoryStore')
+		);
+		let autoHistoryStore: HistoryEntry[] = JSON.parse(
+			window.localStorage.getItem('autoHistoryStore')
+		);
+		expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
+		expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
+
+		applyMigrations();
+
+		manualHistoryStore = JSON.parse(window.localStorage.getItem('manualHistoryStore'));
+		autoHistoryStore = JSON.parse(window.localStorage.getItem('autoHistoryStore'));
+		expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
+		expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
+	});
+});

src/lib/util/migrations.ts

@@ -0,0 +1,35 @@
+import { writable, get, type Writable } from 'svelte/store';
+import { persist, localStorage } from '@macfja/svelte-persistent-store';
+import { injectHistoryIDs } from '$lib/components/history/history';
+import { logEvent } from './stats';
+
+interface MigrationState {
+	version: number;
+}
+
+const migrations: { [key: string]: () => void } = {
+	injectHistoryIDs
+};
+
+const migrationStore: Writable<MigrationState> = persist(
+	writable({ version: -1 }),
+	localStorage(),
+	'migrations'
+);
+
+export const applyMigrations = (): void => {
+	const { version }: MigrationState = get(migrationStore);
+	const allMigrations = Object.entries(migrations);
+	if (version === allMigrations.length - 1) {
+		return;
+	}
+	console.log(`Current migration version: v${version}. Migrating to v${allMigrations.length - 1}.`);
+	for (let i = version + 1; i < allMigrations.length; i++) {
+		const [key, fn] = allMigrations[i];
+		console.log(`Applying migration ${i}: ${key}.`);
+		fn();
+		logEvent('migration', { key });
+		migrationStore.set({ version: i });
+	}
+	logEvent('migration', { status: 'complete', from: version, to: allMigrations.length - 1 });
+};

src/routes/+layout.svelte

@@ -6,10 +6,12 @@
 	import { setTheme, themeStore } from '$lib/util/theme';
 	import { toggleDarkTheme } from '$lib/util/state';
 	import { initHandler } from '$lib/util/util';
+	import { applyMigrations } from '$lib/util/migrations';
 
 	// This can be removed once https://github.com/sveltejs/kit/issues/1612 is fixed.
 	// Then move it into src and vite will bundle it automatically.
 	onMount(() => {
+		applyMigrations();
 		window.addEventListener('hashchange', async (ev) => {
 			await initHandler();
 		});

yarn.lock

@@ -458,6 +458,11 @@
   dependencies:
     "@types/jest" "*"
 
+"@types/uuid@^8.3.4":
+  version "8.3.4"
+  resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-8.3.4.tgz#bd86a43617df0594787d38b735f55c805becf1bc"
+  integrity sha512-c/I8ZRb51j+pYGAu5CrFMRxqZ2ke4y2grEBO5AUjgSkSk+qT2Ea+OdWElz/OiMf5MNpn2b17kuVBwZLQJXzihw==
+
 "@types/yauzl@^2.9.1":
   version "2.9.1"
   resolved "https://registry.npmjs.org/@types/yauzl/-/yauzl-2.9.1.tgz"