Improve /search sortby error message (#1021)

* improve sortby error message

* update changelog

* upgrade packages to satisfy audit

* syntax error after merge conflict

Author: naterubin

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   - Comprehensive documentation now organized into Getting Started, Guides, Reference, and About sections
   - Removed top-level markdown files (ARCHITECTURE.md, USAGE.md, DEPLOYMENT.md, CONFIGURATION.md, CONTRIBUTING.md, SECURITY.md) - all content migrated to docs/
   - Updated README.md to serve as GitHub landing page with links to full documentation
+  - If an invalid sortby parameter is supplied, a 400 status is returned (instead of 500) with
+    a helpful error message.
   - Bbox queries outside of [-180, -90, 180, 90] return a 400 error
 
 ## [4.5.0]

src/lib/api.js

@@ -718,6 +718,15 @@ const searchItems = async function (
       let errorMessage
       if ('caused_by' in e) {
         errorMessage = JSON.stringify(e?.caused_by?.reason)
+      } else if ('root_cause' in e) {
+        const reason = e?.root_cause[0]?.reason
+        errorMessage = reason
+        if (reason.includes('No mapping found for')
+            && reason.includes('to sort on')) {
+          errorMessage += '. (Hint: `sortby` requires fully '
+                + 'qualified identifiers, e.g. `properties.datetime` '
+                + 'instead of `datetime`)'
+        }
       } else if (JSON.stringify(e).includes('failed to create query')) {
         errorMessage = `Query failed with invalid parameters: ${JSON.stringify(e)}`
       } else {

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

@@ -386,6 +386,15 @@ test('GET /search with filter restriction returns filtered results', async (t) =
   }
 })
 
+test('/search sort unqualified field names fails', async (t) => {
+  const error = await t.throwsAsync(async () => t.context.api.client.get('search', {
+    searchParams: { sortby: '-datetime' }
+  }))
+
+  t.is(error.response.statusCode, 400)
+  t.truthy(error.response.body.description.includes('Hint: `sortby` requires fully qualified identifiers'))
+})
+
 test('/search invalid bbox throws error', async (t) => {
   const error = await t.throwsAsync(async () => t.context.api.client.get('search', {
     searchParams: {

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

@@ -150,6 +150,20 @@ test('/search sort', async (t) => {
   t.is(response.features[0].id, 'LC80100102015082LGN00')
 })
 
+test('/search sort unqualified field names fails', async (t) => {
+  const error = await t.throwsAsync(async () => t.context.api.client.post('search', {
+    json: {
+      sortby: [{
+        field: 'datetime',
+        direction: 'desc'
+      }]
+    }
+  }))
+
+  t.is(error.response.statusCode, 400)
+  t.truthy(error.response.body.description.includes('Hint: `sortby` requires fully qualified identifiers'))
+})
+
 test('/search flattened collection properties', async (t) => {
   let response = await t.context.api.client.post('search', {
     json: {