From b124e1dcaeb35ab1dcd2a298ebab8fab31f2365f Mon Sep 17 00:00:00 2001
From: WhyAsh5114 <whyash5114@gmail.com>
Date: Tue, 24 Dec 2024 15:02:37 +0530
Subject: [PATCH] feat: added update data loss warning

---
 .../layout/ChangelogDialog.svelte             | 37 +++++++++++++------
 .../(components)/layout/PWAButtons.svelte     | 37 ++-----------------
 .../layout/PWAFunctions.svelte.ts             | 33 +++++++++++++++++
 .../layout/UpdateDataLossDialog.svelte        | 27 ++++++++++++++
 .../(components)/layout/UserDropdown.svelte   |  1 -
 src/routes/+layout.svelte                     | 15 +++++---
 src/routes/changelog/+page.server.ts          |  3 --
 7 files changed, 99 insertions(+), 54 deletions(-)
 create mode 100644 src/routes/(components)/layout/PWAFunctions.svelte.ts
 create mode 100644 src/routes/(components)/layout/UpdateDataLossDialog.svelte

diff --git a/src/routes/(components)/layout/ChangelogDialog.svelte b/src/routes/(components)/layout/ChangelogDialog.svelte
index 1e8a7455..21f63154 100644
--- a/src/routes/(components)/layout/ChangelogDialog.svelte
+++ b/src/routes/(components)/layout/ChangelogDialog.svelte
@@ -1,38 +1,53 @@
 <script lang="ts">
 	import ResponsiveDialog from '$lib/components/ResponsiveDialog.svelte';
-	import { onMount } from 'svelte';
-	import { marked } from 'marked';
+	import Button from '$lib/components/ui/button/button.svelte';
+	import ScrollArea from '$lib/components/ui/scroll-area/scroll-area.svelte';
 	import DOMPurify from 'dompurify';
+	import { marked } from 'marked';
+	import { onMount } from 'svelte';
 	import LoaderCircle from 'virtual:icons/lucide/loader-circle';
-	import ScrollArea from '$lib/components/ui/scroll-area/scroll-area.svelte';
+	import ReloadIcon from 'virtual:icons/lucide/refresh-ccw';
+	import { needRefresh, updateDataLossDialog } from './PWAFunctions.svelte';
 
 	let open = $state(false);
 	let dialogText = $state<string>();
