@getjones/test-infra 5.2.15 → 5.3.1

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

@@ -1,17 +1,17 @@
-const userModels = require('./models/users.model');
-const tenantUserModel = require('./models/tenant.user.model');
-const { NotificationSettingsModel } = require('./models/notification.settings.model');
-const CreateInnerSystemUserModel = require('./models/create.inner.system.user.model');
-
-const services = require('./api/users.service');
-const util = require('./utils/util');
-
-const tenantUserService = require('./api/tenantApp/tenant.app.service');
-
-const tenants = {
-	services: tenantUserService
-};
-
-const models = { ... userModels, tenantUserModel, NotificationSettingsModel, CreateInnerSystemUserModel };
-
-module.exports = { services, models, util, tenants };
+const userModels = require('./models/users.model');
+const tenantUserModel = require('./models/tenant.user.model');
+const { NotificationSettingsModel } = require('./models/notification.settings.model');
+const CreateInnerSystemUserModel = require('./models/create.inner.system.user.model');
+
+const services = require('./api/users.service');
+const util = require('./utils/util');
+
+const tenantUserService = require('./api/tenantApp/tenant.app.service');
+
+const tenants = {
+	services: tenantUserService
+};
+
+const models = { ... userModels, tenantUserModel, NotificationSettingsModel, CreateInnerSystemUserModel };
+
+module.exports = { services, models, util, tenants };

package/src/saas/internal-api/users/models/create.inner.system.user.model.js

@@ -1,18 +1,18 @@
-const env = require('../../../../env');
-const { credentials } = env.getEnv();
-
-class CreateInnerSystemUserModel {
-	constructor({
-		fullName = '',
-		email = '',
-		password = credentials.strongPassword,
-		userRole
-	}) {
-		this.fullName = fullName;
-		this.email = email;
-		this.password = password;
-		this.role = userRole;
-	}
-}
-
-module.exports = CreateInnerSystemUserModel;
+const env = require('../../../../env');
+const { credentials } = env.getEnv();
+
+class CreateInnerSystemUserModel {
+	constructor({
+		fullName = '',
+		email = '',
+		password = credentials.strongPassword,
+		userRole
+	}) {
+		this.fullName = fullName;
+		this.email = email;
+		this.password = password;
+		this.role = userRole;
+	}
+}
+
+module.exports = CreateInnerSystemUserModel;

package/src/saas/internal-api/users/models/notification.settings.model.js

@@ -1,15 +1,15 @@
-class NotificationSettingsModel {
-	constructor({ aboutToExpire = true, auditCompliant = true, auditNotCompliant = true, missingCoi = true, recordOverrideRequest = true, timedOverrideExpired = true, weeklySummary = true } = {}) {
-		this.aboutToExpire = aboutToExpire;
-		this.auditCompliant = auditCompliant;
-		this.auditNotCompliant = auditNotCompliant;
-		this.missingCoi = missingCoi;
-		this.recordOverrideRequest = recordOverrideRequest;
-		this.timedOverrideExpired = timedOverrideExpired;
-		this.weeklySummary = weeklySummary;
-	}
-}
-
-module.exports = {
-	NotificationSettingsModel
-};
+class NotificationSettingsModel {
+	constructor({ aboutToExpire = true, auditCompliant = true, auditNotCompliant = true, missingCoi = true, recordOverrideRequest = true, timedOverrideExpired = true, weeklySummary = true } = {}) {
+		this.aboutToExpire = aboutToExpire;
+		this.auditCompliant = auditCompliant;
+		this.auditNotCompliant = auditNotCompliant;
+		this.missingCoi = missingCoi;
+		this.recordOverrideRequest = recordOverrideRequest;
+		this.timedOverrideExpired = timedOverrideExpired;
+		this.weeklySummary = weeklySummary;
+	}
+}
+
+module.exports = {
+	NotificationSettingsModel
+};

package/src/saas/internal-api/users/models/tenant.user.model.js

@@ -1,11 +1,11 @@
-class InviteTenantUserModel {
-	constructor(email, companyName, requestId) {
-		this.email = email;
-		this.companyName = companyName;
-		this.id = requestId;
-	}
-}
-
-module.exports = {
-	InviteTenantUserModel
-};
+class InviteTenantUserModel {
+	constructor(email, companyName, requestId) {
+		this.email = email;
+		this.companyName = companyName;
+		this.id = requestId;
+	}
+}
+
+module.exports = {
+	InviteTenantUserModel
+};

package/src/saas/internal-api/users/models/users.model.js

