update tests + docs

Author: roncohen

packages/browser-sdk/index.html

@@ -54,7 +54,7 @@
         document.getElementById("loading").style.display = "none";
       });
 
-      bucket.on("enabledCheck", (check) =>
+      bucket.on("check", (check) =>
         console.log(`Check event for ${check.key}`),
       );
 

packages/browser-sdk/test/client.test.ts

@@ -80,13 +80,15 @@ describe("BucketClient", () => {
       const trackHook = vi.fn();
       const userHook = vi.fn();
       const companyHook = vi.fn();
+      const checkHook = vi.fn();
       const checkHookIsEnabled = vi.fn();
       const checkHookConfig = vi.fn();
       const featuresUpdated = vi.fn();
 
       client.on("track", trackHook);
       client.on("user", userHook);
       client.on("company", companyHook);
+      client.on("check", checkHook);
       client.on("configCheck", checkHookConfig);
       client.on("enabledCheck", checkHookIsEnabled);
       client.on("featuresUpdated", featuresUpdated);
@@ -108,10 +110,14 @@ describe("BucketClient", () => {
       // eslint-disable-next-line @typescript-eslint/no-unused-expressions -- special getter triggering event
       client.getFeature("featureA").isEnabled;
       expect(checkHookIsEnabled).toHaveBeenCalled();
+      expect(checkHook).toHaveBeenCalled();
+
+      checkHook.mockReset();
 
       // eslint-disable-next-line @typescript-eslint/no-unused-expressions -- special getter triggering event
       client.getFeature("featureA").config;
       expect(checkHookConfig).toHaveBeenCalled();
+      expect(checkHook).toHaveBeenCalled();
 
       expect(featuresUpdated).not.toHaveBeenCalled();
       await client.updateOtherContext({ key: "value" });
@@ -121,6 +127,7 @@ describe("BucketClient", () => {
       client.off("track", trackHook);
       client.off("user", userHook);
       client.off("company", companyHook);
+      client.off("check", checkHook);
       client.off("configCheck", checkHookConfig);
       client.off("enabledCheck", checkHookIsEnabled);
       client.off("featuresUpdated", featuresUpdated);
@@ -147,6 +154,7 @@ describe("BucketClient", () => {
       expect(trackHook).not.toHaveBeenCalled();
       expect(userHook).not.toHaveBeenCalled();
       expect(companyHook).not.toHaveBeenCalled();
+      expect(checkHook).not.toHaveBeenCalled();
       expect(checkHookIsEnabled).not.toHaveBeenCalled();
       expect(checkHookConfig).not.toHaveBeenCalled();
       expect(featuresUpdated).not.toHaveBeenCalled();

packages/browser-sdk/test/hooksManager.test.ts

@@ -12,6 +12,20 @@ describe("HookManager", () => {
   });
 
   it("should add and trigger check-is-enabled hooks", () => {
+    const callback = vi.fn();
+    hookManager.addHook("check", callback);
+
+    const checkEvent: CheckEvent = {
+      action: "check-is-enabled",
+      key: "test-key",
+      value: true,
+    };
+    hookManager.trigger("check", checkEvent);
+
+    expect(callback).toHaveBeenCalledWith(checkEvent);
+  });
+
+  it("should add and trigger enabledCheck hooks", () => {
     const callback = vi.fn();
     hookManager.addHook("enabledCheck", callback);
 
@@ -94,15 +108,15 @@ describe("HookManager", () => {
     const callback1 = vi.fn();
     const callback2 = vi.fn();
 
-    hookManager.addHook("enabledCheck", callback1);
-    hookManager.addHook("enabledCheck", callback2);
+    hookManager.addHook("check", callback1);
+    hookManager.addHook("check", callback2);
 
     const checkEvent: CheckEvent = {
       action: "check-is-enabled",
       key: "test-key",
       value: true,
     };
-    hookManager.trigger("enabledCheck", checkEvent);
+    hookManager.trigger("check", checkEvent);
 
     expect(callback1).toHaveBeenCalledWith(checkEvent);
     expect(callback2).toHaveBeenCalledWith(checkEvent);
@@ -112,16 +126,16 @@ describe("HookManager", () => {
     const callback1 = vi.fn();
     const callback2 = vi.fn();
 
-    hookManager.addHook("enabledCheck", callback1);
-    hookManager.addHook("enabledCheck", callback2);
-    hookManager.removeHook("enabledCheck", callback1);
+    hookManager.addHook("check", callback1);
+    hookManager.addHook("check", callback2);
+    hookManager.removeHook("check", callback1);
 
     const checkEvent: CheckEvent = {
       action: "check-is-enabled",
       key: "test-key",
       value: true,
     };
-    hookManager.trigger("enabledCheck", checkEvent);
+    hookManager.trigger("check", checkEvent);
 
     expect(callback1).not.toHaveBeenCalled();
     expect(callback2).toHaveBeenCalledWith(checkEvent);
@@ -131,16 +145,16 @@ describe("HookManager", () => {
     const callback1 = vi.fn();
     const callback2 = vi.fn();
 
-    const removeHook1 = hookManager.addHook("enabledCheck", callback1);
-    hookManager.addHook("enabledCheck", callback2);
+    const removeHook1 = hookManager.addHook("check", callback1);
+    hookManager.addHook("check", callback2);
     removeHook1();
 
     const checkEvent: CheckEvent = {
       action: "check-is-enabled",
       key: "test-key",
       value: true,
     };
-    hookManager.trigger("enabledCheck", checkEvent);
+    hookManager.trigger("check", checkEvent);
 
     expect(callback1).not.toHaveBeenCalled();
     expect(callback2).toHaveBeenCalledWith(checkEvent);

packages/react-sdk/README.md

@@ -409,7 +409,7 @@ function LoggingWrapper({ children }: { children: ReactNode }) {
   const client = useClient();
 
   useEffect(() => {
-    client.on("enabledCheck", (evt) => {
+    client.on("check", (evt) => {
       console.log(`The feature ${evt.key} is ${evt.value} for user.`);
     });
   }, [client]);

packages/react-sdk/src/index.tsx

@@ -362,8 +362,8 @@ export function useUpdateOtherContext() {
  * ```ts
  * const client = useClient();
  * useEffect(() => {
- *   return client?.on("enabledCheck", () => {
- *     console.log("enabledCheck hook called");
+ *   return client?.on("check", () => {
+ *     console.log("check hook called");
  *   });
  * }, [client]);
  * ```