Remove context extension by default (#871)

* default to node 22

* fix typos

* remove context extension by default

* remove context extension by default

* fix bad merge

Author: philvarner

CHANGELOG.md

@@ -7,8 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## unreleased - TBD
 
-## Removed
+### Removed
 
+- Context Extension is not disabled by default, and can be enabled with ENABLE_CONTEXT_EXTENSION
 - Removed configurability of the Root / Landing Page Catalog stac_version via the
   STAC_VERSION environment variable. This is now fixed at 1.1.0.
 - Child link relations removed from root (landing page).

README.md

@@ -10,6 +10,7 @@
   - [Migration](#migration)
     - [Warnings](#warnings)
     - [4.0.0](#400)
+      - [Context Extension disabled by default](#context-extension-disabled-by-default)
       - [Node 22 update](#node-22-update)
     - [3.10.0](#3100)
       - [Node 20 update](#node-20-update)
@@ -81,21 +82,22 @@ Stac-server is an implementation of the [STAC API specification](https://github.
 | 0.4.x                  | 1.0.0        | 1.0.0-beta.5                |
 | 0.5.x-0.8.x            | 1.0.0        | 1.0.0-rc.2                  |
 | >=1.0.0                | 1.0.0        | 1.0.0                       |
+| >=3.10.0               | 1.1.0        | 1.0.0                       |
 
 Currently, stac-server supports the following specifications:
 
 - STAC API - Core
 - STAC API - Features
 - STAC API - Collections
 - STAC API - Item Search
-- Context Extension (deprecated)
+- Context Extension (deprecated, disabled by default)
 - Sort Extension
 - Fields Extension
 - Query Extension
 - Filter Extension (conformance classes "Basic CQL2", "CQL2 JSON", "Basic Spatial Functions", and
   "Basic Spatial Functions with additional Spatial Literals", and
   the "in" and "between" predicates from "Advanced Comparison Operators")
-- Transaction Extension
+- Transaction Extension (disabled by default)
 - Aggregation Extension (experimental)
 
 The following APIs are deployed instances of stac-server:
@@ -168,6 +170,12 @@ apiLambda --> opensearch
 
 ### 4.0.0
 
+#### Context Extension disabled by default
+
+Context Extension is not disabled by default, and can be enabled with ENABLE_CONTEXT_EXTENSION
+env var. Usage of the "context" object "limit", "matched", and "returned" fields can be replaced
+with the root-level fields "numberMatched" and "numberReturned".
+
 #### Node 22 update
 
 The default Lambda deployment environment is now Node 22.
@@ -566,6 +574,7 @@ There are some settings that should be reviewed and updated as needeed in the se
 | REQUEST_LOGGING_FORMAT           | Express request logging format to use. Any of the [Morgan predefined formats](https://github.com/expressjs/morgan#predefined-formats).                                                                                                                                          | tiny                                                                                 |
 | STAC_API_URL                     | The root endpoint of this API                                                                                                                                                                                                                                                   | Inferred from request                                                                |
 | ENABLE_TRANSACTIONS_EXTENSION    | Boolean specifying if the [Transaction Extension](https://github.com/radiantearth/stac-api-spec/tree/master/ogcapi-features/extensions/transaction) should be activated                                                                                                         | false                                                                                |
+| ENABLE_CONTEXT_EXTENSION    | Boolean specifying if the [Context Extension](https://github.com/stac-api-extensions/context) should be activated                                                                                                         | false                                                                                |
 | STAC_API_ROOTPATH                | The path to append to URLs if this is not deployed at the server root. For example, if the server is deployed without a custom domain name, it will have the stage name (e.g., dev) in the path.                                                                                | ""                                                                                   |
 | PRE_HOOK                         | The name of a Lambda function to be called as the pre-hook.                                                                                                                                                                                                                     | none                                                                                 |
 | POST_HOOK                        | The name of a Lambda function to be called as the post-hook.                                                                                                                                                                                                                    | none                                                                                 |

src/lib/api.js

@@ -479,17 +479,25 @@ export const addItemLinks = function (results, endpoint) {
   return results
 }
 
-const wrapResponseInFeatureCollection = function (
-  context, features = [], links = []
-) {
-  return {
+const wrapResponseInFeatureCollection = function (features, links,
+  numberMatched, numberReturned, limit) {
+  const fc = {
     type: 'FeatureCollection',
-    context,
-    numberMatched: context.matched,
-    numberReturned: context.returned,
+    numberMatched,
+    numberReturned,
     features,
     links
   }
+
+  if (process.env['ENABLE_CONTEXT_EXTENSION']) {
+    fc['context'] = {
+      matched: numberMatched,
+      returned: numberReturned,
+      limit
+    }
+  }
+
+  return fc
 }
 
 const buildPaginationLinks = function (limit, parameters, bbox, intersects, endpoint,
@@ -572,7 +580,7 @@ const searchItems = async function (collectionId, queryParameters, backend, endp
   const fields = extractFields(queryParameters)
   const ids = extractIds(queryParameters)
   const collections = extractCollectionIds(queryParameters)
-  const limit = extractLimit(queryParameters)
+  const limit = extractLimit(queryParameters) || 10
   const page = extractPage(queryParameters)
 
   const searchParams = pickBy({
@@ -599,16 +607,13 @@ const searchItems = async function (collectionId, queryParameters, backend, endp
 
   let esResponse
   try {
-    esResponse = await backend.search(searchParams, page, limit)
+    esResponse = await backend.search(searchParams, limit, page)
   } catch (error) {
     if (isIndexNotFoundError(error)) {
       esResponse = {
-        context: {
-          matched: 0,
-          returned: 0,
-          limit
-        },
-        results: []
+        results: [],
+        numberMatched: 0,
+        numberReturned: 0,
       }
     // @ts-ignore
     } else if (error?.meta?.statusCode === 400) {
@@ -631,7 +636,7 @@ const searchItems = async function (collectionId, queryParameters, backend, endp
     }
   }
 
-  const { results: responseItems, context } = esResponse
+  const { results: responseItems, numberMatched, numberReturned } = esResponse
   const paginationLinks = buildPaginationLinks(
     limit, searchParams, bbox, intersects, newEndpoint, httpMethod, sortby, responseItems
   )
@@ -659,8 +664,7 @@ const searchItems = async function (collectionId, queryParameters, backend, endp
   }
 
   const items = addItemLinks(responseItems, endpoint)
-  const response = wrapResponseInFeatureCollection(context, items, links)
-  return response
+  return wrapResponseInFeatureCollection(items, links, numberMatched, numberReturned, limit)
 }
 
 const agg = function (esAggs, name, dataType) {
@@ -1146,7 +1150,13 @@ const getCollections = async function (backend, endpoint = '') {
         href: `${endpoint}`,
       },
     ],
-    context: {
+  }
+
+  // note: adding this to the Collections response is not
+  // part of the Context Extension, and was just a proprietary
+  // behavior of this implemenation
+  if (process.env['ENABLE_CONTEXT_EXTENSION']) {
+    resp['context'] = {
       page: 1,
       limit: COLLECTION_LIMIT,
       matched: linkedCollections && linkedCollections.length,
@@ -1183,7 +1193,7 @@ const createCollection = async function (collection, backend) {
 
 const getItem = async function (collectionId, itemId, backend, endpoint = '') {
   const itemQuery = { collections: [collectionId], id: itemId }
-  const { results } = await backend.search(itemQuery)
+  const { results } = await backend.search(itemQuery, 1)
   const [it] = addItemLinks(results, endpoint)
   if (it) {
     return it
@@ -1233,7 +1243,7 @@ const deleteItem = async function (collectionId, itemId, backend) {
 
 const getItemThumbnail = async function (collectionId, itemId, backend) {
   const itemQuery = { collections: [collectionId], id: itemId }
-  const { results } = await backend.search(itemQuery)
+  const { results } = await backend.search(itemQuery, 1)
   const [item] = results
   if (!item) {
     return new Error('Item not found')

src/lib/database.js

@@ -772,7 +772,7 @@ export async function constructSearchParams(parameters, page, limit) {
   return searchParams
 }
 
-async function search(parameters, page, limit = 10) {
+async function search(parameters, limit, page) {
   const searchParams = await constructSearchParams(parameters, page, limit)
   const dbResponse = await dbQuery({
     ignore_unavailable: true,
@@ -783,12 +783,10 @@ async function search(parameters, page, limit = 10) {
   const results = dbResponse.body.hits.hits.map((r) => (r._source))
   const response = {
     results,
-    context: {
-      limit: Number(limit),
-      matched: dbResponse.body.hits.total.value,
-      returned: results.length
-    }
+    numberMatched: dbResponse.body.hits.total.value,
+    numberReturned: results.length
   }
+
   return response
 }
 
@@ -977,7 +975,7 @@ const getItem = async (collectionId, itemId) => {
   const searchResponse = await search({
     collections: [collectionId],
     id: itemId
-  })
+  }, 1)
 
   return searchResponse.results[0]
 }

src/lib/ingest.js

@@ -28,7 +28,7 @@ export async function convertIngestObjectToDbObject(
     index = data.collection
   } else {
     throw new InvalidIngestError(
-      `Expected data.type to be "Collection" or "Feature" not ${data.type}`
+      `Expected data.type to be 'Collection' or 'Feature' not '${data.type}'`
     )
   }
 

tests/helpers/ingest.js

@@ -76,7 +76,7 @@ export const ingestFixtureC = (ingestTopicArn, ingestQueueUrl) =>
 
 export async function testPostIngestSNS(t, record, shouldError = false) {
   // @ts-ignore
-  process.env.POST_INGEST_TOPIC_ARN = t.context.postIngestTopicArn
+  process.env['POST_INGEST_TOPIC_ARN'] = t.context.postIngestTopicArn
 
   await sns().publish({
     TopicArn: t.context.ingestTopicArn,

tests/system/test-api-get-collections.js

@@ -34,7 +34,7 @@ test('GET /collections', async (t) => {
   t.true(Array.isArray(response.collections))
   t.true(response.collections.length > 0)
 
-  t.truthy(response.context.returned)
+  t.falsy(response.context)
 
   // queryables definition is stored in the collection document in OpenSearch,
   // but we do not want it in the Collection entity returned from the API or

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

@@ -1359,3 +1359,25 @@ test('/search - filter extension - s_intersects - non-existent geometry type', a
     // eslint-disable-next-line max-len
     /.*Operand for 's_intersects' must be a GeoJSON geometry: type was 'notPolygon'*/)
 })
+
+test('/search - context extension - no context when default', async (t) => {
+  const response = await t.context.api.client.post('search', { json: { } })
+  t.is(response.type, 'FeatureCollection')
+  t.is(response.numberMatched, 3)
+  t.is(response.numberReturned, 3)
+
+  t.falsy(response.context)
+})
+
+test('/search - context extension - context added when enabled', async (t) => {
+  process.env['ENABLE_CONTEXT_EXTENSION'] = 'true'
+  const response = await t.context.api.client.post('search', { json: { } })
+  t.is(response.type, 'FeatureCollection')
+  t.is(response.numberMatched, 3)
+  t.is(response.numberReturned, 3)
+
+  t.truthy(response.context)
+  t.is(response.context.matched, 3)
+  t.is(response.context.returned, 3)
+  t.is(response.context.limit, 10)
+})