@@ -1,43 +1,43 @@
-class InviteUserModel {
-	constructor(email, role, projects = [], hasCompleteAccessPermission) {
-		this.email = email;
-		this.role = role;
-		this.projects = projects;
-		this.hasCompleteAccessPermission = hasCompleteAccessPermission;
-	}
-}
-
-class SignupUserModel {
-	constructor(fullName, role, password, encryptedData) {
-		this.fullName = fullName;
-		this.role = role;
-		this.password = password;
-		this.encryptedData = encryptedData;
-	}
-}
-
-class EditUserInvitationModel {
-	constructor(subUserId, email, role, projects = [], hasCompleteAccessPermission) {
-		this.subUserId = subUserId;
-		this.email = email;
-		this.role = role;
-		this.projects = projects;
-		this.hasCompleteAccessPermission = hasCompleteAccessPermission;
-	}
-}
-
-class EditUserProfileModel {
-	constructor(subUserId, email, role, fullName) {
-		this.subUserId = subUserId;
-		this.email = email;
-		this.role = role;
-		this.fullName = fullName;
-	}
-}
-
-module.exports = {
-	InviteUserModel,
-	SignupUserModel,
-	EditUserInvitationModel,
-	EditUserProfileModel
-};
+class InviteUserModel {
+	constructor(email, role, projects = [], hasCompleteAccessPermission) {
+		this.email = email;
+		this.role = role;
+		this.projects = projects;
+		this.hasCompleteAccessPermission = hasCompleteAccessPermission;
+	}
+}
+
+class SignupUserModel {
+	constructor(fullName, role, password, encryptedData) {
+		this.fullName = fullName;
+		this.role = role;
+		this.password = password;
+		this.encryptedData = encryptedData;
+	}
+}
+
+class EditUserInvitationModel {
+	constructor(subUserId, email, role, projects = [], hasCompleteAccessPermission) {
+		this.subUserId = subUserId;
+		this.email = email;
+		this.role = role;
+		this.projects = projects;
+		this.hasCompleteAccessPermission = hasCompleteAccessPermission;
+	}
+}
+
+class EditUserProfileModel {
+	constructor(subUserId, email, role, fullName) {
+		this.subUserId = subUserId;
+		this.email = email;
+		this.role = role;
+		this.fullName = fullName;
+	}
+}
+
+module.exports = {
+	InviteUserModel,
+	SignupUserModel,
+	EditUserInvitationModel,
+	EditUserProfileModel
+};

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

