Eliminated HOOKSTATE-111 and HOOKSTATE-106 exceptions

avkonst · May 16, 2024 · f506584 · f506584
1 parent 040dab4
commit f506584
Show file tree

Hide file tree

Showing 6 changed files with 129 additions and 21 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,19 @@
+{
+    "version": "1.0.0",
+    "configurations": [
+      {
+        "name": "Test Core",
+        "request": "launch",
+        "runtimeArgs": [
+          "nx",
+          "test",
+          "core"
+        ],
+        "runtimeExecutable": "pnpm",
+        "skipFiles": [
+          "<node_internals>/**"
+        ],
+        "type": "node"
+      }
+    ]
+  }
diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ This is the mono repository, which combine the Hookstate core package, extension
 
 From the repository root directory:
 
-- `npm install -f pnpm` - install pnpm tool
+- `npm install -g pnpm` - install pnpm tool
 - `pnpm install` - install node_modules for all packages
 
 - `pnpm nx <script> <package>` - run script for a package as well as build dependencies if required, for example:

diff --git a/core/src/__tests__/Complex.tsx b/core/src/__tests__/Complex.tsx
@@ -199,3 +199,78 @@ test('complex: should auto save latest state for unmounted', async () => {
     expect(unmountedLink.field1.get()).toStrictEqual(2);
     expect(result.current[0].get().field1).toStrictEqual(2);
 });
+
+test('scoped: should reinitialize when parent state changes', async () => {
+    const initialStore = hookstate({ a: 0 });
+    const newStore = hookstate({ a: 1 });
+
+    let renderTimes = 0;
+    const { result, rerender } = renderHook(({ source }) => {
+        renderTimes += 1;
+        return useHookstate(source).a;
+    }, { initialProps: { source: initialStore } });
+
+    expect(renderTimes).toBe(1);
+    expect(result.current.get()).toBe(0);
+
+    act(() => {
+        result.current.set(p => p + 1);
+    });
+
+    expect(result.current.get()).toBe(1);
+    expect(renderTimes).toBe(2);
+
+    rerender({ source: newStore });
+
+    expect(renderTimes).toBe(3);
+    expect(result.current.get()).toBe(1); // Should reinitialize to new store's value
+});
+
+test('should synchronize unsubscription and reinitialization when source/store changes', async () => {
+    const initialStore = hookstate(0);
+    const newStore = hookstate(1);
+
+    let renderTimes = 0;
+    const { result, rerender } = renderHook(({ source }) => {
+        renderTimes += 1;
+        return useHookstate(source);
+    }, { initialProps: { source: initialStore } });
+
+    expect(renderTimes).toBe(1);
+    expect(result.current.get()).toBe(0);
+
+    act(() => {
+        result.current.set(p => p + 1);
+    });
+
+    expect(result.current.get()).toBe(1);
+    expect(renderTimes).toBe(2);
+
+    rerender({ source: newStore });
+
+    expect(renderTimes).toBe(3);
+    expect(result.current.get()).toBe(1); // Should reinitialize to new store's value
+});
+
+test('local: should reinitialize when initial state changes', async () => {
+    let renderTimes = 0;
+    const { result, rerender } = renderHook(({ initialState }) => {
+        renderTimes += 1;
+        return useHookstate(initialState);
+    }, { initialProps: { initialState: { a: 0 } } });
+
+    expect(renderTimes).toBe(1);
+    expect(result.current.a.get()).toBe(0);
+
+    act(() => {
+        result.current.a.set(p => p + 1);
+    });
+
+    expect(result.current.a.get()).toBe(1);
+    expect(renderTimes).toBe(2);
+
+    rerender({ initialState: { a: 1 } });
+
+    expect(renderTimes).toBe(3);
+    expect(result.current.a.get()).toBe(1); // Should reinitialize to new initial state
+});
diff --git a/core/src/__tests__/Extension.tsx b/core/src/__tests__/Extension.tsx
@@ -191,12 +191,13 @@ test('extension: common flow callbacks', async () => {
     expect(messages).toEqual([])
     messages.splice(0, messages.length);
 
+    console.warn = jest.fn()
     act(() => {
-        expect(() => result.current[0].f1.set(p => p + 1)).toThrow(
-            'Error: HOOKSTATE-106 [path: /0/f1]. See https://hookstate.js.org/docs/exceptions#hookstate-106'
-        );
+        result.current[0].f1.set(10)
     });
+    expect(console.warn).toHaveBeenCalledWith(`Warning: HOOKSTATE-106: Attempt to set state when it is destroyed. [path: /0/f1]`)
     expect(renderTimes).toStrictEqual(7);
+    expect(result.current.get()[0].f1).toStrictEqual(10);
     expect(messages).toEqual([])
     messages.splice(0, messages.length);
 });
