@getjones/test-infra 5.2.16 → 5.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "5.2.16",
+  "version": "5.3.1",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "files": [

package/src/common/consts/accountSettings.js

@@ -7,6 +7,10 @@ module.exports = {
 		on: { isAccountRequirementsEnabled: true },
 		off: { isAccountRequirementsEnabled: false }
 	},
+	isWeeklyDigestEnabled: {
+		on: { isWeeklyDigestEnabled: true },
+		off: { isWeeklyDigestEnabled: false }
+	},
 	isPolicyVerificationEnabled: {
 		on: { hasPolicyVerification: true },
 		off: { hasPolicyVerification: false }

package/src/index.js

@@ -48,6 +48,7 @@ const getInternalAPI = () => {
 
 	const threadScheduler = require('./saas/internal-api/thread-scheduler/runner');
 	const schedulerJobRun = require('./saas/internal-api/schedulerJobRun');
+	const weeklyDigest = require('./saas/internal-api/weeklyDigest');
 	const certificial = require('./saas/internal-api/certificial');
 	const dbEmails = require('./saas/internal-api/dbEmails/index');
 	const agreement = require('./saas/internal-api/agreement/index');
@@ -89,6 +90,7 @@ const getInternalAPI = () => {
 		sampleCoi,
 		threadScheduler,
 		schedulerJobRun,
+		weeklyDigest,
 		certificial,
 		dbEmails,
 		emailCustomization,

package/src/saas/internal-api/accountDirectory/api/accountDirectory.service.js

@@ -289,6 +289,7 @@ const getAllRecords = async (accountId, context, {
 	sortOrder,
 	pageNum,
 	rowsPerPage,
+	digestScope,
 	expectError
 } = {}) => {
 	const model = new accountDirectoryModels.AllRecordsTableRequestModel({
@@ -304,7 +305,8 @@ const getAllRecords = async (accountId, context, {
 		sortBy,
 		sortOrder,
 		pageNum,
-		rowsPerPage
+		rowsPerPage,
+		digestScope
 	});
 
 	const response = await accountDirectoryAPI.getAllRecords(model, context);
@@ -329,6 +331,7 @@ const selectAllRecords = async (accountId, context, {
 	selectedTagIds,
 	expiryDateFrom,
 	expiryDateTo,
+	digestScope,
 	expectError
 } = {}) => {
 	const model = new accountDirectoryModels.AllRecordsTableRequestModel({
@@ -340,7 +343,8 @@ const selectAllRecords = async (accountId, context, {
 		selectedRequirementIds,
 		selectedTagIds,
 		expiryDateFrom,
-		expiryDateTo
+		expiryDateTo,
+		digestScope
 	});
 
 	const response = await accountDirectoryAPI.selectAllRecords(model, context);
@@ -397,6 +401,7 @@ const exportAllRecords = async (accountId, context, {
 	expiryDateTo,
 	sortBy,
 	sortOrder,
+	digestScope,
 	expectError
 } = {}) => {
 	const model = new accountDirectoryModels.AllRecordsTableRequestModel({
@@ -410,7 +415,8 @@ const exportAllRecords = async (accountId, context, {
 		expiryDateFrom,
 		expiryDateTo,
 		sortBy,
-		sortOrder
+		sortOrder,
+		digestScope
 	});
 
 	const response = await accountDirectoryAPI.exportAllRecords(model, context);

package/src/saas/internal-api/accountDirectory/models/accountDirectory.models.js

@@ -80,7 +80,8 @@ class AllRecordsTableRequestModel {
 		sortBy = ALL_RECORDS_TABLE_SORT_BY.COMPANY_NAME,
 		sortOrder = 'ASC',
 		pageNum = 1,
-		rowsPerPage = ROWS_PER_PAGE.TEN
+		rowsPerPage = ROWS_PER_PAGE.TEN,
+		digestScope = undefined
 	} = {}) {
 		this.accountId = accountId;
 		this.searchTerm = searchTerm;
@@ -95,6 +96,7 @@ class AllRecordsTableRequestModel {
 		this.sortOrder = sortOrder;
 		this.pageNum = pageNum;
 		this.rowsPerPage = rowsPerPage;
+		this.digestScope = digestScope;
 	}
 }
 

package/src/saas/internal-api/accounts/models/settings/update.settings.model.js

@@ -33,6 +33,7 @@ class UpdateAccountSettingsModel {
 			inviteGapCadence = null,
 			isAcord25SplitExtractionEnabled = false,
 			isCertificialEnabled = false,
+			isWeeklyDigestEnabled = false,
 			sampleCoi = {}
 		} = {}
 	) {
@@ -64,6 +65,7 @@ class UpdateAccountSettingsModel {
 		this.isConfigurableRenewalCadenceEnabled = isConfigurableRenewalCadenceEnabled;
 		this.isAcord25SplitExtractionEnabled = isAcord25SplitExtractionEnabled;
 		this.isCertificialEnabled = isCertificialEnabled;
+		this.isWeeklyDigestEnabled = isWeeklyDigestEnabled;
 		this.gapsChat = { ... DEFAULT_GAPS_CHAT, ... gapsChat };
 		this.supportAutomation = { ... DEFAULT_SUPPORT_AUTOMATION, ... supportAutomation };
 		this.sampleCoi = { ... DEFAULT_SAMPLE_COI, ... sampleCoi };

package/src/saas/internal-api/dbEmails/consts/consts.js

@@ -55,7 +55,15 @@ const EMAIL_SUBJECT = {
 	overrideGapRequestRejected: ({ accountName }) => `${accountName} denied your exception request`,
 	overrideGapRequestApproved: ({ accountName }) => `${accountName} approved your exception request`,
 	timedOverrideExpired: ({ recordCompanyName, requesterName }) => `Override ended - ${recordCompanyName} in ${requesterName}`,
-	allRecordsExport: 'Jones - All Records Export'
+	allRecordsExport: 'Jones - All Records Export',
+	weeklyDigest: ({ accountName }) => `Your Weekly updates for ${accountName}`
+};
+
+const EMAIL_LINK_REGEX = {
+	mailActionButton: /(https:\/\/[a-zA-Z0-9.].*[a-zA-Z.]+\/CheckCustomersInviteLinkJSON\?data=[^"]+)/g,
+	sampleCoiDownload: /\/sample-coi\/requirement\/([^/]+)\/download\?source=email/,
+	allRecordsExportDownload: /href="(https?:\/\/[^"]+)"/,
+	weeklyDigestViewAll: issue => new RegExp(`(https:\\/\\/[^"]+\\/all-records\\?digestIssue=${issue}[^"]*)`)
 };
 
 const EMAIL_POLLING = {
@@ -63,4 +71,4 @@ const EMAIL_POLLING = {
 	expectNoMail: { maxRetries: 3, pollIntervalSeconds: 1 }
 };
 
-module.exports = { DEFAULT_EMAIL_SENDER, EMAIL_TYPES, EMAIL_SUBJECT, EMAIL_POLLING, tenantUserExtension };
+module.exports = { DEFAULT_EMAIL_SENDER, EMAIL_TYPES, EMAIL_SUBJECT, EMAIL_LINK_REGEX, EMAIL_POLLING, tenantUserExtension };

package/src/saas/internal-api/dbEmails/utils/util.js

@@ -62,10 +62,6 @@ const getEmailTextInSubject = (recordCompanyName, emailType, isAfterUpdateRequir
 	return isAfterUpdateRequirements ? `Updated Requirements - ${subject}` : subject;
 };
 
-const getMailActionButtonUrlRegex = () => {
-	return /(https:\/\/[a-zA-Z0-9.].*[a-zA-Z.]+\/CheckCustomersInviteLinkJSON\?data=[^"]+)/g;
-};
-
 const getEncryptedDataFromLink = (link, { removeLastTwoCharts } = {}) => {
 	const encryptedData = link.split('data=').pop();
 	return removeLastTwoCharts ? encryptedData.slice(0, -2) : encryptedData;
@@ -77,6 +73,5 @@ module.exports = {
 	extractEmailFromNameAndEmailFormat,
 	logRetrievedEmailInfo,
 	getEmailTextInSubject,
-	getMailActionButtonUrlRegex,
 	getEncryptedDataFromLink
 };

package/src/saas/internal-api/thread-scheduler/runner.js

@@ -66,6 +66,9 @@ module.exports = {
 		requireScope(entityIds, schedulerJobs.CERTIFICIAL_MONITORING);
 		return runSchedulerJob({ jobType: schedulerJobs.CERTIFICIAL_MONITORING, entityIds });
 	},
+	runJobForWeeklyDigest: function(entityIds) {
+		return runSchedulerJob({ jobType: schedulerJobs.WEEKLY_DIGEST, entityIds });
+	},
 	runAllJobsNew: function(entityIds) {
 		return runSchedulerJob({ jobType: schedulerJobs.ALL, entityIds });
 	}

package/src/saas/internal-api/thread-scheduler/schedulerJobs.js

@@ -6,5 +6,6 @@ module.exports = {
 	EXPIRE_TIMED_OVERRIDES: 'EXPIRE_TIMED_OVERRIDES',
 	CERTIFICIAL_ENROLLMENT: 'CERTIFICIAL_ENROLLMENT',
 	CERTIFICIAL_MONITORING: 'CERTIFICIAL_MONITORING',
+	WEEKLY_DIGEST: 'WEEKLY_DIGEST',
 	ALL: 'ALL'
 };

package/src/saas/internal-api/weeklyDigest/api/weekly.digest.api.js

@@ -0,0 +1,32 @@
+const requests = require('../../../../common/requests/cookieAuth/requests');
+const { backendUrl } = require('../../../../env').getEnv();
+
+const Endpoints = {
+	snapshot: `${backendUrl}/saas/integration-tests/weekly-digest/snapshot`,
+	accountSnapshot: accountId => `${backendUrl}/saas/integration-tests/weekly-digest/account/${accountId}/snapshot`,
+	run: accountId => `${backendUrl}/saas/integration-tests/weekly-digest/account/${accountId}/run`,
+	reportLog: `${backendUrl}/saas/integration-tests/weekly-digest/report-log`
+};
+
+const takeAccountSnapshot = (accountId, context) => {
+	return requests.postRequestHandler(Endpoints.accountSnapshot(accountId), null, context);
+};
+
+const takeAccountsSnapshot = (accountIds, context) => {
+	return requests.postRequestHandler(Endpoints.snapshot, { accountIds }, context);
+};
+
+const runWeeklyDigest = (accountId, body, context) => {
+	return requests.postRequestHandler(Endpoints.run(accountId), body, context);
+};
+
+const getWeeklyDigestReports = (accountId, weekStart, context) => {
+	return requests.getRequestHandler(Endpoints.reportLog, { accountId, weekStart }, context);
+};
+
+module.exports = {
+	takeAccountSnapshot,
+	takeAccountsSnapshot,
+	runWeeklyDigest,
+	getWeeklyDigestReports
+};

package/src/saas/internal-api/weeklyDigest/api/weekly.digest.service.js

@@ -0,0 +1,69 @@
+const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
+const timeUtils = require('../../../../common/utils/timeUtils');
+
+const authService = require('../../auth/api/auth.service');
+const weeklyDigestApi = require('./weekly.digest.api');
+const { REPORT_STATUS } = require('../consts/weekly.digest.consts');
+
+const takeAccountSnapshot = async accountId => {
+	const response = await weeklyDigestApi.takeAccountSnapshot(accountId, await authService.getIcsCookie());
+
+	if (response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Account snapshot failed for account ${accountId}. Status code: ${response.status}`);
+	}
+
+	return response.data.snapshotId;
+};
+
+const takeAccountsSnapshot = async accountIds => {
+	const response = await weeklyDigestApi.takeAccountsSnapshot(accountIds, await authService.getIcsCookie());
+
+	if (response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Accounts snapshot failed for accounts ${accountIds}. Status code: ${response.status}`);
+	}
+
+	return response.data.snapshotId;
+};
+
+// Runs synchronously for next Monday's week, after clearing the account's report-log rows for that week.
+const runWeeklyDigest = async (accountId, { previousRunId, currentRunId }) => {
+	const body = { beforeSnapshotId: previousRunId, afterSnapshotId: currentRunId };
+	const response = await weeklyDigestApi.runWeeklyDigest(accountId, body, await authService.getIcsCookie());
+
+	if (response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Weekly digest run failed for account ${accountId}. Status code: ${response.status}`);
+	}
+
+	return response.data;
+};
+
+const getWeeklyDigestReports = async (accountId, weekStart) => {
+	const response = await weeklyDigestApi.getWeeklyDigestReports(accountId, weekStart, await authService.getIcsCookie());
+
+	if (response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Weekly digest reports failed for account ${accountId}. Status code: ${response.status}`);
+	}
+
+	return response.data;
+};
+
+// The scheduler endpoint returns before the job runs, so a real-job run has to poll the report log.
+const waitForWeeklyDigestReport = async (accountId, weekStart, userId, { expectedStatus = REPORT_STATUS.SENT, retries = 10 } = {}) => {
+	let report;
+
+	while (report?.reportData.status !== expectedStatus && retries-- > 0) {
+		await timeUtils.waitFor(3).seconds;
+		const reports = await getWeeklyDigestReports(accountId, weekStart);
+		report = reports.find(row => row.userId === userId);
+	}
+
+	return report;
+};
+
+module.exports = {
+	takeAccountSnapshot,
+	takeAccountsSnapshot,
+	runWeeklyDigest,
+	getWeeklyDigestReports,
+	waitForWeeklyDigestReport
+};

package/src/saas/internal-api/weeklyDigest/consts/weekly.digest.consts.js

@@ -0,0 +1,21 @@
+const REPORT_STATUS = {
+	IN_PROGRESS: 'IN_PROGRESS',
+	SENT: 'SENT',
+	NO_VISIBLE_REQUESTS: 'NO_VISIBLE_REQUESTS'
+};
+
+const NEW_ISSUE_TYPE = {
+	EXPIRED_LAST_WEEK: 'EXPIRED_LAST_WEEK',
+	BECAME_NOT_COMPLIANT: 'BECAME_NOT_COMPLIANT',
+	EXPIRING_THIS_WEEK: 'EXPIRING_THIS_WEEK',
+	BECAME_NOT_RESPONSIVE: 'BECAME_NOT_RESPONSIVE'
+};
+
+const ACTIVITY_TYPE = {
+	TIMED_OVERRIDE_ENDING: 'TIMED_OVERRIDE_ENDING',
+	EXCEPTION_REQUEST: 'EXCEPTION_REQUEST',
+	MENTION: 'MENTION',
+	RELATED_DOC: 'RELATED_DOC'
+};
+
+module.exports = { REPORT_STATUS, NEW_ISSUE_TYPE, ACTIVITY_TYPE };

package/src/saas/internal-api/weeklyDigest/index.js

@@ -0,0 +1,4 @@
+const services = require('./api/weekly.digest.service');
+const consts = require('./consts/weekly.digest.consts');
+
+module.exports = { services, consts };