@@ -1,50 +1,50 @@
-const { getEnv, getSystemUserIdentity } = require('../../../../env');
-const { SignupUserModel } = require('../models/users.model');
-const { NotificationSettingsModel } = require('../models/notification.settings.model');
-const usersApi = require('../api/users.api');
-const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
-const objectUtils = require('../../../../common/utils/configsUtil');
-
-const { credentials } = getEnv();
-
-const attributesConvertor = {
-	'COI is not compliant.': 'auditNotCompliant',
-	'Policy is about to expire.': 'aboutToExpire',
-	'COI is compliant.': 'auditCompliant',
-	'Unresponsive contact.': 'missingCoi',
-	'Record Override Request': 'recordOverrideRequest',
-	'Timed override expired — record is not compliant.': 'timedOverrideExpired',
-	'Weekly summary': 'weeklySummary'
-};
-
-const getUserEncryptedData = async (email, role, context) => {
-	const response = await usersApi.getUserEncryptedData(email, role, context);
-
-	if (response.status !== httpResponseStatusCodes.OK) {
-		throw new Error(`Failed to retrieve user: ${email} encrypted data\n${response}`);
-	}
-
-	return response.data;
-};
-
-const getIcsUserId = ({ email = credentials.superUser } = {}) => {
-	const icsIdentity = getSystemUserIdentity(email);
-	return icsIdentity.id;
-};
-
-const getSignupUserModel = async (email, role, fullName, password, context) => {
-	const userEncryptedData = await getUserEncryptedData(email, role, context);
-	return new SignupUserModel(fullName, role, password, userEncryptedData);
-};
-
-const getSettingsModel = settings => {
-	const isUIConfig = objectUtils.isUIConfig(settings, attributesConvertor);
-
-	const settingConfig = isUIConfig ?
-		objectUtils.objectConvertor(settings, attributesConvertor) :
-		settings;
-
-	return new NotificationSettingsModel(settingConfig);
-};
-
-module.exports = { getSignupUserModel, getIcsUserId, getSettingsModel };
+const { getEnv, getSystemUserIdentity } = require('../../../../env');
+const { SignupUserModel } = require('../models/users.model');
+const { NotificationSettingsModel } = require('../models/notification.settings.model');
+const usersApi = require('../api/users.api');
+const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
+const objectUtils = require('../../../../common/utils/configsUtil');
+
+const { credentials } = getEnv();
+
+const attributesConvertor = {
+	'COI is not compliant.': 'auditNotCompliant',
+	'Policy is about to expire.': 'aboutToExpire',
+	'COI is compliant.': 'auditCompliant',
+	'Unresponsive contact.': 'missingCoi',
+	'Record Override Request': 'recordOverrideRequest',
+	'Timed override expired — record is not compliant.': 'timedOverrideExpired',
+	'Weekly summary': 'weeklySummary'
+};
+
+const getUserEncryptedData = async (email, role, context) => {
+	const response = await usersApi.getUserEncryptedData(email, role, context);
+
+	if (response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Failed to retrieve user: ${email} encrypted data\n${response}`);
+	}
+
+	return response.data;
+};
+
+const getIcsUserId = ({ email = credentials.superUser } = {}) => {
+	const icsIdentity = getSystemUserIdentity(email);
+	return icsIdentity.id;
+};
+
+const getSignupUserModel = async (email, role, fullName, password, context) => {
+	const userEncryptedData = await getUserEncryptedData(email, role, context);
+	return new SignupUserModel(fullName, role, password, userEncryptedData);
+};
+
+const getSettingsModel = settings => {
+	const isUIConfig = objectUtils.isUIConfig(settings, attributesConvertor);
+
+	const settingConfig = isUIConfig ?
+		objectUtils.objectConvertor(settings, attributesConvertor) :
+		settings;
+
+	return new NotificationSettingsModel(settingConfig);
+};
+
+module.exports = { getSignupUserModel, getIcsUserId, getSettingsModel };

package/src/saas/internal-api/vendorProfile/api/vendor.profile.api.js

@@ -1,26 +1,26 @@
-const requests = require('../../../../common/requests/cookieAuth/requests');
-const { backendUrl } = require('../../../../env').getEnv();
-
-const Endpoints = {
-	getVendorProfileJson: (contractorId, requirementId) => `${backendUrl}/saas/vendorProfile/contractor/${contractorId}/requirement/${requirementId}/immediateComplianceReport`,
-	shouldShowRecordProfile: recordId => `${backendUrl}/saas/record-profile/record/${recordId}/should-show-record-profile`,
-	getRecordProfileDetails: (recordId, projectId) => `${backendUrl}/saas/vendorProfile/data/record/${recordId}/project/${projectId}`
-};
-
-const createVendorProfileReport = async (contractorId, requirementId, context) => {
-	return requests.getRequestHandler(Endpoints.getVendorProfileJson(contractorId, requirementId), {}, context);
-};
-
-const getShouldShowRecordProfile = async (recordId, context) => {
-	return requests.getRequestHandler(Endpoints.shouldShowRecordProfile(recordId), {}, context);
-};
-
-const getRecordProfileDetails = (recordId, projectId, context) => {
-	return requests.getRequestHandler(Endpoints.getRecordProfileDetails(recordId, projectId), {}, context);
-};
-
-module.exports = {
-	getShouldShowRecordProfile,
-	createVendorProfileReport,
-	getRecordProfileDetails
-};
+const requests = require('../../../../common/requests/cookieAuth/requests');
+const { backendUrl } = require('../../../../env').getEnv();
+
+const Endpoints = {
+	getVendorProfileJson: (contractorId, requirementId) => `${backendUrl}/saas/vendorProfile/contractor/${contractorId}/requirement/${requirementId}/immediateComplianceReport`,
+	shouldShowRecordProfile: recordId => `${backendUrl}/saas/record-profile/record/${recordId}/should-show-record-profile`,
+	getRecordProfileDetails: (recordId, projectId) => `${backendUrl}/saas/vendorProfile/data/record/${recordId}/project/${projectId}`
+};
+
+const createVendorProfileReport = async (contractorId, requirementId, context) => {
+	return requests.getRequestHandler(Endpoints.getVendorProfileJson(contractorId, requirementId), {}, context);
+};
+
+const getShouldShowRecordProfile = async (recordId, context) => {
+	return requests.getRequestHandler(Endpoints.shouldShowRecordProfile(recordId), {}, context);
+};
+
+const getRecordProfileDetails = (recordId, projectId, context) => {
+	return requests.getRequestHandler(Endpoints.getRecordProfileDetails(recordId, projectId), {}, context);
+};
+
+module.exports = {
+	getShouldShowRecordProfile,
+	createVendorProfileReport,
+	getRecordProfileDetails
+};

package/src/saas/internal-api/vendorProfile/api/vendor.profile.service.js

@@ -1,19 +1,19 @@
-const vendorProfileApi = require('./vendor.profile.api');
-
-const createVendorProfileReport = async (contractorId, requirementId, context) => {
-	return vendorProfileApi.createVendorProfileReport(contractorId, requirementId, context);
-};
-
-const getShouldShowRecordProfile = async (recordId, context) => {
-	return vendorProfileApi.getShouldShowRecordProfile(recordId, context);
-};
-
-const getRecordProfileDetails = (recordId, projectId, context) => {
-	return vendorProfileApi.getRecordProfileDetails(recordId, projectId, context);
-};
-
-module.exports = {
-	getShouldShowRecordProfile,
-	createVendorProfileReport,
-	getRecordProfileDetails
-};
+const vendorProfileApi = require('./vendor.profile.api');
+
+const createVendorProfileReport = async (contractorId, requirementId, context) => {
+	return vendorProfileApi.createVendorProfileReport(contractorId, requirementId, context);
+};
+
+const getShouldShowRecordProfile = async (recordId, context) => {
+	return vendorProfileApi.getShouldShowRecordProfile(recordId, context);
+};
+
+const getRecordProfileDetails = (recordId, projectId, context) => {
+	return vendorProfileApi.getRecordProfileDetails(recordId, projectId, context);
+};
+
+module.exports = {
+	getShouldShowRecordProfile,
+	createVendorProfileReport,
+	getRecordProfileDetails
+};

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

@@ -1,3 +1,3 @@
-const services = require('./api/vendor.profile.service');
-
-module.exports = { services };
+const services = require('./api/vendor.profile.service');
+
+module.exports = { services };

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 };

package/src/saas/openapi/accounts/accounts.api.js

@@ -1,17 +1,17 @@
-const requests = require('../../../common/requests/apiKeyAuth/requests');
-const { openapiUrl } = require('../../../env').getEnv();
-
-const Endpoints = {
-	getAccountList: `${openapiUrl}/accounts`,
-	dynamicApiKey: accountId => `${openapiUrl}/accounts/${accountId}/dynamic-api-key`
-};
-
-const getAccountList = async apiKey => {
-	return requests.getRequestHandler(Endpoints.getAccountList, apiKey).then(res => res.data);
-};
-
-const generateDynamicApiKey = async (accountId, masterApiKey) => {
-	return requests.getRequestHandler(Endpoints.dynamicApiKey(accountId), masterApiKey).then(res => res.data);
-};
-
-module.exports = { getAccountList, generateDynamicApiKey };
+const requests = require('../../../common/requests/apiKeyAuth/requests');
+const { openapiUrl } = require('../../../env').getEnv();
+
+const Endpoints = {
+	getAccountList: `${openapiUrl}/accounts`,
+	dynamicApiKey: accountId => `${openapiUrl}/accounts/${accountId}/dynamic-api-key`
+};
+
+const getAccountList = async apiKey => {
+	return requests.getRequestHandler(Endpoints.getAccountList, apiKey).then(res => res.data);
+};
+
+const generateDynamicApiKey = async (accountId, masterApiKey) => {
+	return requests.getRequestHandler(Endpoints.dynamicApiKey(accountId), masterApiKey).then(res => res.data);
+};
+
+module.exports = { getAccountList, generateDynamicApiKey };

package/src/saas/openapi/accounts/accounts.service.js

@@ -1,11 +1,11 @@
-const accountsApi = require('./accounts.api');
-
-const getAccountList = async apiKey => {
-	return accountsApi.getAccountList(apiKey);
-};
-
-const generateDynamicApiKey = async (accountId, masterApiKey) => {
-	return accountsApi.generateDynamicApiKey(accountId, masterApiKey);
-};
-
-module.exports = { getAccountList, generateDynamicApiKey };
+const accountsApi = require('./accounts.api');
+
+const getAccountList = async apiKey => {
+	return accountsApi.getAccountList(apiKey);
+};
+
+const generateDynamicApiKey = async (accountId, masterApiKey) => {
+	return accountsApi.generateDynamicApiKey(accountId, masterApiKey);
+};
+
+module.exports = { getAccountList, generateDynamicApiKey };