@plusscommunities/pluss-maintenance-aws 2.0.5-auth.0 → 2.1.0-auth.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plusscommunities/pluss-maintenance-aws",
-  "version": "2.0.5-auth.0",
+  "version": "2.1.0-auth.0",
   "description": "Extension package to enable maintenance on Pluss Communities Platform",
   "scripts": {
     "gc": "node ../../tools/gc ./",
@@ -14,21 +14,22 @@
     "authupload": "npm i && npm i && npm publish --access public --tag auth",
     "authupload:p": "npm run authpatch && npm run authupload",
     "upload": "rm -rf .serverless && npm i && npm publish --access public",
-    "upload:p": "npm run patch && npm run upload"
+    "upload:p": "npm run patch && npm run upload",
+    "test": "jest tests -i"
   },
-  "author": "Phillip Suh",
+  "author": "Thorbjorn Kappel Davis",
   "license": "ISC",
   "dependencies": {
     "@aws/dynamodb-auto-marshaller": "^0.7.1",
-    "@plusscommunities/pluss-core-aws": "2.0.5-auth.0",
+    "@plusscommunities/pluss-core-aws": "2.0.7-auth.0",
     "amazon-cognito-identity-js": "^2.0.19",
-    "axios": "^1.6.8",
     "aws-sdk": "^2.1591.0",
+    "axios": "^1.6.8",
+    "base64-arraybuffer": "^1.0.2",
     "expo-server-sdk": "^3.0.1",
-    "get-image-colors": "^1.8.1",
     "https": "^1.0.0",
     "lodash": "^4.17.10",
-    "moment": "^2.22.2",
+    "moment": "^2.30.1",
     "node-fetch": "^2.2.0",
     "node-jose": "^1.0.0",
     "nodemailer": "^6.9.12",
@@ -36,14 +37,25 @@
     "uuid": "^2.0.3"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.23",
     "eslint-config-rallycoding": "^3.2.0",
+    "jest": "^29.0.0",
+    "jest-aws-sdk-mock": "^1.0.2",
     "serverless-domain-manager": "^3.3.1",
     "serverless-prune-plugin": "^1.4.1"
   },
   "files": [
     "db/*",
+    "integration/*",
+    "requests/*",
     "ticketing/*",
     "*.js",
     "package*.json"
-  ]
+  ],
+  "jest": {
+    "rootDir": "./",
+    "moduleNameMapper": {
+      "^./testing/(.*)$": "<rootDir>/testing/$1"
+    }
+  }
 }

package/requests/assignRequest.js

@@ -0,0 +1,100 @@
+const moment = require("moment");
+const editRef = require("@plusscommunities/pluss-core-aws/db/common/editRef");
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+const getUserPreviewFromReq = require("@plusscommunities/pluss-core-aws/helper/getUserPreviewFromReq");
+const getRef = require("@plusscommunities/pluss-core-aws/db/common/getRef");
+const isValidAssignee = require("./helper/isValidAssignee");
+const getUserPreview = require("@plusscommunities/pluss-core-aws/helper/getUserPreview");
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const publishNotifications = require("@plusscommunities/pluss-core-aws/db/notifications/publishNotifications");
+
+module.exports = async (event, data) => {
+  const logId = log("assignRequest", "data", data);
+  // check required data
+  const requiredKeys = ["id", "userId"];
+  if (!data || requiredKeys.some((prop) => !data.hasOwnProperty(prop))) {
+    log("assignRequest", "InsufficientInput", 422, logId);
+    return { status: 422, data: { error: "Insufficient input" } };
+  }
+
+  const request = await getRef("maintenance", "id", data.id);
+  log("assignRequest", "request", request, logId);
+  log("assignRequest", "site", request.site, logId);
+
+  // validate authorisation
+  const valid = await validateMasterAuth(
+    event,
+    "maintenanceTracking",
+    request.site
+  );
+  log("assignRequest", "valid", valid, logId);
+  if (!valid) {
+    const validAssignee = await isValidAssignee(
+      event,
+      request.site,
+      request.AssigneeId
+    );
+    log("assignRequest", "validAssignee", validAssignee, logId);
+    if (!validAssignee) {
+      log("assignRequest", "NotAuthorised", 403, logId);
+      return { status: 403, data: { error: "Not authorised" } };
+    }
+  }
+
+  const user = await getUserPreviewFromReq(event);
+  log("assignRequest", "user", user, logId);
+  const assignedUser = await getUserPreview(data.userId);
+  log("assignRequest", "assignedUser", assignedUser, logId);
+
+  const changes = {
+    history: request.history || [],
+  };
+
+  // Update history
+  changes.history.push({
+    timestamp: moment.utc().valueOf(),
+    EntryType: "assignment",
+    user,
+    assignedUser,
+  });
+
+  changes.AssigneeId = data.userId;
+  changes.Assignee = assignedUser;
+
+  log("assignRequest", "changes", changes, logId);
+
+  const result = await editRef("maintenance", "id", data.id, changes);
+
+  log("assignRequest", "result", result, logId);
+
+  // send notification to assigned user
+  if (user.id !== assignedUser.id) {
+    await publishNotifications(
+      [assignedUser.id],
+      "MaintenanceJobAssigned",
+      result.site,
+      result.id,
+      result,
+      true
+    );
+  }
+
+  // send notification to previous assignee
+  if (request.AssigneeId && result.AssigneeId !== request.AssigneeId) {
+    await publishNotifications(
+      [request.AssigneeId],
+      "MaintenanceJobUnassigned",
+      result.site,
+      result.id,
+      result,
+      true
+    );
+  }
+
+  return {
+    status: 200,
+    data: {
+      job: result,
+    },
+  };
+};

