add label filter for entities geojson, fixes getodk/central#1525

Author: brontolosone

lib/model/query/entities.js

@@ -1110,5 +1110,5 @@ module.exports = {
   getAll, getAllDefs, del,
   createEntitiesFromPendingSubmissions,
   resolveConflict, restore, purge, getEntitiesState,
-  getAllCreators, deleteByIds, restoreByIds
+  getAllCreators, deleteByIds, restoreByIds, searchClause
 };

lib/model/query/geo-extracts.js

@@ -9,6 +9,7 @@
 
 const { sql } = require('slonik');
 const { arrayHasElements } = require('../../util/util');
+const { searchClause } = require('./entities');
 
 
 const stateFilterToQueryFragments = (field, states, pgType = 'text') => {
@@ -183,21 +184,22 @@ const getSubmissionFeatureCollectionGeoJson = (formPK, IDs, fieldPaths, submitte
 };
 
 
-const getEntityFeatureCollectionGeoJson = (datasetPK, IDs, creatorIds, TSTZRange, conflictStates, deleted, limit) => ({ db }) => {
+const getEntityFeatureCollectionGeoJson = (datasetPK, IDs, creatorIds, TSTZRange, conflictStates, deleted, limit, search) => ({ db }) => {
 
   const idFilter = arrayHasElements(IDs) ? sql`AND e.uuid = ANY(${sql.array(IDs, 'text')})` : sql``; // TODO: this should be a uuid[] array once/if the entities."uuid" column is converted from varchar(255) to uuid
   const creatorFilter = arrayHasElements(creatorIds) ? sql`AND e."creatorId" = ANY(${sql.array(creatorIds, 'int4')})` : sql``;
   const TSTZRangeFilter = arrayHasElements(TSTZRange) ? sql`AND e."createdAt" <@ tstzrange(${TSTZRange[0]}, ${TSTZRange[1]}, ${TSTZRange[2]})` : sql``;
   const conflictStatusFilter = arrayHasElements(conflictStates) ? sql`AND ${stateFilterToQueryFragments(['e', 'conflict'], conflictStates, 'conflictType')}` : sql``;
   const deletedFilter = deleted ? sql`IS NOT NULL` : sql`IS NULL`;
   const queryLimit = limit ? sql`LIMIT ${limit}` : sql``;
+  const searchFilter = searchClause(search);
 
 
   return db.oneFirst(sql`
       WITH extracted AS (
           SELECT
               e.uuid,
-              odk2geojson_ducktyped(ed.data ->> 'geometry') AS geojsoned
+              odk2geojson_ducktyped(entity_defs.data ->> 'geometry') AS geojsoned
           FROM
               datasets ds
               INNER JOIN ds_properties dsprops ON (
@@ -214,12 +216,13 @@ const getEntityFeatureCollectionGeoJson = (datasetPK, IDs, creatorIds, TSTZRange
                   ${TSTZRangeFilter}
                   ${conflictStatusFilter}
               )
-              INNER JOIN entity_defs ed ON (
-                  ed."entityId" = e.id
+              INNER JOIN entity_defs ON (
+                  entity_defs."entityId" = e.id
                   AND
-                  ed.current
+                  entity_defs.current
                   AND
-                  (ed.data ? 'geometry' AND (ed.data ->> 'geometry' ~ '\\d'))  -- there's an index on this expression
+                  (entity_defs.data ? 'geometry' AND (entity_defs.data ->> 'geometry' ~ '\\d'))  -- there's an index on this expression
+                  AND ${searchFilter}
               )
           ${queryLimit}
           ),

lib/resources/geo-extracts.js

@@ -69,6 +69,7 @@ module.exports = (service, endpoint) => {
       Sanitize.getEntityConflictStates(query.conflict, 'conflict'),
       isTrue(query.deleted),
       Number.parseInt(query.limit, 10) || null,
+      Sanitize.queryParamToArray(query.$search)[0],
     ).then(json);
   }));
 

test/integration/api/geodata.js

@@ -803,6 +803,18 @@ describe('api: entities-geodata', () => {
   }));
 
 
+  it('Attribute label filter does its job', testService(async (service, { db }) => {
+    const { asAlice } = await setupGeoEntities(service, db);
+
+    await asAlice.get(`/v1/projects/1/datasets/geofun/entities.geojson?$search=a`)
+      .expect(200)
+      .then((resp) => {
+        resp.body.features.length.should.equal(1);
+      });
+
+  }));
+
+
   it('conflict status filter does its job', testService(async (service, { db }) => {
     const { asAlice } = await setupGeoEntities(service, db);