@@ -399,12 +400,14 @@ test('extension: common flow callbacks global state', async () => {
     expect(messages).toEqual([])
     messages.splice(0, messages.length);
 
+
+    console.warn = jest.fn()
     act(() => {
-        expect(() => result.current[0].f1.set(p => p + 1)).toThrow(
-            'Error: HOOKSTATE-106 [path: /0/f1]. See https://hookstate.js.org/docs/exceptions#hookstate-106'
-        );
+        result.current[0].f1.set(p => p + 1)
     });
+    expect(console.warn).toHaveBeenCalledWith(`Warning: HOOKSTATE-106: Attempt to set state when it is destroyed. [path: /0/f1]`)
     expect(renderTimes).toStrictEqual(7);
+    expect(result.current.get()[0].f1).toStrictEqual(1);
     expect(messages).toEqual([])
     messages.splice(0, messages.length);
 });
diff --git a/core/src/__tests__/Primitive.tsx b/core/src/__tests__/Primitive.tsx
@@ -236,7 +236,7 @@ test('primitive: global state created locally', async () => {
         result.current!.set(p => p + 1);
     });
     expect(renderTimes).toStrictEqual(2);
-    expect(errorMessage).toStrictEqual("Error: Error: HOOKSTATE-111 [path: /]. See https://hookstate.js.org/docs/exceptions#hookstate-111")
+    expect(errorMessage).toStrictEqual("")
 });
 
 test('primitive: stale state should auto refresh', async () => {

diff --git a/core/src/index.ts b/core/src/index.ts
@@ -609,9 +609,10 @@ export function useHookstate<S, E extends {} = {}>(
                 // warning: this is called twice in react strict mode
                 let store = parentMethods.store
                 let onSetUsedCallback = () => setValue({
-                    store: store, // immutable
-                    state: state, // immutable
-                    source: value.source // mutable, get the latest from value
+                    store, // immutable
+                    state, // immutable
+                    source: value.source, // mutable, get the latest from value,
+                    parentMethods
                 })
                 let state = new StateMethodsImpl<S, E>(
                     store,
@@ -621,22 +622,26 @@ export function useHookstate<S, E extends {} = {}>(
                     onSetUsedCallback
                 );
                 return {
-                    store: store,
-                    state: state,
-                    source: source
+                    store,
+                    state,
+                    source,
+                    parentMethods
                 }
             };
-            const [value, setValue] = React.useState(initializer);
+            let [value, setValue] = React.useState(initializer);
 
             if (value.store !== parentMethods.store || !('source' in value)) {
-                throw new StateInvalidUsageError(parentMethods.path, ErrorId.InitStateStoreSwitchover)
+                value.state.onUnmount()
+                value.parentMethods.unsubscribe(value.state);
+                value = initializer()
             }
 
             // TODO move to a class hide props on prototype level
             // hide props from development tools
             Object.defineProperty(value, 'store', { enumerable: false });
             Object.defineProperty(value, 'state', { enumerable: false });
             Object.defineProperty(value, 'source', { enumerable: false });
+            Object.defineProperty(value, 'parentMethods', { enumerable: false });
 
             value.state.reconstruct(
                 parentMethods.path,
@@ -692,10 +697,12 @@ export function useHookstate<S, E extends {} = {}>(
                     source: source
                 }
             }
-            const [value, setValue] = React.useState(initializer);
+            let [value, setValue] = React.useState(initializer);
 
             if (value.store !== parentMethods.store || !('source' in value)) {
-                throw new StateInvalidUsageError(parentMethods.path, ErrorId.InitStateStoreSwitchover)
+                value.state.onUnmount()
+                value.store.unsubscribe(value.state);
+                value = initializer()
             }
 
             // hide props from development tools
@@ -759,10 +766,13 @@ export function useHookstate<S, E extends {} = {}>(
                 state: state
             }
         }
-        const [value, setValue] = React.useState(initializer);
+        let [value, setValue] = React.useState(initializer);
 
         if ('source' in value) {
-            throw new StateInvalidUsageError(RootPath, ErrorId.InitStateStoreSwitchover)
+            value.state.onUnmount()
+            value.store.unsubscribe(value.state);
+            value.store.deactivate()
+            value = initializer()
         }
 
         // hide props from development tools
@@ -1056,7 +1066,8 @@ class Store implements Subscribable {
     set(path: Path, value: StateValueAtPath): SetActionDescriptor {
         if (this.edition < 0) {
             // TODO convert to console log
-            throw new StateInvalidUsageError(path, ErrorId.SetStateWhenDestroyed)
+            // throw new StateInvalidUsageError(path, ErrorId.SetStateWhenDestroyed)
+            console.warn(`Warning: HOOKSTATE-106: Attempt to set state when it is destroyed. [path: /${path.join('/')}]`)
         }
 
         if (path.length === 0) {