2606/Multiple Exercise Custom Report (#1283)

* wip

* wip

* Amend callable function interface

---------

Co-authored-by: warrensearle <warren@precise-minds.co.uk>

functions/actions/exercises/getMultipleApplicationData.js

@@ -0,0 +1,27 @@
+import initGetApplicationData from './getApplicationData.js';
+
+export default (config, firebase, db, auth) => {
+
+  const getApplicationData = initGetApplicationData(config, firebase, db, auth);
+
+  return getMultipleApplicationData;
+
+  async function getMultipleApplicationData(exerciseIds, columns) {
+    const allData = [];
+
+    for (const exerciseId of exerciseIds) {
+      const whereClauses = [];
+      const exerciseParams = { whereClauses, columns, exerciseId };
+      const exerciseData = await getApplicationData(exerciseParams);
+
+      if (Array.isArray(exerciseData)) {
+        allData.push(...exerciseData);
+      } else {
+        console.warn(`Non-iterable data returned for exerciseId: ${exerciseId}`, exerciseData);
+      }
+    }
+
+    return allData;
+  }
+
+};

functions/callableFunctions/getMultipleApplicationData.js

@@ -0,0 +1,36 @@
+import functions from 'firebase-functions';
+import { auth } from '../shared/admin.js';
+import config from '../shared/config.js';
+import { firebase, db } from '../shared/admin.js';
+import { checkArguments } from '../shared/helpers.js';
+import initGetMultipleApplicationData from '../actions/exercises/getMultipleApplicationData.js';
+import initServiceSettings from '../shared/serviceSettings.js';
+import { PERMISSIONS, hasPermissions } from '../shared/permissions.js';
+
+const getMultipleApplicationData = initGetMultipleApplicationData(config, firebase, db, auth);
+const { checkFunctionEnabled } = initServiceSettings(db);
+
+const runtimeOptions = {
+  memory: '512MB',
+};
+
+export default functions.runWith(runtimeOptions).region('europe-west2').https.onCall(async (data, context) => {
+  await checkFunctionEnabled();
+  if (!context.auth) {
+    throw new functions.https.HttpsError('failed-precondition', 'The function must be called while authenticated.');
+  }
+
+  hasPermissions(context.auth.token.rp, [
+    PERMISSIONS.applications.permissions.canReadApplications.value,
+  ]);
+
+  if (!checkArguments({
+    exerciseIds: { required: true },
+    columns: { required: true },
+  }, data)) {
+    throw new functions.https.HttpsError('invalid-argument', 'Please provide valid arguments');
+  }
+  return getMultipleApplicationData(data.exerciseIds, data.columns);
+
+});
+

functions/index.js

@@ -97,6 +97,7 @@ import getLatestReleases from './callableFunctions/getLatestReleases.js';
 import verifyFileChecksum from './callableFunctions/verifyFileChecksum.js';
 import sendSmsVerificationCode from './callableFunctions/sendSmsVerificationCode.js';
 import verifySmsVerificationCode from './callableFunctions/verifySmsVerificationCode.js';
+import getMultipleApplicationData from './callableFunctions/getMultipleApplicationData.js';
 
 // Callable - QTs v2
 import listQualifyingTests from './callableFunctions/qualifyingTests/v2/listQualifyingTests.js';
@@ -206,6 +207,7 @@ export {
   verifyFileChecksum,
   sendSmsVerificationCode,
   verifySmsVerificationCode,
+  getMultipleApplicationData,
 
   // Callable - QTs v2
   listQualifyingTests,