From 68d1d726af63a3e77d5a0c7f48ac7f277de34174 Mon Sep 17 00:00:00 2001
From: KoloMl <thekolomoets@hotmail.com>
Date: Mon, 12 Aug 2024 19:37:35 +0400
Subject: [PATCH] Added debug section to inspect extension's local storage

---
 src/components/debugging/StorageViewer.svelte | 93 +++++++++++++++++++
 src/lib/utils.js                              | 23 +++++
 src/routes/preferences/+page.svelte           |  2 +
 src/routes/preferences/debug/+page.svelte     | 10 ++
 .../preferences/debug/storage/+page.svelte    | 13 +++
 .../debug/storage/[...path]/+page.svelte      | 29 ++++++
 src/stores/debug.js                           | 19 ++++
 7 files changed, 189 insertions(+)
 create mode 100644 src/components/debugging/StorageViewer.svelte
 create mode 100644 src/lib/utils.js
 create mode 100644 src/routes/preferences/debug/+page.svelte
 create mode 100644 src/routes/preferences/debug/storage/+page.svelte
 create mode 100644 src/routes/preferences/debug/storage/[...path]/+page.svelte
 create mode 100644 src/stores/debug.js

diff --git a/src/components/debugging/StorageViewer.svelte b/src/components/debugging/StorageViewer.svelte
new file mode 100644
index 0000000..161ce7d
--- /dev/null
+++ b/src/components/debugging/StorageViewer.svelte
@@ -0,0 +1,93 @@
+<script>
+    import Menu from "$components/ui/menu/Menu.svelte";
+    import MenuItem from "$components/ui/menu/MenuItem.svelte";
+    import {storagesCollection} from "$stores/debug.js";
+    import {goto} from "$app/navigation";
+    import {findDeepObject} from "$lib/utils.js";
+
+    /** @type {string} */
+    export let storage;
+
+    /** @type {string[]} */
+    export let path;
+
+    /** @type {Object|null} */
+    let targetStorage = null;
+    /** @type {[string, string][]} */
+    let breadcrumbs = [];
+    /** @type {Object<string, any>|null} */
+    let targetObject = null;
+    let targetPathString = '';
+
+    $: {
+        /** @type {[string, string][]} */
+        const builtBreadcrumbs = [];
+
+        breadcrumbs = path.reduce((resultCrumbs, entry) => {
+            let entryPath = entry;
+
+            if (resultCrumbs.length) {
+                entryPath = resultCrumbs[resultCrumbs.length - 1] + "/" + entryPath;
+            }
+
+            resultCrumbs.push([entry, entryPath]);
+
+            return resultCrumbs;
+        }, builtBreadcrumbs);
+
+        targetPathString = path.join("/");
+
+        if (targetPathString.length) {
+            targetPathString += "/";
+        }
+    }
+
+    $: {
+        targetStorage = $storagesCollection[storage];
+
+        if (!targetStorage) {
+            goto("/preferences/debug/storage");
+        }
+    }
+
+    $: {
+        targetObject = targetStorage
+                ? findDeepObject(targetStorage, path)
+                : null;
+    }
+</script>
+
+<Menu>
+    <MenuItem href="/preferences/debug/storage" icon="arrow-left">Back</MenuItem>
+    <hr>
+</Menu>
+<p class="path">
+    <span>/ <a href="/preferences/debug/storage/{storage}">{storage}</a></span>
+    {#each breadcrumbs as [name, entryPath]}
+        <span>/ <a href="/preferences/debug/storage/{storage}/{entryPath}/">{name}</a></span>
+    {/each}
+</p>
+{#if targetObject}
+    <Menu>
+        <hr>
+        {#each Object.entries(targetObject) as [key, value]}
+            {#if targetObject[key] && typeof targetObject[key] === 'object'}
+                <MenuItem href="/preferences/debug/storage/{storage}/{targetPathString}{key}">
+                    {key}: Object
+                </MenuItem>
+            {:else}
+                <MenuItem>
+                    {key}: {typeof key} = {targetObject[key]}
+                </MenuItem>
+            {/if}
+        {/each}
+    </Menu>
+{/if}
+
+<style lang="scss">
+    .path {
+        display: flex;
+        flex-wrap: wrap;
+        column-gap: .5em;
+    }
+</style>
diff --git a/src/lib/utils.js b/src/lib/utils.js
new file mode 100644
index 0000000..db17ea5
--- /dev/null
+++ b/src/lib/utils.js
@@ -0,0 +1,23 @@
+/**
+ * Traverse and find the object using the key path.
+ * @param {Object} targetObject Target object to traverse into.
+ * @param {string[]} path Path of keys to traverse deep into the object.
+ * @return {Object|null} Resulting object or null if nothing found (or target entry is not an object.
+ */
+export function findDeepObject(targetObject, path) {
+  let result = targetObject;
+
+  for (let key of path) {
+    if (!result || typeof result !== 'object') {
+      return null;
+    }
+
+    result = result[key];
+  }
+
+  if (!result || typeof result !== "object") {
+    return null;
+  }
+
+  return result;
+}
diff --git a/src/routes/preferences/+page.svelte b/src/routes/preferences/+page.svelte
index c9f37fe..bc1d369 100644
--- a/src/routes/preferences/+page.svelte
+++ b/src/routes/preferences/+page.svelte
@@ -8,4 +8,6 @@
     <hr>
     <MenuItem href="/preferences/search">Search</MenuItem>
     <MenuItem href="/preferences/misc">Misc & Tools</MenuItem>
+    <hr>
+    <MenuItem href="/preferences/debug">Debug</MenuItem>
 </Menu>
diff --git a/src/routes/preferences/debug/+page.svelte b/src/routes/preferences/debug/+page.svelte
new file mode 100644
index 0000000..31e7210
--- /dev/null
+++ b/src/routes/preferences/debug/+page.svelte
@@ -0,0 +1,10 @@
+<script>
+    import Menu from "$components/ui/menu/Menu.svelte";
+    import MenuItem from "$components/ui/menu/MenuItem.svelte";
+</script>
+
+<Menu>
+    <MenuItem href="/preferences" icon="arrow-left">Back</MenuItem>
+    <hr>
+    <MenuItem href="/preferences/debug/storage">Inspect Storages</MenuItem>
+</Menu>
diff --git a/src/routes/preferences/debug/storage/+page.svelte b/src/routes/preferences/debug/storage/+page.svelte
new file mode 100644
index 0000000..ae87de5
--- /dev/null
+++ b/src/routes/preferences/debug/storage/+page.svelte
@@ -0,0 +1,13 @@
+<script>
+    import MenuItem from "$components/ui/menu/MenuItem.svelte";
+    import Menu from "$components/ui/menu/Menu.svelte";
+    import {storagesCollection} from "$stores/debug.js";
+</script>
+
+<Menu>
+    <MenuItem href="/preferences/debug" icon="arrow-left">Back</MenuItem>
+    <hr>
+    {#each Object.keys($storagesCollection) as storageName}
+        <MenuItem href="/preferences/debug/storage/{storageName}/">Storage: {storageName}</MenuItem>
+    {/each}
+</Menu>
diff --git a/src/routes/preferences/debug/storage/[...path]/+page.svelte b/src/routes/preferences/debug/storage/[...path]/+page.svelte
new file mode 100644
index 0000000..fecea3c
--- /dev/null
+++ b/src/routes/preferences/debug/storage/[...path]/+page.svelte
@@ -0,0 +1,29 @@
+<script>
+    import StorageViewer from "$components/debugging/StorageViewer.svelte";
+    import {page} from "$app/stores";
+    import {goto} from "$app/navigation";
+
+    let pathString = '';
+    /** @type {string[]} */
+    let pathArray = [];
+    /** @type {string|undefined} */
+    let storageName = void 0;
+
+    $: {
+        pathString = $page.params.path;
+        pathArray = pathString.length ? pathString.split("/") : [];
+        storageName = pathArray.shift()
+
+        if (pathArray.length && pathArray[pathArray.length - 1] === '') {
+            pathArray.pop();
+        }
+
+        if (!storageName) {
+            goto("/preferences/debug/storage");
+        }
+    }
+</script>
+
+{#if storageName}
+    <StorageViewer storage="{storageName}" path="{pathArray}"></StorageViewer>
+{/if}
diff --git a/src/stores/debug.js b/src/stores/debug.js
new file mode 100644
index 0000000..bfa2e52
--- /dev/null
+++ b/src/stores/debug.js
@@ -0,0 +1,19 @@
+import {writable} from "svelte/store";
+
+/**
+ * This is readable version of storages. Any changes made to these objects will not be sent to the local storage.
+ * @type {Writable<Record<string, Object>>}
+ */
+export const storagesCollection = writable({});
+
+chrome.storage.local.get(storages => {
+  storagesCollection.set(storages);
+});
+
+chrome.storage.local.onChanged.addListener(changes => {
+  storagesCollection.update(storages => {
+    for (let updatedStorageName of Object.keys(changes)) {
+      storages[updatedStorageName] = changes[updatedStorageName].newValue;
+    }
+  })
+});