@adventurelabs/scout-core 1.0.110 → 1.0.112

package/dist/hooks/useScoutRefresh.js

@@ -1,7 +1,7 @@
 import { useEffect, useCallback, useRef, useMemo } from "react";
 import { useAppDispatch } from "../store/hooks";
 import { useStore } from "react-redux";
-import { EnumScoutStateStatus, setHerdModules, setStatus, setHerdModulesLoadingState, setHerdModulesLoadedInMs, setHerdModulesApiDuration, setUserApiDuration, setDataProcessingDuration, setUser, setDataSource, setDataSourceInfo, } from "../store/scout";
+import { EnumScoutStateStatus, setHerdModules, setStatus, setHerdModulesLoadingState, setHerdModulesLoadedInMs, setHerdModulesApiDuration, setUserApiDuration, setDataProcessingDuration, setCacheLoadDuration, setUser, setDataSource, setDataSourceInfo, } from "../store/scout";
 import { EnumHerdModulesLoadingState } from "../types/herd_module";
 import { server_load_herd_modules } from "../helpers/herds";
 import { scoutCache } from "../helpers/cache";
@@ -91,37 +91,104 @@ export function useScoutRefresh(options = {}) {
         }
         return true;
     }, []);
-    // Helper function to normalize herd modules for comparison (excludes metadata)
-    const normalizeHerdModulesForComparison = useCallback((herdModules) => {
+    // Helper function to sort herd modules consistently by ID
+    const sortHerdModulesById = useCallback((herdModules) => {
         if (!Array.isArray(herdModules))
             return herdModules;
-        return herdModules.map((hm) => {
-            if (!hm || typeof hm !== "object")
-                return hm;
-            // Create a copy without metadata fields that don't represent business data changes
-            const { timestamp_last_refreshed, ...businessData } = hm;
-            return businessData;
+        return [...herdModules].sort((a, b) => {
+            const aId = a?.herd?.id || 0;
+            const bId = b?.herd?.id || 0;
+            return aId - bId;
         });
     }, []);
-    // Helper function to conditionally dispatch only if business data has changed
-    const conditionalDispatch = useCallback((newData, currentData, actionCreator, dataType, useNormalizedComparison = false) => {
+    // Helper function to find differences between herd modules for debugging
+    const findHerdModulesDifferences = useCallback((newData, currentData) => {
+        if (!Array.isArray(newData) || !Array.isArray(currentData)) {
+            return `Array type mismatch: new=${Array.isArray(newData)}, current=${Array.isArray(currentData)}`;
+        }
+        if (newData.length !== currentData.length) {
+            return `Array length mismatch: new=${newData.length}, current=${currentData.length}`;
+        }
+        // Sort both arrays by herd ID for consistent comparison
+        const sortedNew = sortHerdModulesById(newData);
+        const sortedCurrent = sortHerdModulesById(currentData);
+        const differences = [];
+        for (let i = 0; i < sortedNew.length; i++) {
+            const newHerd = sortedNew[i];
+            const currentHerd = sortedCurrent[i];
+            if (!newHerd || !currentHerd) {
+                differences.push(`Herd ${i}: null/undefined mismatch`);
+                continue;
+            }
+            // Get herd identifiers for better debugging
+            const newHerdId = newHerd.herd?.id || "unknown";
+            const currentHerdId = currentHerd.herd?.id || "unknown";
+            const newHerdName = newHerd.herd?.name || "unknown";
+            const currentHerdName = currentHerd.herd?.name || "unknown";
+            // Check if herd IDs match (data shuffling detection)
+            if (newHerdId !== currentHerdId) {
+                differences.push(`Herd ${i}: ID mismatch - expected ${currentHerdId}(${currentHerdName}) got ${newHerdId}(${newHerdName})`);
+            }
+            // Check top-level fields
+            const fieldsToCheck = [
+                "timestamp_last_refreshed",
+                "total_events",
+                "total_events_with_filters",
+                "events_page_index",
+            ];
+            fieldsToCheck.forEach((field) => {
+                if (newHerd[field] !== currentHerd[field]) {
+                    differences.push(`Herd ${i}(${newHerdName}).${field}: ${currentHerd[field]} → ${newHerd[field]}`);
+                }
+            });
+            // Check array lengths for nested data
+            const arrayFields = [
+                "devices",
+                "events",
+                "plans",
+                "zones",
+                "sessions",
+                "layers",
+                "providers",
+            ];
+            arrayFields.forEach((field) => {
+                const newArray = newHerd[field];
+                const currentArray = currentHerd[field];
+                if (Array.isArray(newArray) && Array.isArray(currentArray)) {
+                    if (newArray.length !== currentArray.length) {
+                        differences.push(`Herd ${i}(${newHerdName}).${field}[]: length ${currentArray.length} → ${newArray.length}`);
+                    }
+                }
+            });
+        }
+        return differences.length > 0
+            ? differences.join(", ")
+            : "No significant differences found";
+    }, []);
+    // Helper function to conditionally dispatch only if data has changed
+    const conditionalDispatch = useCallback((newData, currentData, actionCreator, dataType, enableDebugging = false) => {
+        // For herd modules, sort both datasets by ID before comparison
         let dataToCompare = newData;
         let currentToCompare = currentData;
-        // For herd modules, use normalized comparison that ignores metadata
-        if (useNormalizedComparison && dataType.includes("Herd modules")) {
-            dataToCompare = normalizeHerdModulesForComparison(newData);
-            currentToCompare = normalizeHerdModulesForComparison(currentData);
+        if (dataType.includes("Herd modules")) {
+            dataToCompare = sortHerdModulesById(newData);
+            currentToCompare = sortHerdModulesById(currentData);
         }
         if (!deepEqual(dataToCompare, currentToCompare)) {
-            console.log(`[useScoutRefresh] ${dataType} business data changed, updating store`);
-            dispatch(actionCreator(newData)); // Always dispatch the full data including timestamps
+            console.log(`[useScoutRefresh] ${dataType} data changed, updating store`);
+            // Add debugging for herd modules to see what actually changed
+            if (enableDebugging && dataType.includes("Herd modules")) {
+                const differences = findHerdModulesDifferences(newData, currentData);
+                console.log(`[useScoutRefresh] ${dataType} differences: ${differences}`);
+            }
+            dispatch(actionCreator(newData)); // Always dispatch original unsorted data
             return true;
         }
         else {
-            console.log(`[useScoutRefresh] ${dataType} business data unchanged, skipping store update`);
+            console.log(`[useScoutRefresh] ${dataType} data unchanged, skipping store update`);
             return false;
         }
-    }, [dispatch, deepEqual, normalizeHerdModulesForComparison]);
+    }, [dispatch, deepEqual, findHerdModulesDifferences, sortHerdModulesById]);
     // Helper function to handle IndexedDB errors - memoized for stability
     const handleIndexedDbError = useCallback(async (error, operation, retryFn) => {
         if (error instanceof Error &&
@@ -163,6 +230,7 @@ export function useScoutRefresh(options = {}) {
                     const cacheResult = await scoutCache.getHerdModules();
                     cacheLoadDuration = Date.now() - cacheStartTime;
                     timingRefs.current.cacheLoadDuration = cacheLoadDuration;
+                    dispatch(setCacheLoadDuration(cacheLoadDuration));
                     if (cacheResult.data && cacheResult.data.length > 0) {
                         cachedHerdModules = cacheResult.data;
                         console.log(`[useScoutRefresh] Loaded ${cachedHerdModules.length} herd modules from cache in ${cacheLoadDuration}ms (age: ${Math.round(cacheResult.age / 1000)}s, stale: ${cacheResult.isStale})`);

package/dist/store/scout.d.ts

@@ -14,6 +14,7 @@ export interface ScoutState {
     herd_modules_api_duration_ms: number | null;
     user_api_duration_ms: number | null;
     data_processing_duration_ms: number | null;
+    cache_load_duration_ms: number | null;
     active_herd_id: string | null;
     active_device_id: string | null;
     lastRefreshed: number;
@@ -54,6 +55,10 @@ export declare const scoutSlice: import("@reduxjs/toolkit").Slice<ScoutState, {
         payload: any;
         type: string;
     }) => void;
+    setCacheLoadDuration: (state: import("immer").WritableDraft<ScoutState>, action: {
+        payload: any;
+        type: string;
+    }) => void;
     setActiveHerdId: (state: import("immer").WritableDraft<ScoutState>, action: {
         payload: any;
         type: string;
@@ -155,6 +160,6 @@ export declare const scoutSlice: import("@reduxjs/toolkit").Slice<ScoutState, {
         type: string;
     }) => void;
 }, "scout", "scout", import("@reduxjs/toolkit").SliceSelectors<ScoutState>>;
-export declare const setHerdModules: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModules">, setStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setStatus">, setHerdModulesLoadingState: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModulesLoadingState">, setHerdModulesLoadedInMs: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModulesLoadedInMs">, setHerdModulesApiDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModulesApiDuration">, setUserApiDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setUserApiDuration">, setDataProcessingDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setDataProcessingDuration">, setActiveHerdId: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setActiveHerdId">, setActiveDeviceId: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setActiveDeviceId">, setDataSource: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setDataSource">, setDataSourceInfo: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setDataSourceInfo">, appendEventsToHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/appendEventsToHerdModule">, replaceEventsForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/replaceEventsForHerdModule">, updateEventValuesForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateEventValuesForHerdModule">, updatePageIndexForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updatePageIndexForHerdModule">, appendPlansToHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/appendPlansToHerdModule">, setUser: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setUser">, addTag: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addTag">, deleteTag: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deleteTag">, updateTag: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateTag">, addNewDeviceToHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addNewDeviceToHerdModule">, updateDeviceForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateDeviceForHerdModule">, addDevice: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addDevice">, deleteDevice: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deleteDevice">, updateDevice: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateDevice">, addPlan: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addPlan">, deletePlan: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deletePlan">, updatePlan: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updatePlan">, addSessionToStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addSessionToStore">, deleteSessionFromStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deleteSessionFromStore">, updateSessionInStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateSessionInStore">, setActiveHerdGpsTrackersConnectivity: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setActiveHerdGpsTrackersConnectivity">;
+export declare const setHerdModules: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModules">, setStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setStatus">, setHerdModulesLoadingState: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModulesLoadingState">, setHerdModulesLoadedInMs: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModulesLoadedInMs">, setHerdModulesApiDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setHerdModulesApiDuration">, setUserApiDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setUserApiDuration">, setDataProcessingDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setDataProcessingDuration">, setCacheLoadDuration: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setCacheLoadDuration">, setActiveHerdId: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setActiveHerdId">, setActiveDeviceId: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setActiveDeviceId">, setDataSource: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setDataSource">, setDataSourceInfo: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setDataSourceInfo">, appendEventsToHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/appendEventsToHerdModule">, replaceEventsForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/replaceEventsForHerdModule">, updateEventValuesForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateEventValuesForHerdModule">, updatePageIndexForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updatePageIndexForHerdModule">, appendPlansToHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/appendPlansToHerdModule">, setUser: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setUser">, addTag: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addTag">, deleteTag: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deleteTag">, updateTag: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateTag">, addNewDeviceToHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addNewDeviceToHerdModule">, updateDeviceForHerdModule: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateDeviceForHerdModule">, addDevice: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addDevice">, deleteDevice: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deleteDevice">, updateDevice: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateDevice">, addPlan: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addPlan">, deletePlan: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deletePlan">, updatePlan: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updatePlan">, addSessionToStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/addSessionToStore">, deleteSessionFromStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/deleteSessionFromStore">, updateSessionInStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/updateSessionInStore">, setActiveHerdGpsTrackersConnectivity: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "scout/setActiveHerdGpsTrackersConnectivity">;
 declare const _default: import("redux").Reducer<ScoutState>;
 export default _default;

package/dist/store/scout.js

@@ -15,6 +15,7 @@ const initialState = {
     herd_modules_api_duration_ms: null,
     user_api_duration_ms: null,
     data_processing_duration_ms: null,
+    cache_load_duration_ms: null,
     lastRefreshed: 0,
     active_herd_id: null,
     active_device_id: null,
@@ -50,6 +51,9 @@ export const scoutSlice = createSlice({
         setDataProcessingDuration: (state, action) => {
             state.data_processing_duration_ms = action.payload;
         },
+        setCacheLoadDuration: (state, action) => {
+            state.cache_load_duration_ms = action.payload;
+        },
         setActiveHerdId: (state, action) => {
             state.active_herd_id = action.payload;
             state.active_herd_gps_trackers_connectivity = {};
@@ -265,5 +269,5 @@ export const scoutSlice = createSlice({
     },
 });
 // Action creators are generated for each case reducer function
-export const { setHerdModules, setStatus, setHerdModulesLoadingState, setHerdModulesLoadedInMs, setHerdModulesApiDuration, setUserApiDuration, setDataProcessingDuration, setActiveHerdId, setActiveDeviceId, setDataSource, setDataSourceInfo, appendEventsToHerdModule, replaceEventsForHerdModule, updateEventValuesForHerdModule, updatePageIndexForHerdModule, appendPlansToHerdModule, setUser, addTag, deleteTag, updateTag, addNewDeviceToHerdModule, updateDeviceForHerdModule, addDevice, deleteDevice, updateDevice, addPlan, deletePlan, updatePlan, addSessionToStore, deleteSessionFromStore, updateSessionInStore, setActiveHerdGpsTrackersConnectivity, } = scoutSlice.actions;
+export const { setHerdModules, setStatus, setHerdModulesLoadingState, setHerdModulesLoadedInMs, setHerdModulesApiDuration, setUserApiDuration, setDataProcessingDuration, setCacheLoadDuration, setActiveHerdId, setActiveDeviceId, setDataSource, setDataSourceInfo, appendEventsToHerdModule, replaceEventsForHerdModule, updateEventValuesForHerdModule, updatePageIndexForHerdModule, appendPlansToHerdModule, setUser, addTag, deleteTag, updateTag, addNewDeviceToHerdModule, updateDeviceForHerdModule, addDevice, deleteDevice, updateDevice, addPlan, deletePlan, updatePlan, addSessionToStore, deleteSessionFromStore, updateSessionInStore, setActiveHerdGpsTrackersConnectivity, } = scoutSlice.actions;
 export default scoutSlice.reducer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adventurelabs/scout-core",
-  "version": "1.0.110",
+  "version": "1.0.112",
   "description": "Core utilities and helpers for Adventure Labs Scout applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",