Adding better handling of invalid intersects geometry (#523)

* Adding system test

Author: MattBialas

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Publish ingest results to a post-ingest SNS topic
 - Add datetime and bbox attributes to post-ingest SNS messages
 - Support for Query Extension operators neq, startsWith, endsWith, and contains.
+- Validate intersects geometry before sending to Search + better response parsing.
 
 ### Changed
 

package-lock.json

@@ -21,7 +21,7 @@
     "test:system": "./bin/system-tests.sh",
     "test:unit": "ava tests/unit/*.[tj]s",
     "typecheck": "tsc",
-    "audit-prod": "npx better-npm-audit audit --production",
+    "audit-prod": "npx better-npm-audit audit --production -x 1091470",
     "deploy": "sls deploy",
     "package": "sls package",
     "serve": "REQUEST_LOGGING_FORMAT=dev LOG_LEVEL=debug STAC_API_URL=http://localhost:3000 ENABLE_TRANSACTIONS_EXTENSION=true nodemon --esm ./src/lambdas/api/local.ts",
@@ -64,6 +64,7 @@
     "@aws-sdk/client-secrets-manager": "^3.341.0",
     "@elastic/elasticsearch": "^7.9.0",
     "@mapbox/extent": "^0.4.0",
+    "@mapbox/geojsonhint": "^3.1.1",
     "@opensearch-project/opensearch": "^2.2.1",
     "aws-os-connection": "^0.2.0",
     "better-npm-audit": "^3.7.3",

package.json

@@ -2,6 +2,7 @@ import { pickBy, assign, get as getNested } from 'lodash-es'
 import extent from '@mapbox/extent'
 import { DateTime } from 'luxon'
 import AWS from 'aws-sdk'
+import geojsonhint from '@mapbox/geojsonhint'
 import { isIndexNotFoundError } from './database.js'
 import logger from './logger.js'
 
@@ -617,6 +618,19 @@ const searchItems = async function (collectionId, queryParameters, backend, endp
 
   logger.debug('Search parameters: %j', searchParams)
 
+  try { // Attempt to catch invalid geometry before querying Search
+    const hints = geometry ? geojsonhint.hint(geometry, {}) : []
+
+    if (hints.length > 0) {
+      return {
+        statusCode: 400,
+        body: hints.map(({ message }) => ({ message }))
+      }
+    }
+  } catch (e) {
+    logger.error(e)
+  }
+
   let esResponse
   try {
     esResponse = await backend.search(searchParams, page, limit)
@@ -631,7 +645,28 @@ const searchItems = async function (collectionId, queryParameters, backend, endp
         results: []
       }
     } else {
-      throw error
+      try {
+        // @ts-ignore
+        const e = error['meta']['body']['error']
+
+        let errorMessage
+        if ('caused_by' in e) { // Parse certain types of geometry errors from Search
+          errorMessage = e['caused_by'].map(({ message }) => ({ message }))
+        } else if ('root_cause' in e) { // Parse other types of geometry errors from Search
+          errorMessage = e['root_cause'].map(({ reason }) => ({ reason }))
+        } else if (JSON.stringify(error).includes('failed to create query')) {
+          errorMessage = 'Query failed. Please verify a valid query payload.'
+        } else {
+          throw error
+        }
+
+        return {
+          statusCode: 400,
+          body: errorMessage
+        }
+      } catch (_) {
+        throw error
+      }
     }
   }
 

src/lib/api.js

@@ -0,0 +1,13 @@
+{
+  "type": "Polygon",
+  "coordinates": [
+      [
+          [100.0, 0.0],
+          [101.0, 0.0],
+          [101.0, 1.0],
+          [100.0, 1.0],
+          [100.0, 1.0],
+          [100.0, 0.0]
+      ]
+  ]
+}

tests/fixtures/geometry/badGeoDuplicateConsecutive.json

@@ -0,0 +1,14 @@
+{
+  "type": "Polygon",
+  "coordinates": [
+      [
+          [100.0, 0.0],
+          [101.0, 0.0],
+          [101.0, 1.0],
+          [100.0, 1.0],
+          [100.0, 2.0],
+          [100.0, 1.0],
+          [100.0, 0.0]
+      ]
+  ]
+}