@getjones/test-infra 2.7.11 → 2.7.13

package/package.json

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

package/src/factory/records/records.js

@@ -113,7 +113,7 @@ const prepareWaivedRecord = async (recordCompany, recordEmail, tabId, requiremen
 	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.notCompliant, tabId, requirementId, context);
 
 	const { data: record } = await contractors.services.getContractorById(recordId, context);
-	await compliance.services.overrideGap.waiveAll(record, context);
+	await compliance.services.overrideGap.waiveAllGaps(record, context);
 
 	return recordId;
 };

package/src/saas/internal-api/compliance/api/overrideGap/override.gap.api.js

@@ -2,32 +2,18 @@ const requests = require('../../../../../common/requests/cookieAuth/requests');
 const { backendUrl } = require('../../../../../env').getEnv();
 
 const Endpoints = {
-	waive: contractorId => `${backendUrl}/saas/contractors/${contractorId}/waiver`,
-	retract: contractorId => `${backendUrl}/saas/contractors/${contractorId}/waiver`,
 	overrideGap: `${backendUrl}/saas/record/override-gap`,
 	retractOverride: `${backendUrl}/saas/record/retract-override`
 };
 
-const waive = async (contractorId, waiveRequestModel, context) => {
-	const status = waiveRequestModel.status;
-	delete waiveRequestModel.status;
-	return requests.postRequestHandler(Endpoints.waive(contractorId), waiveRequestModel, context, {}, { status });
-};
-
-const retract = async (contractorId, retractRequestModel, context) => {
-	const status = retractRequestModel.status;
-	delete retractRequestModel.status;
-	return requests.postRequestHandler(Endpoints.retract(contractorId), retractRequestModel, context, {}, { status });
-};
-
-const overrideGap = (waiveRequestModel, isTestingBackwardCompatibility, context) => {
+const overrideGap = ({ overrideGapModel, isTestingBackwardCompatibility = false, context }) => {
 	const headers = {};
 	const params = { isTestingBackwardCompatibility };
-	return requests.postRequestHandler(Endpoints.overrideGap, waiveRequestModel, context, headers, params);
+	return requests.postRequestHandler(Endpoints.overrideGap, overrideGapModel, context, headers, params);
 };
 
-const retractOverride = (retractRequestModel, context) => {
-	return requests.postRequestHandler(Endpoints.retractOverride, retractRequestModel, context);
+const retractOverride = (retractModel, context) => {
+	return requests.postRequestHandler(Endpoints.retractOverride, retractModel, context);
 };
 
-module.exports = { waive, retract, overrideGap, retractOverride };
+module.exports = { overrideGap, retractOverride };

package/src/saas/internal-api/compliance/api/overrideGap/override.gap.service.js

@@ -1,7 +1,9 @@
 const env = require('../../../../../env');
 
 const overrideGapApi = require('./override.gap.api');
-const { WaiveRequestModel, RetractRequestModel, WAIVER_REASONS } = require('../../models/waive/waive.model');
+const { OverrideGapModel } = require('../../models/overrideGap/override.gap.model');
+const { RetractOverrideGapModel } = require('../../models/overrideGap/retract.override.gap.model');
+const { OVERRIDE_GAP_REASONS } = require('../../consts/overrideGap');
 const { validateType } = require('../../../../../common/validations/typeValidations');
 const auditUtil = require('../../utils/auditUtil');
 const httpResponseStatusCodes = require('../../../../../common/httpResponseStatusCodes.json');
@@ -9,27 +11,17 @@ const httpResponseStatusCodes = require('../../../../../common/httpResponseStatu
 const { credentials } = env.getEnv();
 const userTypes = require('../../../../../common/consts/userTypes');
 
-const waive = (waiveRequestModel, context) => {
-	validateType(waiveRequestModel, WaiveRequestModel);
-	return overrideGapApi.waive(waiveRequestModel.contractorId, waiveRequestModel, context);
+const overrideGap = ({ overrideGapModel, isTestingBackwardCompatibility = false, context }) => {
+	validateType(overrideGapModel, OverrideGapModel);
+	return overrideGapApi.overrideGap({ overrideGapModel, isTestingBackwardCompatibility, context });
 };
 
-const retract = (retractRequestModel, context) => {
-	validateType(retractRequestModel, RetractRequestModel);
-	return overrideGapApi.retract(retractRequestModel.contractorId, retractRequestModel, context);
+const retractOverride = (retractModel, context) => {
+	validateType(retractModel, RetractOverrideGapModel);
+	return overrideGapApi.retractOverride(retractModel, context);
 };
 
-const overrideGap = ({ waiveRequestModel, isTestingBackwardCompatibility = false, context }) => {
-	validateType(waiveRequestModel, WaiveRequestModel);
-	return overrideGapApi.overrideGap(waiveRequestModel, isTestingBackwardCompatibility, context);
-};
-
-const retractOverride = (retractRequestModel, context) => {
-	validateType(retractRequestModel, RetractRequestModel);
-	return overrideGapApi.retractOverride(retractRequestModel, context);
-};
-
-const getWaiveModel = (
+const getOverrideGapModel = (
 	record,
 	policyName,
 	attributeName,
@@ -43,7 +35,7 @@ const getWaiveModel = (
 	userId = userId || env.getSystemUserIdentity(credentials.superUser).id;
 	userRole = userRole || userTypes.ICS;
 
-	const waiveModel = new WaiveRequestModel({
+	const waiveModel = new OverrideGapModel({
 		contractorId: record.id,
 		auditId,
 		waiverReason,
@@ -67,7 +59,7 @@ const getWaiveModelByGap = (
 	} = {}) => {
 	const attributeName = auditUtil.getAttributeNameByGap(record, policyName, gap);
 
-	return getWaiveModel(record, policyName, attributeName, reason, note, { userId, userRole });
+	return getOverrideGapModel(record, policyName, attributeName, reason, note, { userId, userRole });
 };
 
 const getRetractModel = (record, policyName, attributeName) => {
@@ -75,7 +67,7 @@ const getRetractModel = (record, policyName, attributeName) => {
 	const userId = env.getSystemUserIdentity(credentials.superUser).id;
 	const userRole = userTypes.ICS;
 
-	const retractModel = new RetractRequestModel({
+	const retractModel = new RetractOverrideGapModel({
 		contractorId: record.id,
 		auditId,
 		userId,
@@ -102,12 +94,13 @@ const getPolicyAuditIdFromRecord = (record, policyName, attributeName) => {
 	return attribute.auditId;
 };
 
-const waiveAll = async (record, context, { reason = WAIVER_REASONS.BUSINESS_DECISION, note = 'WAIVED AUTOMATICALLY' } = {}) => {
+// PRIVATE METHOD - please refer to waiveAllGaps / acceptAllGaps according to your needs
+const overrideAllGaps = async (record, context, { reason = OVERRIDE_GAP_REASONS.BUSINESS_DECISION, note = 'WAIVED AUTOMATICALLY' } = {}) => {
 	const allWaivablePolicies = auditUtil.getAllWaivablePolicies(record, context);
 
 	for (const waivable of allWaivablePolicies) {
-		const waiveModel = getWaiveModel(record, waivable.policyName, waivable.attributeName, reason, note);
-		const waiveResponse = await waive(waiveModel, context);
+		const overrideGapModel = getOverrideGapModel(record, waivable.policyName, waivable.attributeName, reason, note);
+		const waiveResponse = await overrideGap({ overrideGapModel, context });
 
 		if (waiveResponse.status !== httpResponseStatusCodes.OK) {
 			throw Error(`Failed to waive ${waivable.policyName} - ${waivable.attributeName} for ${record.company}`);
@@ -115,11 +108,24 @@ const waiveAll = async (record, context, { reason = WAIVER_REASONS.BUSINESS_DECI
 	}
 };
 
+const waiveAllGaps = async (record, context, { reason = OVERRIDE_GAP_REASONS.BUSINESS_DECISION, note = 'WAIVED AUTOMATICALLY' } = {}) => {
+	const waivedReasons = new Set([OVERRIDE_GAP_REASONS.BUSINESS_DECISION, OVERRIDE_GAP_REASONS.EXECUTIVE_APPROVAL, OVERRIDE_GAP_REASONS.NO_EXPOSURE]);
+
+	if (!waivedReasons.has(reason)) {
+		throw Error(`Invalid waive reason ${reason} provided when trying to waive all gaps to waive`);
+	}
+
+	await overrideAllGaps(record, context, { reason, note });
+};
+
+const acceptAllGaps = async (record, context, { note = 'ACCEPTED AUTOMATICALLY' } = {}) => {
+	overrideAllGaps(record, context, { reason: OVERRIDE_GAP_REASONS.ACCEPT_NO_EXPOSURE, note });
+};
+
 module.exports = {
-	waive,
-	waiveAll,
-	retract,
-	getWaiveModel,
+	acceptAllGaps,
+	waiveAllGaps,
+	getOverrideGapModel,
 	getRetractModel,
 	getWaiveModelByGap,
 	overrideGap,

package/src/saas/internal-api/compliance/consts/overrideGap.js

@@ -0,0 +1,10 @@
+const OVERRIDE_GAP_REASONS = {
+	BUSINESS_DECISION: 'Business Decision',
+	EXECUTIVE_APPROVAL: 'Executive Approval',
+	ACCEPT_NO_EXPOSURE: 'Accept / No Exposure',
+	NO_EXPOSURE: 'No Exposure' // DEPRECATED - BACKWARD COMPATIBILITY
+};
+
+module.exports = {
+	OVERRIDE_GAP_REASONS
+};

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

@@ -1,13 +1,14 @@
 const auditModels = require('./models/audit/audit.model');
 const auditServices = require('./api/audit/audit.service');
 
-const waiveModels = require('./models/waive/waive.model');
+const waiveModels = require('./models/overrideGap/override.gap.model');
 const overrideGapServices = require('./api/overrideGap/override.gap.service');
 
 const convertServices = require('./api/convert/convert.service');
 const coverageServices = require('./api/coverage/coverage.service');
 
 const auditConsts = require('./consts/audit');
+const overrideGapConsts = require('./consts/overrideGap');
 const auditUtils = require('./utils/auditUtil');
 
 const models = {
@@ -16,7 +17,8 @@ const models = {
 };
 
 const consts = {
-	audit: auditConsts
+	audit: auditConsts,
+	overrideGap: overrideGapConsts
 };
 
 const utils = {

package/src/saas/internal-api/compliance/models/overrideGap/override.gap.model.js

@@ -0,0 +1,16 @@
+class OverrideGapModel {
+	constructor({
+		contractorId, auditId, waiverReason, remarks, userId, userRole
+	}) {
+		this.auditorContractorId = auditId;
+		this.contractorId = contractorId;
+		this.waiverReason = waiverReason;
+		this.remarks = remarks || '';
+		this.userId = userId;
+		this.userRole = userRole;
+	}
+}
+
+module.exports = {
+	OverrideGapModel
+};

package/src/saas/internal-api/compliance/models/overrideGap/retract.override.gap.model.js

@@ -0,0 +1,14 @@
+class RetractOverrideGapModel {
+	constructor({
+		contractorId, auditId, userId, userRole
+	}) {
+		this.auditorContractorId = auditId;
+		this.contractorId = contractorId;
+		this.userId = userId;
+		this.userRole = userRole;
+	}
+}
+
+module.exports = {
+	RetractOverrideGapModel
+};

package/src/saas/internal-api/compliance/utils/auditUtil.js

@@ -2,7 +2,7 @@ const { AUDIT_ENTITY_STATUSES, DEFAULT_POLICY_ID, VALID_SCORES } = require('../c
 const { isObject, isArray } = require('../../../../common/utils/dataTypeUtils');
 const timeUtils = require('../../../../common/utils/timeUtils');
 const auditModels = require('../models/audit/audit.model');
-const waiveModels = require('../models/waive/waive.model');
+const { OVERRIDE_GAP_REASONS } = require('../consts/overrideGap');
 
 const emptyValue = '';
 
@@ -216,7 +216,7 @@ const specialAttributes = {
 };
 
 const waiveReasons = {
-	'No Exposure': waiveModels.WAIVER_REASONS.NO_EXPOSURE,
-	'Business Decision': waiveModels.WAIVER_REASONS.BUSINESS_DECISION,
-	'Executive Approval': waiveModels.WAIVER_REASONS.EXECUTIVE_APPROVAL
+	'No Exposure': OVERRIDE_GAP_REASONS.NO_EXPOSURE,
+	'Business Decision': OVERRIDE_GAP_REASONS.BUSINESS_DECISION,
+	'Executive Approval': OVERRIDE_GAP_REASONS.EXECUTIVE_APPROVAL
 };

package/src/saas/internal-api/compliance/models/waive/waive.model.js

@@ -1,49 +0,0 @@
-const WAIVE_ACTIONS = {
-	WAIVE: 'ignored',
-	RETRACT: 'notIgnored'
-};
-
-const WAIVER_REASONS = {
-	BUSINESS_DECISION: 'Business Decision',
-	EXECUTIVE_APPROVAL: 'Executive Approval',
-	ACCEPT_NO_EXPOSURE: 'Accept / No Exposure',
-	NO_EXPOSURE: 'No Exposure' // DEPRECATED - BACKWARD COMPATIBILITY
-};
-
-function WaiveRequestModel({
-	contractorId,
-	auditId,
-	waiverReason,
-	remarks,
-	userId,
-	userRole
-}) {
-	this.auditorContractorId = auditId;
-	this.contractorId = contractorId;
-	this.waiverReason = waiverReason;
-	this.remarks = remarks || '';
-
-	this.userId = userId,
-	this.userRole = userRole,
-	this.status = WAIVE_ACTIONS.WAIVE;
-}
-
-function RetractRequestModel({
-	contractorId,
-	auditId,
-	userId,
-	userRole
-}) {
-	this.auditorContractorId = auditId;
-	this.contractorId = contractorId;
-	this.userId = userId;
-	this.userRole = userRole;
-	this.status = WAIVE_ACTIONS.RETRACT;
-}
-
-module.exports = {
-	WaiveRequestModel,
-	RetractRequestModel,
-	WAIVE_ACTIONS,
-	WAIVER_REASONS
-};