fix(routing): support parsing URLs with up to 100 refinements (#3671)

Author: francoischalifour

src/lib/__tests__/RoutingManager-test.js

@@ -1,4 +1,5 @@
 /* globals jsdom */
+import qs from 'qs';
 import instantsearch from '../main';
 import RoutingManager from '../RoutingManager';
 import historyRouter from '../routers/history';
@@ -585,4 +586,73 @@ describe('RoutingManager', () => {
       setWindowTitle.mockRestore();
     });
   });
+
+  describe('parseURL', () => {
+    const createFakeUrlWithRefinements = ({ length }) =>
+      [
+        'https://website.com/',
+        Array.from(
+          { length },
+          (_v, i) => `refinementList[brand][${i}]=brand-${i}`
+        ).join('&'),
+      ].join('?');
+
+    test('should parse refinements with more than 20 filters per category as array', () => {
+      jsdom.reconfigure({
+        url: createFakeUrlWithRefinements({ length: 22 }),
+      });
+
+      const router = historyRouter();
+      const parsedUrl = router.parseURL({
+        qsModule: qs,
+        location: window.location,
+      });
+
+      expect(parsedUrl.refinementList.brand).toBeInstanceOf(Array);
+      expect(parsedUrl).toMatchInlineSnapshot(`
+        Object {
+          "refinementList": Object {
+            "brand": Array [
+              "brand-0",
+              "brand-1",
+              "brand-2",
+              "brand-3",
+              "brand-4",
+              "brand-5",
+              "brand-6",
+              "brand-7",
+              "brand-8",
+              "brand-9",
+              "brand-10",
+              "brand-11",
+              "brand-12",
+              "brand-13",
+              "brand-14",
+              "brand-15",
+              "brand-16",
+              "brand-17",
+              "brand-18",
+              "brand-19",
+              "brand-20",
+              "brand-21",
+            ],
+          },
+        }
+      `);
+    });
+
+    test('should support returning 100 refinements as array', () => {
+      jsdom.reconfigure({
+        url: createFakeUrlWithRefinements({ length: 100 }),
+      });
+
+      const router = historyRouter();
+      const parsedUrl = router.parseURL({
+        qsModule: qs,
+        location: window.location,
+      });
+
+      expect(parsedUrl.refinementList.brand).toBeInstanceOf(Array);
+    });
+  });
 });

src/lib/routers/history.js

@@ -12,7 +12,17 @@ function defaultCreateURL({ qsModule, routeState, location }) {
 }
 
 function defaultParseURL({ qsModule, location }) {
-  return qsModule.parse(location.search.slice(1));
+  // `qs` by default converts arrays with more than 20 items to an object.
+  // We want to avoid this because the data structure manipulated can therefore vary.
+  // Setting the limit to `100` seems a good number because the engine's default is 100
+  // (it can go up to 1000 but it is very unlikely to select more than 100 items in the UI).
+  //
+  // Using an `arrayLimit` of `n` allows `n + 1` items.
+  //
+  // See:
+  //   - https://github.com/ljharb/qs#parsing-arrays
+  //   - https://www.algolia.com/doc/api-reference/api-parameters/maxValuesPerFacet/
+  return qsModule.parse(location.search.slice(1), { arrayLimit: 99 });
 }
 
 function setWindowTitle(title) {