filter ext adv comp ops in and between (#852)

* Add support for the Filter Extension operator 'IN' and 'BETWEEN'

Author: Phil Varner

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.11.0] - TBD
+
+### Added
+
+- Added support for the "in" and "between" operators of the Filter Extension
+
 ## [3.10.0] - 2025-03-21
 
 ### Changed

src/lambdas/api/app.js

@@ -5,7 +5,8 @@ import morgan from 'morgan'
 import path from 'path'
 import { fileURLToPath } from 'url'
 import database from '../../lib/database.js'
-import api, { ValidationError } from '../../lib/api.js'
+import api from '../../lib/api.js'
+import { ValidationError } from '../../lib/errors.js'
 import { readFile } from '../../lib/fs.js'
 import addEndpoint from './middleware/add-endpoint.js'
 import logger from '../../lib/logger.js'

src/lib/api.js

@@ -3,7 +3,7 @@ import extent from '@mapbox/extent'
 import { DateTime } from 'luxon'
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
 import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3'
-
+import { ValidationError } from './errors.js'
 import { isIndexNotFoundError } from './database.js'
 import logger from './logger.js'
 
@@ -51,13 +51,6 @@ const ALL_AGGREGATION_NAMES = DEFAULT_AGGREGATIONS.map((x) => x.name).concat(
   ]
 )
 
-export class ValidationError extends Error {
-  constructor(message) {
-    super(message)
-    this.name = 'ValidationError'
-  }
-}
-
 export const extractIntersects = function (params) {
   let intersectsGeometry
   const { intersects } = params

src/lib/database.js

@@ -1,22 +1,24 @@
 import { isEmpty } from 'lodash-es'
 import { dbClient as _client, createIndex } from './database-client.js'
 import logger from './logger.js'
+import { ValidationError } from './errors.js'
 
 const COLLECTIONS_INDEX = process.env['COLLECTIONS_INDEX'] || 'collections'
 const DEFAULT_INDICES = ['*', '-.*', '-collections']
-const LOGICAL_OP = {
+const OP = {
   AND: 'and',
   OR: 'or',
-  NOT: 'not'
-}
-const COMPARISON_OP = {
+  NOT: 'not',
   EQ: '=',
   NEQ: '<>',
   LT: '<',
   LTE: '<=',
   GT: '>',
   GTE: '>=',
-  IS_NULL: 'isNull'
+  IS_NULL: 'isNull',
+  IN: 'in',
+  BETWEEN: 'between',
+  LIKE: 'like',
 }
 const RANGE_TRANSLATION = {
   '<': 'lt',
@@ -213,34 +215,34 @@ function buildFilterExtQuery(filter) {
 
   switch (filter.op) {
   // recursive cases
-  case LOGICAL_OP.AND:
+  case OP.AND:
     return {
       bool: {
         filter: filter.args.map(buildFilterExtQuery)
       }
     }
-  case LOGICAL_OP.OR:
+  case OP.OR:
     return {
       bool: {
         should: filter.args.map(buildFilterExtQuery),
         minimum_should_match: 1
       }
     }
-  case LOGICAL_OP.NOT:
+  case OP.NOT:
     return {
       bool: {
         must_not: filter.args.map(buildFilterExtQuery)
       }
     }
 
   // direct cases
-  case COMPARISON_OP.EQ:
+  case OP.EQ:
     return {
       term: {
         [cql2Field]: cql2Value
       }
     }
-  case COMPARISON_OP.NEQ:
+  case OP.NEQ:
     return {
       bool: {
         must_not: [
@@ -252,7 +254,7 @@ function buildFilterExtQuery(filter) {
         ]
       }
     }
-  case COMPARISON_OP.IS_NULL:
+  case OP.IS_NULL:
     return {
       bool: {
         must_not: [
@@ -266,17 +268,61 @@ function buildFilterExtQuery(filter) {
     }
 
   // range cases
-  case COMPARISON_OP.LT:
-  case COMPARISON_OP.LTE:
-  case COMPARISON_OP.GT:
-  case COMPARISON_OP.GTE:
+  case OP.LT:
+  case OP.LTE:
+  case OP.GT:
+  case OP.GTE:
     return {
       range: {
         [cql2Field]: {
           [RANGE_TRANSLATION[filter.op]]: cql2Value
         }
       }
     }
+  case OP.IN:
+    if (!Array.isArray(cql2Value) || cql2Value.length === 0) {
+      throw new ValidationError("Operand for 'in' must be a non-empty array")
+    }
+    if (!cql2Value.every((x) => x !== Object(x))) {
+      throw new ValidationError(
+        "Operand for 'in' must contain only string, number, or boolean types"
+      )
+    }
+
+    return {
+      terms: {
+        [cql2Field]: cql2Value
+      }
+    }
+  case OP.BETWEEN:
+    if (filter.args.length < 3) {
+      throw new ValidationError("Two operands must be provided for the 'between' operator")
+    }
+
+    // eslint-disable-next-line no-case-declarations
+    const cql2Value2 = filter.args[2]
+    if (!(typeof cql2Value === 'number' && typeof cql2Value2 === 'number')) {
+      throw new ValidationError("Operands for 'between' must be numbers")
+    }
+
+    if (cql2Value > cql2Value2) {
+      throw new ValidationError(
+        "For the 'between' operator, the first operand must be less than or equal "
+        + 'to the second operand'
+      )
+    }
+
+    return {
+      range: {
+        [cql2Field]: {
+          gte: cql2Value,
+          lte: cql2Value2
+        }
+      }
+    }
+
+  case OP.LIKE:
+    throw new ValidationError("The 'like' operator is not currently supported")
 
   // should not get here
   default:

src/lib/errors.js

@@ -0,0 +1,7 @@
+/* eslint-disable import/prefer-default-export */
+export class ValidationError extends Error {
+  constructor(message) {
+    super(message)
+    this.name = 'ValidationError'
+  }
+}

tests/fixtures/stac/collection2_item.json

@@ -15,7 +15,8 @@
       "landsat:processing_level": "L1T",
       "landsat:product_id": null,
       "landsat:wrs_row": "10",
-      "landsat:scene_id": "collection2_item"
+      "landsat:scene_id": "collection2_item",
+      "boolean_property": true
    },
    "geometry": {
       "coordinates": [