feat: add contextual filtering

Co-authored-by: Antoine Hurard <[email protected]>

Author: matheus-relief

src/models/layer.model.ts

@@ -119,6 +119,7 @@ export interface Layer extends Document {
   opacity: number;
   layerDefinition?: LayerDefinition;
   popupInfo?: PopupElement[];
+  contextFilters: string;
 }
 
 /** Mongoose layer schema declaration */
@@ -170,6 +171,7 @@ const layerSchema = new Schema(
         enum: Object.values(GeometryType),
       },
     },
+    contextFilters: String,
   },
   {
     timestamps: { createdAt: 'createdAt', updatedAt: 'modifiedAt' },

src/routes/gis/index.ts

@@ -154,6 +154,9 @@ router.get('/feature', async (req, res) => {
   const longitudeField = get(req, 'query.longitudeField');
   const geoField = get(req, 'query.geoField');
   const layerType = get(req, 'query.type', GeometryType.POINT);
+  const contextFilters = JSON.parse(
+    decodeURIComponent(get(req, 'query.contextFilters', null))
+  );
   // const tolerance = get(req, 'query.tolerance', 1);
   // const highQuality = get(req, 'query.highquality', true);
   // turf.simplify(geoJsonData, {
@@ -225,17 +228,23 @@ router.get('/feature', async (req, res) => {
       // const filterPolygon = getFilterPolygon(req.query);
 
       if (aggregation) {
-        query = `query recordsAggregation($resource: ID!, $aggregation: ID!) {
-          recordsAggregation(resource: $resource, aggregation: $aggregation)
+        query = `query recordsAggregation($resource: ID!, $aggregation: ID!, $contextFilters: JSON) {
+          recordsAggregation(resource: $resource, aggregation: $aggregation, contextFilters: $contextFilters)
         }`;
         variables = {
           resource: resourceData._id,
           aggregation: aggregation._id,
+          contextFilters,
         };
       } else if (layout) {
         query = buildQuery(layout.query);
         variables = {
-          filter: layout.query.filter,
+          filter: {
+            logic: 'and',
+            filters: contextFilters
+              ? [layout.query.filter, contextFilters]
+              : [layout.query.filter],
+          },
         };
       } else {
         return res.status(404).send(i18next.t('common.errors.dataNotFound'));

src/schema/inputs/layer.input.ts

@@ -154,6 +154,7 @@ const LayerInputType = new GraphQLInputObjectType({
       }),
     },
     datasource: { type: LayerDataSourceInputType },
+    contextFilters: { type: GraphQLString },
   }),
 });
 

src/schema/query/recordsAggregation.query.ts

@@ -39,6 +39,23 @@ const CREATED_BY_STAGES = [
   },
 ];
 
+/**
+ * Extracts the source fields from a filter
+ *
+ * @param filter the filter to extract the source fields from
+ * @param fields the fields to add the source fields to
+ */
+const extractSourceFields = (filter: any, fields: string[] = []) => {
+  if (filter.filters) {
+    filter.filters.forEach((f) => {
+      extractSourceFields(f, fields);
+    });
+  } else if (filter.field) {
+    if (typeof filter.field === 'string' && !fields.includes(filter.field))
+      fields.push(filter.field);
+  }
+};
+
 /**
  * Take an aggregation configuration as parameter.
  * Return aggregated records data.
@@ -48,6 +65,7 @@ export default {
   args: {
     resource: { type: new GraphQLNonNull(GraphQLID) },
     aggregation: { type: new GraphQLNonNull(GraphQLID) },
+    contextFilters: { type: GraphQLJSON },
     mapping: { type: GraphQLJSON },
     first: { type: GraphQLInt },
     skip: { type: GraphQLInt },
@@ -92,6 +110,13 @@ export default {
 
       const refDataNameMap: Record<string, string> = {};
       if (aggregation?.sourceFields && aggregation.pipeline) {
+        if (args.contextFilters) {
+          extractSourceFields(args.contextFilters, aggregation.sourceFields);
+          aggregation.pipeline.unshift({
+            type: 'filter',
+            form: args.contextFilters,
+          });
+        }
         // Go through the aggregation source fields to update possible refData field names
         for (const field of aggregation.sourceFields) {
           // find field in resource fields

src/schema/types/layer.type.ts

@@ -171,6 +171,7 @@ export const LayerType = new GraphQLObjectType({
     modifiedAt: { type: GraphQLString },
     layerType: { type: LayerTypeEnum },
     datasource: { type: LayerDatasource },
+    contextFilters: { type: GraphQLString },
   }),
 });