CMR-10296: Adding arrayLimit to qs parser to increase the array limit without indices (#389)

* CMR-10296: Adding arrayLimit to qs parser to increase the array limit without indices

* CMR-10296: Fixing linter issues

* CMR-10296: Resetting limit to 100

* CMR-10296: Adding a unit test when passing in more than 20 polygon coordinates

Author: william-valencia

src/__tests__/providerSearch.spec.ts

@@ -166,6 +166,31 @@ describe("GET /:provider/search", () => {
       });
     });
 
+    describe("given a polygon with more than 20 coordinates", () => {
+      it("getItems should be called with the proper polygon coordinates", async () => {
+        sandbox
+          .stub(Providers, "getProviders")
+          .resolves([null, [{ "provider-id": "TEST", "short-name": "TEST" }]]);
+        sandbox.stub(Collections, "getCollections").resolves(emptyCollections);
+        const getItemsSpy = sandbox
+          .stub(Items, "getItems")
+          .resolves({ count: 0, cursor: null, items: [] });
+
+        const { statusCode, body } = await request(app).get(
+          "/stac/TEST/search?collections[0]=HLSS30_2.0&intersects[type]=Polygon&intersects[coordinates][0][0][0]=-48.31876570764564&intersects[coordinates][0][0][1]=-24.13235588091331&intersects[coordinates][0][1][0]=-48.319182157887525&intersects[coordinates][0][1][1]=-24.135649639167937&intersects[coordinates][0][2][0]=-48.2842003375668&intersects[coordinates][0][2][1]=-24.159843492656776&intersects[coordinates][0][3][0]=-48.26087912402002&intersects[coordinates][0][3][1]=-24.122474097202897&intersects[coordinates][0][4][0]=-48.259074506305325&intersects[coordinates][0][4][1]=-24.110310854137083&intersects[coordinates][0][5][0]=-48.268652861869185&intersects[coordinates][0][5][1]=-24.095231896596758&intersects[coordinates][0][6][0]=-48.273511448024976&intersects[coordinates][0][6][1]=-24.09662582428146&intersects[coordinates][0][7][0]=-48.2842003375668&intersects[coordinates][0][7][1]=-24.086361092375142&intersects[coordinates][0][8][0]=-48.28600495528215&intersects[coordinates][0][8][1]=-24.081038315106454&intersects[coordinates][0][9][0]=-48.28142400262118&intersects[coordinates][0][9][1]=-24.076095538322363&intersects[coordinates][0][10][0]=-48.28364507057779&intersects[coordinates][0][10][1]=-24.070645589226345&intersects[coordinates][0][11][0]=-48.29280697589971&intersects[coordinates][0][11][1]=-24.079390744017203&intersects[coordinates][0][12][0]=-48.29655502807688&intersects[coordinates][0][12][1]=-24.07977095461004&intersects[coordinates][0][13][0]=-48.295583310845984&intersects[coordinates][0][13][1]=-24.08433339376434&intersects[coordinates][0][14][0]=-48.30169124772749&intersects[coordinates][0][14][1]=-24.08293933236135&intersects[coordinates][0][15][0]=-48.3040511324312&intersects[coordinates][0][15][1]=-24.0845868578446&intersects[coordinates][0][16][0]=-48.298914912781214&intersects[coordinates][0][16][1]=-24.08876894281238&intersects[coordinates][0][17][0]=-48.30058071374884&intersects[coordinates][0][17][1]=-24.089909487754852&intersects[coordinates][0][18][0]=-48.30641101713553&intersects[coordinates][0][18][1]=-24.086614552446946&intersects[coordinates][0][19][0]=-48.31140842003842&intersects[coordinates][0][19][1]=-24.096879264048766&intersects[coordinates][0][20][0]=-48.310020252565636&intersects[coordinates][0][20][1]=-24.10068080039386&intersects[coordinates][0][21][0]=-48.31876570764564&intersects[coordinates][0][21][1]=-24.13235588091331"
+        );
+        expect(statusCode, JSON.stringify(body, null, 2)).to.equal(200);
+        expect(getItemsSpy).to.have.been.calledOnce;
+        expect(getItemsSpy).to.have.been.calledWithMatch({
+          provider: "TEST",
+          entryId: ["HLSS30_2.0"],
+          polygon: [
+            "-48.31876570764564,-24.13235588091331,-48.319182157887525,-24.135649639167937,-48.2842003375668,-24.159843492656776,-48.26087912402002,-24.122474097202897,-48.259074506305325,-24.110310854137083,-48.268652861869185,-24.095231896596758,-48.273511448024976,-24.09662582428146,-48.2842003375668,-24.086361092375142,-48.28600495528215,-24.081038315106454,-48.28142400262118,-24.076095538322363,-48.28364507057779,-24.070645589226345,-48.29280697589971,-24.079390744017203,-48.29655502807688,-24.07977095461004,-48.295583310845984,-24.08433339376434,-48.30169124772749,-24.08293933236135,-48.3040511324312,-24.0845868578446,-48.298914912781214,-24.08876894281238,-48.30058071374884,-24.089909487754852,-48.30641101713553,-24.086614552446946,-48.31140842003842,-24.096879264048766,-48.310020252565636,-24.10068080039386,-48.31876570764564,-24.13235588091331",
+          ],
+        });
+      });
+    });
+
     const limits = [
       ["valid", 100, 200],
       ["needing to page", 4000, 200],

src/app.ts

@@ -4,6 +4,7 @@ import helmet from "helmet";
 import express from "express";
 import compression from "compression";
 import cookieParser from "cookie-parser";
+import qs from "qs";
 
 import * as dotenv from "dotenv";
 dotenv.config();
@@ -14,6 +15,13 @@ import { notFoundHandler, errorHandler } from "./middleware";
 const createApp = () => {
   const app = express();
 
+  // This allows the query parser to parse up to 100 coordinates without adding indices.
+  // Anything over 100 would error out because indices are added. See CMR-10296 and
+  // https://github.com/ljharb/qs for more details.
+  app.set("query parser", function (str: string) {
+    return qs.parse(str, { arrayLimit: 100 });
+  });
+
   app.use(compression());
   app.use(helmet());
   app.use(cors());