package/requests/getAssignees.js

@@ -0,0 +1,39 @@
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const getUsersByPermission = require("@plusscommunities/pluss-core-aws/helper/users/getUsersByPermission");
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+
+// Define the new function to get assignees
+module.exports = async (event) => {
+  const qParams = event.queryStringParameters || {};
+  const logId = log("getAssignees", "Input", qParams);
+
+  const isAdmin = await validateMasterAuth(
+    event,
+    "maintenanceTracking",
+    qParams.site
+  );
+  const isAssignee = await validateMasterAuth(
+    event,
+    "maintenanceAssignment",
+    qParams.site
+  );
+
+  const valid = isAdmin || isAssignee;
+  log("getRequests", "valid", valid, logId);
+  if (!valid) {
+    return { status: 403, data: { error: "Not authorised" } };
+  }
+
+  // get assignees
+  const assignees = await getUsersByPermission(qParams.site, [
+    "maintenanceTracking",
+    "maintenanceAssignment",
+  ]);
+
+  log("getAssignees", "AssigneesLength", assignees.length, logId);
+
+  // compile results
+  const results = { Users: assignees };
+  log("getAssignees", "Done", true, logId);
+  return { status: 200, data: results };
+};

package/requests/getRequests.js

@@ -0,0 +1,99 @@
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const getSessionUserFromReqAuthKey = require("@plusscommunities/pluss-core-aws/helper/auth/getSessionUserFromReqAuthKey");
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+const validateSiteAccess = require("@plusscommunities/pluss-core-aws/helper/auth/validateSiteAccess");
+const indexQuery = require("@plusscommunities/pluss-core-aws/db/common/indexQuery");
+
+module.exports = async (event) => {
+  const qParams = event.queryStringParameters;
+  const logId = log("getRequests", "Params", qParams);
+
+  // insufficient input
+  if (!qParams.site) {
+    return { status: 422, data: { error: "Insufficient input" } };
+  }
+  log("getRequests", "SufficientInput", true, logId);
+
+  // no access to site
+  const valid = await validateSiteAccess(event, qParams.site);
+  log("getRequests", "valid", valid, logId);
+  if (!valid) {
+    return { status: 403, data: { error: "Not authorised" } };
+  }
+
+  // check auth level to determine whether to fetch all requests or only matching requests
+  const authorised = await validateMasterAuth(
+    event,
+    "maintenanceTracking",
+    qParams.site
+  );
+  let assigneeTracking = false;
+  if (!authorised) {
+    assigneeTracking = await validateMasterAuth(
+      event,
+      "maintenanceAssignment",
+      qParams.site
+    );
+  }
+
+  log("getRequests", "authorised", authorised, logId);
+  const userId = authorised ? null : await getSessionUserFromReqAuthKey(event);
+
+  log("getRequests", "userId", userId, logId);
+
+  const query =
+    authorised || assigneeTracking
+      ? {
+          IndexName: "MaintenanceSiteIndex",
+          KeyConditionExpression: "site = :site",
+          ExpressionAttributeValues: {
+            ":site": qParams.site,
+          },
+        }
+      : {
+          IndexName: "MaintenanceSiteUserIdIndex",
+          KeyConditionExpression: "site = :site AND userID = :userId",
+          ExpressionAttributeValues: {
+            ":site": qParams.site,
+            ":userId": userId,
+          },
+        };
+  log("getRequests", "query", query, logId);
+
+  // check whether pagination is applied
+  if (qParams.lastKey) {
+    try {
+      query.ExclusiveStartKey = JSON.parse(qParams.lastKey);
+    } catch (e) {}
+  }
+
+  // get jobs
+  const result = await indexQuery("maintenance", query);
+  let jobs = result.Items;
+
+  log("getRequests", "LastEvaluatedKey", result.LastEvaluatedKey, logId);
+  log("getRequests", "JobsLength", jobs.length, logId);
+
+  // filter on status
+  if (qParams.status) {
+    jobs = jobs.filter((j) => qParams.status.includes(j.status));
+    log("getRequests", "FilteredOnStatus", jobs.length, logId);
+  }
+
+  // filter on type
+  if (qParams.type) {
+    jobs = jobs.filter((j) => qParams.type.includes(j.type));
+    log("getRequests", "FilteredOnType", jobs.length, logId);
+  }
+
+  // filter to assigned jobs
+  if (!authorised && assigneeTracking) {
+    jobs = jobs.filter((j) => j.AssigneeId === userId || j.userID === userId);
+    log("getRequests", "FilteredOnAssignee", jobs.length, logId);
+  }
+
+  // compile results
+  const results = { Items: jobs, LastKey: result.LastEvaluatedKey };
+  log("getRequests", "Done", true, logId);
+  return { status: 200, data: results };
+};

