[params] Listeners fire if set before definition

Author: jamesgpearce

coverage.json

@@ -1 +1 @@
-{"tests":7250,"assertions":32247,"lines":{"total":2401,"covered":2401,"skipped":0,"pct":100},"statements":{"total":2598,"covered":2598,"skipped":0,"pct":100},"functions":{"total":1041,"covered":1041,"skipped":0,"pct":100},"branches":{"total":908,"covered":908,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
+{"tests":7252,"assertions":32251,"lines":{"total":2399,"covered":2399,"skipped":0,"pct":100},"statements":{"total":2599,"covered":2599,"skipped":0,"pct":100},"functions":{"total":1037,"covered":1037,"skipped":0,"pct":100},"branches":{"total":903,"covered":903,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}

src/common/obj.ts

@@ -72,6 +72,7 @@ export const objSize = (obj: IdObj<unknown>): number => size(objIds(obj));
 export const objIsEmpty = <Value>(obj: IdObj<Value> | any): boolean =>
   isObject(obj) && objSize(obj) == 0;
 
+/*! istanbul ignore next */
 export const objIsEqual = (
   obj1: IdObj<unknown>,
   obj2: IdObj<unknown>,
@@ -83,7 +84,8 @@ export const objIsEqual = (
     size(entries1) === objSize(obj2) &&
     arrayEvery(entries1, ([index, value1]) =>
       isObject(value1)
-        ? isObject(obj2[index])
+        ? /*! istanbul ignore next */
+          isObject(obj2[index])
           ? objIsEqual(obj2[index] as any, value1 as any)
           : false
         : isEqual(value1, obj2[index]),

src/queries/index.ts

@@ -56,13 +56,19 @@ import {
   mapEnsure,
   mapForEach,
   mapGet,
-  mapMatch,
   mapNew,
   mapSet,
   mapToObj,
   visitTree,
 } from '../common/map.ts';
-import {objFreeze, objMap, objToMap} from '../common/obj.ts';
+import {
+  objFreeze,
+  objGet,
+  objIds,
+  objIsEqual,
+  objMap,
+  objToMap,
+} from '../common/obj.ts';
 import {
   getUndefined,
   ifNotUndefined,
@@ -211,8 +217,11 @@ export const createQueries = getCreateFunction((store: Store): Queries => {
     build: Build,
     paramValues: ParamValues = {},
   ): Queries => {
+    const oldParamValues = getParamValues(queryId);
+
     setDefinition(queryId, tableId);
     setQueryArgs(queryId, [build, objToMap(paramValues)]);
+    callParamListeners(queryId, oldParamValues, paramValues);
     resetPreStores(queryId);
 
     const [, paramsMap] = getQueryArgs(queryId)!;
@@ -593,33 +602,42 @@ export const createQueries = getCreateFunction((store: Store): Queries => {
     return queries;
   };
 
+  const callParamListeners = (
+    queryId: Id,
+    oldParamValues: ParamValues,
+    newParamValues: ParamValues,
+  ) => {
+    const allParamIds = setNew<Id>([
+      ...objIds(oldParamValues),
+      ...objIds(newParamValues),
+    ]);
+
+    let changed = 0;
+    collForEach(allParamIds, (paramId) => {
+      const newParamValue = objGet(newParamValues, paramId);
+      if (!arrayOrValueEqual(objGet(oldParamValues, paramId), newParamValue)) {
+        changed = 1;
+        callListeners(paramValueListeners, [queryId, paramId], newParamValue);
+      }
+    });
+    if (changed) {
+      callListeners(paramValuesListeners, [queryId], newParamValues);
+    }
+  };
+
   const delQueryDefinition = (queryId: Id): Queries => {
-    const oldParamValues = getQueryArgs(queryId)?.[1];
+    const oldParamValues = getParamValues(queryId);
     resetPreStores(queryId);
     delDefinition(queryId);
-    ifNotUndefined(oldParamValues, (paramValues) => {
-      mapForEach(paramValues, (paramId) =>
-        callListeners(paramValueListeners, [queryId, paramId], undefined),
-      );
-      callListeners(paramValuesListeners, [queryId], {});
-    });
+    callParamListeners(queryId, oldParamValues, {});
     return queries;
   };
 
   const setParamValues = (queryId: Id, paramValues: ParamValues): Queries => {
     ifNotUndefined(getQueryArgs(queryId), ([definition, oldParamValues]) => {
-      const changedParamValues: IdMap<ParamValue> = mapNew();
-      mapMatch(
-        oldParamValues,
-        paramValues,
-        (_, paramId, newValue) => {
-          if (!arrayOrValueEqual(newValue, mapGet(oldParamValues, paramId))) {
-            mapSet(changedParamValues, paramId, newValue);
-          }
-        },
-        (_, paramId) => mapSet(changedParamValues, paramId, undefined),
-      );
-      if (!collIsEmpty(changedParamValues)) {
+      if (
+        !objIsEqual(mapToObj(oldParamValues), paramValues, arrayOrValueEqual)
+      ) {
         resultStore.transaction(() =>
           setQueryDefinition(
             queryId,
@@ -628,10 +646,6 @@ export const createQueries = getCreateFunction((store: Store): Queries => {
             paramValues,
           ),
         );
-        mapForEach(changedParamValues, (paramId, value) =>
-          callListeners(paramValueListeners, [queryId, paramId], value),
-        );
-        callListeners(paramValuesListeners, [queryId], {...paramValues});
       }
     });
     return queries;
@@ -641,14 +655,15 @@ export const createQueries = getCreateFunction((store: Store): Queries => {
     queryId: Id,
     paramId: Id,
     value: ParamValue,
-  ): Queries =>
-    setParamValues(queryId, {
-      ...mapToObj(getQueryArgs(queryId)?.[1]),
-      [paramId]: value,
-    });
+  ): Queries => {
+    if (!arrayOrValueEqual(getParamValue(queryId, paramId), value)) {
+      setParamValues(queryId, {...getParamValues(queryId), [paramId]: value});
+    }
+    return queries;
+  };
 
   const getParamValues = (queryId: Id): ParamValues =>
-    ifNotUndefined(getQueryArgs(queryId)?.[1], mapToObj) ?? {};
+    mapToObj(getQueryArgs(queryId)?.[1]);
 
   const getParamValue = (queryId: Id, paramId: Id): ParamValue | undefined =>
     mapGet(getQueryArgs(queryId)?.[1], paramId);

test/unit/core/other/queries.test.ts

@@ -5597,5 +5597,44 @@ describe('Parameterized', () => {
       queries.setParamValue('q1', 'p1', [false]);
       expect(listener).toHaveBeenCalledTimes(1);
     });
+
+    test('addParamValuesListener before query exists', () => {
+      const listener = vi.fn();
+      queries.addParamValuesListener('q1', listener);
+
+      queries.setQueryDefinition(
+        'q1',
+        't1',
+        ({select, where, param}) => {
+          select('c1');
+          where('c1', param('p1') as Cell);
+        },
+        {p1: 'a', p2: 'test'},
+      );
+
+      expect(listener).toHaveBeenCalledTimes(1);
+      expect(listener).toHaveBeenCalledWith(queries, 'q1', {
+        p1: 'a',
+        p2: 'test',
+      });
+    });
+
+    test('addParamValueListener before query exists', () => {
+      const listener = vi.fn();
+      queries.addParamValueListener('q1', 'p1', listener);
+
+      queries.setQueryDefinition(
+        'q1',
+        't1',
+        ({select, where, param}) => {
+          select('c1');
+          where('c1', param('p1') as Cell);
+        },
+        {p1: 'a', p2: 'test'},
+      );
+
+      expect(listener).toHaveBeenCalledTimes(1);
+      expect(listener).toHaveBeenCalledWith(queries, 'q1', 'p1', 'a');
+    });
   });
 });

test/unit/core/ui-react/hooks.test.tsx

@@ -2629,9 +2629,7 @@ describe('Read Hooks', () => {
     );
     const Test = ({queryId, paramId}: {queryId: Id; paramId: Id}) =>
       didRender(JSON.stringify(useParamValue(queryId, paramId, queries)));
-    const {container, rerender, unmount} = render(
-      <Test queryId="q1" paramId="p1" />,
-    );
+    const {container, unmount} = render(<Test queryId="q1" paramId="p1" />);
 
     expect(container.textContent).toEqual('"a"');