feat: add failed store creation strategy

Lomray-Software · Aug 8, 2024 · 53c73bf · 53c73bf
1 parent adf35fe
commit 53c73bf
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 23 deletions.
diff --git a/src/manager.ts b/src/manager.ts
@@ -75,6 +75,7 @@ class Manager {
   public readonly options: IManagerOptions = {
     shouldDisablePersist: false,
     shouldRemoveInitState: true,
+    failedCreationStrategy: 'empty',
   };
 
   /**
@@ -337,14 +338,16 @@ class Manager {
     componentName: string,
     componentProps: Record<string, any> = {},
   ): IGroupedStores {
+    const { failedCreationStrategy } = this.options;
+
     const result = map.reduce(
       (res, [key, store]) => {
         const {
           id,
           store: s,
           isParent = false,
         } = 'store' in store ? store : { store, id: undefined, isParent: false };
-        const storeId =
+        let storeId =
           id ||
           (isParent
             ? (this.getStore(s, { contextId, parentId })?.libStoreId as string)
@@ -360,7 +363,16 @@ class Manager {
             true,
           );
 
-          return res;
+          if (failedCreationStrategy === 'dummy') {
+            // try to force create store
+            storeId = this.getStoreId(s, { key, contextId });
+          } else {
+            if (failedCreationStrategy === 'empty') {
+              res.hasCreationFailure = true;
+            }
+
+            return res;
+          }
         }
 
         const storeInstance = this.createStore(s, {
@@ -382,7 +394,7 @@ class Manager {
 
         return res;
       },
-      { relativeStores: {}, parentStores: {}, globalStores: {} },
+      { relativeStores: {}, parentStores: {}, globalStores: {}, hasCreationFailure: false },
     );
 
     // need create context relation in case when component doesn't include relative stores

diff --git a/src/types.ts b/src/types.ts
@@ -94,6 +94,13 @@ export interface IManagerOptions {
     touched?: number; // NOTE: set to max timeout request
     unused?: number;
   };
+  /**
+   * When for some strange reason stores cannot be created or found in the parent context:
+   * none: don't do anything
+   * dummy: force create empty store
+   * empty (default): don't render component if any of the stores not created
+   */
+  failedCreationStrategy: 'none' | 'dummy' | 'empty';
 }
 
 export type TAnyStore = IStore | IStorePersisted;
@@ -149,6 +156,7 @@ export interface IGroupedStores {
   relativeStores: TStores;
   parentStores: TStores;
   globalStores: TStores;
+  hasCreationFailure: boolean;
 }
 
 export interface IPersistOptions {

diff --git a/src/with-stores.tsx b/src/with-stores.tsx
@@ -23,32 +23,35 @@ const withStores = <T extends Record<string, any>, TS extends TMapStores>(
     const parentId = useStoreManagerParent();
     const { suspenseId } = useConsistentSuspense();
     const id = useId();
-    const [{ contextId, componentStores, touchableStores, mountStores }] = useState(() => {
-      const ctxId = manualContextId || id;
-      const groupedStores = storeManager.createStores(
-        Object.entries(stores),
-        parentId,
-        ctxId,
-        suspenseId,
-        componentName,
-        props,
-      );
-      const { globalStores, relativeStores, parentStores } = groupedStores;
-      const tStores = { ...relativeStores, ...globalStores };
+    const [{ contextId, hasFailure, touchableStores, componentStores, mountStores }] = useState(
+      () => {
+        const ctxId = manualContextId || id;
+        const groupedStores = storeManager.createStores(
+          Object.entries(stores),
+          parentId,
+          ctxId,
+          suspenseId,
+          componentName,
+          props,
+        );
+        const { globalStores, relativeStores, parentStores, hasCreationFailure } = groupedStores;
+        const tStores = { ...relativeStores, ...globalStores };
 
-      return {
-        touchableStores: tStores,
-        componentStores: { ...tStores, ...parentStores },
-        contextId: ctxId,
-        mountStores: () => storeManager.mountStores(ctxId, groupedStores),
-      };
-    });
+        return {
+          contextId: ctxId,
+          hasFailure: hasCreationFailure,
+          touchableStores: tStores,
+          componentStores: { ...tStores, ...parentStores },
+          mountStores: () => storeManager.mountStores(ctxId, groupedStores),
+        };
+      },
+    );
 
     useEffect(mountStores, [mountStores]);
 
     return (
       <StoreManagerParentProvider parentId={contextId} touchableStores={touchableStores}>
-        <ObservableComponent {...props} {...componentStores} />
+        {!hasFailure && <ObservableComponent {...props} {...componentStores} />}
       </StoreManagerParentProvider>
     );
   };