@squide/firefly 16.2.0 → 16.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @squide/firefly
 
+## 16.2.1
+
+### Patch Changes
+
+- [#567](https://github.com/workleap/wl-squide/pull/567) [`5f16979`](https://github.com/workleap/wl-squide/commit/5f16979d9e922590fdca39be76e79dde54211efa) Thanks [@patricklafrance](https://github.com/patricklafrance)! - useDeferredRegistrations will now trigger a deferred registration update whenever the data object reference changes, even if no global data has been fetch or no feature flags changed.
+
 ## 16.2.0
 
 ### Minor Changes

package/dist/useCanUpdateDeferredRegistrations.d.ts

@@ -1 +1 @@
-export declare function useCanUpdateDeferredRegistrations(): boolean | 0 | undefined;
+export declare function useCanUpdateDeferredRegistrations(): boolean;

package/dist/useCanUpdateDeferredRegistrations.js

@@ -5,10 +5,21 @@ import { useAppRouterState } from "./AppRouterContext.js";
 ;// CONCATENATED MODULE: ./src/useCanUpdateDeferredRegistrations.ts
 
 function useCanUpdateDeferredRegistrations() {
-    const { areModulesReady, publicDataUpdatedAt, protectedDataUpdatedAt, featureFlagsUpdatedAt, deferredRegistrationsUpdatedAt } = useAppRouterState();
-    return(// Do not trigger an update if the deferred registrations has not been registered yet (if there are deferred registrations, once they are
-    // registered, the modules will be marked as ready).
-    areModulesReady && deferredRegistrationsUpdatedAt && (publicDataUpdatedAt && publicDataUpdatedAt > deferredRegistrationsUpdatedAt || protectedDataUpdatedAt && protectedDataUpdatedAt > deferredRegistrationsUpdatedAt || featureFlagsUpdatedAt && featureFlagsUpdatedAt > deferredRegistrationsUpdatedAt));
+    const { areModulesReady } = useAppRouterState();
+    return areModulesReady;
+// return !!(
+//     // Do not trigger an update if the deferred registrations has not been registered yet (if there are deferred registrations, once they are
+//     // registered, the modules will be marked as ready).
+//     areModulesReady
+//     // Make sure the apps is actually having deferred registrations.
+//     // && deferredRegistrationsUpdatedAt
+//     // // If either the public data or the protected data has been updated, update the deferred registrations.
+//     // && (
+//     //     (publicDataUpdatedAt && publicDataUpdatedAt > deferredRegistrationsUpdatedAt) ||
+//     //     (protectedDataUpdatedAt && protectedDataUpdatedAt > deferredRegistrationsUpdatedAt) ||
+//     //     (featureFlagsUpdatedAt && featureFlagsUpdatedAt > deferredRegistrationsUpdatedAt)
+//     // )
+// );
 }
 
 export { useCanUpdateDeferredRegistrations };

package/dist/useCanUpdateDeferredRegistrations.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCanUpdateDeferredRegistrations.js","sources":["../src/useCanUpdateDeferredRegistrations.ts"],"sourcesContent":["import { useAppRouterState } from \"./AppRouterContext.ts\";\n\nexport function useCanUpdateDeferredRegistrations() {\n    const {\n        areModulesReady,\n        publicDataUpdatedAt,\n        protectedDataUpdatedAt,\n        featureFlagsUpdatedAt,\n        deferredRegistrationsUpdatedAt\n    } = useAppRouterState();\n\n    return (\n        // Do not trigger an update if the deferred registrations has not been registered yet (if there are deferred registrations, once they are\n        // registered, the modules will be marked as ready).\n        areModulesReady\n        // Make sure the apps is actually having deferred registrations.\n        && deferredRegistrationsUpdatedAt\n        // If either the public data or the protected data has been updated, update the deferred registrations.\n        && (\n            (publicDataUpdatedAt && publicDataUpdatedAt > deferredRegistrationsUpdatedAt) ||\n            (protectedDataUpdatedAt && protectedDataUpdatedAt > deferredRegistrationsUpdatedAt) ||\n            (featureFlagsUpdatedAt && featureFlagsUpdatedAt > deferredRegistrationsUpdatedAt)\n        )\n    );\n}\n"],"names":["useAppRouterState","useCanUpdateDeferredRegistrations","areModulesReady","publicDataUpdatedAt","protectedDataUpdatedAt","featureFlagsUpdatedAt","deferredRegistrationsUpdatedAt"],"mappings":";;;;;AAA0D;AAEnD,SAASC;IACZ,MAAM,EACFC,eAAe,EACfC,mBAAmB,EACnBC,sBAAsB,EACtBC,qBAAqB,EACrBC,8BAA8B,EACjC,GAAGN,iBAAiBA;IAErB,OACI,yIAAyI;IACzI,oDAAoD;IACpDE,mBAEGI,kCAGC,CAACH,uBAAuBA,sBAAsBG,kCAC7CF,0BAA0BA,yBAAyBE,kCACnDD,yBAAyBA,wBAAwBC,8BAA8B;AAG5F"}
+{"version":3,"file":"useCanUpdateDeferredRegistrations.js","sources":["../src/useCanUpdateDeferredRegistrations.ts"],"sourcesContent":["import { useAppRouterState } from \"./AppRouterContext.ts\";\n\nexport function useCanUpdateDeferredRegistrations() {\n    const {\n        areModulesReady\n        // publicDataUpdatedAt,\n        // protectedDataUpdatedAt,\n        // featureFlagsUpdatedAt,\n        // deferredRegistrationsUpdatedAt\n    } = useAppRouterState();\n\n    return areModulesReady;\n\n    // return !!(\n    //     // Do not trigger an update if the deferred registrations has not been registered yet (if there are deferred registrations, once they are\n    //     // registered, the modules will be marked as ready).\n    //     areModulesReady\n    //     // Make sure the apps is actually having deferred registrations.\n    //     // && deferredRegistrationsUpdatedAt\n    //     // // If either the public data or the protected data has been updated, update the deferred registrations.\n    //     // && (\n    //     //     (publicDataUpdatedAt && publicDataUpdatedAt > deferredRegistrationsUpdatedAt) ||\n    //     //     (protectedDataUpdatedAt && protectedDataUpdatedAt > deferredRegistrationsUpdatedAt) ||\n    //     //     (featureFlagsUpdatedAt && featureFlagsUpdatedAt > deferredRegistrationsUpdatedAt)\n    //     // )\n    // );\n}\n"],"names":["useAppRouterState","useCanUpdateDeferredRegistrations","areModulesReady"],"mappings":";;;;;AAA0D;AAEnD,SAASC;IACZ,MAAM,EACFC,eAAe,EAKlB,GAAGF,iBAAiBA;IAErB,OAAOE;AAEP,aAAa;AACb,gJAAgJ;AAChJ,2DAA2D;AAC3D,sBAAsB;AACtB,uEAAuE;AACvE,2CAA2C;AAC3C,iHAAiH;AACjH,cAAc;AACd,8FAA8F;AAC9F,oGAAoG;AACpG,+FAA+F;AAC/F,WAAW;AACX,KAAK;AACT"}

