[CDX-283] Allows Hiding of Groups in the Groups Filter (#192)

* adds both blocklisting interfaces

* Update docs

* address comments

Author: Mudaafi

spec/components/Groups/Groups.test.jsx

@@ -123,6 +123,31 @@ describe('Testing Component: Groups', () => {
       expect(mockChildren).toHaveBeenCalled();
       expect(getByText('Custom Filters')).toBeInTheDocument();
     });
+
+    it('Should exclude groups excluded by isHiddenGroupFn', () => {
+      const filtersPropsWithChildren = {
+        ...groupsProps,
+        isHiddenGroupFn: (group) => ['2', '12'].includes(group.groupId),
+      };
+
+      const { getByText, queryByText } = render(
+        <CioPlp apiKey={DEMO_API_KEY}>
+          <Groups {...filtersPropsWithChildren} />
+        </CioPlp>,
+      );
+      expect(queryByText('Souvenirs')).toBeNull();
+      expect(getByText('Deals')).toBeInTheDocument();
+    });
+
+    it('Should exclude groups excluded by group.data.cio_plp_hidden', () => {
+      const { getByText, queryByText } = render(
+        <CioPlp apiKey={DEMO_API_KEY}>
+          <Groups {...groupsProps} />
+        </CioPlp>,
+      );
+      expect(queryByText('Hidden Group')).toBeNull();
+      expect(getByText('Deals')).toBeInTheDocument();
+    });
   });
 
   describe(' - Behavior Tests', () => {

spec/hooks/useGroups/useGroups.test.js

@@ -265,4 +265,44 @@ describe('Testing Hook: useGroups', () => {
       expect(setOptionsToRender).not.toBeUndefined();
     });
   });
+
+  it('Should not return groups that are meant to be excluded via isHiddenGroupFn', async () => {
+    const isHiddenGroupFn = (group) => group.groupId === 'W676714';
+    const { result } = renderHookWithCioPlp(() =>
+      useGroups({ ...useGroupsProps, isHiddenGroupFn }),
+    );
+
+    await waitFor(() => {
+      const {
+        current: { optionsToRender },
+      } = result;
+
+      expect(optionsToRender.filter((group) => !isHiddenGroupFn(group)).length).toBe(
+        optionsToRender.length,
+      );
+      expect(optionsToRender.length).toBeLessThan(useGroupsProps.groups[0].children.length);
+      const rawOptions = useGroupsProps.groups[0].children;
+      const excludedGroups = rawOptions.filter((group) =>
+        optionsToRender.find((option) => option.groupId !== group.groupId),
+      );
+      expect(excludedGroups.find((group) => group.groupId === 'W676714')).toBeTruthy();
+    });
+  });
+
+  it('Should not return groups that are flagged with groups.data.cio_plp_hidden = true', async () => {
+    const { result } = renderHookWithCioPlp(() => useGroups({ ...useGroupsProps }));
+
+    await waitFor(() => {
+      const {
+        current: { optionsToRender },
+      } = result;
+
+      expect(optionsToRender.length).toBeLessThan(useGroupsProps.groups[0].children.length);
+      const rawOptions = useGroupsProps.groups[0].children;
+      const excludedGroups = rawOptions.filter((group) =>
+        optionsToRender.find((option) => option.groupId !== group.groupId),
+      );
+      expect(excludedGroups.find((group) => group.groupId === 'cio_plp_hidden_group')).toBeTruthy();
+    });
+  });
 });

spec/local_examples/apiSearchResponse.json

@@ -5998,7 +5998,10 @@
                 "count": 23,
                 "data": null,
                 "children": [],
-                "parents": [{ "display_name": "All Products", "group_id": "AP01" }, { "display_name": "Clearance", "group_id": "W676714" }]
+                "parents": [
+                  { "display_name": "All Products", "group_id": "AP01" },
+                  { "display_name": "Clearance", "group_id": "W676714" }
+                ]
               }
             ],
             "parents": [
@@ -6085,6 +6088,21 @@
                 "group_id": "AP01"
               }
             ]
+          },
+          {
+            "group_id": "cio_plp_hidden_group",
+            "display_name": "CIO PLP Hidden Group",
+            "count": 85,
+            "data": {
+              "cio_plp_hidden": true
+            },
+            "children": [],
+            "parents": [
+              {
+                "display_name": "All Products",
+                "group_id": "AP01"
+              }
+            ]
           }
         ],
         "parents": []