feat(hub-common): add default predicate for portal search (#1315)

* feat(hub-common): add default predicate for portal search * fix(hub-common): move function to add default predicate to util * fix(hub-common): update tests to get full coverage * fix(hub-common): remove check for item entity when adding default search predicates * fix(hub-common): remove test to check if default predicates are added for non-item
Esri · Nov 6, 2023 · 6a42e63 · 6a42e63
1 parent f3cf4a5
commit 6a42e63
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 7 deletions.
diff --git a/packages/common/src/search/_internal/portalSearchItems.ts b/packages/common/src/search/_internal/portalSearchItems.ts
@@ -17,7 +17,7 @@ import {
   IPredicate,
   IQuery,
 } from "../types";
-import { getNextFunction } from "../utils";
+import { addDefaultItemSearchPredicates, getNextFunction } from "../utils";
 import { convertPortalAggregations } from "./portalSearchUtils";
 import { expandPredicate } from "./expandPredicate";
 import HubError from "../../HubError";
@@ -37,7 +37,8 @@ export async function portalSearchItems(
   query: IQuery,
   options: IHubSearchOptions
 ): Promise<IHubSearchResponse<IHubSearchResult>> {
-  const so = processSearchParams(options, query);
+  const queryWithDefaultPredicates = addDefaultItemSearchPredicates(query);
+  const so = processSearchParams(options, queryWithDefaultPredicates);
   return searchPortalAsHubSearchResult(so);
 }
 

diff --git a/packages/common/src/search/utils.ts b/packages/common/src/search/utils.ts
@@ -349,3 +349,22 @@ export function getResultSiteRelativeLink(
   }
   return siteRelativeLink;
 }
+
+/**
+ * Adds default predicates for item target entity
+ *
+ * @param query IQuery to search items
+ * @returns a cloned copy of the query object with default item search predicates
+ */
+export function addDefaultItemSearchPredicates(query: IQuery): IQuery {
+  const queryWithDefaultItemPredicates: IQuery = cloneObject(query);
+  const defaultPredicates = {
+    // 'Code Attachment' is an old AGO type that has
+    // been defunct for some time, so add this predicate
+    // to all catalog filter to omit 'Code Attachment' items
+    // from search results
+    predicates: [{ type: { not: ["Code Attachment"] } }],
+  };
+  queryWithDefaultItemPredicates.filters.push(defaultPredicates);
+  return queryWithDefaultItemPredicates;
+}
diff --git a/packages/common/test/search/_internal/portalSearchItems.test.ts b/packages/common/test/search/_internal/portalSearchItems.test.ts
@@ -76,7 +76,8 @@ describe("portalSearchItems Module:", () => {
       expect(searchItemsSpy.calls.count()).toBe(1, "should call searchItems");
       const [expectedParams] = searchItemsSpy.calls.argsFor(0);
       expect(expectedParams.portal).toEqual(opts.requestOptions?.portal);
-      expect(expectedParams.q).toEqual("(water)");
+      // 'Code Attachment' comes from default item predicate
+      expect(expectedParams.q).toEqual('(water) AND (-type:"Code Attachment")');
       expect(expectedParams.countFields).not.toBeDefined();
     });
     it("simple search with bbox", async () => {
@@ -107,7 +108,8 @@ describe("portalSearchItems Module:", () => {
       expect(searchItemsSpy.calls.count()).toBe(1, "should call searchItems");
       const [expectedParams] = searchItemsSpy.calls.argsFor(0);
       expect(expectedParams.portal).toEqual(opts.requestOptions?.portal);
-      expect(expectedParams.q).toEqual("(water)");
+      // 'Code Attachment' comes from default item predicate
+      expect(expectedParams.q).toEqual('(water) AND (-type:"Code Attachment")');
       expect(expectedParams.params.bbox).toEqual("1,2,3,4");
       expect(expectedParams.countFields).not.toBeDefined();
     });
@@ -139,7 +141,8 @@ describe("portalSearchItems Module:", () => {
       expect(searchItemsSpy.calls.count()).toBe(1, "should call searchItems");
       const [expectedParams] = searchItemsSpy.calls.argsFor(0);
       expect(expectedParams.portal).toBeUndefined();
-      expect(expectedParams.q).toEqual("(water)");
+      // 'Code Attachment' comes from default item predicate
+      expect(expectedParams.q).toEqual('(water) AND (-type:"Code Attachment")');
       expect(expectedParams.authentication).toEqual(
         opts.requestOptions?.authentication
       );
@@ -173,7 +176,8 @@ describe("portalSearchItems Module:", () => {
       expect(searchItemsSpy.calls.count()).toBe(1, "should call searchItems");
       const [expectedParams] = searchItemsSpy.calls.argsFor(0);
       // verify q
-      expect(expectedParams.q).toEqual("(water)");
+      // 'Code Attachment' comes from default item predicate
+      expect(expectedParams.q).toEqual('(water) AND (-type:"Code Attachment")');
       expect(expectedParams.countFields).toEqual("tags");
       expect(expectedParams.countSize).toEqual(10);
     });
@@ -206,7 +210,8 @@ describe("portalSearchItems Module:", () => {
       expect(searchItemsSpy.calls.count()).toBe(1, "should call searchItems");
       const [expectedParams] = searchItemsSpy.calls.argsFor(0);
       // verify q
-      expect(expectedParams.q).toEqual("(water)");
+      // 'Code Attachment' comes from default item predicate
+      expect(expectedParams.q).toEqual('(water) AND (-type:"Code Attachment")');
       expect(expectedParams.countFields).toEqual("tags");
       expect(expectedParams.countSize).toEqual(100);
       expect(expectedParams.portal).toEqual(