package/dist/useDeferredRegistrations.js

@@ -1,5 +1,5 @@
 import { useRuntime } from "@squide/core";
-import { useEffect } from "react";
+import { useEffect, useRef } from "react";
 import { useCanRegisterDeferredRegistrations } from "./useCanRegisterDeferredRegistrations.js";
 import { useCanUpdateDeferredRegistrations } from "./useCanUpdateDeferredRegistrations.js";
 import { useRegisterDeferredRegistrations } from "./useRegisterDeferredRegistrations.js";
@@ -26,6 +26,7 @@ import { useUpdateDeferredRegistrations } from "./useUpdateDeferredRegistrations
 
 function useDeferredRegistrations(data, { onError } = {}) {
     const runtime = useRuntime();
+    // const isExecutedBecauseModulesAreNowReadyRef = useRef(true);
     const canRegisterDeferredRegistrations = useCanRegisterDeferredRegistrations();
     const canUpdateDeferredRegistrations = useCanUpdateDeferredRegistrations();
     const registerDeferredRegistrations = useRegisterDeferredRegistrations();
@@ -46,8 +47,18 @@ function useDeferredRegistrations(data, { onError } = {}) {
         data,
         onError
     ]);
+    const isInitialUpdateDeferredRegistrationsExecution = useRef(true);
     useEffect(()=>{
         if (canUpdateDeferredRegistrations) {
+            // HACK: Skipping the first execution successfully passing the gate because this is due to
+            // the modules being ready, and it's most certainly the same data that has been forwarded earlier to the deferred registration.
+            // Ideally, instead of this hacky ref, it would be a ref tracking the previous data object, and the deferred registration would
+            // only be updated if the current data object != than the previous data object. Sadly, it is not possible because
+            // of the feature flags.
+            if (isInitialUpdateDeferredRegistrationsExecution.current) {
+                isInitialUpdateDeferredRegistrationsExecution.current = false;
+                return;
+            }
             const update = async ()=>{
                 const errors = await updateDeferredRegistrations(data);
                 if (errors.length > 0 && onError) {

package/dist/useDeferredRegistrations.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDeferredRegistrations.js","sources":["../src/useDeferredRegistrations.ts"],"sourcesContent":["import { useRuntime, type ModuleRegistrationError } from \"@squide/core\";\nimport { useEffect } from \"react\";\nimport { FireflyRuntime } from \"./FireflyRuntime.tsx\";\nimport { useCanRegisterDeferredRegistrations } from \"./useCanRegisterDeferredRegistrations.ts\";\nimport { useCanUpdateDeferredRegistrations } from \"./useCanUpdateDeferredRegistrations.ts\";\nimport { useRegisterDeferredRegistrations } from \"./useRegisterDeferredRegistrations.ts\";\nimport { useUpdateDeferredRegistrations } from \"./useUpdateDeferredRegistrations.ts\";\n\nexport type DeferredRegistrationsErrorCallback = (errors: ModuleRegistrationError[]) => void;\n\nexport interface UseDeferredRegistrationsOptions {\n    onError?: DeferredRegistrationsErrorCallback;\n}\n\nexport function useDeferredRegistrations(data?: unknown, { onError }: UseDeferredRegistrationsOptions = {}) {\n    const runtime = useRuntime() as FireflyRuntime;\n\n    const canRegisterDeferredRegistrations = useCanRegisterDeferredRegistrations();\n    const canUpdateDeferredRegistrations = useCanUpdateDeferredRegistrations();\n\n    const registerDeferredRegistrations = useRegisterDeferredRegistrations();\n    const updateDeferredRegistrations = useUpdateDeferredRegistrations();\n\n    useEffect(() => {\n        if (canRegisterDeferredRegistrations) {\n            const register = async () => {\n                const errors = await registerDeferredRegistrations(data);\n\n                if (errors.length > 0 && onError) {\n                    onError(errors);\n                }\n            };\n\n            register();\n        }\n    }, [canRegisterDeferredRegistrations, registerDeferredRegistrations, data, onError]);\n\n    useEffect(() => {\n        if (canUpdateDeferredRegistrations) {\n            const update = async () => {\n                const errors = await updateDeferredRegistrations(data);\n\n                if (errors.length > 0 && onError) {\n                    onError(errors);\n                }\n            };\n\n            update();\n        }\n    }, [\n        canUpdateDeferredRegistrations,\n        updateDeferredRegistrations,\n        data,\n        onError,\n        // Trigger this closure when the feature flags changed. Using the timestamp because the\n        // actual feature flags are not forwarded to the deferred registrations.\n        runtime.appRouterStore.state.featureFlagsUpdatedAt\n    ]);\n}\n"],"names":["useRuntime","useEffect","useCanRegisterDeferredRegistrations","useCanUpdateDeferredRegistrations","useRegisterDeferredRegistrations","useUpdateDeferredRegistrations","useDeferredRegistrations","data","onError","runtime","canRegisterDeferredRegistrations","canUpdateDeferredRegistrations","registerDeferredRegistrations","updateDeferredRegistrations","register","errors","update"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAwE;AACtC;AAE6D;AACJ;AACF;AACJ;AAQ9E,SAASM,yBAAyBC,IAAc,EAAE,EAAEC,OAAO,EAAmC,GAAG,CAAC,CAAC;IACtG,MAAMC,UAAUT,UAAUA;IAE1B,MAAMU,mCAAmCR,mCAAmCA;IAC5E,MAAMS,iCAAiCR,iCAAiCA;IAExE,MAAMS,gCAAgCR,gCAAgCA;IACtE,MAAMS,8BAA8BR,8BAA8BA;IAElEJ,SAASA,CAAC;QACN,IAAIS,kCAAkC;YAClC,MAAMI,WAAW;gBACb,MAAMC,SAAS,MAAMH,8BAA8BL;gBAEnD,IAAIQ,OAAO,MAAM,GAAG,KAAKP,SAAS;oBAC9BA,QAAQO;gBACZ;YACJ;YAEAD;QACJ;IACJ,GAAG;QAACJ;QAAkCE;QAA+BL;QAAMC;KAAQ;IAEnFP,SAASA,CAAC;QACN,IAAIU,gCAAgC;YAChC,MAAMK,SAAS;gBACX,MAAMD,SAAS,MAAMF,4BAA4BN;gBAEjD,IAAIQ,OAAO,MAAM,GAAG,KAAKP,SAAS;oBAC9BA,QAAQO;gBACZ;YACJ;YAEAC;QACJ;IACJ,GAAG;QACCL;QACAE;QACAN;QACAC;QACA,uFAAuF;QACvF,wEAAwE;QACxEC,QAAQ,cAAc,CAAC,KAAK,CAAC,qBAAqB;KACrD;AACL"}
+{"version":3,"file":"useDeferredRegistrations.js","sources":["../src/useDeferredRegistrations.ts"],"sourcesContent":["import { useRuntime, type ModuleRegistrationError } from \"@squide/core\";\nimport { useEffect, useRef } from \"react\";\nimport { FireflyRuntime } from \"./FireflyRuntime.tsx\";\nimport { useCanRegisterDeferredRegistrations } from \"./useCanRegisterDeferredRegistrations.ts\";\nimport { useCanUpdateDeferredRegistrations } from \"./useCanUpdateDeferredRegistrations.ts\";\nimport { useRegisterDeferredRegistrations } from \"./useRegisterDeferredRegistrations.ts\";\nimport { useUpdateDeferredRegistrations } from \"./useUpdateDeferredRegistrations.ts\";\n\nexport type DeferredRegistrationsErrorCallback = (errors: ModuleRegistrationError[]) => void;\n\nexport interface UseDeferredRegistrationsOptions {\n    onError?: DeferredRegistrationsErrorCallback;\n}\n\nexport function useDeferredRegistrations(data?: unknown, { onError }: UseDeferredRegistrationsOptions = {}) {\n    const runtime = useRuntime() as FireflyRuntime;\n    // const isExecutedBecauseModulesAreNowReadyRef = useRef(true);\n\n    const canRegisterDeferredRegistrations = useCanRegisterDeferredRegistrations();\n    const canUpdateDeferredRegistrations = useCanUpdateDeferredRegistrations();\n\n    const registerDeferredRegistrations = useRegisterDeferredRegistrations();\n    const updateDeferredRegistrations = useUpdateDeferredRegistrations();\n\n    useEffect(() => {\n        if (canRegisterDeferredRegistrations) {\n            const register = async () => {\n                const errors = await registerDeferredRegistrations(data);\n\n                if (errors.length > 0 && onError) {\n                    onError(errors);\n                }\n            };\n\n            register();\n        }\n    }, [canRegisterDeferredRegistrations, registerDeferredRegistrations, data, onError]);\n\n    const isInitialUpdateDeferredRegistrationsExecution = useRef(true);\n\n    useEffect(() => {\n        if (canUpdateDeferredRegistrations) {\n            // HACK: Skipping the first execution successfully passing the gate because this is due to\n            // the modules being ready, and it's most certainly the same data that has been forwarded earlier to the deferred registration.\n            // Ideally, instead of this hacky ref, it would be a ref tracking the previous data object, and the deferred registration would\n            // only be updated if the current data object != than the previous data object. Sadly, it is not possible because\n            // of the feature flags.\n            if (isInitialUpdateDeferredRegistrationsExecution.current) {\n                isInitialUpdateDeferredRegistrationsExecution.current = false;\n                return;\n            }\n\n            const update = async () => {\n                const errors = await updateDeferredRegistrations(data);\n\n                if (errors.length > 0 && onError) {\n                    onError(errors);\n                }\n            };\n\n            update();\n        }\n    }, [\n        canUpdateDeferredRegistrations,\n        updateDeferredRegistrations,\n        data,\n        onError,\n        // Trigger this closure when the feature flags changed. Using the timestamp because the\n        // actual feature flags are not forwarded to the deferred registrations.\n        runtime.appRouterStore.state.featureFlagsUpdatedAt\n    ]);\n}\n"],"names":["useRuntime","useEffect","useRef","useCanRegisterDeferredRegistrations","useCanUpdateDeferredRegistrations","useRegisterDeferredRegistrations","useUpdateDeferredRegistrations","useDeferredRegistrations","data","onError","runtime","canRegisterDeferredRegistrations","canUpdateDeferredRegistrations","registerDeferredRegistrations","updateDeferredRegistrations","register","errors","isInitialUpdateDeferredRegistrationsExecution","update"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAwE;AAC9B;AAEqD;AACJ;AACF;AACJ;AAQ9E,SAASO,yBAAyBC,IAAc,EAAE,EAAEC,OAAO,EAAmC,GAAG,CAAC,CAAC;IACtG,MAAMC,UAAUV,UAAUA;IAC1B,+DAA+D;IAE/D,MAAMW,mCAAmCR,mCAAmCA;IAC5E,MAAMS,iCAAiCR,iCAAiCA;IAExE,MAAMS,gCAAgCR,gCAAgCA;IACtE,MAAMS,8BAA8BR,8BAA8BA;IAElEL,SAASA,CAAC;QACN,IAAIU,kCAAkC;YAClC,MAAMI,WAAW;gBACb,MAAMC,SAAS,MAAMH,8BAA8BL;gBAEnD,IAAIQ,OAAO,MAAM,GAAG,KAAKP,SAAS;oBAC9BA,QAAQO;gBACZ;YACJ;YAEAD;QACJ;IACJ,GAAG;QAACJ;QAAkCE;QAA+BL;QAAMC;KAAQ;IAEnF,MAAMQ,gDAAgDf,MAAMA,CAAC;IAE7DD,SAASA,CAAC;QACN,IAAIW,gCAAgC;YAChC,0FAA0F;YAC1F,+HAA+H;YAC/H,+HAA+H;YAC/H,iHAAiH;YACjH,wBAAwB;YACxB,IAAIK,8CAA8C,OAAO,EAAE;gBACvDA,8CAA8C,OAAO,GAAG;gBACxD;YACJ;YAEA,MAAMC,SAAS;gBACX,MAAMF,SAAS,MAAMF,4BAA4BN;gBAEjD,IAAIQ,OAAO,MAAM,GAAG,KAAKP,SAAS;oBAC9BA,QAAQO;gBACZ;YACJ;YAEAE;QACJ;IACJ,GAAG;QACCN;QACAE;QACAN;QACAC;QACA,uFAAuF;QACvF,wEAAwE;QACxEC,QAAQ,cAAc,CAAC,KAAK,CAAC,qBAAqB;KACrD;AACL"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/firefly",
   "author": "Workleap",
-  "version": "16.2.0",
+  "version": "16.2.1",
   "description": "Squide bundle for the firefly technology stack.",
   "license": "Apache-2.0",
   "repository": {
@@ -49,10 +49,10 @@
     "@workleap-telemetry/core": "^2.0.0",
     "@workleap/logging": "^1.3.6",
     "uuid": "^13.0.0",
-    "@squide/core": "^6.1.14",
-    "@squide/launch-darkly": "^1.0.10",
     "@squide/env-vars": "^1.4.19",
+    "@squide/launch-darkly": "^1.0.10",
     "@squide/msw": "^4.0.17",
+    "@squide/core": "^6.1.14",
     "@squide/react-router": "^8.1.17"
   },
   "devDependencies": {

package/src/useCanUpdateDeferredRegistrations.ts

@@ -2,24 +2,26 @@ import { useAppRouterState } from "./AppRouterContext.ts";
 
 export function useCanUpdateDeferredRegistrations() {
     const {
-        areModulesReady,
-        publicDataUpdatedAt,
-        protectedDataUpdatedAt,
-        featureFlagsUpdatedAt,
-        deferredRegistrationsUpdatedAt
+        areModulesReady
+        // publicDataUpdatedAt,
+        // protectedDataUpdatedAt,
+        // featureFlagsUpdatedAt,
+        // deferredRegistrationsUpdatedAt
     } = useAppRouterState();
 
-    return (
-        // Do not trigger an update if the deferred registrations has not been registered yet (if there are deferred registrations, once they are
-        // registered, the modules will be marked as ready).
-        areModulesReady
-        // Make sure the apps is actually having deferred registrations.
-        && deferredRegistrationsUpdatedAt
-        // If either the public data or the protected data has been updated, update the deferred registrations.
-        && (
-            (publicDataUpdatedAt && publicDataUpdatedAt > deferredRegistrationsUpdatedAt) ||
-            (protectedDataUpdatedAt && protectedDataUpdatedAt > deferredRegistrationsUpdatedAt) ||
-            (featureFlagsUpdatedAt && featureFlagsUpdatedAt > deferredRegistrationsUpdatedAt)
-        )
-    );
+    return areModulesReady;
+
+    // return !!(
+    //     // Do not trigger an update if the deferred registrations has not been registered yet (if there are deferred registrations, once they are
+    //     // registered, the modules will be marked as ready).
+    //     areModulesReady
+    //     // Make sure the apps is actually having deferred registrations.
+    //     // && deferredRegistrationsUpdatedAt
+    //     // // If either the public data or the protected data has been updated, update the deferred registrations.
+    //     // && (
+    //     //     (publicDataUpdatedAt && publicDataUpdatedAt > deferredRegistrationsUpdatedAt) ||
+    //     //     (protectedDataUpdatedAt && protectedDataUpdatedAt > deferredRegistrationsUpdatedAt) ||
+    //     //     (featureFlagsUpdatedAt && featureFlagsUpdatedAt > deferredRegistrationsUpdatedAt)
+    //     // )
+    // );
 }

package/src/useDeferredRegistrations.ts

@@ -1,5 +1,5 @@
 import { useRuntime, type ModuleRegistrationError } from "@squide/core";
-import { useEffect } from "react";
+import { useEffect, useRef } from "react";
 import { FireflyRuntime } from "./FireflyRuntime.tsx";
 import { useCanRegisterDeferredRegistrations } from "./useCanRegisterDeferredRegistrations.ts";
 import { useCanUpdateDeferredRegistrations } from "./useCanUpdateDeferredRegistrations.ts";
@@ -14,6 +14,7 @@ export interface UseDeferredRegistrationsOptions {
 
 export function useDeferredRegistrations(data?: unknown, { onError }: UseDeferredRegistrationsOptions = {}) {
     const runtime = useRuntime() as FireflyRuntime;
+    // const isExecutedBecauseModulesAreNowReadyRef = useRef(true);
 
     const canRegisterDeferredRegistrations = useCanRegisterDeferredRegistrations();
     const canUpdateDeferredRegistrations = useCanUpdateDeferredRegistrations();
@@ -35,8 +36,20 @@ export function useDeferredRegistrations(data?: unknown, { onError }: UseDeferre
         }
     }, [canRegisterDeferredRegistrations, registerDeferredRegistrations, data, onError]);
 
+    const isInitialUpdateDeferredRegistrationsExecution = useRef(true);
+
     useEffect(() => {
         if (canUpdateDeferredRegistrations) {
+            // HACK: Skipping the first execution successfully passing the gate because this is due to
+            // the modules being ready, and it's most certainly the same data that has been forwarded earlier to the deferred registration.
+            // Ideally, instead of this hacky ref, it would be a ref tracking the previous data object, and the deferred registration would
+            // only be updated if the current data object != than the previous data object. Sadly, it is not possible because
+            // of the feature flags.
+            if (isInitialUpdateDeferredRegistrationsExecution.current) {
+                isInitialUpdateDeferredRegistrationsExecution.current = false;
+                return;
+            }
+
             const update = async () => {
                 const errors = await updateDeferredRegistrations(data);