aggregation builder v1

backend/actions/Model/aggregate.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const Archetype = require('archetype');
+const { EJSON } = require('mongoose').mongo.BSON;
+const authorize = require('../../authorize');
+
+const AggregateParams = new Archetype({
+  model: {
+    $type: 'string',
+    $required: true
+  },
+  pipeline: {
+    $type: Archetype.Any,
+    $required: true
+  },
+  limit: {
+    $type: 'number',
+    $default: 20
+  },
+  roles: {
+    $type: ['string']
+  }
+}).compile('AggregateParams');
+
+module.exports = ({ db }) => async function aggregate(params) {
+  params = new AggregateParams(params);
+  const { model, roles } = params;
+  await authorize('Model.aggregate', roles);
+
+  const Model = db.models[model];
+  if (Model == null) {
+    throw new Error(`Model ${model} not found`);
+  }
+
+  if (!Array.isArray(params.pipeline)) {
+    throw new Error('`pipeline` must be an array');
+  }
+
+  let pipeline;
+  try {
+    pipeline = EJSON.deserialize(params.pipeline);
+  } catch (err) {
+    throw new Error(`Invalid pipeline (EJSON): ${err.message}`);
+  }
+
+  if (!Array.isArray(pipeline)) {
+    throw new Error('`pipeline` must be an array');
+  }
+
+  pipeline = pipeline.map((stage, index) => {
+    if (stage == null || Array.isArray(stage) || typeof stage !== 'object') {
+      throw new Error(`Invalid stage at index ${index}`);
+    }
+    return stage;
+  });
+
+  const limit = Math.max(1, Math.min(200, Math.floor(params.limit ?? 20)));
+  pipeline.push({ $limit: limit });
+
+  const docs = await Model.aggregate(pipeline).exec();
+  return { docs };
+};

backend/actions/Model/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 exports.addField = require('./addField');
+exports.aggregate = require('./aggregate');
 exports.analyzeSchema = require('./analyzeSchema');
 exports.createChatMessage = require('./createChatMessage');
 exports.createDocument = require('./createDocument');

backend/authorize.js

@@ -21,6 +21,7 @@ const actionsToRequiredRoles = {
   'Model.deleteDocuments': ['owner', 'admin', 'member'],
   'Model.dropCollection': ['owner', 'admin'],
   'Model.dropIndex': ['owner', 'admin'],
+  'Model.aggregate': ['owner', 'admin', 'member', 'readonly'],
   'Model.executeDocumentScript': ['owner', 'admin', 'member'],
   'Model.exportQueryResults': ['owner', 'admin', 'member', 'readonly'],
   'Model.getDocument': ['owner', 'admin', 'member', 'readonly'],