@getjones/test-infra 2.8.4 → 2.8.5

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

@@ -1,127 +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.getAllMessages(emailModel);
-};
-
-const deleteMultipleMessages = emailIds => {
-	return dbEmailsApi.deleteMultipleMessages(emailIds);
-};
-
-const deleteAllMessages = () => {
-	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\n${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}\n${response}`);
-		}
-	}
-
-	return newestResult;
-};
-
-module.exports = {
-	util,
-
-	getAllMessages,
-	getLastMessage,
-	deleteMultipleMessages,
-	deleteAllMessages
-};
+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.getAllMessages(emailModel);
+};
+
+const deleteMultipleMessages = emailIds => {
+	return dbEmailsApi.deleteMultipleMessages(emailIds);
+};
+
+const deleteAllMessages = () => {
+	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\n${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}\n${response}`);
+		}
+	}
+
+	return newestResult;
+};
+
+module.exports = {
+	util,
+
+	getAllMessages,
+	getLastMessage,
+	deleteMultipleMessages,
+	deleteAllMessages
+};

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

@@ -1,37 +1,37 @@
-const DEFAULT_EMAIL_SENDER = 'hellogetjonestest@gmail.com';
-
-const EMAIL_TYPES = {
-	COMPLIANT: 'compliant',
-	SEND_GAPS: 'sendGaps',
-	REQUEST_NEW_COI_EXPIRED: 'requestNewCoiExpired',
-	FIRST_REMINDER: 'firstReminder',
-	SECOND_REMINDER: 'secondReminder',
-	FINAL_REMINDER: 'finalReminder',
-	ABOUT_TO_EXPIRE_PM: 'aboutToExpirePM',
-	ABOUT_TO_EXPIRE_MONTH_AUTO_RENEWAL: 'aboutToExpireMonthAutoRenewal',
-	ABOUT_TO_EXPIRE_TWO_WEEKS_AUTO_RENEWAL: 'aboutToExpireTwoWeeksAutoRenewal',
-	ABOUT_TO_EXPIRE_WEEK_AUTO_RENEWAL: 'aboutToExpireWeekAutoRenewal',
-	SAME_DAY_EXPIRATION_RECORD_AUTO_RENEWAL: 'sameDayExpirationRecordAutoRenewal',
-	SAME_DAY_EXPIRATION_PM_AUTO_RENEWAL: 'sameDayExpirationPMAutoRenewal',
-	REQUIREMENTS_UPDATED_NOTIFICATION: 'requirementsUpdatedNotification',
-	UPDATE_REQUIREMENTS_PREFIX: 'updatedRequirementsSubjectPrefix'
-};
-
-const EMAIL_SUBJECT = {
-	compliant: ({ recordCompanyName }) => `Compliant COI - ${recordCompanyName}`,
-	sendGaps: ({ requesterName }) => `New Insurance Docs Required for ${requesterName}`, //doesn't includes text for guest or tenant
-	requestNewCoiExpired: ({ recordCompanyName }) => `${recordCompanyName}'s COI is`,
-	firstReminder: ({ requesterName }) => `We are still awaiting the Insurance Docs for ${requesterName}`,
-	secondReminder: ({ requesterName }) => `We are still awaiting the Insurance Docs for ${requesterName}`,
-	finalReminder: ({ recordCompanyName, requesterName }) => `Missing ${recordCompanyName}'s Insurance Docs for ${requesterName}`,
-	aboutToExpirePM: ({ recordCompanyName }) => `Insurance Policy of ${recordCompanyName} expires Soon`,
-	aboutToExpireMonthAutoRenewal: ({ requesterName }) => `Your COI for ${requesterName} expires in 30 days`,
-	aboutToExpireTwoWeeksAutoRenewal: ({ requesterName }) => `Your COI for ${requesterName} expires in 14 days`,
-	aboutToExpireWeekAutoRenewal: ({ requesterName }) => `Only 7 days! Your COI for ${requesterName} expires`,
-	sameDayExpirationRecordAutoRenewal: ({ requesterName }) => `Your COI for ${requesterName} expires TODAY`,
-	sameDayExpirationPMAutoRenewal: ({ recordCompanyName }) => `COI expired for ${recordCompanyName} at`,
-	requirementsUpdatedNotification: ({ requesterName }) => `Updated Requirements - Your Insurance Docs are needed for ${requesterName}`,
-	updatedRequirementsSubjectPrefix: () => 'Updated Requirements - '
-};
-
-module.exports = { DEFAULT_EMAIL_SENDER, EMAIL_TYPES, EMAIL_SUBJECT };
+const DEFAULT_EMAIL_SENDER = 'hellogetjonestest@gmail.com';
+
+const EMAIL_TYPES = {
+	COMPLIANT: 'compliant',
+	SEND_GAPS: 'sendGaps',
+	REQUEST_NEW_COI_EXPIRED: 'requestNewCoiExpired',
+	FIRST_REMINDER: 'firstReminder',
+	SECOND_REMINDER: 'secondReminder',
+	FINAL_REMINDER: 'finalReminder',
+	ABOUT_TO_EXPIRE_PM: 'aboutToExpirePM',
+	ABOUT_TO_EXPIRE_MONTH_AUTO_RENEWAL: 'aboutToExpireMonthAutoRenewal',
+	ABOUT_TO_EXPIRE_TWO_WEEKS_AUTO_RENEWAL: 'aboutToExpireTwoWeeksAutoRenewal',
+	ABOUT_TO_EXPIRE_WEEK_AUTO_RENEWAL: 'aboutToExpireWeekAutoRenewal',
+	SAME_DAY_EXPIRATION_RECORD_AUTO_RENEWAL: 'sameDayExpirationRecordAutoRenewal',
+	SAME_DAY_EXPIRATION_PM_AUTO_RENEWAL: 'sameDayExpirationPMAutoRenewal',
+	REQUIREMENTS_UPDATED_NOTIFICATION: 'requirementsUpdatedNotification',
+	UPDATE_REQUIREMENTS_PREFIX: 'updatedRequirementsSubjectPrefix'
+};
+
+const EMAIL_SUBJECT = {
+	compliant: ({ recordCompanyName }) => `Compliant COI - ${recordCompanyName}`,
+	sendGaps: ({ requesterName }) => `New Insurance Docs Required for ${requesterName}`, //doesn't includes text for guest or tenant
+	requestNewCoiExpired: ({ recordCompanyName }) => `${recordCompanyName}'s COI is`,
+	firstReminder: ({ requesterName }) => `We are still awaiting the Insurance Docs for ${requesterName}`,
+	secondReminder: ({ requesterName }) => `We are still awaiting the Insurance Docs for ${requesterName}`,
+	finalReminder: ({ recordCompanyName, requesterName }) => `Missing ${recordCompanyName}'s Insurance Docs for ${requesterName}`,
+	aboutToExpirePM: ({ recordCompanyName }) => `Insurance Policy of ${recordCompanyName} expires Soon`,
+	aboutToExpireMonthAutoRenewal: ({ requesterName }) => `Your COI for ${requesterName} expires in 30 days`,
+	aboutToExpireTwoWeeksAutoRenewal: ({ requesterName }) => `Your COI for ${requesterName} expires in 14 days`,
+	aboutToExpireWeekAutoRenewal: ({ requesterName }) => `Only 7 days! Your COI for ${requesterName} expires`,
+	sameDayExpirationRecordAutoRenewal: ({ requesterName }) => `Your COI for ${requesterName} expires TODAY`,
+	sameDayExpirationPMAutoRenewal: ({ recordCompanyName }) => `COI expired for ${recordCompanyName} at`,
+	requirementsUpdatedNotification: ({ requesterName }) => `Updated Requirements - Your Insurance Docs are needed for ${requesterName}`,
+	updatedRequirementsSubjectPrefix: () => 'Updated Requirements - '
+};
+
+module.exports = { DEFAULT_EMAIL_SENDER, EMAIL_TYPES, EMAIL_SUBJECT };

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

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

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

