Optimized Jest tests (#29)

Author: Ruitjes

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 /lib
+/coverage

__tests__/adaptRequest.test.ts

@@ -5,8 +5,29 @@ import {
   adaptRequest,
   adaptNumericFilters,
   parseRange,
+  filterRegex,
 } from "../src/adaptRequest";
 
+describe("filterRegex test", () => {
+  it("filter regex should add string to object", () => {
+    const itemsJsFacets = {};
+
+    const facet1 = "color:blue";
+    const filter1 = filterRegex(itemsJsFacets, facet1);
+    const result1 = {
+      color: ["blue"],
+    };
+    expect(filter1).toStrictEqual(result1);
+
+    const facet2 = "color:red";
+    const filter2 = filterRegex(itemsJsFacets, facet2);
+    const result2 = {
+      color: ["blue", "red"],
+    };
+    expect(filter2).toStrictEqual(result2);
+  });
+});
+
 describe("adaptPage tests", () => {
   it("adaptpage(x) should return x+1", () => {
     expect(adaptPage(0)).toBe(1);
@@ -16,14 +37,15 @@ describe("adaptPage tests", () => {
 });
 
 describe("adaptRequest tests", () => {
-  it("adaptRequest should convert request to ItemsJs request", () => {
+  it("adaptRequest should convert (max parameters) request to ItemsJs request", () => {
     const instantsearchRequest: MultipleQueriesQuery = {
       indexName: "products",
       params: {
         query: "a",
         page: 2,
         hitsPerPage: 5,
         facets: ["price", "in_stock"],
+        facetFilters: ["category:electronics"],
         numericFilters: ["price>=10", "price<=100"],
       },
     };
@@ -35,6 +57,26 @@ describe("adaptRequest tests", () => {
     expect(itemsjsRequest.per_page).toBe(5);
     expect(itemsjsRequest.aggregations).toMatchObject(["price", "in_stock"]);
     expect(itemsjsRequest.filter).toBeDefined(); // Returns native javascript .filter() function
+    expect(itemsjsRequest.filters).toStrictEqual({ category: ["electronics"] });
+    expect(itemsjsRequest.indexName).toBe("products");
+    expect(itemsjsRequest.sort).toBe("products");
+  });
+
+  it("adaptRequest should convert (min parameters) request to ItemsJs request ", () => {
+    const instantsearchRequest: MultipleQueriesQuery = {
+      indexName: "products",
+      params: {
+        query: "a",
+        page: 2,
+        hitsPerPage: 5,
+      },
+    };
+
+    const itemsjsRequest = adaptRequest(instantsearchRequest);
+
+    expect(itemsjsRequest.query).toBe("a");
+    expect(itemsjsRequest.page).toBe(3);
+    expect(itemsjsRequest.per_page).toBe(5);
     expect(itemsjsRequest.indexName).toBe("products");
     expect(itemsjsRequest.sort).toBe("products");
   });
@@ -136,8 +178,8 @@ describe("regexInput tests group in three", () => {
   });
 });
 
-describe("adaptFacets tests", () => {
-  it("adaptFacets should convert nested arrays to Itemsjs format", () => {
+describe("adaptFilters tests", () => {
+  it("adaptFilters should convert nested arrays to Itemsjs format", () => {
     const instantsearchFacets = [
       ["category:electronics", "category:men's clothing"],
       ["color:blue"],
@@ -152,7 +194,7 @@ describe("adaptFacets tests", () => {
     expect(adaptedResult).toMatchObject(itemsJsFacets);
   });
 
-  it("adaptFacets should convert a single array to Itemsjs format", () => {
+  it("adaptFilters should convert a single array to Itemsjs format", () => {
     const instantsearchFacets = [
       "category:electronics",
       "category:men's clothing",
@@ -166,7 +208,7 @@ describe("adaptFacets tests", () => {
     expect(adaptedResult).toMatchObject(itemsJsFacets);
   });
 
-  it("adaptFacets should convert single and nested arrays to Itemsjs format", () => {
+  it("adaptFilters should convert single and nested arrays to Itemsjs format", () => {
     const instantsearchFacets = [
       ["category:electronics", "category:men's clothing"],
       "color:Blue",
@@ -181,4 +223,14 @@ describe("adaptFacets tests", () => {
     const adaptedResult = adaptFilters(instantsearchFacets);
     expect(adaptedResult).toMatchObject(itemsJsFacets);
   });
+
+  it("adaptFilters should throw an error when no array is given", () => {
+    const instantsearchFacets = "category:electronics";
+
+    expect(() => {
+      adaptFilters(instantsearchFacets);
+    }).toThrowError(
+      new Error("request.params.facetFilters does not contain an array")
+    );
+  });
 });

__tests__/adapter.test.ts

@@ -1,5 +1,5 @@
 import products from "./products.json";
-import { performSearch, createIndex } from "../src/adapter";
+import { performSearch, createIndex, getSearchClient } from "../src/adapter";
 import {
   MultipleQueriesQuery,
   MultipleQueriesResponse,
@@ -52,6 +52,45 @@ const requests: MultipleQueriesQuery[] = [
   },
 ];
 
+describe("getSearchClient", () => {
+  it("getSearchClient", () => {
+    const queries: MultipleQueriesQuery[] = [
+      {
+        indexName: "instant_search",
+        params: {
+          highlightPreTag: "<ais-highlight-0000000000>",
+          highlightPostTag: "</ais-highlight-0000000000>",
+          query: "",
+          maxValuesPerFacet: 10,
+          page: 0,
+          hitsPerPage: per_page,
+          facets: ["category.lvl0"],
+          tagFilters: "",
+        },
+      },
+      {
+        indexName: "instant_search",
+        params: {
+          highlightPreTag: "<ais-highlight-0000000000>",
+          highlightPostTag: "</ais-highlight-0000000000>",
+          query: "",
+          maxValuesPerFacet: 10,
+          page: 0,
+          hitsPerPage: per_page,
+          facets: ["price"],
+          tagFilters: "",
+        },
+      },
+    ];
+
+    expect(() => {
+      getSearchClient().searchForFacetValues();
+    }).toThrowError(new Error("Not implemented"));
+
+    expect(getSearchClient().search(queries)).toBeDefined();
+  });
+});
+
 describe("performSearch", () => {
   it("Performs a search", async () => {
     createIndex(products, options);

src/adaptRequest.ts

@@ -56,7 +56,7 @@ export function adaptFilters(instantsearchFacets) {
   return itemsJsFacets;
 }
 
-function filterRegex(itemsJsFacets, facet) {
+export function filterRegex(itemsJsFacets, facet) {
   const facetRegex = new RegExp(/(.+)(:)(.+)/);
   const [, name, , value] = facet.match(facetRegex);
   if (itemsJsFacets[name]) {