Memoize computation of property references

Author: forman

chartlets.js/packages/lib/src/actions/handleHostStoreChange.ts

@@ -7,7 +7,6 @@ import type {
   ContribRef,
   InputRef,
 } from "@/types/model/callback";
-import type { Input } from "@/types/model/channel";
 import { getInputValues } from "@/actions/helpers/getInputValues";
 import { formatObjPath } from "@/utils/objPath";
 import { invokeCallbacks } from "@/actions/helpers/invokeCallbacks";
@@ -37,7 +36,7 @@ export function handleHostStoreChange() {
     // Exit if there are no extensions (yet)
     return;
   }
-  const propertyRefs = getHostStorePropertyRefs(contributionsRecord);
+  const propertyRefs = getPropertyRefsForContribPoints(contributionsRecord);
   if (!propertyRefs || propertyRefs.length === 0) {
     // Exit if there are is nothing to be changed
     return;
@@ -71,18 +70,64 @@ function getCallbackRequests(
 }
 
 /**
- * Get the static list of host state property references for all contributions.
+ * Get the static list of host state property references
+ * for given contribution points.
  */
-const getHostStorePropertyRefs = memoize(_getHostStorePropertyRefs);
+const getPropertyRefsForContribPoints = memoize(
+  _getPropertyRefsForContribPoints,
+);
 
-function getCallbackfn(
+function _getPropertyRefsForContribPoints(
+  contributionsRecord: Record<ContribPoint, ContributionState[]>,
+): PropertyRef[] {
+  const propertyRefs: PropertyRef[] = [];
+  Object.getOwnPropertyNames(contributionsRecord).forEach((contribPoint) => {
+    const contributions = contributionsRecord[contribPoint];
+    propertyRefs.push(
+      ...getPropertyRefsForContributions(contribPoint, contributions),
+    );
+  });
+  return propertyRefs;
+}
+
+/**
+ * Get the static list of host state property references
+ * for given contributions.
+ */
+const getPropertyRefsForContributions = memoize(
+  _getPropertyRefsForContributions,
+);
+
+function _getPropertyRefsForContributions(
+  contribPoint: string,
+  contributions: ContributionState[],
+): PropertyRef[] {
+  const propertyRefs: PropertyRef[] = [];
+  contributions.forEach((contribution, contribIndex) => {
+    propertyRefs.push(
+      ...getPropertyRefsForCallbacks(
+        contribPoint,
+        contribIndex,
+        contribution.callbacks,
+      ),
+    );
+  });
+  return propertyRefs;
+}
+
+/**
+ * Get the static list of host state property references
+ * for given callbacks.
+ */
+const getPropertyRefsForCallbacks = memoize(_getPropertyRefsForCallbacks);
+
+function _getPropertyRefsForCallbacks(
   contribPoint: string,
-  contribution: ContributionState,
   contribIndex: number,
+  callbacks: Callback[] | undefined,
 ) {
   const propertyRefs: PropertyRef[] = [];
-  const callbacks: Callback[] = contribution.callbacks || [];
-  callbacks.forEach((callback, callbackIndex) => {
+  (callbacks || []).forEach((callback, callbackIndex) => {
     const inputs = callback.inputs || [];
     inputs.forEach((input, inputIndex) => {
       if (!input.noTrigger && input.id === "@app" && input.property) {
@@ -99,17 +144,6 @@ function getCallbackfn(
   return propertyRefs;
 }
 
-function _getHostStorePropertyRefs(
-  contributionsRecord: Record<ContribPoint, ContributionState[]>,
-): PropertyRef[] {
-  const propertyRefs: PropertyRef[] = [];
-  Object.getOwnPropertyNames(contributionsRecord).forEach((contribPoint) => {
-    const contributions = contributionsRecord[contribPoint];
-    contributions.forEach(getCallbackfn(propertyRefs, contribPoint));
-  });
-  return propertyRefs;
-}
-
 function synchronizeThemeMode(hostStore: HostStore) {
   const newThemeMode = hostStore.get("themeMode");
   const oldThemeMode = store.getState().themeMode;

chartlets.js/packages/lib/src/types/state/store.ts

@@ -9,14 +9,33 @@ import type { FrameworkOptions } from "./options";
 
 export type ThemeMode = "dark" | "light" | "system";
 
+// TODO: Split contributionsRecord into two fields comprising static
+//  contribution data and dynamic contribution states.
+//  This will allow memoizing the computation of property references
+//  (PropertyRef[]) on the level of the StoreState from static data only.
+//  The property references would then be just computed once.
+//  See function getPropertyRefsForContribPoints()
+//  in actions/handleHostStoreChange.ts
+
+/**
+ * The state of the Chartlets main store.
+ */
 export interface StoreState {
-  /** Framework configuration */
+  /**
+   * Framework configuration.
+   */
   configuration: FrameworkOptions;
-  /** All extensions */
+  /**
+   * All extensions.
+   */
   extensions: Extension[];
-  /** API call result from `GET /contributions`. */
+  /**
+   * API call result from `GET /contributions`.
+   */
   contributionsResult: ApiResult<Contributions>;
-  /** A record that maps contribPoint --> ContributionState[].*/
+  /**
+   * A record that maps contribPoint --> ContributionState[].
+   */
   contributionsRecord: Record<ContribPoint, ContributionState[]>;
   /**
    * The app's current theme mode.