Refined test

Author: forman

chartlets.js/CHANGES.md

@@ -6,6 +6,9 @@
 * Static information about callbacks retrieved from API is not cached
   reducing unnecessary processing and improving performance. (#113)
 
+* Relaxed requirements for adding new components to Chartlets.js via 
+  plugins. Implementing `ComponentProps` is now optional. (#115)
+
 * Callbacks will now only be invoked when there’s an actual change in state, 
   reducing unnecessary processing and improving performance. (#112)
 

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

@@ -24,23 +24,31 @@ export interface PropertyRef extends ContribRef, CallbackRef, InputRef {
   property: string;
 }
 
-export function handleHostStoreChange() {
+/**
+ * This action is called once a host store change has been detected.
+ * Note this will only create callback requests for callbacks whose input
+ * value are affected by the change.
+ *
+ * @returns The array of callback requests made or `undefined`,
+ *   if no callback requests have been made.
+ */
+export function handleHostStoreChange(): CallbackRequest[] | undefined {
   const { extensions, configuration, contributionsRecord } = store.getState();
   const { hostStore } = configuration;
   if (!hostStore) {
     // Exit if no host store configured.
     // Actually, we should not come here.
-    return;
+    return undefined;
   }
   synchronizeThemeMode(hostStore);
   if (extensions.length === 0) {
     // Exit if there are no extensions (yet)
-    return;
+    return undefined;
   }
   const propertyRefs = getPropertyRefsForContribPoints(contributionsRecord);
   if (!propertyRefs || propertyRefs.length === 0) {
     // Exit if there are is nothing to be changed
-    return;
+    return undefined;
   }
   const callbackRequests = getCallbackRequests(
     propertyRefs,
@@ -52,9 +60,12 @@ export function handleHostStoreChange() {
     (callbackRequest): callbackRequest is CallbackRequest =>
       callbackRequest !== undefined,
   );
-  if (filteredCallbackRequests && filteredCallbackRequests.length > 0) {
-    invokeCallbacks(filteredCallbackRequests);
+  if (!filteredCallbackRequests || !filteredCallbackRequests.length) {
+    return undefined;
   }
+
+  invokeCallbacks(filteredCallbackRequests);
+  return filteredCallbackRequests;
 }
 
 // Exporting for testing only

chartlets.js/packages/lib/src/actions/handleHostStoreChanges.test.tsx

@@ -12,6 +12,7 @@ import type { ContributionState } from "@/types/state/contribution";
 describe("handleHostStoreChange", () => {
   let listeners: (() => void)[] = [];
   let hostState: Record<string, unknown> = {};
+  // noinspection JSUnusedGlobalSymbols
   const hostStore = {
     get: (key: string) => hostState[key],
     set: (key: string, value: unknown) => {
@@ -181,12 +182,20 @@ describe("handleHostStoreChange", () => {
       },
     });
     hostStore.set("variableName", "CHL");
-    handleHostStoreChange();
+    expect(handleHostStoreChange()).toEqual([
+      {
+        contribPoint: "panel",
+        contribIndex: 0,
+        callbackIndex: 0,
+        inputIndex: 0,
+        inputValues: ["CHL"],
+        property: "variableName",
+      },
+    ]);
 
-    // calling it second time for coverage. No state change changes the
-    // control flow
-    handleHostStoreChange();
-    //   TODO: Update this test to assert the generated callback request
+    // calling it second time for coverage,
+    // because the no-state-change changes the control flow
+    expect(handleHostStoreChange()).toBeUndefined();
   });
 
   it("should memoize second call with same arguments", () => {