package/requests/helper/hasRequestPermission.js

@@ -0,0 +1,24 @@
+/**
+ * Checks if the request has permission.
+ *
+ * @param {Object} event - The api request object.
+ * @param {Object} job - The job object.
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating if the request has permission.
+ */
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+const isValidAssignee = require("./isValidAssignee");
+
+module.exports = async (event, job) => {
+  const valid = await validateMasterAuth(
+    event,
+    "maintenanceTracking",
+    job.site
+  );
+  if (valid) {
+    return true;
+  }
+  if (!job.AssigneeId) {
+    return false;
+  }
+  return await isValidAssignee(event, job.site, job.AssigneeId);
+};

package/requests/helper/isValidAssignee.js

@@ -0,0 +1,18 @@
+const getSessionUserFromReqAuthKey = require("@plusscommunities/pluss-core-aws/helper/auth/getSessionUserFromReqAuthKey");
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+
+/**
+ * Checks whether the logged in user is the assignee as has the assignment permission for that site
+ * @param {*} event A request including headers
+ * @param {String} site A site id
+ * @param {String} userId A user id to check for
+ * @returns {Boolean} true if valid
+ */
+module.exports = async (event, site, userId) => {
+  const valid = await validateMasterAuth(event, "maintenanceAssignment", site);
+  if (!valid) {
+    return false;
+  }
+  const loggedInUser = await getSessionUserFromReqAuthKey(event);
+  return loggedInUser === userId;
+};

package/scheduleJobImport.js

