add support for Query Extension neq, startsWith, endsWith, and contains

Author: Phil Varner

CHANGELOG.md

@@ -11,6 +11,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.
 
 ### Changed
 

src/lib/database.js

@@ -74,36 +74,99 @@ export function buildDatetimeQuery(parameters) {
 
 function buildQuery(parameters) {
   const eq = 'eq'
+  const neq = 'neq'
   const inop = 'in'
+  const startsWith = 'startsWith'
+  const endsWith = 'endsWith'
+  const contains = 'contains'
+
   const { query, intersects, collections, ids } = parameters
+
   let filterQueries = []
+  let mustNotQueries = []
+
   if (query) {
     // Using reduce rather than map as we don't currently support all
     // stac query operators.
     filterQueries = Object.keys(query).reduce((accumulator, property) => {
       const operatorsObject = query[property]
       const operators = Object.keys(operatorsObject)
+
+      // eq
       if (operators.includes(eq)) {
-        const termQuery = {
+        accumulator.push({
           term: {
             [`properties.${property}`]: operatorsObject.eq
           }
-        }
-        accumulator.push(termQuery)
-      } else if (operators.includes(inop)) {
-        const termsQuery = {
+        })
+      }
+
+      // in
+      if (operators.includes(inop)) {
+        accumulator.push({
           terms: {
             [`properties.${property}`]: operatorsObject.in
           }
-        }
-        accumulator.push(termsQuery)
+        })
+      }
+
+      // startsWith
+      if (operators.includes(startsWith)) {
+        accumulator.push({
+          prefix: {
+            [`properties.${property}`]: {
+              value: operatorsObject.startsWith
+            }
+          }
+        })
+      }
+
+      // endsWith
+      if (operators.includes(endsWith)) {
+        accumulator.push({
+          wildcard: {
+            [`properties.${property}`]: {
+              value: `*${operatorsObject.endsWith}`
+            }
+          }
+        })
+      }
+
+      // contains
+      if (operators.includes(contains)) {
+        accumulator.push({
+          wildcard: {
+            [`properties.${property}`]: {
+              value: `*${operatorsObject.contains}*`
+            }
+          }
+        })
       }
+
+      // lt, lte, gt, gte
       const rangeQuery = buildRangeQuery(property, operators, operatorsObject)
       if (rangeQuery) {
         accumulator.push(rangeQuery)
       }
+
       return accumulator
     }, filterQueries)
+
+    mustNotQueries = Object.keys(query).reduce((accumulator, property) => {
+      const operatorsObject = query[property]
+      const operators = Object.keys(operatorsObject)
+
+      // neq
+      if (operators.includes(neq)) {
+        accumulator.push({
+          term: {
+            [`properties.${property}`]: operatorsObject.neq
+          }
+        })
+      }
+
+      return accumulator
+    }, mustNotQueries)
   }
 
   if (ids) {
@@ -133,15 +196,14 @@ function buildQuery(parameters) {
   const datetimeQuery = buildDatetimeQuery(parameters)
   if (datetimeQuery instanceof Error) {
     throw datetimeQuery
-  }
-
-  if (datetimeQuery) {
+  } else if (datetimeQuery) {
     filterQueries.push(datetimeQuery)
   }
 
   return {
     query: {
       bool: {
+        must_not: mustNotQueries,
         filter: filterQueries
       }
     }

tests/system/test-api-search-post.js

@@ -447,3 +447,69 @@ test('/search preserve bbox in prev and next links', async (t) => {
   t.is(linkRel(response, 'next').body.datetime, datetime)
   t.deepEqual(linkRel(response, 'next').body.bbox, bbox)
 })
+
+test('/search Query Extension', async (t) => {
+  let response = null
+
+  // 3 items, 2 with platform landsat-8, 1 with platform2
+
+  response = await t.context.api.client.post('search', {
+    json: {}
+  })
+  t.is(response.features.length, 3)
+
+  response = await t.context.api.client.post('search', {
+    json: {
+      query: {
+        platform: {
+          eq: 'landsat-8'
+        }
+      }
+    }
+  })
+  t.is(response.features.length, 2)
+
+  response = await t.context.api.client.post('search', {
+    json: {
+      query: {
+        platform: {
+          neq: 'landsat-8'
+        }
+      }
+    }
+  })
+  t.is(response.features.length, 1)
+
+  response = await t.context.api.client.post('search', {
+    json: {
+      query: {
+        platform: {
+          startsWith: 'land'
+        }
+      }
+    }
+  })
+  t.is(response.features.length, 2)
+
+  response = await t.context.api.client.post('search', {
+    json: {
+      query: {
+        platform: {
+          endsWith: '-8'
+        }
+      }
+    }
+  })
+  t.is(response.features.length, 2)
+
+  response = await t.context.api.client.post('search', {
+    json: {
+      query: {
+        platform: {
+          contains: 'ndsa'
+        }
+      }
+    }
+  })
+  t.is(response.features.length, 2)
+})