+	let latestRelease = $state<{ tag_name: string; body: string }>();
+
+	onMount(async () => {
+		const response = await fetch('https://api.github.com/repos/WhyAsh5114/MyFit/releases/latest');
+		latestRelease = await response.json();
 
-	onMount(() => {
 		const ls = window.localStorage;
-		if (ls.getItem('changelogShown') !== 'true') {
+		const changelogShownOf = ls.getItem('changelogShownOf');
+		if (
+			changelogShownOf &&
+			changelogShownOf.localeCompare(latestRelease!.tag_name, undefined, { numeric: true }) === -1
+		) {
 			open = true;
 			loadChangelog();
-			ls.setItem('changelogShown', 'true');
 		}
+		ls.setItem('changelogShownOf', latestRelease!.tag_name);
 	});
 
 	async function loadChangelog() {
-		await new Promise((resolve) => setTimeout(resolve, 2000));
-		const response = await fetch('https://api.github.com/repos/WhyAsh5114/MyFit/releases/latest');
-		const data = await response.json();
-		dialogText = DOMPurify.sanitize(await marked.parse(data.body));
+		dialogText = DOMPurify.sanitize(await marked.parse(latestRelease!.body));
 	}
 </script>
 
-<ResponsiveDialog title="What's new?" bind:open>
+<ResponsiveDialog title="What's new?" bind:open dismissible={false}>
 	{#if dialogText}
 		<ScrollArea class="h-96">
 			<article class="prose prose-sm dark:prose-invert">
 				{@html dialogText}
 			</article>
 		</ScrollArea>
+		<Button disabled={!$needRefresh} class="gap-2" onclick={() => (updateDataLossDialog.open = true)}>
+			{#if !$needRefresh}
+				Fetching update <LoaderCircle class="animate-spin" />
+			{:else}
+				Update & reload <ReloadIcon />
+			{/if}
+		</Button>
 	{:else}
 		<div class="flex items-center justify-center gap-2 p-2 text-sm text-muted-foreground">
 			<LoaderCircle class="animate-spin" />
diff --git a/src/routes/(components)/layout/PWAButtons.svelte b/src/routes/(components)/layout/PWAButtons.svelte
index ab8ebe3e..26dcfbdd 100644
--- a/src/routes/(components)/layout/PWAButtons.svelte
+++ b/src/routes/(components)/layout/PWAButtons.svelte
@@ -1,20 +1,16 @@
 <script lang="ts">
+	import Button from '$lib/components/ui/button/button.svelte';
+	import { cn } from '$lib/utils';
 	import { onMount } from 'svelte';
-	import { useRegisterSW } from 'virtual:pwa-register/svelte';
-	import type { Writable } from 'svelte/store';
 	import DownloadIcon from 'virtual:icons/lucide/download';
 	import UpdateIcon from 'virtual:icons/lucide/refresh-cw';
-	import Button from '$lib/components/ui/button/button.svelte';
-	import { cn } from '$lib/utils';
+	import { needRefresh, updateDataLossDialog } from './PWAFunctions.svelte';
 
 	let { isMobile }: { isMobile: boolean } = $props();
 
 	let deferredPrompt: Event | null;
-	let needRefresh: Writable<boolean> | undefined = $state();
-
 	let reloading = $state(false);
 	let showInstallButton = $state(false);
-	let updateServiceWorker: (_arg0: boolean) => void;
 
 	onMount(() => {
 		window.addEventListener('beforeinstallprompt', (e) => {
@@ -26,35 +22,10 @@
 			showInstallButton = false;
 			deferredPrompt = null;
 		});
-
-		({ needRefresh, updateServiceWorker } = useRegisterSW({
-			onRegisteredSW(swUrl, r) {
-				// eslint-disable-next-line @typescript-eslint/no-unused-expressions
-				r &&
-					setInterval(async () => {
-						if (!(!r.installing && navigator)) return;
-						if ('connection' in navigator && !navigator.onLine) return;
-						const resp = await fetch(swUrl, {
-							cache: 'no-store',
-							headers: {
-								cache: 'no-store',
-								'cache-control': 'no-cache'
-							}
-						});
-						if (resp.status === 200) await r.update();
-					}, 3600000);
-				console.log(`SW Registered: ${r}`);
-			},
-			onRegisterError(error) {
-				console.log('SW registration error', error);
-			}
-		}));
 	});
 
 	function updateApplication() {
-		reloading = true;
-		localStorage.clear();
-		updateServiceWorker(true);
+		updateDataLossDialog.open = true;
 	}
 </script>
 
diff --git a/src/routes/(components)/layout/PWAFunctions.svelte.ts b/src/routes/(components)/layout/PWAFunctions.svelte.ts
new file mode 100644
index 00000000..78e3d2a1
--- /dev/null
+++ b/src/routes/(components)/layout/PWAFunctions.svelte.ts
@@ -0,0 +1,33 @@
+import { browser } from '$app/environment';
+import { useRegisterSW } from 'virtual:pwa-register/svelte';
+
+const sw = browser
+	? useRegisterSW({
+			onRegisteredSW(swUrl, r) {
+				if (r) {
+					setInterval(async () => {
+						if (!navigator || r.installing) return;
+						if ('connection' in navigator && !navigator.onLine) return;
+
+						const resp = await fetch(swUrl, {
+							cache: 'no-store',
+							headers: {
+								cache: 'no-store',
+								'cache-control': 'no-cache'
+							}
+						});
+						if (resp.status === 200) await r.update();
+					}, 3600000);
+				}
+				console.log(`SW Registered: ${r}`);
+			},
+			onRegisterError(error) {
+				console.log('SW registration error', error);
+			}
+		})
+	: null;
+
+export const needRefresh = sw?.needRefresh;
+export const updateServiceWorker = sw?.updateServiceWorker;
+export const offlineReady = sw?.offlineReady;
+export const updateDataLossDialog = $state({ open: false });
diff --git a/src/routes/(components)/layout/UpdateDataLossDialog.svelte b/src/routes/(components)/layout/UpdateDataLossDialog.svelte
new file mode 100644
index 00000000..fa5bcd97
--- /dev/null
+++ b/src/routes/(components)/layout/UpdateDataLossDialog.svelte
@@ -0,0 +1,27 @@
+<script lang="ts">
+	import ResponsiveDialog from '$lib/components/ResponsiveDialog.svelte';
+	import Button from '$lib/components/ui/button/button.svelte';
+	import LoaderCircle from 'virtual:icons/lucide/loader-circle';
+	import { updateDataLossDialog, updateServiceWorker } from './PWAFunctions.svelte';
+
+	let updating = $state(false);
+
+	function updateApp() {
+		updating = true;
+		localStorage.clear();
+		updateServiceWorker!(true);
+	}
+</script>
+
+<ResponsiveDialog title="Update app?" bind:open={updateDataLossDialog.open}>
+	{#snippet description()}
+		<p>Any unsaved data, like a workout in progress, or an unsaved mesocycle will be lost.</p>
+	{/snippet}
+	<Button disabled={updating} onclick={updateApp} class="gap-2">
+		{#if updating}
+			<LoaderCircle class="animate-spin" />
+		{:else}
+			Update
+		{/if}
+	</Button>
+</ResponsiveDialog>
diff --git a/src/routes/(components)/layout/UserDropdown.svelte b/src/routes/(components)/layout/UserDropdown.svelte
index c3b36bfb..eee3a323 100644
--- a/src/routes/(components)/layout/UserDropdown.svelte
+++ b/src/routes/(components)/layout/UserDropdown.svelte
@@ -8,7 +8,6 @@
 	function logOut() {
 		signOut();
 		localStorage.clear();
-		localStorage.setItem('changelogShown', 'true');
 	}
 </script>
 
diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte
index d6e4f483..e51e02a1 100644
--- a/src/routes/+layout.svelte
+++ b/src/routes/+layout.svelte
@@ -1,14 +1,15 @@
 <script lang="ts">
-	import '../app.pcss';
-	import { pwaInfo } from 'virtual:pwa-info';
-	import { ModeWatcher } from 'mode-watcher';
 	import { Toaster } from '$lib/components/ui/sonner';
-	import MobileLayout from './(components)/layout/MobileLayout.svelte';
-	import DesktopLayout from './(components)/layout/DesktopLayout.svelte';
+	import { ModeWatcher } from 'mode-watcher';
 	import { onMount } from 'svelte';
+	import { pwaInfo } from 'virtual:pwa-info';
+	import '../app.pcss';
+	import ChangelogDialog from './(components)/layout/ChangelogDialog.svelte';
+	import DesktopLayout from './(components)/layout/DesktopLayout.svelte';
+	import MobileLayout from './(components)/layout/MobileLayout.svelte';
+	import UpdateDataLossDialog from './(components)/layout/UpdateDataLossDialog.svelte';
 
 	import { overrideItemIdKeyNameBeforeInitialisingDndZones } from 'svelte-dnd-action';
-	import ChangelogDialog from './(components)/layout/ChangelogDialog.svelte';
 	overrideItemIdKeyNameBeforeInitialisingDndZones('name');
 
 	const { children } = $props();
@@ -30,7 +31,9 @@
 
 <ModeWatcher />
 <Toaster />
+
 <ChangelogDialog />
+<UpdateDataLossDialog />
 
 {#if isMobile === true}
 	<MobileLayout>{@render children()}</MobileLayout>
diff --git a/src/routes/changelog/+page.server.ts b/src/routes/changelog/+page.server.ts
index d57d7bb1..c9c30533 100644
--- a/src/routes/changelog/+page.server.ts
+++ b/src/routes/changelog/+page.server.ts
@@ -12,6 +12,3 @@ export const load = async () => {
 	})) as ReleaseData[];
 	return { releases };
 };
-
-// * fix changelogShownOf to be release version instead of a boolean
-// * compare it with the release version of the latest release and show dialog if needed