@@ -0,0 +1,80 @@
+const indexQuery = require("@plusscommunities/pluss-core-aws/db/common/indexQuery");
+const editRef = require("@plusscommunities/pluss-core-aws/db/common/editRef");
+const moment = require("moment");
+const { getStrategy } = require("./integration");
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+
+const processSingle = async (strategy, item) => {
+  // use IDs to refresh request data
+  const logId = log("processSingle", "RefreshFromSource", item.ExternalId);
+
+  // refresh from external source
+  await strategy.refreshFromSource(
+    item.InternalId,
+    item.ExternalId,
+    item.TrackedData
+  );
+
+  // save updated timestamp
+  await editRef("externalentities", "RowId", item.RowId, {
+    LastUpdated: moment().valueOf(),
+  });
+
+  log("processBatch", "Refreshed", item.ExternalId, logId);
+  return true;
+};
+
+const processBatch = async (strategy, startTime) => {
+  const logId = log("processBatch", "StartTime", moment().valueOf());
+
+  // use index query to fetch IDs of requests
+  const query = {
+    IndexName: "EntityTypeIndex",
+    KeyConditionExpression:
+      "EntityType = :entityType AND LastUpdated < :lastUpdate", // only fetch items that haven't been updated in this scan
+    ExpressionAttributeValues: {
+      ":entityType": strategy.getEntityType(),
+      ":lastUpdate": startTime - strategy.getRefreshInterval(),
+    },
+    Limit: 10,
+    ScanIndexForward: false,
+  };
+  const { Items } = await indexQuery("externalentities", query);
+
+  const promises = [];
+
+  Items.forEach((item) => {
+    promises.push(processSingle(strategy, item));
+  });
+
+  await Promise.all(promises);
+  log("processBatch", "EndOfBatch", Items.length, logId);
+  return Items.length;
+};
+
+module.exports.scheduleJobImport = async (event, context, callback) => {
+  const logId = log("scheduleJobImport", "Start", true);
+  // get active integration
+  const integrationStrategy = await getStrategy("plussSpace");
+  if (!integrationStrategy.isValidIntegration()) {
+    log("scheduleJobImport", "Exit", "No valid integration", logId);
+    return;
+  }
+
+  const startTime = moment().valueOf();
+  const timeout = 3 * 60 * 1000; // 3 minutes
+  let noneToProcess = false;
+  log("scheduleJobImport", "StartTime", startTime, logId);
+
+  while (!noneToProcess && moment().valueOf() < startTime + timeout) {
+    const logId = log("scheduleJobImport", "StartLoop", moment().valueOf());
+    const count = await processBatch(integrationStrategy, startTime);
+    log("scheduleJobImport", "Count", count, logId);
+    if (!count) {
+      log("scheduleJobImport", "noneToProcess", true, logId);
+      noneToProcess = true;
+    }
+    log("scheduleJobImport", "EndLoop", moment().valueOf(), logId);
+  }
+  log("scheduleJobImport", "End", moment().valueOf(), logId);
+};

package/updateData.js

@@ -0,0 +1,33 @@
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const generateJsonResponse = require("@plusscommunities/pluss-core-aws/helper/generateJsonResponse");
+const { init } = require("@plusscommunities/pluss-core-aws/config");
+const config = require("./config.json");
+const assignRequest = require("./requests/assignRequest");
+
+module.exports.updateData = async (event, context, callback) => {
+  init(config);
+  const action = event.pathParameters.action;
+  const data = JSON.parse(event.body);
+  const logId = log(action, "Input", data);
+
+  let response;
+
+  try {
+    switch (action) {
+      case "assign":
+        response = await assignRequest(event, data);
+        break;
+      default:
+        break;
+    }
+  } catch (err) {
+    log(action, "InternalError", err.toString(), logId);
+    if (!response) {
+      response = { status: 500, data: { error: "Internal Error" } };
+    }
+  }
+
+  log(action, "Response", response, logId);
+
+  return callback(null, generateJsonResponse(response.status, response.data));
+};

package/ticketing/addTicket.js