@@ -1,21 +1,21 @@
-class EmailModel {
-	constructor(
-		from,
-		recipientsTo,
-		includesOneOfRecipientsTo,
-		recipientsCc,
-		textInSubject,
-		textInBody,
-		excludingPhrasesInBody
-	) {
-		this.from = from;
-		this.recipientsTo = recipientsTo;
-		this.includesOneOfRecipientsTo = includesOneOfRecipientsTo;
-		this.recipientsCc = recipientsCc;
-		this.textInSubject = textInSubject;
-		this.textInBody = textInBody;
-		this.excludingPhrasesInBody = excludingPhrasesInBody;
-	}
-}
-
-module.exports = { EmailModel };
+class EmailModel {
+	constructor(
+		from,
+		recipientsTo,
+		includesOneOfRecipientsTo,
+		recipientsCc,
+		textInSubject,
+		textInBody,
+		excludingPhrasesInBody
+	) {
+		this.from = from;
+		this.recipientsTo = recipientsTo;
+		this.includesOneOfRecipientsTo = includesOneOfRecipientsTo;
+		this.recipientsCc = recipientsCc;
+		this.textInSubject = textInSubject;
+		this.textInBody = textInBody;
+		this.excludingPhrasesInBody = excludingPhrasesInBody;
+	}
+}
+
+module.exports = { EmailModel };

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

@@ -1,68 +1,68 @@
-const { EMAIL_SUBJECT } = require('../consts/consts');
-
-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}`;
-};
-
-const getEmailTextInSubject = (recordCompanyName, emailType, isAfterUpdateRequirements = false, { requesterName = 'Default' } = {}) => {
-	const subject = EMAIL_SUBJECT[emailType]({ recordCompanyName, requesterName });
-
-	return isAfterUpdateRequirements ? `Updated Requirements - ${subject}` : subject;
-};
-
-module.exports = {
-	recipientsMatchVerification,
-	regexVerification,
-	extractEmailFromNameAndEmailFormat,
-	logRetrievedEmailInfo,
-	getEmailTextInSubject
-};
+const { EMAIL_SUBJECT } = require('../consts/consts');
+
+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}`;
+};
+
+const getEmailTextInSubject = (recordCompanyName, emailType, isAfterUpdateRequirements = false, { requesterName = 'Default' } = {}) => {
+	const subject = EMAIL_SUBJECT[emailType]({ recordCompanyName, requesterName });
+
+	return isAfterUpdateRequirements ? `Updated Requirements - ${subject}` : subject;
+};
+
+module.exports = {
+	recipientsMatchVerification,
+	regexVerification,
+	extractEmailFromNameAndEmailFormat,
+	logRetrievedEmailInfo,
+	getEmailTextInSubject
+};