Add useStorage and useCache hooks

dev_data/state/.gitignore

@@ -1 +1,2 @@
-logs
+logs
+local_storage

dev_plugin/src/command-generator.ts

@@ -18,6 +18,12 @@ export default function CommandGenerator(): GeneratedCommand[] {
             name: 'Generated Item 2',
             fn: () => {
                 console.log('generated-test-2')
+
+                sessionStorage.setItem("test", "test")
+                console.dir(sessionStorage.getItem("test"))
+
+                localStorage.setItem("test", "test")
+                console.dir(localStorage.getItem("test"))
             }
         },
         {

dev_plugin/src/grid-view.tsx

@@ -1,11 +1,17 @@
 import { Grid } from "@project-gauntlet/api/components";
 import { ReactElement } from "react";
+import { useStorage } from "@project-gauntlet/api/hooks";
 
 export default function GridView(): ReactElement {
     const numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19];
 
+    const [val1, setValue1] = useStorage("test", undefined);
+    const [val2, setValue2] = useStorage("test", { " test": "test" });
+    const [val3, setValue3] = useStorage("test", "");
+    const [val4, setValue4] = useStorage<string>("test", "");
+
     return (
-        <Grid>
+        <Grid onSelectionChange={id => {}}>
             {
                 numbers.map(value => (
                     <Grid.Item id={"id" + value} title={"Title " + value}>

js/api/src/hooks.ts

@@ -1,4 +1,4 @@
-import { ReactNode, useRef, useState, useCallback, useEffect, MutableRefObject } from 'react';
+import { ReactNode, useRef, useState, useCallback, useEffect, MutableRefObject, Dispatch, SetStateAction } from 'react';
 // @ts-ignore TODO how to add declaration for this?
 import { useGauntletContext } from "gauntlet:renderer";
 
@@ -203,3 +203,45 @@ export function usePromise<T extends (...args: any[]) => Promise<any>, R>(
         ...state
     };
 }
+
+// persistent, uses localStorage under the hood
+export function useStorage<T>(key: string, initialState: T | (() => T)): [T, Dispatch<SetStateAction<T>>] {
+    return useWebStorage(key, initialState, localStorage)
+}
+
+// ephemeral, uses sessionStorage under the hood
+export function useCache<T>(key: string, initialState: T | (() => T)): [T, Dispatch<SetStateAction<T>>] {
+    return useWebStorage(key, initialState, sessionStorage)
+}
+
+// keys are shared per plugin, across all entrypoints
+// uses JSON.serialize
+function useWebStorage<T>(
+    key: string,
+    initialState: T | (() => T),
+    storageObject: Storage
+): [T, Dispatch<SetStateAction<T>>] {
+
+    const [value, setValue] = useState<T>(() => {
+        const jsonValue = storageObject.getItem(key)
+
+        if (jsonValue != null) {
+            return JSON.parse(jsonValue) as T
+        }
+
+        if (initialState instanceof Function) {
+            return initialState()
+        } else {
+            return initialState
+        }
+    })
+
+    useEffect(() => {
+        if (value === undefined) {
+            return storageObject.removeItem(key)
+        }
+        storageObject.setItem(key, JSON.stringify(value))
+    }, [key, value, storageObject])
+
+    return [value, setValue]
+}

rust/common/src/dirs.rs

@@ -94,6 +94,10 @@ impl Dirs {
         (out_log_file, err_log_file)
     }
 
+    pub fn plugin_local_storage(&self, plugin_uuid: &str) -> PathBuf {
+        self.state_dir().join("local_storage").join(&plugin_uuid)
+    }
+
     pub fn state_dir(&self) -> PathBuf {
         let state_dir = if cfg!(feature = "release") || cfg!(feature = "scenario_runner") {
             let dir = match self.inner.state_dir() {

rust/server/src/plugins/js/mod.rs

@@ -322,6 +322,8 @@ async fn start_js_runtime(
         (StdioPipe::Inherit, StdioPipe::Inherit)
     };
 
+    let local_storage_dir = dirs.plugin_local_storage(&plugin_uuid);
+
     // let _inspector_server = Arc::new(
     //     InspectorServer::new(
     //         "127.0.0.1:9229".parse::<SocketAddr>().unwrap(),
@@ -352,6 +354,7 @@ async fn start_js_runtime(
             maybe_inspector_server: None,
             should_wait_for_inspector_session: false,
             should_break_on_first_statement: false,
+            origin_storage_dir: Some(local_storage_dir),
             stdio: Stdio {
                 stdin: StdioPipe::Inherit,
                 stdout,