@@ -1,87 +0,0 @@
-const uuid = require("uuid");
-const moment = require("moment");
-const config = require("../config.json");
-const { init } = require("@plusscommunities/pluss-core-aws/config");
-const { getBody } = require("@plusscommunities/pluss-core-aws/helper");
-const generateJsonResponse = require("@plusscommunities/pluss-core-aws/helper/generateJsonResponse");
-const updateRef = require("@plusscommunities/pluss-core-aws/db/common/updateRef");
-const validateSiteAccess = require("@plusscommunities/pluss-core-aws/helper/auth/validateSiteAccess");
-const publishActivity = require("@plusscommunities/pluss-core-aws/db/activity/publishActivity");
-const getUserPreviewFromHeader = require("@plusscommunities/pluss-core-aws/helper/getUserPreviewFromHeader");
-const {
-  newTicketEmailTemplate,
-  plussTeamEmails,
-} = require("@plusscommunities/pluss-core-aws/templates/supportTicketEmails");
-const sendEmail = require("@plusscommunities/pluss-core-aws/helper/sendEmail");
-const { getConfig } = require("@plusscommunities/pluss-core-aws/config");
-
-const sendTicketEmail = (ticket) => {
-  const { communityConfig } = getConfig();
-
-  const subject = newTicketEmailTemplate.subject.replace(
-    "___TITLE___",
-    ticket.Title
-  );
-  const content = newTicketEmailTemplate.content
-    .replace("___NAME___", ticket.User.displayName)
-    .replace("___SITE___", ticket.Site)
-    .replace("___CLIENT___", communityConfig.company)
-    .replace("___TITLE___", ticket.Title)
-    .replace("___TEXT___", ticket.Text.replace(/\n/g, " <br /> "));
-  sendEmail(plussTeamEmails.join(","), subject, content, true);
-};
-
-module.exports.addTicket = (event, context, callback) => {
-  init(config);
-  const data = getBody(event);
-
-  if (!data.site || !data.title) {
-    return callback(
-      null,
-      generateJsonResponse(422, { error: "No site, title, or text attached" })
-    );
-  }
-
-  validateSiteAccess(event, data.site).then((authorised) => {
-    if (!authorised) {
-      console.error("Authorization not valid");
-      callback(
-        null,
-        generateJsonResponse(422, {
-          error: {
-            message: "Authorization not valid.",
-          },
-        })
-      );
-      return;
-    }
-
-    getUserPreviewFromHeader(event.headers.authkey)
-      .then((user) => {
-        const ticket = {
-          Title: data.title,
-          Text: data.text,
-          Attachments: data.attachments,
-          Site: data.site,
-          Id: uuid.v1(),
-          Timestamp: moment.utc().valueOf(),
-          History: [],
-          User: user,
-          Status: "open",
-        };
-        updateRef("supporttickets", ticket).then((result) => {
-          sendTicketEmail(ticket);
-          publishActivity("AddTicket", data.site, ticket.id, user, {
-            title: data.title,
-          });
-          callback(
-            null,
-            generateJsonResponse(200, { success: true, ticket: result })
-          );
-        });
-      })
-      .catch((error) => {
-        callback(null, generateJsonResponse(422, { error }));
-      });
-  });
-};

package/ticketing/deleteTicket.js

@@ -1,50 +0,0 @@
-const config = require("../config.json");
-const { init } = require("@plusscommunities/pluss-core-aws/config");
-const { getBody } = require("@plusscommunities/pluss-core-aws/helper");
-const generateJsonResponse = require("@plusscommunities/pluss-core-aws/helper/generateJsonResponse");
-const deleteRef = require("@plusscommunities/pluss-core-aws/db/common/deleteRef");
-const getRef = require("@plusscommunities/pluss-core-aws/db/common/getRef");
-const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
-const getUserPreviewFromHeader = require("@plusscommunities/pluss-core-aws/helper/getUserPreviewFromHeader");
-const publishActivity = require("@plusscommunities/pluss-core-aws/db/activity/publishActivity");
-
-module.exports.deleteTicket = (event, context, callback) => {
-  init(config);
-  const data = getBody(event);
-
-  validateMasterAuth(event, "master", "plussSpace", true).then((authorised) => {
-    if (!authorised) {
-      console.error("Authorization not valid");
-      callback(
-        null,
-        generateJsonResponse(422, {
-          error: {
-            message: "Authorization not valid.",
-          },
-        })
-      );
-      return;
-    }
-    getRef("supporttickets", "Id", data.id)
-      .then((ticket) => {
-        deleteRef("supporttickets", "Id", data.id)
-          .then(() => {
-            getUserPreviewFromHeader(event.headers.authkey).then((user) => {
-              publishActivity("DeleteTicket", ticket.Site, data.id, user, {
-                title: ticket.Title,
-              });
-            });
-            callback(null, generateJsonResponse(200, { success: true }));
-            return;
-          })
-          .catch((error) => {
-            callback(null, generateJsonResponse(422, { error }));
-            return;
-          });
-      })
-      .catch((error) => {
-        callback(null, generateJsonResponse(422, { error }));
-        return;
-      });
-  });
-};