@getjones/test-infra 1.11.0 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "1.11.0",
+  "version": "2.0.0",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "scripts": {

package/src/common/factory/records/records.js

@@ -31,6 +31,30 @@ const updateInviteDate = async function(recordId, inviteDate, context) {
 	await timeUtils.waitFor(2.5).seconds; // calls for the same records can override each other
 };
 
+const runOverAllRenewalDatesForRecord = async function(recordId, policyName) {
+	const dates = timeUtils.getAutomaticRenewalsExpirationDates();
+
+	for (const date of dates) {
+		await updatePolicyExpiryDateForRecord(recordId, date, policyName);
+	}
+};
+
+const updatePolicyExpiryDateForRecord = async function(recordId, expiryDate, policyName) {
+	const updateResponse = await contractors.services.updateExpiryDate(recordId, expiryDate, policyName);
+
+	if (updateResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error('Record expiry date could not be updated', updateResponse);
+	}
+
+	const threadSchedulerResponse = await threadScheduler.runThreadScheduler({ contractorIds: [recordId] });
+
+	if (threadSchedulerResponse.status !== httpResponseStatusCodes.OK) {
+		throw new Error('Thread scheduler has failed to run', threadSchedulerResponse);
+	}
+
+	await timeUtils.waitFor(2.5).seconds; // calls for the same records can override each other
+};
+
 const getHistoryEvents = async function(recordId, context) {
 	const recordHistory = await contractors.services.getRecordHistory(recordId, context);
 	expect(recordHistory.status, 'Expected record history response status to equal 200.').to.equal(httpResponseStatusCodes.OK);
@@ -40,6 +64,8 @@ const getHistoryEvents = async function(recordId, context) {
 
 module.exports = {
 	makeRecordNotResponsive,
+	runOverAllRenewalDatesForRecord,
 	updateInviteDate,
+	updatePolicyExpiryDateForRecord,
 	getHistoryEvents
 };

package/src/common/utils/timeUtils.js

@@ -115,6 +115,19 @@ const getInvitationDatesForNotResponsiveTenant = function() {
 	return [fiveDaysAgoUtc, tenDaysAgoUtc, fifteenDaysAgoUtc];
 };
 
+const isDateAfterOther = (date, other) => {
+	return moment(date).isAfter(other);
+};
+
+const getAutomaticRenewalsExpirationDates = function() {
+	const inTwentyNineDaysUtc = getDateinTwentyNineDays();
+	const inThirteenDaysUtc = getDateinThirteenDays();
+	const inSixDaysUtc = getDateinSixDays();
+	const todayUtc = getCurrentDate();
+
+	return [inTwentyNineDaysUtc, inThirteenDaysUtc, inSixDaysUtc, todayUtc];
+};
+
 module.exports = {
 	formats,
 	getOneYearAgoDate,
@@ -134,6 +147,7 @@ module.exports = {
 	getDateinTwentyNineDays,
 	getInvitationDatesForNotResponsiveVendor,
 	getInvitationDatesForNotResponsiveTenant,
+	getAutomaticRenewalsExpirationDates,
 	getLogTimestamp,
 	getCurrentFormattedDate,
 	getAuditDateFormat,
@@ -143,5 +157,6 @@ module.exports = {
 	getDayInMilliseconds,
 	extractDateFromDateTime,
 	getPreviousDateByDays,
-	waitFor
+	waitFor,
+	isDateAfterOther
 };

package/src/index.js

@@ -31,6 +31,7 @@ const getInternalAPI = () => {
 	const serviceArea = require('./saas/internal-api/serviceArea');
 
 	const threadScheduler = require('./saas/internal-api/thread-scheduler/runner');
+	const dbEmails = require('./saas/internal-api/dbEmails/index');
 
 	const internalAPI = {
 		auth,
@@ -48,7 +49,8 @@ const getInternalAPI = () => {
 		globalRecord,
 		vendorProfile,
 		serviceArea,
-		threadScheduler
+		threadScheduler,
+		dbEmails
 	};
 
 	return internalAPI;
@@ -57,10 +59,10 @@ const getInternalAPI = () => {
 const getOpenAPI = () => {
 	const accounts = require('./saas/openapi/accounts/accounts.service');
 	const tabs = require('./saas/openapi/tabs/tabs.service');
-	const contractors = require('./saas/openapi/contractors');
+	const requests = require('./saas/openapi/requests');
 	const projects = require('./saas/openapi/projects/projects.service');
 	const requirements = require('./saas/openapi/requirements');
-	const openAPI = { accounts, tabs, contractors, projects, requirements };
+	const openAPI = { accounts, tabs, requests, projects, requirements };
 	return openAPI;
 };
 

package/src/saas/internal-api/contractors/api/contractors.api.js

@@ -19,7 +19,6 @@ const Endpoints = {
 	changeRequirement: `${backendUrl}/saas/contractor/requirement`,
 	updateVendorExpiryDate: contractorId => `${backendUrl}/_saas/automation/contractor/${contractorId}/expiry-date`,
 	updateContractorInviteDate: contractorId => `${backendUrl}/_saas/automation/contractor/${contractorId}/invite-date`,
-	assignMptToProperties: (accountId, tenantId) => `${backendUrl}/saas/account/${accountId}/multi-properties/${tenantId}`,
 	searchInAutocomplete: ({ tabId, searchWord }) =>
 		`${backendUrl}/saas/contractors/search/audited?&tabId=${tabId}&searchWord=${searchWord}`,
 	automationUpdateContractorUploadDate: contractorId => `${backendUrl}/saas/automation/contractor/${contractorId}/upload-date`,
@@ -85,7 +84,8 @@ const requestNewCoiExpired = (recordModifyDateVerificationModel, context) => {
 };
 
 const resendInvitation = (recordModifyDateVerificationModel, context) => {
-	return requests.postRequestHandler(Endpoints.resendInvitation, recordModifyDateVerificationModel, context);
+	const recordId = recordModifyDateVerificationModel.contractorId;
+	return requests.postRequestHandler(Endpoints.resendInvitation(recordId), recordModifyDateVerificationModel, context);
 };
 
 const updateExpiryDate = (contractorId, expiryDate, policyName) => {
@@ -98,17 +98,6 @@ const updateInviteDate = (contractorId, inviteDate, context) => {
 	return requests.postRequestHandler(Endpoints.updateContractorInviteDate(contractorId), data, context);
 };
 
-const assignMptToProperties = (assignToMptModel, context) => {
-	const params = { updateInfoUser: 'EditVendor' };
-	return requests.postRequestHandler(
-		Endpoints.assignMptToProperties(assignToMptModel.accountId, assignToMptModel.tenantId),
-		assignToMptModel.properties,
-		context,
-		{},
-		params
-	);
-};
-
 const getContractorsByTabId = async (tabId, context, activityStatus) => {
 	const body = { tabId, activityStatus };
 	const response = await requests.postRequestHandler(Endpoints.get, body, context);
@@ -145,7 +134,6 @@ module.exports = {
 	editContractor,
 	updateInviteDate,
 	updateExpiryDate,
-	assignMptToProperties,
 	getContractorsByTabId,
 	searchInAutocomplete,
 	updateContractorUploadDate,

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

@@ -1,6 +1,5 @@
 const contractorsAPI = require('./contractors.api');
 const { CreateContractorModel } = require('../models/create.contractor.model');
-const { MptModel } = require('../models/edit.contractor.model');
 const { RequestModel } = require('../../requests/models/edit.request.model');
 const { validateType } = require('../../../../common/validations/typeValidations');
 const { RecordModifyDateVerificationModel } = require('../models/verification.contractor.model');
@@ -56,11 +55,6 @@ const getContractorsByTabId = (tabId, context, activityStatus = 'ACTIVE') => {
 	return contractorsAPI.getContractorsByTabId(tabId, context, activityStatus);
 };
 
-const assignMptToProperties = (assignToMptModel, context) => {
-	validateType(assignToMptModel, MptModel);
-	return contractorsAPI.assignMptToProperties(assignToMptModel, context);
-};
-
 const searchInAutoComplete = ({ tabId, searchWord }, context) => {
 	return contractorsAPI.searchInAutocomplete({ tabId, searchWord }, context);
 };
@@ -123,7 +117,6 @@ module.exports = {
 	updateInviteDate,
 	updateExpiryDate,
 	getContractorsByTabId,
-	assignMptToProperties,
 	searchInAutoComplete,
 	updateContractorUploadDate,
 	inviteContractorViaPublicLink,

package/src/saas/internal-api/contractors/models/create.contractor.model.js

@@ -1,10 +1,10 @@
 const { validateType } = require('../../../../common/validations/typeValidations');
 
-function CreateContractorModel(requirementId, inviterEmail, vendorInfo, { tabId = null, disableMail = true, publicLink } = {}) {
+function CreateContractorModel(requirementId, inviterEmail, vendorInfo, { tabId = null, sendMail = false, publicLink } = {}) {
 	this.reqId = requirementId;
 	this.inviterEmail = inviterEmail;
 	this.vendorInfo = vendorInfo;
-	this.disableMail = disableMail;
+	this.disableMail = !sendMail;
 	this.tabId = tabId;
 	this.publicLink = publicLink;
 

package/src/saas/internal-api/contractors/models/edit.contractor.model.js

@@ -54,16 +54,7 @@ class ContractorDetailsModel {
 	}
 }
 
-class MptModel {
-	constructor(accountId, tenantId, properties) {
-		this.accountId = accountId;
-		this.tenantId = tenantId;
-		this.properties = properties;
-	}
-}
-
 module.exports = {
 	ContractorModel,
-	ContractorDetailsModel,
-	MptModel
+	ContractorDetailsModel
 };

package/src/saas/internal-api/dbEmails/api/db.emails.api.js

@@ -11,7 +11,7 @@ const getAllMessages = emailModel => {
 };
 
 const deleteMultipleMessages = emailIds => {
-	return requests.deleteRequestHandler(Endpoints.dbEmails, { data: emailIds });
+	return requests.deleteRequestHandler(Endpoints.dbEmails, {}, {}, emailIds);
 };
 
 const deleteAllMessages = () => {

package/src/saas/internal-api/dbEmails/api/db.emails.service.js

@@ -1,19 +1,127 @@
 const dbEmailsApi = require('./db.emails.api');
+const util = require('../utils/util');
+const timeUtils = require('../../../../common/utils/timeUtils');
+const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
+const { EmailModel } = require('../models/db.emails.model');
+
+const strict = 'strict';
 
 const getAllMessages = emailModel => {
-	return dbEmailsApi.postRequestHandler(Endpoints.dbEmails, emailModel);
+	return dbEmailsApi.getAllMessages(emailModel);
 };
 
 const deleteMultipleMessages = emailIds => {
-	return dbEmailsApi.deleteRequestHandler(Endpoints.dbEmails, { data: emailIds });
+	return dbEmailsApi.deleteMultipleMessages(emailIds);
 };
 
 const deleteAllMessages = () => {
-	return dbEmailsApi.deleteRequestHandler(Endpoints.deleteAllDbEmails);
+	return dbEmailsApi.deleteAllMessages();
+};
+
+const getLastMessage = async (
+	{
+		recipients,
+		recipientsVerification = strict,
+		textInSubject,
+		textInBody,
+		excludingPhrasesInBody,
+		regex,
+		returnType
+	} = {}
+) => {
+	async function getLatestMessage(messages) {
+		for (const message of messages) {
+			/* The query we use to search for messages guarantees the recipients are included,
+			but it doesn't guarantee other emails aren't in to, cc or bcc */
+			let emailsMatch = true;
+
+			if (recipientsVerification === strict) {
+				const emptyArray = [''];
+
+				const expectedRecipients = {
+					from: util.extractEmailFromNameAndEmailFormat(recipients.from),
+					to: recipients.to || emptyArray,
+					cc: recipients.cc || emptyArray
+				};
+
+				const actualRecipients = {
+					from: util.extractEmailFromNameAndEmailFormat(message.from),
+					to: message.recipientsTo || emptyArray,
+					cc: message.recipientsCc || emptyArray
+				};
+
+				emailsMatch = util.recipientsMatchVerification(expectedRecipients, actualRecipients);
+			}
+
+			if (!emailsMatch) {
+				continue;
+			}
+
+			const result = regex ? util.regexVerification(message.body, regex, { returnType }) : message.body;
+
+			const isMessageNewest = timeUtils.isDateAfterOther(message.insertedTime, newestDateTime);
+
+			if (result && (!newestResult || !newestId || isMessageNewest)) {
+				newestResult = result;
+				newestId = message.id;
+				newestDateTime = message.insertedTime;
+
+				// Used for logging purposes only
+				newestTo = message.recipientsTo;
+				newestCc = message.recipientsCc;
+				newestSubject = message.subject;
+			}
+		}
+	}
+
+	let newestDateTime = '2020-01-01T01:01:01.000+0000';
+	let newestId, newestResult, newestTo, newestCc, newestSubject;
+
+	let recipientsTo = recipients.to;
+	let includesOneOfRecipientsTo;
+
+	if (recipientsVerification !== strict) {
+		recipientsTo = null;
+		includesOneOfRecipientsTo = recipients.to;
+	}
+
+	// In case the format is 'First Last <username@domain.com>' we need the email part only
+	const emailModel = new EmailModel(
+		util.extractEmailFromNameAndEmailFormat(recipients.from),
+		recipientsTo,
+		includesOneOfRecipientsTo,
+		recipients.cc,
+		textInSubject,
+		textInBody,
+		excludingPhrasesInBody
+	);
+
+	const response = await getAllMessages(emailModel);
+
+	if (response.status !== httpResponseStatusCodes.OK) {
+		throw new Error('Inbox messages could not be retrieved', response);
+	}
+
+	await getLatestMessage(response.data);
+
+	if (newestId) {
+		util.logRetrievedEmailInfo(newestTo, newestSubject, { cc: newestCc });
+
+		const response = await deleteMultipleMessages([newestId]);
+
+		if (response.status !== httpResponseStatusCodes.NO_CONTENT) {
+			throw new Error(`Failed to delete email with ID : ${newestId}`, response);
+		}
+	}
+
+	return newestResult;
 };
 
 module.exports = {
+	util,
+
 	getAllMessages,
+	getLastMessage,
 	deleteMultipleMessages,
 	deleteAllMessages
 };

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

@@ -0,0 +1,3 @@
+const DEFAULT_EMAIL_SENDER = 'hellogetjonestest@gmail.com';
+
+module.exports = { DEFAULT_EMAIL_SENDER };

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

@@ -1,3 +1,4 @@
 const services = require('./api/db.emails.service');
+const consts = require('./consts/consts');
 
-module.exports = { services };
+module.exports = { services, consts };

package/src/saas/internal-api/dbEmails/models/db.emails.model.js

@@ -18,4 +18,4 @@ class EmailModel {
 	}
 }
 
-module.exports = EmailModel;
+module.exports = { EmailModel };

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

@@ -0,0 +1,59 @@
+const compareUnorderedArrays = (arr, other, { caseSensitive = true } = {}) => {
+	const isEachElementEqual = arr.sort().every((mail, i) => {
+		if (caseSensitive) {
+			return mail === other.sort()[i];
+		} else {
+			return mail.toLowerCase() === other.sort()[i].toLowerCase();
+		}
+	});
+	return arr.length === other.length && isEachElementEqual;
+};
+
+const recipientsMatchVerification = (expectedRecipients, actualRecipients) => {
+	const caseSensitive = false;
+
+	return expectedRecipients.from.includes(actualRecipients.from) && // For some emails can be few sendor options (ex: branded emails)
+		compareUnorderedArrays(actualRecipients.to, expectedRecipients.to, { caseSensitive }) &&
+		compareUnorderedArrays(actualRecipients.cc, expectedRecipients.cc, { caseSensitive });
+};
+
+const regexVerification = (message, regex, { returnType } = {}) => {
+	const capturingGroupsArr = message.match(regex);
+
+	if (!capturingGroupsArr || capturingGroupsArr.length < 1) {
+		return null;
+	}
+
+	const capturingGroups = capturingGroupsArr[capturingGroupsArr.length - 1];
+
+	if (!capturingGroups || capturingGroups.length < 2) {
+		return null;
+	}
+
+	switch (returnType) {
+		case 'url':
+			return typeof capturingGroups === 'string' ? capturingGroups : capturingGroups[capturingGroups.length - 1];
+		case 'body':
+			return message;
+		default:
+			return 'Bad "returnType" argument';
+	}
+};
+
+const extractEmailFromNameAndEmailFormat = str => {
+	// In case the format is 'First Last <username@domain.com>' we will return username@domain.com only
+	return str.split('<').pop().split('>')[0];
+};
+const logRetrievedEmailInfo = (to, subject, { cc } = {}) => {
+	let log = 'The following email retrieved and will be sent to trash:';
+	log += `\n| To: ${to}`;
+	cc ? log += `\n| Cc: ${cc}` : '';
+	log += `\n| Subject: ${subject}`;
+};
+
+module.exports = {
+	recipientsMatchVerification,
+	regexVerification,
+	extractEmailFromNameAndEmailFormat,
+	logRetrievedEmailInfo
+};

package/src/saas/internal-api/requests/models/edit.request.model.js

@@ -1,5 +1,5 @@
 const { validateType } = require('../../../../common/validations/typeValidations');
-const { validateContractorModel } = require('../models/validation.models');
+const { validateContractorModel } = require('../utils');
 
 class RequestModel {
 	constructor(id, record, tabModel, tenantRequest) {

package/src/saas/internal-api/requests/utils.js

@@ -0,0 +1,8 @@
+const { validateType } = require('../../../common/validations/typeValidations');
+const { ContractorModel } = require('../contractors/models/edit.contractor.model');
+
+function validateContractorModel(record) {
+	validateType(record, ContractorModel);
+}
+
+module.exports = { validateContractorModel };

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

@@ -16,9 +16,8 @@ const Endpoints = {
 	removeAllUserTraceFromDb: userId => `${backendUrl}/saas/user/automation/${userId}`
 };
 
-const invite = (invitedUser, context) => {
-	const params = { disableSendMail: true };
-	return requests.putRequestHandler(Endpoints.invite, invitedUser, context, {}, params);
+const invite = (invitedUser, context, { disableSendMail = true } = {}) => {
+	return requests.putRequestHandler(Endpoints.invite, invitedUser, context, {}, { disableSendMail });
 };
 
 const signupUser = (signupUserModel, context) => {

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

@@ -6,8 +6,8 @@ const userAPI = require('./users.api');
 const util = require('../utils/util');
 const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
 
-const inviteUser = async (invitedUser, context) => {
-	return userAPI.invite(invitedUser, context);
+const inviteUser = async (invitedUser, context, { disableSendMail } = {}) => {
+	return userAPI.invite(invitedUser, context, { disableSendMail });
 };
 
 const signupUser = (signupUserModel, context) => {

package/src/saas/openapi/requests/index.js

@@ -0,0 +1,6 @@
+const services = require('./requests.service');
+
+const InviteRequestModel = require('./models/invite.request.model');
+const models = { InviteRequestModel };
+
+module.exports = { ... services, models };

package/src/saas/openapi/{contractors/models/invite.contractor.model.js → requests/models/invite.request.model.js}

@@ -1,4 +1,4 @@
-class InviteContractorModel {
+class InviteRequestModel {
 	constructor(
 		email,
 		company,
@@ -33,5 +33,5 @@ class InviteContractorModel {
 }
 
 module.exports = {
-	InviteContractorModel
+	InviteRequestModel
 };

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

@@ -0,0 +1,20 @@
+const requests = require('../../../common/requests/apiKeyAuth/requests');
+const { openapiUrl } = require('../../../env').getEnv();
+const { isLocalhost } = require('../../../env');
+
+const contractorUrl = isLocalhost() ? 'contractors' : 'records';
+
+const Endpoints = {
+	getAllRequests: `${openapiUrl}/${contractorUrl}/all`,
+	inviteRequest: tabId => `${openapiUrl}/tabs/${tabId}/${contractorUrl}`
+};
+
+const getAllRequests = async (apiKey, params) => {
+	return requests.getRequestHandler(Endpoints.getAllRequests, apiKey, params).then(res => res.data);
+};
+
+const inviteRequest = async (apiKey, tabId, params) => {
+	return requests.postRequestHandler(Endpoints.inviteRequest(tabId), apiKey, params).then(res => res.data);
+};
+
+module.exports = { getAllRequests, inviteRequest };

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

@@ -0,0 +1,18 @@
+const requestsApi = require('./requests.api');
+const { InviteRequestModel } = require('./models/invite.request.model');
+const { validateType } = require('../../../common/validations/typeValidations');
+
+const getAllAccountRequests = async (apiKey, { projectId, type, activationStatuses } = {}) => {
+	if (activationStatuses) {
+		activationStatuses = activationStatuses.reduce((f, s) => `${f},${s}`);
+	}
+
+	return requestsApi.getAllRequests(apiKey, { propertyId: projectId, type, activationStatuses });
+};
+
+const inviteRequest = async (apiKey, tabId, inviteRequestModel = {}) => {
+	validateType(inviteRequestModel, InviteRequestModel);
+	return requestsApi.inviteRequest(apiKey, tabId, inviteRequestModel);
+};
+
+module.exports = { getAllAccountRequests, inviteRequest };

package/src/saas/internal-api/requests/models/validation.models.js

@@ -1,8 +0,0 @@
-const { validateType } = require('../../../../common/validations/typeValidations');
-const { ContractorModel } = require('../../contractors/models/edit.contractor.model');
-
-function validateContractorModel(record) {
-	validateType(record, ContractorModel);
-}
-
-module.exports = { validateContractorModel };

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

@@ -1,20 +0,0 @@
-const requests = require('../../../common/requests/apiKeyAuth/requests');
-const { openapiUrl } = require('../../../env').getEnv();
-const { isLocalhost } = require('../../../env');
-
-const contractorUrl = isLocalhost() ? 'contractors' : 'records';
-
-const Endpoints = {
-	getAllContractors: `${openapiUrl}/${contractorUrl}/all`,
-	inviteContractor: tabId => `${openapiUrl}/tabs/${tabId}/${contractorUrl}`
-};
-
-const getAllContractors = async (apiKey, params) => {
-	return requests.getRequestHandler(Endpoints.getAllContractors, apiKey, params).then(res => res.data);
-};
-
-const inviteContractor = async (apiKey, tabId, params) => {
-	return requests.postRequestHandler(Endpoints.inviteContractor(tabId), apiKey, params).then(res => res.data);
-};
-
-module.exports = { getAllContractors, inviteContractor };

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

@@ -1,18 +0,0 @@
-const contractorsApi = require('./contractors.api');
-const { InviteContractorModel } = require('./models/invite.contractor.model');
-const { validateType } = require('../../../common/validations/typeValidations');
-
-const getContractors = async (apiKey, { projectId, type, activationStatuses } = {}) => {
-	if (activationStatuses) {
-		activationStatuses = activationStatuses.reduce((f, s) => `${f},${s}`);
-	}
-
-	return contractorsApi.getAllContractors(apiKey, { propertyId: projectId, type, activationStatuses });
-};
-
-const inviteContractor = async (apiKey, tabId, inviteContractorModel = {}) => {
-	validateType(inviteContractorModel, InviteContractorModel);
-	return contractorsApi.inviteContractor(apiKey, tabId, inviteContractorModel);
-};
-
-module.exports = { getContractors, inviteContractor };

package/src/saas/openapi/contractors/index.js

@@ -1,6 +0,0 @@
-const services = require('./contractors.service');
-
-const InviteContractorModel = require('./models/invite.contractor.model');
-const models = { InviteContractorModel };
-
-module.exports = { ... services, models };