@plusscommunities/pluss-maintenance-aws-forms 2.1.43 → 2.1.45

package/feature.config.js

@@ -212,6 +212,7 @@ exports.serverless = {
         { name: "jobNo", type: "N" },
         { name: "userID", type: "S" },
         { name: "AssigneeId", type: "S" },
+        { name: "status", type: "S" },
       ],
       id: "id",
       indexes: [
@@ -247,6 +248,13 @@ exports.serverless = {
             { name: "AssigneeId", type: "RANGE" },
           ],
         },
+        {
+          name: "MaintenanceSiteStatusIndex",
+          keys: [
+            { name: "site", type: "HASH" },
+            { name: "status", type: "RANGE" },
+          ],
+        },
       ],
     },
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plusscommunities/pluss-maintenance-aws-forms",
-  "version": "2.1.43",
+  "version": "2.1.45",
   "description": "Extension package to enable maintenance on Pluss Communities Platform",
   "scripts": {
     "gc": "node ../../tools/gc ./",

package/requests/getRequests.js

@@ -3,169 +3,244 @@ const getSessionUserFromReqAuthKey = require("@plusscommunities/pluss-core-aws/h
 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");
+const indexQueryRecursive = require("@plusscommunities/pluss-core-aws/db/common/indexQueryRecursive");
 const { values } = require("../values.config");
 
 // Normalise legacy/null status to "Open" (null = very old jobs, "Unassigned" = pre-rename)
 const STATUS_OPEN = "Open";
 const normalizeStatus = (status) =>
-  !status || status === "Unassigned" ? STATUS_OPEN : status;
-
-// HACK: Lax "complete" match handles minor label variations across sites
-const isCompleted = (status) =>
-  status && status.toLowerCase().includes("complete");
+	!status || status === "Unassigned" ? STATUS_OPEN : status;
 
 // Priority defaults to "Low" when not set (not set on creation)
 const DEFAULT_PRIORITY = "Low";
 const normalizePriority = (priority) =>
-  priority == null ? DEFAULT_PRIORITY : priority;
+	priority == null ? DEFAULT_PRIORITY : priority;
 
 // Minimum number of filtered results to return before stopping.
 // Because DynamoDB pages are unfiltered and we filter after query,
 // a single page may yield very few matching results. We keep
 // fetching pages until we have this many items to return.
-const MIN_RESULT_COUNT = 50;
+const MIN_RESULT_COUNT = 250;
+
+// When filters are active, fetch all matching results so the
+// client receives a complete set rather than a truncated page.
+const MIN_RESULT_COUNT_FILTERED = Infinity;
+
+const hasActiveFilters = (qParams) =>
+	qParams.status ||
+	qParams.priority ||
+	qParams.type ||
+	qParams.search ||
+	qParams.startTime ||
+	qParams.endTime;
 
 /**
  * Apply all post-query filters to a set of jobs.
  * Extracted so the same logic runs on every auto-fill page.
  */
 const filterJobs = (jobs, qParams, authorised, assigneeTracking, userId) => {
-  let filtered = jobs;
-
-  if (qParams.status) {
-    if (qParams.status === "Incomplete") {
-      filtered = filtered.filter((j) => !isCompleted(normalizeStatus(j.status)));
-    } else {
-      filtered = filtered.filter((j) => qParams.status.includes(normalizeStatus(j.status)));
-    }
-  }
-
-  if (qParams.priority) {
-    filtered = filtered.filter((j) => qParams.priority.includes(normalizePriority(j.priority)));
-  }
-
-  if (qParams.type) {
-    filtered = filtered.filter((j) => qParams.type.includes(j.type));
-  }
-
-  if (!authorised && assigneeTracking) {
-    filtered = filtered.filter((j) => j.AssigneeId === userId || j.userID === userId);
-  }
-
-  if (qParams.startTime) {
-    const startTime = parseInt(qParams.startTime, 10);
-    filtered = filtered.filter((j) => j.createdUnix >= startTime);
-  }
-  if (qParams.endTime) {
-    const endTime = parseInt(qParams.endTime, 10);
-    filtered = filtered.filter((j) => j.createdUnix <= endTime);
-  }
-
-  if (qParams.search) {
-    const searchLower = qParams.search.toLowerCase();
-    filtered = filtered.filter((j) => {
-      if (j.jobId && j.jobId === qParams.search) return true;
-      if (j.room && j.room.toLowerCase().indexOf(searchLower) > -1) return true;
-      if (j.title && j.title.toLowerCase().indexOf(searchLower) > -1) return true;
-      return false;
-    });
-  }
-
-  return filtered;
+	let filtered = jobs;
+
+	if (qParams.status) {
+		filtered = filtered.filter((j) =>
+			qParams.status.includes(normalizeStatus(j.status)),
+		);
+	}
+
+	if (qParams.priority) {
+		filtered = filtered.filter((j) =>
+			qParams.priority.includes(normalizePriority(j.priority)),
+		);
+	}
+
+	if (qParams.type) {
+		filtered = filtered.filter((j) => qParams.type.includes(j.type));
+	}
+
+	if (!authorised && assigneeTracking) {
+		filtered = filtered.filter(
+			(j) => j.AssigneeId === userId || j.userID === userId,
+		);
+	}
+
+	if (qParams.startTime) {
+		const startTime = parseInt(qParams.startTime, 10);
+		filtered = filtered.filter((j) => j.createdUnix >= startTime);
+	}
+	if (qParams.endTime) {
+		const endTime = parseInt(qParams.endTime, 10);
+		filtered = filtered.filter((j) => j.createdUnix <= endTime);
+	}
+
+	if (qParams.search) {
+		const searchLower = qParams.search.toLowerCase();
+		filtered = filtered.filter((j) => {
+			if (j.jobId && j.jobId === qParams.search) return true;
+			if (j.room && j.room.toLowerCase().indexOf(searchLower) > -1) return true;
+			if (j.title && j.title.toLowerCase().indexOf(searchLower) > -1)
+				return true;
+			return false;
+		});
+	}
+
+	return filtered;
 };
 
 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,
-    values.permissionMaintenanceTracking,
-    qParams.site
-  );
-  let assigneeTracking = false;
-  if (!authorised) {
-    assigneeTracking = await validateMasterAuth(
-      event,
-      values.permissionMaintenanceAssignment,
-      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,
-          },
-        };
-
-  // Use the assignee GSI when filtering by assignee (avoids fetching the entire site's jobs)
-  if (qParams.assignee && (authorised || assigneeTracking)) {
-    query.IndexName = "MaintenanceSiteAssigneeIndex";
-    query.KeyConditionExpression = "site = :site AND AssigneeId = :assigneeId";
-    query.ExpressionAttributeValues[":assigneeId"] = qParams.assignee;
-  }
-  log("getRequests", "query", query, logId);
-
-  // check whether pagination is applied
-  if (qParams.lastKey) {
-    try {
-      query.ExclusiveStartKey = JSON.parse(qParams.lastKey);
-    } catch (e) {}
-  }
-
-  // get first page of jobs
-  let result = await indexQuery(values.tableNameMaintenance, query);
-  let allJobs = filterJobs(result.Items, qParams, authorised, assigneeTracking, userId);
-  let lastKey = result.LastEvaluatedKey;
-
-  log("getRequests", "LastEvaluatedKey", lastKey, logId);
-  log("getRequests", "FirstPageFiltered", allJobs.length, logId);
-
-  // auto-fill: keep fetching pages until we have MIN_RESULT_COUNT filtered results
-  while (lastKey && allJobs.length < MIN_RESULT_COUNT) {
-    const nextQuery = { ...query, ExclusiveStartKey: lastKey };
-    result = await indexQuery(values.tableNameMaintenance, nextQuery);
-    const filtered = filterJobs(result.Items, qParams, authorised, assigneeTracking, userId);
-    allJobs = [...allJobs, ...filtered];
-    lastKey = result.LastEvaluatedKey;
-  }
-
-  log("getRequests", "TotalFiltered", allJobs.length, logId);
-  log("getRequests", "PagesFetched", lastKey ? "more available" : "exhausted", logId);
-
-  // compile results
-  const results = { Items: allJobs, LastKey: lastKey };
-  log("getRequests", "Done", true, logId);
-  return { status: 200, data: results };
+	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,
+		values.permissionMaintenanceTracking,
+		qParams.site,
+	);
+	let assigneeTracking = false;
+	if (!authorised) {
+		assigneeTracking = await validateMasterAuth(
+			event,
+			values.permissionMaintenanceAssignment,
+			qParams.site,
+		);
+	}
+
+	log("getRequests", "authorised", authorised, logId);
+	const userId = authorised ? null : await getSessionUserFromReqAuthKey(event);
+
+	log("getRequests", "userId", userId, logId);
+
+	// Queries each status value in parallel for speed.
+	// Each job has one status, so no dedup needed.
+	const useStatusGsi =
+		qParams.status && !qParams.assignee && (authorised || assigneeTracking);
+
+	if (useStatusGsi) {
+		const statusValues = Array.isArray(qParams.status)
+			? qParams.status
+			: qParams.status.split(",");
+
+		// "Open" matches both "Open" and legacy "Unassigned" in the DB
+		const dbStatuses = statusValues.flatMap((s) =>
+			s === STATUS_OPEN ? [STATUS_OPEN, "Unassigned"] : [s],
+		);
+
+		log("getRequests", "StatusGsi", dbStatuses, logId);
+
+		const allResults = await Promise.all(
+			dbStatuses.map((s) =>
+				indexQueryRecursive(values.tableNameMaintenance, {
+					IndexName: "MaintenanceSiteStatusIndex",
+					KeyConditionExpression: "site = :site AND #status = :status",
+					ExpressionAttributeNames: { "#status": "status" },
+					ExpressionAttributeValues: {
+						":site": qParams.site,
+						":status": s,
+					},
+				}),
+			),
+		);
+
+		const allJobs = filterJobs(
+			allResults.flat(),
+			qParams,
+			authorised,
+			assigneeTracking,
+			userId,
+		);
+		log("getRequests", "StatusGsiResult", allJobs.length, logId);
+		return { status: 200, data: { Items: allJobs } };
+	}
+
+	const query =
+		authorised || assigneeTracking
+			? {
+					IndexName: "MaintenanceSiteJobNoIndex",
+					KeyConditionExpression: "site = :site",
+					ExpressionAttributeValues: {
+						":site": qParams.site,
+					},
+					ScanIndexForward: false,
+				}
+			: {
+					IndexName: "MaintenanceSiteUserIdIndex",
+					KeyConditionExpression: "site = :site AND userID = :userId",
+					ExpressionAttributeValues: {
+						":site": qParams.site,
+						":userId": userId,
+					},
+				};
+
+	// Use the assignee GSI when filtering by assignee (avoids fetching the entire site's jobs)
+	if (qParams.assignee && (authorised || assigneeTracking)) {
+		query.IndexName = "MaintenanceSiteAssigneeIndex";
+		query.KeyConditionExpression = "site = :site AND AssigneeId = :assigneeId";
+		query.ExpressionAttributeValues[":assigneeId"] = qParams.assignee;
+	}
+	log("getRequests", "query", query, logId);
+
+	// check whether pagination is applied
+	if (qParams.lastKey) {
+		try {
+			query.ExclusiveStartKey = JSON.parse(qParams.lastKey);
+		} catch (e) {}
+	}
+
+	// get first page of jobs
+	let result = await indexQuery(values.tableNameMaintenance, query);
+	let allJobs = filterJobs(
+		result.Items,
+		qParams,
+		authorised,
+		assigneeTracking,
+		userId,
+	);
+	let lastKey = result.LastEvaluatedKey;
+
+	log("getRequests", "LastEvaluatedKey", lastKey, logId);
+	log("getRequests", "FirstPageFiltered", allJobs.length, logId);
+
+	const minResults = hasActiveFilters(qParams)
+		? MIN_RESULT_COUNT_FILTERED
+		: MIN_RESULT_COUNT;
+
+	// auto-fill: keep fetching pages until we have enough filtered results
+	while (lastKey && allJobs.length < minResults) {
+		const nextQuery = { ...query, ExclusiveStartKey: lastKey };
+		result = await indexQuery(values.tableNameMaintenance, nextQuery);
+		const filtered = filterJobs(
+			result.Items,
+			qParams,
+			authorised,
+			assigneeTracking,
+			userId,
+		);
+		allJobs = [...allJobs, ...filtered];
+		lastKey = result.LastEvaluatedKey;
+	}
+
+	log("getRequests", "TotalFiltered", allJobs.length, logId);
+	log(
+		"getRequests",
+		"PagesFetched",
+		lastKey ? "more available" : "exhausted",
+		logId,
+	);
+
+	const results = { Items: allJobs, LastKey: lastKey };
+	log("getRequests", "Done", true, logId);
+	return { status: 200, data: results };
 };