| Project | +${projectName} | +
| Related NCS project | +${ + isNationalCoreStudies ? `View NCS project` : 'no' + } | +
| Dataset(s) | +${datasetTitles} | +
| Date of submission | +${dateSubmitted} | +
| Applicant | +${userName}, ${_displayCorrectEmailAddress( + userEmail, + userType + )} | +
| Project | +${projectName} | +
| Date of amendment submission | +${dateSubmitted} | +
| Applicant | +${userName}, ${_displayCorrectEmailAddress( + userEmail, + userType + )} | +
+ Datasets requested+ |
+ |
| Previous datasets | +${initialDatasetTitles} | +
| New datasets | +${datasetTitles} | +
+
+
+
{
return body;
};
+const _generateNewDARMessage = options => {
+ let { id, projectName, datasetTitles, applicants, firstname, lastname, messageBody, questionWithAnswer } = options;
+ let body = `
-
- Reason for rejection
-
-
-
-
- ${comment}
-
- `;
+
+ Comment from reviewer:
+
+
+
+
+ "${comment}"
+
+ `;
}
let body = `
| + ${heading} + | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| + ${subject} + | +||||||||||
| + ${body} + | +
| - ${heading} - | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| - ${subject} - | -||||||||||
-
|
-
- ${page}+${page} |
Message to data custodian:
+${submissionDescription}
+
+ ${_displayDARLink(applicationId)}
+
+ ${gatewayAttributionPolicy}
+${gatewayAttributionPolicy}
| + New message about an application + | +||||||
|---|---|---|---|---|---|---|
| + ${firstname} ${lastname} sent a message regarding their application form + | +||||||
+
|
+ ||||||
| + Message from ${firstname} ${lastname} + | +||||||
+
|
+ ||||||
| + ${questionWithAnswer.page} + | +||||||
| + ${questionWithAnswer.questionPanel} + | +||||||
+
|
+
@@ -1817,14 +2051,14 @@ const _generateMetadataOnboardingRejected = options => {
style="font-family: Arial, sans-serif">
-
- Your dataset version has been reviewed and rejected
+
+ Your dataset version requires revision before it can be accepted on the Gateway
- The submitted version of ${name} has been reviewed and rejected by the HDRUK admins. Please view and create a new version of this dataset and make the necessary changes if you would like to make another submission to the Gateway.
-
+ Thank you for submitting ${name}, which has been reviewed by the team at HDR UK. The dataset version cannot be approved for release on the Gateway at this time. Please look at the comment from the reviewer below and make any necessary changes on a new version of the dataset before resubmitting.
+
${commentHTML}
@@ -1838,11 +2072,45 @@ const _generateMetadataOnboardingRejected = options => {
return body;
};
+const _generateMetadataOnboardingDraftDeleted = options => {
+ let { publisherName, draftDatasetName } = options;
+
+ let body = `
+
`;
+ return body;
+};
+
const _generateMessageNotification = options => {
let { firstMessage, firstname, lastname, messageDescription, openMessagesLink } = options;
let body = `
+
+
+
+
+ | + Draft dataset deleted + | +
|---|
|
+ + The draft version of ${draftDatasetName} has been deleted. + + |
+
- 
{
return body;
};
+const _generateEntityNotification = options => {
+ let { resourceType, resourceName, resourceLink, subject, rejectionReason, activeflag, type, resourceAuthor } = options;
+ let authorBody;
+ if (activeflag === 'active') {
+ authorBody = `${resourceName} ${resourceType} has been approved by the HDR UK admin team and can be publicly viewed on the gateway, including in search results.`;
+ } else if (activeflag === 'archive') {
+ authorBody = `${resourceName} ${resourceType} has been archived by the HDR UK admin team.`;
+ } else if (activeflag === 'rejected') {
+ authorBody = `${resourceName} ${resourceType} has been rejected by the HDR UK admin team.
+ `;
+
const _generateEmailFooter = (recipient, allowUnsubscribe) => {
// 1. Generate HTML for unsubscribe link if allowed depending on context
@@ -1999,6 +2343,7 @@ export default {
generateAttachment: _generateAttachment,
//DAR
generateEmail: _generateEmail,
+ generateAmendEmail: _generateAmendEmail,
generateDARReturnedEmail: _generateDARReturnedEmail,
generateDARStatusChangedEmail: _generateDARStatusChangedEmail,
generateDARClonedEmail: _generateDARClonedEmail,
@@ -2012,6 +2357,7 @@ export default {
generateTeamNotificationEmail: _generateTeamNotificationEmail,
generateRemovedFromTeam: _generateRemovedFromTeam,
generateAddedToTeam: _generateAddedToTeam,
+ generateNewDARMessage: _generateNewDARMessage,
//Workflows
generateWorkflowAssigned: _generateWorkflowAssigned,
generateWorkflowCreated: _generateWorkflowCreated,
@@ -2019,8 +2365,10 @@ export default {
generateMetadataOnboardingSumbitted: _generateMetadataOnboardingSumbitted,
generateMetadataOnboardingApproved: _generateMetadataOnboardingApproved,
generateMetadataOnboardingRejected: _generateMetadataOnboardingRejected,
+ generateMetadataOnboardingDraftDeleted: _generateMetadataOnboardingDraftDeleted,
//generateMetadataOnboardingArchived: _generateMetadataOnboardingArchived,
//generateMetadataOnboardingUnArchived: _generateMetadataOnboardingUnArchived,
//Messages
generateMessageNotification: _generateMessageNotification,
+ generateEntityNotification: _generateEntityNotification,
};
diff --git a/src/resources/utilities/notificationBuilder.js b/src/resources/utilities/notificationBuilder.js
index d89b7878..5bb081ad 100644
--- a/src/resources/utilities/notificationBuilder.js
+++ b/src/resources/utilities/notificationBuilder.js
@@ -11,7 +11,7 @@ const triggerNotificationMessage = (messageRecipients, messageDescription, messa
messageID,
messageObjectID: typeof messageObjectID == 'number' ? messageObjectID : messageID,
messageTo: recipient,
- messageDataRequestID: messageType === 'data access request' ? messageObjectID : null,
+ messageDataRequestID: messageType === 'data access request' || messageType === 'data access message sent' ? messageObjectID : null,
publisherName,
datasetID: messageType === 'dataset approved' || messageType === 'dataset rejected' ? messageObjectID : null,
});
diff --git a/src/resources/workflow/dependency.js b/src/resources/workflow/dependency.js
new file mode 100644
index 00000000..263ece27
--- /dev/null
+++ b/src/resources/workflow/dependency.js
@@ -0,0 +1,5 @@
+import WorkflowRepository from './workflow.repository';
+import WorkflowService from './workflow.service';
+
+export const workflowRepository = new WorkflowRepository();
+export const workflowService = new WorkflowService(workflowRepository);
diff --git a/src/resources/workflow/workflow.controller.js b/src/resources/workflow/workflow.controller.js
index e3513c6a..f479a4c3 100644
--- a/src/resources/workflow/workflow.controller.js
+++ b/src/resources/workflow/workflow.controller.js
@@ -1,714 +1,304 @@
+import _ from 'lodash';
+import Mongoose from 'mongoose';
+
import { PublisherModel } from '../publisher/publisher.model';
import { DataRequestModel } from '../datarequest/datarequest.model';
import { WorkflowModel } from './workflow.model';
import teamController from '../team/team.controller';
import helper from '../utilities/helper.util';
import constants from '../utilities/constants.util';
-import emailGenerator from '../utilities/emailGenerator.util';
-import notificationBuilder from '../utilities/notificationBuilder';
-
-import moment from 'moment';
-import _ from 'lodash';
-import mongoose from 'mongoose';
+import Controller from '../base/controller';
-// GET api/v1/workflows/:id
-const getWorkflowById = async (req, res) => {
- try {
- // 1. Get the workflow from the database including the team members to check authorisation and the number of in-flight applications
- const workflow = await WorkflowModel.findOne({
- _id: req.params.id,
- }).populate([
- {
- path: 'publisher',
- select: 'team',
- populate: {
- path: 'team',
- select: 'members -_id',
- },
- },
- {
- path: 'steps.reviewers',
- model: 'User',
- select: '_id id firstname lastname',
- },
- {
- path: 'applications',
- select: 'aboutApplication',
- match: { applicationStatus: 'inReview' },
- },
- ]);
- if (!workflow) {
- return res.status(404).json({ success: false });
- }
- // 2. Check the requesting user is a manager of the custodian team
- let { _id: userId } = req.user;
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
- // 3. If not return unauthorised
- if (!authorised) {
- return res.status(401).json({ success: false });
- }
- // 4. Build workflow response
- let { active, _id, id, workflowName, version, steps, applications = [] } = workflow.toObject();
- applications = applications.map(app => {
- let { aboutApplication = {}, _id } = app;
- let { projectName = 'No project name' } = aboutApplication;
- return { projectName, _id };
- });
- // Set operation permissions
- let canDelete = applications.length === 0,
- canEdit = applications.length === 0;
- // 5. Return payload
- return res.status(200).json({
- success: true,
- workflow: {
- active,
- _id,
- id,
- workflowName,
- version,
- steps,
- applications,
- appCount: applications.length,
- canDelete,
- canEdit,
- },
- });
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred searching for the specified workflow',
- });
+export default class WorkflowController extends Controller {
+ constructor(workflowService) {
+ super(workflowService);
+ this.workflowService = workflowService;
}
-};
-// POST api/v1/workflows
-const createWorkflow = async (req, res) => {
- try {
- const { _id: userId, firstname, lastname } = req.user;
- // 1. Look at the payload for the publisher passed
- const { workflowName = '', publisher = '', steps = [] } = req.body;
- if (_.isEmpty(workflowName.trim()) || _.isEmpty(publisher.trim()) || _.isEmpty(steps)) {
- return res.status(400).json({
- success: false,
- message: 'You must supply a workflow name, publisher, and at least one step definition to create a workflow',
+ async getWorkflowById(req, res) {
+ try {
+ // 1. Get the workflow from the database including the team members to check authorisation and the number of in-flight applications
+ const workflow = await WorkflowModel.findOne({
+ _id: req.params.id,
+ }).populate([
+ {
+ path: 'publisher',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
+ },
+ {
+ path: 'steps.reviewers',
+ model: 'User',
+ select: '_id id firstname lastname',
+ },
+ {
+ path: 'applications',
+ select: 'aboutApplication',
+ match: { applicationStatus: 'inReview' },
+ },
+ ]);
+ if (!workflow) {
+ return res.status(404).json({ success: false });
+ }
+ // 2. Check the requesting user is a manager of the custodian team
+ let { _id: userId } = req.user;
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
+ // 3. If not return unauthorised
+ if (!authorised) {
+ return res.status(401).json({ success: false });
+ }
+ // 4. Build workflow response
+ let { active, _id, id, workflowName, version, steps, applications = [] } = workflow.toObject();
+ applications = applications.map(app => {
+ let { aboutApplication = {}, _id } = app;
+ let { projectName = 'No project name' } = aboutApplication;
+ return { projectName, _id };
});
- }
- // 2. Look up publisher and team
- const publisherObj = await PublisherModel.findOne({
- _id: publisher,
- }).populate({
- path: 'team members',
- populate: {
- path: 'users',
- select: '_id id email firstname lastname',
- },
- });
-
- if (!publisherObj) {
- return res.status(400).json({
+ // Set operation permissions
+ let canDelete = applications.length === 0,
+ canEdit = applications.length === 0;
+ // 5. Return payload
+ return res.status(200).json({
+ success: true,
+ workflow: {
+ active,
+ _id,
+ id,
+ workflowName,
+ version,
+ steps,
+ applications,
+ appCount: applications.length,
+ canDelete,
+ canEdit,
+ },
+ });
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
success: false,
- message: 'You must supply a valid publisher to create the workflow against',
+ message: 'An error occurred searching for the specified workflow',
});
}
- // 3. Check the requesting user is a manager of the custodian team
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, publisherObj.team.toObject(), userId);
+ }
- // 4. Refuse access if not authorised
- if (!authorised) {
- return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
- }
- // 5. Create new workflow model
- const id = helper.generatedNumericId();
- // 6. set workflow obj for saving
- let workflow = new WorkflowModel({
- id,
- workflowName,
- publisher,
- steps,
- createdBy: new mongoose.Types.ObjectId(userId),
- });
- // 7. save new workflow to db
- workflow.save(function (err) {
- if (err) {
+ async createWorkflow(req, res) {
+ try {
+ const { _id: userId, firstname, lastname } = req.user;
+ // 1. Look at the payload for the publisher passed
+ const { workflowName = '', publisher = '', steps = [] } = req.body;
+ if (_.isEmpty(workflowName.trim()) || _.isEmpty(publisher.trim()) || _.isEmpty(steps)) {
return res.status(400).json({
success: false,
- message: err.message,
+ message: 'You must supply a workflow name, publisher, and at least one step definition to create a workflow',
});
}
- // 8. populate the workflow with the needed fiedls for our new notification and email
- workflow.populate(
- {
- path: 'steps.reviewers',
- select: 'firstname lastname email -_id',
+ // 2. Look up publisher and team
+ const publisherObj = await PublisherModel.findOne({ //lgtm [js/sql-injection]
+ _id: publisher,
+ }).populate({
+ path: 'team members',
+ populate: {
+ path: 'users',
+ select: '_id id email firstname lastname',
},
- (err, doc) => {
- if (err) {
- // 9. if issue
- return res.status(400).json({
- success: false,
- message: err.message,
- });
- }
- // 10. set context
- let context = {
- publisherObj: publisherObj.team.toObject(),
- actioner: `${firstname} ${lastname}`,
- workflow: doc.toObject(),
- };
- // 11. Generate new notifications / emails for managers of the team only on creation of a workflow
- createNotifications(context, constants.notificationTypes.WORKFLOWCREATED);
- // 12. full complete return
- return res.status(201).json({
- success: true,
- workflow,
- });
- }
- );
- });
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred creating the workflow',
- });
- }
-};
+ });
-// PUT api/v1/workflows/:id
-const updateWorkflow = async (req, res) => {
- try {
- const { _id: userId } = req.user;
- const { id: workflowId } = req.params;
- // 1. Look up workflow
- let workflow = await WorkflowModel.findOne({
- _id: req.params.id,
- }).populate({
- path: 'publisher steps.reviewers',
- select: 'team',
- populate: {
- path: 'team',
- select: 'members -_id',
- },
- });
- if (!workflow) {
- return res.status(404).json({ success: false });
- }
- // 2. Check the requesting user is a manager of the custodian team
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
- // 3. Refuse access if not authorised
- if (!authorised) {
- return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
- }
- // 4. Ensure there are no in-review DARs with this workflow
- const applications = await DataRequestModel.countDocuments({
- workflowId,
- applicationStatus: 'inReview',
- });
- if (applications > 0) {
- return res.status(400).json({
- success: false,
- message: 'A workflow which is attached to applications currently in review cannot be edited',
+ if (!publisherObj) {
+ return res.status(400).json({
+ success: false,
+ message: 'You must supply a valid publisher to create the workflow against',
+ });
+ }
+ // 3. Check the requesting user is a manager of the custodian team
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, publisherObj.team.toObject(), userId);
+
+ // 4. Refuse access if not authorised
+ if (!authorised) {
+ return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
+ }
+ // 5. Create new workflow model
+ const id = helper.generatedNumericId();
+ // 6. set workflow obj for saving
+ let workflow = new WorkflowModel({
+ id,
+ workflowName,
+ publisher,
+ steps,
+ createdBy: new Mongoose.Types.ObjectId(userId),
});
- }
- // 5. Edit workflow
- const { workflowName = '', steps = [] } = req.body;
- let isDirty = false;
- // Check if workflow name updated
- if (!_.isEmpty(workflowName)) {
- workflow.workflowName = workflowName;
- isDirty = true;
- } // Check if steps updated
- if (!_.isEmpty(steps)) {
- workflow.steps = steps;
- isDirty = true;
- } // Perform save if changes have been made
- if (isDirty) {
- workflow.save(async err => {
+ // 7. save new workflow to db
+ workflow = await workflow.save().catch(err => {
if (err) {
- console.error(err.message);
return res.status(400).json({
success: false,
message: err.message,
});
- } else {
- // 7. Return workflow payload
- return res.status(204).json({
- success: true,
- workflow,
- });
}
});
- } else {
- return res.status(200).json({
+ // 8. populate the workflow with the needed fields for our new notification and email
+ const detailedWorkflow = await WorkflowModel.findById(workflow._id).populate({
+ path: 'steps.reviewers',
+ select: 'firstname lastname email -_id',
+ }).lean();
+ // 9. set context
+ let context = {
+ publisherObj: publisherObj.team.toObject(),
+ actioner: `${firstname} ${lastname}`,
+ workflow: detailedWorkflow,
+ };
+ // 10. Generate new notifications / emails for managers of the team only on creation of a workflow
+ this.workflowService.createNotifications(context, constants.notificationTypes.WORKFLOWCREATED);
+ // 11. full complete return
+ return res.status(201).json({
success: true,
+ workflow: detailedWorkflow,
+ });
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
+ success: false,
+ message: 'An error occurred creating the workflow',
});
}
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred editing the workflow',
- });
}
-};
-// DELETE api/v1/workflows/:id
-const deleteWorkflow = async (req, res) => {
- try {
- const { _id: userId } = req.user;
- const { id: workflowId } = req.params;
- // 1. Look up workflow
- const workflow = await WorkflowModel.findOne({
- _id: req.params.id,
- }).populate({
- path: 'publisher steps.reviewers',
- select: 'team',
- populate: {
- path: 'team',
- select: 'members -_id',
- },
- });
- if (!workflow) {
- return res.status(404).json({ success: false });
- }
- // 2. Check the requesting user is a manager of the custodian team
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
- // 3. Refuse access if not authorised
- if (!authorised) {
- return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
- }
- // 4. Ensure there are no in-review DARs with this workflow
- const applications = await DataRequestModel.countDocuments({
- workflowId,
- applicationStatus: 'inReview',
- });
- if (applications > 0) {
- return res.status(400).json({
- success: false,
- message: 'A workflow which is attached to applications currently in review cannot be deleted',
+ async updateWorkflow(req, res) {
+ try {
+ const { _id: userId } = req.user;
+ const { id: workflowId } = req.params;
+ // 1. Look up workflow
+ let workflow = await WorkflowModel.findOne({
+ _id: req.params.id,
+ }).populate({
+ path: 'publisher steps.reviewers',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
});
- }
- // 5. Delete workflow
- WorkflowModel.deleteOne({ _id: workflowId }, function (err) {
- if (err) {
- console.error(err.message);
+ if (!workflow) {
+ return res.status(404).json({ success: false });
+ }
+ // 2. Check the requesting user is a manager of the custodian team
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
+ // 3. Refuse access if not authorised
+ if (!authorised) {
+ return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
+ }
+ // 4. Ensure there are no in-review DARs with this workflow
+ const applications = await DataRequestModel.countDocuments({
+ workflowId,
+ applicationStatus: 'inReview',
+ });
+ if (applications > 0) {
return res.status(400).json({
success: false,
- message: 'An error occurred deleting the workflow',
+ message: 'A workflow which is attached to applications currently in review cannot be edited',
+ });
+ }
+ // 5. Edit workflow
+ const { workflowName = '', steps = [] } = req.body;
+ let isDirty = false;
+ // Check if workflow name updated
+ if (!_.isEmpty(workflowName)) {
+ workflow.workflowName = workflowName;
+ isDirty = true;
+ } // Check if steps updated
+ if (!_.isEmpty(steps)) {
+ workflow.steps = steps;
+ isDirty = true;
+ } // Perform save if changes have been made
+ if (isDirty) {
+ workflow.save(async err => {
+ if (err) {
+ console.error(err.message);
+ return res.status(400).json({
+ success: false,
+ message: err.message,
+ });
+ } else {
+ // 7. Return workflow payload
+ return res.status(204).json({
+ success: true,
+ workflow,
+ });
+ }
});
} else {
- // 7. Return workflow payload
- return res.status(204).json({
+ return res.status(200).json({
success: true,
});
}
- });
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred deleting the workflow',
- });
- }
-};
-
-const createNotifications = async (context, type = '') => {
- if (!_.isEmpty(type)) {
- // local variables set here
- let custodianManagers = [],
- managerUserIds = [],
- options = {},
- html = '';
-
- // deconstruct context
- let { publisherObj, workflow = {}, actioner = '' } = context;
-
- // switch over types
- switch (type) {
- case constants.notificationTypes.WORKFLOWCREATED:
- // 1. Get managers for publisher
- custodianManagers = teamController.getTeamMembersByRole(publisherObj, constants.roleTypes.MANAGER);
- // 2. Get managerIds for notifications
- managerUserIds = custodianManagers.map(user => user.id);
- // 3. deconstruct workflow
- let { workflowName = 'Workflow Title', _id, steps, createdAt } = workflow;
- // 4. setup options
- options = {
- actioner,
- workflowName,
- _id,
- steps,
- createdAt,
- };
- // 4. Create notifications for the managers only
- await notificationBuilder.triggerNotificationMessage(
- managerUserIds,
- `A new workflow of ${workflowName} has been created`,
- 'workflow',
- _id
- );
- // 5. Generate the email
- html = await emailGenerator.generateWorkflowCreated(options);
- // 6. Send email to custodian managers only within the team
- await emailGenerator.sendEmail(custodianManagers, constants.hdrukEmail, `A Workflow has been created`, html, false);
- break;
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
+ success: false,
+ message: 'An error occurred editing the workflow',
+ });
}
}
-};
-const calculateStepDeadlineReminderDate = step => {
- // Extract deadline and reminder offset in days from step definition
- let { deadline, reminderOffset } = step;
- // Subtract SLA reminder offset
- let reminderPeriod = +deadline - +reminderOffset;
- return `P${reminderPeriod}D`;
-};
-
-const workflowStepContainsManager = (reviewers, team) => {
- let managerExists = false;
- // 1. Extract team members
- let { members } = team;
- // 2. Iterate through each reviewer to check if they are a manager of the team
- reviewers.forEach(reviewer => {
- // 3. Find the current user
- let userMember = members.find(member => member.memberid.toString() === reviewer.toString());
- // 4. If the user was found check if they are a manager
- if (userMember) {
- let { roles } = userMember;
- if (roles.includes(constants.roleTypes.MANAGER)) {
- managerExists = true;
+ async deleteWorkflow(req, res) {
+ try {
+ const { _id: userId } = req.user;
+ const { id: workflowId } = req.params;
+ // 1. Look up workflow
+ const workflow = await WorkflowModel.findOne({
+ _id: req.params.id,
+ }).populate({
+ path: 'publisher steps.reviewers',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
+ });
+ if (!workflow) {
+ return res.status(404).json({ success: false });
}
- }
- });
- return managerExists;
-};
-
-const buildNextStep = (userId, application, activeStepIndex, override) => {
- // Check the current position of the application within its assigned workflow
- const finalStep = activeStepIndex === application.workflow.steps.length - 1;
- const requiredReviews = application.workflow.steps[activeStepIndex].reviewers.length;
- const completedReviews = application.workflow.steps[activeStepIndex].recommendations.length;
- const stepComplete = completedReviews === requiredReviews;
- // Establish base payload for Camunda
- // (1) phaseApproved is passed as true when the manager is overriding the current step/phase
- // this short circuits the review process in the workflow and closes any remaining user tasks
- // i.e. reviewers within the active step OR when the last reviewer in the step submits a vote
- // (2) managerApproved is passed as true when the manager is approving the entire application
- // from any point within the review process
- // (3) finalPhaseApproved is passed as true when the final step is completed naturally through all
- // reviewers casting their votes
- let bpmContext = {
- businessKey: application._id,
- dataRequestUserId: userId.toString(),
- managerApproved: override,
- phaseApproved: (override && !finalStep) || stepComplete,
- finalPhaseApproved: finalStep,
- stepComplete,
- };
- if (!finalStep) {
- // Extract the information for the next step defintion
- let { name: dataRequestPublisher } = application.publisherObj;
- let nextStep = application.workflow.steps[activeStepIndex + 1];
- let reviewerList = nextStep.reviewers.map(reviewer => reviewer._id.toString());
- let { stepName: dataRequestStepName } = nextStep;
- // Update Camunda payload with the next step information
- bpmContext = {
- ...bpmContext,
- dataRequestPublisher,
- dataRequestStepName,
- notifyReviewerSLA: calculateStepDeadlineReminderDate(nextStep),
- reviewerList,
- };
- }
- return bpmContext;
-};
-
-const getWorkflowCompleted = (workflow = {}) => {
- let workflowCompleted = false;
- if (!_.isEmpty(workflow)) {
- let { steps } = workflow;
- workflowCompleted = steps.every(step => step.completed);
- }
- return workflowCompleted;
-};
-
-const getActiveWorkflowStep = (workflow = {}) => {
- let activeStep = {};
- if (!_.isEmpty(workflow)) {
- let { steps } = workflow;
- activeStep = steps.find(step => {
- return step.active;
- });
- }
- return activeStep;
-};
-
-const getStepReviewers = (step = {}) => {
- let stepReviewers = [];
- // Attempt to get step reviewers if workflow passed
- if (!_.isEmpty(step)) {
- // Get active reviewers
- if (step) {
- ({ reviewers: stepReviewers } = step);
- }
- }
- return stepReviewers;
-};
-
-const getRemainingReviewers = (Step = {}, users) => {
- let { reviewers = [], recommendations = [] } = Step;
- let remainingActioners = reviewers.filter(reviewer => !recommendations.some(rec => rec.reviewer.toString() === reviewer._id.toString()));
- remainingActioners = [...users].filter(user => remainingActioners.some(actioner => actioner._id.toString() === user._id.toString()));
-
- return remainingActioners;
-};
-
-const getActiveStepStatus = (activeStep, users = [], userId = '') => {
- let reviewStatus = '',
- deadlinePassed = false,
- remainingActioners = [],
- decisionMade = false,
- decisionComments = '',
- decisionApproved = false,
- decisionDate = '',
- decisionStatus = '';
- let { stepName, deadline, startDateTime, reviewers = [], recommendations = [], sections = [] } = activeStep;
- let deadlineDate = moment(startDateTime).add(deadline, 'days');
- let diff = parseInt(deadlineDate.diff(new Date(), 'days'));
- if (diff > 0) {
- reviewStatus = `Deadline in ${diff} days`;
- } else if (diff < 0) {
- reviewStatus = `Deadline was ${Math.abs(diff)} days ago`;
- deadlinePassed = true;
- } else {
- reviewStatus = `Deadline is today`;
- }
- remainingActioners = reviewers.filter(reviewer => !recommendations.some(rec => rec.reviewer.toString() === reviewer._id.toString()));
- remainingActioners = users
- .filter(user => remainingActioners.some(actioner => actioner._id.toString() === user._id.toString()))
- .map(user => {
- let isCurrentUser = user._id.toString() === userId.toString();
- return `${user.firstname} ${user.lastname}${isCurrentUser ? ` (you)` : ``}`;
- });
-
- let isReviewer = reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
- let hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
-
- decisionMade = isReviewer && hasRecommended;
-
- if (decisionMade) {
- decisionStatus = 'Decision made for this phase';
- } else if (isReviewer) {
- decisionStatus = 'Decision required';
- } else {
- decisionStatus = '';
- }
-
- if (hasRecommended) {
- let recommendation = recommendations.find(rec => rec.reviewer.toString() === userId.toString());
- ({ comments: decisionComments, approved: decisionApproved, createdDate: decisionDate } = recommendation);
- }
-
- let reviewPanels = sections.map(section => constants.darPanelMapper[section]).join(', ');
-
- return {
- stepName,
- remainingActioners: remainingActioners.join(', '),
- deadlinePassed,
- isReviewer,
- reviewStatus,
- decisionMade,
- decisionApproved,
- decisionDate,
- decisionStatus,
- decisionComments,
- reviewPanels,
- };
-};
-
-const getWorkflowStatus = application => {
- let workflowStatus = {};
- let { workflow = {} } = application;
- if (!_.isEmpty(workflow)) {
- let { workflowName, steps } = workflow;
- // Find the active step in steps
- let activeStep = getActiveWorkflowStep(workflow);
- let activeStepIndex = steps.findIndex(step => {
- return step.active === true;
- });
- if (activeStep) {
- let { reviewStatus, deadlinePassed } = getActiveStepStatus(activeStep);
- //Update active step with review status
- steps[activeStepIndex] = {
- ...steps[activeStepIndex],
- reviewStatus,
- deadlinePassed,
- };
- }
- //Update steps with user friendly review sections
- let formattedSteps = [...steps].reduce((arr, item) => {
- let step = {
- ...item,
- sections: [...item.sections].map(section => constants.darPanelMapper[section]),
- };
- arr.push(step);
- return arr;
- }, []);
-
- workflowStatus = {
- workflowName,
- steps: formattedSteps,
- isCompleted: getWorkflowCompleted(workflow),
- };
- }
- return workflowStatus;
-};
-
-const getReviewStatus = (application, userId) => {
- let inReviewMode = false,
- reviewSections = [],
- isActiveStepReviewer = false,
- hasRecommended = false;
- // Get current application status
- let { applicationStatus } = application;
- // Check if the current user is a reviewer on the current step of an attached workflow
- let { workflow = {} } = application;
- if (!_.isEmpty(workflow)) {
- let { steps } = workflow;
- let activeStep = steps.find(step => {
- return step.active === true;
- });
- if (activeStep) {
- isActiveStepReviewer = activeStep.reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
- reviewSections = [...activeStep.sections];
-
- let { recommendations = [] } = activeStep;
- if (!_.isEmpty(recommendations)) {
- hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
+ // 2. Check the requesting user is a manager of the custodian team
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
+ // 3. Refuse access if not authorised
+ if (!authorised) {
+ return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
}
- }
- }
- // Return active review mode if conditions apply
- if (applicationStatus === 'inReview' && isActiveStepReviewer) {
- inReviewMode = true;
- }
-
- return { inReviewMode, reviewSections, hasRecommended };
-};
-
-const getWorkflowEmailContext = (accessRecord, workflow, relatedStepIndex) => {
- // Extract workflow email variables
- const { dateReviewStart = '' } = accessRecord;
- const { workflowName, steps } = workflow;
- const { stepName, startDateTime = '', endDateTime = '', completed = false, deadline: stepDeadline = 0, reminderOffset = 0 } = steps[
- relatedStepIndex
- ];
- const stepReviewers = getStepReviewers(steps[relatedStepIndex]);
- const reviewerNames = [...stepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
- const reviewSections = [...steps[relatedStepIndex].sections].map(section => constants.darPanelMapper[section]).join(', ');
- const stepReviewerUserIds = [...stepReviewers].map(user => user.id);
- const currentDeadline = stepDeadline === 0 ? 'No deadline specified' : moment().add(stepDeadline, 'days');
- let nextStepName = '',
- nextReviewerNames = '',
- nextReviewSections = '',
- duration = '',
- totalDuration = '',
- nextDeadline = '',
- dateDeadline = '',
- deadlineElapsed = false,
- deadlineApproaching = false,
- remainingReviewers = [],
- remainingReviewerUserIds = [];
-
- // Calculate duration for step if it is completed
- if (completed) {
- if (!_.isEmpty(startDateTime.toString()) && !_.isEmpty(endDateTime.toString())) {
- duration = moment(endDateTime).diff(moment(startDateTime), 'days');
- duration = duration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
- }
- } else {
- //If related step is not completed, check if deadline has elapsed or is approaching
- if (!_.isEmpty(startDateTime.toString()) && stepDeadline != 0) {
- dateDeadline = moment(startDateTime).add(stepDeadline, 'days');
- deadlineElapsed = moment().isAfter(dateDeadline, 'second');
-
- // If deadline is not elapsed, check if it is within SLA period
- if (!deadlineElapsed && reminderOffset !== 0) {
- let deadlineReminderDate = moment(dateDeadline).subtract(reminderOffset, 'days');
- deadlineApproaching = moment().isAfter(deadlineReminderDate, 'second');
+ // 4. Ensure there are no in-review DARs with this workflow
+ const applications = await DataRequestModel.countDocuments({
+ workflowId,
+ applicationStatus: 'inReview',
+ });
+ if (applications > 0) {
+ return res.status(400).json({
+ success: false,
+ message: 'A workflow which is attached to applications currently in review cannot be deleted',
+ });
}
+ // 5. Delete workflow
+ WorkflowModel.deleteOne({ _id: workflowId }, function (err) {
+ if (err) {
+ console.error(err.message);
+ return res.status(400).json({
+ success: false,
+ message: 'An error occurred deleting the workflow',
+ });
+ } else {
+ // 7. Return workflow payload
+ return res.status(204).json({
+ success: true,
+ });
+ }
+ });
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
+ success: false,
+ message: 'An error occurred deleting the workflow',
+ });
}
- // Find reviewers of the current incomplete phase
- let accessRecordObj = accessRecord.toObject();
- if (_.has(accessRecordObj, 'publisherObj.team.users')) {
- let {
- publisherObj: {
- team: { users = [] },
- },
- } = accessRecordObj;
- remainingReviewers = getRemainingReviewers(steps[relatedStepIndex], users);
- remainingReviewerUserIds = [...remainingReviewers].map(user => user.id);
- }
- }
-
- // Check if there is another step after the current related step
- if (relatedStepIndex + 1 === steps.length) {
- // If workflow completed
- nextStepName = 'No next step';
- // Calculate total duration for workflow
- if (steps[relatedStepIndex].completed && !_.isEmpty(dateReviewStart.toString())) {
- totalDuration = moment().diff(moment(dateReviewStart), 'days');
- totalDuration = totalDuration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
- }
- } else {
- // Get details of next step if this is not the final step
- ({ stepName: nextStepName } = steps[relatedStepIndex + 1]);
- let nextStepReviewers = getStepReviewers(steps[relatedStepIndex + 1]);
- nextReviewerNames = [...nextStepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
- nextReviewSections = [...steps[relatedStepIndex + 1].sections].map(section => constants.darPanelMapper[section]).join(', ');
- let { deadline = 0 } = steps[relatedStepIndex + 1];
- nextDeadline = deadline === 0 ? 'No deadline specified' : moment().add(deadline, 'days');
}
- return {
- workflowName,
- steps,
- stepName,
- startDateTime,
- endDateTime,
- stepReviewers,
- duration,
- totalDuration,
- reviewerNames,
- stepReviewerUserIds,
- reviewSections,
- currentDeadline,
- nextStepName,
- nextReviewerNames,
- nextReviewSections,
- nextDeadline,
- dateDeadline,
- deadlineElapsed,
- deadlineApproaching,
- remainingReviewers,
- remainingReviewerUserIds,
- };
-};
-
-export default {
- getWorkflowById: getWorkflowById,
- createWorkflow: createWorkflow,
- updateWorkflow: updateWorkflow,
- deleteWorkflow: deleteWorkflow,
- calculateStepDeadlineReminderDate: calculateStepDeadlineReminderDate,
- workflowStepContainsManager: workflowStepContainsManager,
- buildNextStep: buildNextStep,
- getWorkflowCompleted: getWorkflowCompleted,
- getActiveWorkflowStep: getActiveWorkflowStep,
- getStepReviewers: getStepReviewers,
- getActiveStepStatus: getActiveStepStatus,
- getWorkflowStatus: getWorkflowStatus,
- getReviewStatus: getReviewStatus,
- getWorkflowEmailContext: getWorkflowEmailContext,
- createNotifications: createNotifications,
-};
+}
diff --git a/src/resources/workflow/workflow.repository.js b/src/resources/workflow/workflow.repository.js
new file mode 100644
index 00000000..358fc61b
--- /dev/null
+++ b/src/resources/workflow/workflow.repository.js
@@ -0,0 +1,75 @@
+import Repository from '../base/repository';
+import { WorkflowModel } from './workflow.model';
+
+export default class WorkflowRepository extends Repository {
+ constructor() {
+ super(WorkflowModel);
+ this.workflowModel = WorkflowModel;
+ }
+
+ getWorkflowsByPublisher(id) {
+ return WorkflowModel.find({
+ publisher: id,
+ })
+ .populate([
+ {
+ path: 'publisher',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
+ },
+ {
+ path: 'steps.reviewers',
+ model: 'User',
+ select: '_id id firstname lastname',
+ },
+ {
+ path: 'applications',
+ select: 'aboutApplication',
+ match: { applicationStatus: 'inReview' },
+ },
+ ])
+ .lean();
+ }
+
+ getWorkflowById(id, options = {}) {
+ return WorkflowModel.findOne(
+ {
+ _id: id,
+ }, //lgtm [js/sql-injection]
+ null,
+ options
+ )
+ .populate([
+ {
+ path: 'steps.reviewers',
+ model: 'User',
+ select: '_id id firstname lastname email',
+ },
+ ])
+ .lean();
+ }
+
+ async assignWorkflowToApplication(accessRecord, workflowId) {
+ // Retrieve workflow using ID from database
+ const workflow = await this.getWorkflowById(workflowId, { lean: false });
+ if (!workflow) {
+ throw new Error('Workflow could not be found');
+ }
+ // Set first workflow step active and ensure all others are false
+ const workflowObj = workflow;
+ workflowObj.steps = workflowObj.steps.map(step => {
+ return { ...step, active: false };
+ });
+ workflowObj.steps[0].active = true;
+ workflowObj.steps[0].startDateTime = new Date();
+ // Update application with attached workflow
+ accessRecord.workflowId = workflowId;
+ accessRecord.workflow = workflowObj;
+ await accessRecord.save();
+
+ return accessRecord;
+ }
+}
diff --git a/src/resources/workflow/workflow.route.js b/src/resources/workflow/workflow.route.js
index 75910fb1..e2dd08b3 100644
--- a/src/resources/workflow/workflow.route.js
+++ b/src/resources/workflow/workflow.route.js
@@ -1,27 +1,52 @@
import express from 'express';
import passport from 'passport';
-import workflowController from './workflow.controller';
+import { logger } from '../utilities/logger';
+import WorkflowController from './workflow.controller';
+import { workflowService } from './dependency';
+
+const workflowController = new WorkflowController(workflowService);
+const logCategory = 'Workflow';
const router = express.Router();
// @route GET api/v1/workflows/:id
// @desc Fetch a workflow by id
// @access Private
-router.get('/:id', passport.authenticate('jwt'), workflowController.getWorkflowById);
+router.get(
+ '/:id',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Viewed a workflow instance details' }),
+ (req, res) => workflowController.getWorkflowById(req, res)
+);
// @route POST api/v1/workflows/
// @desc Create a new workflow
// @access Private
-router.post('/', passport.authenticate('jwt'), workflowController.createWorkflow);
+router.post(
+ '/',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Creating a new workflow definition' }),
+ (req, res) => workflowController.createWorkflow(req, res)
+);
// @route PUT api/v1/workflows/:id
// @desc Edit a workflow by id
// @access Private
-router.put('/:id', passport.authenticate('jwt'), workflowController.updateWorkflow);
+router.put(
+ '/:id',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Updating an existing workflow definition' }),
+ (req, res) => workflowController.updateWorkflow(req, res)
+);
// @route DELETE api/v1/workflows/
// @desc Delete a workflow by id
// @access Private
-router.delete('/:id', passport.authenticate('jwt'), workflowController.deleteWorkflow);
+router.delete(
+ '/:id',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Deleting a workflow definition' }),
+ (req, res) => workflowController.deleteWorkflow(req, res)
+);
module.exports = router;
diff --git a/src/resources/workflow/workflow.service.js b/src/resources/workflow/workflow.service.js
new file mode 100644
index 00000000..6af0cfac
--- /dev/null
+++ b/src/resources/workflow/workflow.service.js
@@ -0,0 +1,538 @@
+import moment from 'moment';
+import { isEmpty, has } from 'lodash';
+
+import teamController from '../team/team.controller';
+import constants from '../utilities/constants.util';
+import emailGenerator from '../utilities/emailGenerator.util';
+import notificationBuilder from '../utilities/notificationBuilder';
+
+const bpmController = require('../bpmnworkflow/bpmnworkflow.controller');
+
+export default class WorkflowService {
+ constructor(workflowRepository) {
+ this.workflowRepository = workflowRepository;
+ }
+
+ getApplicationWorkflowStatusForUser(accessRecord, requestingUserObjectId) {
+ // Set the review mode if user is a custodian reviewing the current step
+ let { inReviewMode, reviewSections, hasRecommended } = this.getReviewStatus(accessRecord, requestingUserObjectId);
+ // Get the workflow/voting status
+ let workflow = this.getWorkflowStatus(accessRecord);
+ let isManager = false;
+ // Check if the current user can override the current step
+ if (has(accessRecord, 'publisherObj.team')) {
+ const { team } = accessRecord.publisherObj;
+ isManager = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, team, requestingUserObjectId);
+ // Set the workflow override capability if there is an active step and user is a manager
+ if (!isEmpty(workflow)) {
+ workflow.canOverrideStep = !workflow.isCompleted && isManager;
+ }
+ }
+ return { inReviewMode, reviewSections, hasRecommended, isManager, workflow };
+ }
+
+ async getWorkflowsByPublisher(id) {
+ const workflows = await this.workflowRepository.getWorkflowsByPublisher(id);
+
+ const formattedWorkflows = [...workflows].map(workflow => {
+ let { active, _id, id, workflowName, version, applications = [], publisher } = workflow;
+ const formattedSteps = this.formatWorkflowSteps(workflow, 'displaySections');
+ return {
+ active,
+ _id,
+ id,
+ workflowName,
+ version,
+ steps: formattedSteps,
+ appCount: applications.length,
+ canDelete: applications.length === 0,
+ canEdit: applications.length === 0,
+ publisher,
+ };
+ });
+
+ return formattedWorkflows;
+ }
+
+ async assignWorkflowToApplication(accessRecord, workflowId) {
+ return this.workflowRepository.assignWorkflowToApplication(accessRecord, workflowId);
+ }
+
+ getWorkflowById(id){
+ return this.workflowRepository.getWorkflowById(id);
+ }
+
+ getWorkflowDetails(accessRecord, requestingUserId) {
+ if (!has(accessRecord, 'publisherObj.team.members')) return accessRecord;
+
+ let { workflow = {} } = accessRecord;
+
+ const activeStep = this.getActiveWorkflowStep(workflow);
+ accessRecord = this.getRemainingActioners(accessRecord, activeStep, requestingUserId);
+
+ if (isEmpty(workflow)) return accessRecord;
+
+ accessRecord.workflowName = workflow.workflowName;
+ accessRecord.workflowCompleted = this.getWorkflowCompleted(workflow);
+
+ if (isEmpty(activeStep)) return accessRecord;
+
+ const activeStepDetails = this.getActiveStepStatus(activeStep, requestingUserId);
+ accessRecord = { ...accessRecord, ...activeStepDetails };
+
+ accessRecord = this.setActiveStepReviewStatus(accessRecord);
+
+ accessRecord.workflow.steps = this.formatWorkflowSteps(workflow, 'sections');
+
+ return accessRecord;
+ }
+
+ formatWorkflowSteps(workflow, sectionsKey) {
+ // Set review section to display format
+ const { steps = [] } = workflow;
+ let formattedSteps = [...steps].reduce((arr, item) => {
+ let step = {
+ ...item,
+ [sectionsKey]: [...item.sections].map(section => constants.darPanelMapper[section]),
+ };
+ arr.push(step);
+ return arr;
+ }, []);
+ return [...formattedSteps];
+ }
+
+ setActiveStepReviewStatus(accessRecord) {
+ const { workflow } = accessRecord;
+ if (!workflow) return '';
+
+ let activeStepIndex = workflow.steps.findIndex(step => {
+ return step.active === true;
+ });
+
+ if (activeStepIndex === -1) return '';
+
+ accessRecord.workflow.steps[activeStepIndex].reviewStatus = accessRecord.reviewStatus;
+
+ return accessRecord;
+ }
+
+ getRemainingActioners(accessRecord, activeStep = {}, requestingUserId) {
+ let {
+ workflow = {},
+ applicationStatus,
+ publisherObj: { team },
+ } = accessRecord;
+
+ if (
+ applicationStatus === constants.applicationStatuses.SUBMITTED ||
+ (applicationStatus === constants.applicationStatuses.INREVIEW && isEmpty(workflow))
+ ) {
+ accessRecord.remainingActioners = this.getReviewManagers(team, requestingUserId).join(', ');
+ } else if (!isEmpty(workflow) && isEmpty(activeStep) && applicationStatus === constants.applicationStatuses.INREVIEW) {
+ remainingActioners = this.getReviewManagers(team, requestingUserId).join(', ');
+ accessRecord.reviewStatus = 'Final decision required';
+ } else {
+ accessRecord.remainingActioners = this.getRemainingReviewerNames(activeStep, team.users, requestingUserId);
+ }
+
+ return accessRecord;
+ }
+
+ getReviewManagers(team, requestingUserId) {
+ const { members = [], users = [] } = team;
+ const managers = members.filter(mem => {
+ return mem.roles.includes('manager');
+ });
+ return users
+ .filter(user => managers.some(manager => manager.memberid.toString() === user._id.toString()))
+ .map(user => {
+ const isCurrentUser = user._id.toString() === requestingUserId.toString();
+ return `${user.firstname} ${user.lastname}${isCurrentUser ? ` (you)` : ``}`;
+ });
+ }
+
+ async createNotifications(context, type = '') {
+ if (!isEmpty(type)) {
+ // local variables set here
+ let custodianManagers = [],
+ managerUserIds = [],
+ options = {},
+ html = '';
+
+ // deconstruct context
+ let { publisherObj, workflow = {}, actioner = '' } = context;
+
+ // switch over types
+ switch (type) {
+ case constants.notificationTypes.WORKFLOWCREATED:
+ // 1. Get managers for publisher
+ custodianManagers = teamController.getTeamMembersByRole(publisherObj, constants.roleTypes.MANAGER);
+ // 2. Get managerIds for notifications
+ managerUserIds = custodianManagers.map(user => user.id);
+ // 3. deconstruct workflow
+ let { workflowName = 'Workflow Title', _id, steps, createdAt } = workflow;
+ // 4. setup options
+ options = {
+ actioner,
+ workflowName,
+ _id,
+ steps,
+ createdAt,
+ };
+ // 4. Create notifications for the managers only
+ await notificationBuilder.triggerNotificationMessage(
+ managerUserIds,
+ `A new workflow of ${workflowName} has been created`,
+ 'workflow',
+ _id
+ );
+ // 5. Generate the email
+ html = await emailGenerator.generateWorkflowCreated(options);
+ // 6. Send email to custodian managers only within the team
+ await emailGenerator.sendEmail(custodianManagers, constants.hdrukEmail, `A Workflow has been created`, html, false);
+ break;
+ }
+ }
+ }
+
+ calculateStepDeadlineReminderDate(step) {
+ // Extract deadline and reminder offset in days from step definition
+ let { deadline, reminderOffset } = step;
+ // Subtract SLA reminder offset
+ let reminderPeriod = +deadline - +reminderOffset;
+ return `P${reminderPeriod}D`;
+ }
+
+ buildNextStep(userId, application, activeStepIndex, override) {
+ // Check the current position of the application within its assigned workflow
+ const finalStep = activeStepIndex === application.workflow.steps.length - 1;
+ const requiredReviews = application.workflow.steps[activeStepIndex].reviewers.length;
+ const completedReviews = application.workflow.steps[activeStepIndex].recommendations.length;
+ const stepComplete = completedReviews === requiredReviews;
+ // Establish base payload for Camunda
+ // (1) phaseApproved is passed as true when the manager is overriding the current step/phase
+ // this short circuits the review process in the workflow and closes any remaining user tasks
+ // i.e. reviewers within the active step OR when the last reviewer in the step submits a vote
+ // (2) managerApproved is passed as true when the manager is approving the entire application
+ // from any point within the review process
+ // (3) finalPhaseApproved is passed as true when the final step is completed naturally through all
+ // reviewers casting their votes
+ let bpmContext = {
+ businessKey: application._id,
+ dataRequestUserId: userId.toString(),
+ managerApproved: override,
+ phaseApproved: (override && !finalStep) || stepComplete,
+ finalPhaseApproved: finalStep,
+ stepComplete,
+ };
+ if (!finalStep) {
+ // Extract the information for the next step defintion
+ let { name: dataRequestPublisher } = application.publisherObj;
+ let nextStep = application.workflow.steps[activeStepIndex + 1];
+ let reviewerList = nextStep.reviewers.map(reviewer => reviewer._id.toString());
+ let { stepName: dataRequestStepName } = nextStep;
+ // Update Camunda payload with the next step information
+ bpmContext = {
+ ...bpmContext,
+ dataRequestPublisher,
+ dataRequestStepName,
+ notifyReviewerSLA: this.calculateStepDeadlineReminderDate(nextStep),
+ reviewerList,
+ };
+ }
+ return bpmContext;
+ }
+
+ getWorkflowCompleted(workflow = {}) {
+ let workflowCompleted = false;
+ if (!isEmpty(workflow)) {
+ let { steps } = workflow;
+ workflowCompleted = steps.every(step => step.completed);
+ }
+ return workflowCompleted;
+ }
+
+ getActiveWorkflowStep(workflow = {}) {
+ let activeStep = {};
+ if (!isEmpty(workflow)) {
+ let { steps } = workflow;
+ activeStep = steps.find(step => {
+ return step.active;
+ });
+ }
+ return activeStep;
+ }
+
+ getStepReviewers(step = {}) {
+ let stepReviewers = [];
+ // Attempt to get step reviewers if workflow passed
+ if (!isEmpty(step)) {
+ // Get active reviewers
+ if (step) {
+ ({ reviewers: stepReviewers } = step);
+ }
+ }
+ return stepReviewers;
+ }
+
+ getRemainingReviewers(step = {}, users) {
+ let { reviewers = [], recommendations = [] } = step;
+ let remainingActioners = reviewers.filter(
+ reviewer => !recommendations.some(rec => rec.reviewer.toString() === reviewer._id.toString())
+ );
+ remainingActioners = [...users].filter(user => remainingActioners.some(actioner => actioner._id.toString() === user._id.toString()));
+
+ return remainingActioners;
+ }
+
+ getRemainingReviewerNames(step = {}, users, requestingUserId) {
+ if (isEmpty(step)) return '';
+ let remainingActioners = this.getRemainingReviewers(step, users);
+
+ if (isEmpty(remainingActioners)) return '';
+
+ let remainingReviewerNames = remainingActioners.map(user => {
+ let isCurrentUser = user._id.toString() === requestingUserId.toString();
+ return `${user.firstname} ${user.lastname}${isCurrentUser ? ` (you)` : ``}`;
+ });
+
+ return remainingReviewerNames.join(', ');
+ }
+
+ getActiveStepStatus(activeStep, userId = '') {
+ let reviewStatus = '',
+ deadlinePassed = false,
+ decisionMade = false,
+ decisionComments = '',
+ decisionApproved = false,
+ decisionDate = '',
+ decisionStatus = '';
+ let { stepName = '', deadline, startDateTime, reviewers = [], recommendations = [], sections = [] } = activeStep;
+ let deadlineDate = moment(startDateTime).add(deadline, 'days');
+ let diff = parseInt(deadlineDate.diff(new Date(), 'days'));
+ if (diff > 0) {
+ reviewStatus = `Deadline in ${diff} days`;
+ } else if (diff < 0) {
+ reviewStatus = `Deadline was ${Math.abs(diff)} days ago`;
+ deadlinePassed = true;
+ } else {
+ reviewStatus = `Deadline is today`;
+ }
+
+ let isReviewer = reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
+ let hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
+
+ decisionMade = isReviewer && hasRecommended;
+
+ if (decisionMade) {
+ decisionStatus = 'Decision made for this phase';
+ } else if (isReviewer) {
+ decisionStatus = 'Decision required';
+ } else {
+ decisionStatus = '';
+ }
+
+ if (hasRecommended) {
+ let recommendation = recommendations.find(rec => rec.reviewer.toString() === userId.toString());
+ ({ comments: decisionComments, approved: decisionApproved, createdDate: decisionDate } = recommendation);
+ }
+
+ let reviewPanels = sections.map(section => constants.darPanelMapper[section]).join(', ');
+
+ return {
+ stepName,
+ deadlinePassed,
+ isReviewer,
+ reviewStatus,
+ decisionMade,
+ decisionApproved,
+ decisionDate,
+ decisionStatus,
+ decisionComments,
+ reviewPanels,
+ };
+ }
+
+ getWorkflowStatus(application) {
+ let workflowStatus = {};
+ let { workflow = {} } = application;
+ if (!isEmpty(workflow)) {
+ let { workflowName, steps } = workflow;
+ // Find the active step in steps
+ let activeStep = this.getActiveWorkflowStep(workflow);
+ let activeStepIndex = steps.findIndex(step => {
+ return step.active === true;
+ });
+ if (activeStep) {
+ let { reviewStatus, deadlinePassed } = this.getActiveStepStatus(activeStep);
+ //Update active step with review status
+ steps[activeStepIndex] = {
+ ...steps[activeStepIndex],
+ reviewStatus,
+ deadlinePassed,
+ };
+ }
+ //Update steps with user friendly review sections
+ let formattedSteps = [...steps].reduce((arr, item) => {
+ let step = {
+ ...item,
+ sections: [...item.sections].map(section => constants.darPanelMapper[section]),
+ };
+ arr.push(step);
+ return arr;
+ }, []);
+
+ workflowStatus = {
+ workflowName,
+ steps: formattedSteps,
+ isCompleted: this.getWorkflowCompleted(workflow),
+ };
+ }
+ return workflowStatus;
+ }
+
+ getReviewStatus(application, userId) {
+ let inReviewMode = false,
+ reviewSections = [],
+ isActiveStepReviewer = false,
+ hasRecommended = false;
+ // Get current application status
+ let { applicationStatus } = application;
+ // Check if the current user is a reviewer on the current step of an attached workflow
+ let { workflow = {} } = application;
+ if (!isEmpty(workflow)) {
+ let { steps } = workflow;
+ let activeStep = steps.find(step => {
+ return step.active === true;
+ });
+ if (activeStep) {
+ isActiveStepReviewer = activeStep.reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
+ reviewSections = [...activeStep.sections];
+
+ let { recommendations = [] } = activeStep;
+ if (!isEmpty(recommendations)) {
+ hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
+ }
+ }
+ }
+ // Return active review mode if conditions apply
+ if (applicationStatus === 'inReview' && isActiveStepReviewer) {
+ inReviewMode = true;
+ }
+
+ return { inReviewMode, reviewSections, hasRecommended };
+ }
+
+ getWorkflowEmailContext(accessRecord, relatedStepIndex = 0) {
+ // Extract workflow email variables
+ const { dateReviewStart = '', workflow = {} } = accessRecord;
+ const { workflowName, steps } = workflow;
+ const { stepName, startDateTime = '', endDateTime = '', completed = false, deadline: stepDeadline = 0, reminderOffset = 0 } = steps[
+ relatedStepIndex
+ ];
+ const stepReviewers = this.getStepReviewers(steps[relatedStepIndex]);
+ const reviewerNames = [...stepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
+ const reviewSections = [...steps[relatedStepIndex].sections].map(section => constants.darPanelMapper[section]).join(', ');
+ const stepReviewerUserIds = [...stepReviewers].map(user => user.id);
+ const currentDeadline = stepDeadline === 0 ? 'No deadline specified' : moment().add(stepDeadline, 'days');
+ let nextStepName = '',
+ nextReviewerNames = '',
+ nextReviewSections = '',
+ duration = '',
+ totalDuration = '',
+ nextDeadline = '',
+ dateDeadline = '',
+ deadlineElapsed = false,
+ deadlineApproaching = false,
+ remainingReviewers = [],
+ remainingReviewerUserIds = [];
+
+ // Calculate duration for step if it is completed
+ if (completed) {
+ if (!isEmpty(startDateTime.toString()) && !isEmpty(endDateTime.toString())) {
+ duration = moment(endDateTime).diff(moment(startDateTime), 'days');
+ duration = duration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
+ }
+ } else {
+ //If related step is not completed, check if deadline has elapsed or is approaching
+ if (!isEmpty(startDateTime.toString()) && stepDeadline != 0) {
+ dateDeadline = moment(startDateTime).add(stepDeadline, 'days');
+ deadlineElapsed = moment().isAfter(dateDeadline, 'second');
+
+ // If deadline is not elapsed, check if it is within SLA period
+ if (!deadlineElapsed && reminderOffset !== 0) {
+ let deadlineReminderDate = moment(dateDeadline).subtract(reminderOffset, 'days');
+ deadlineApproaching = moment().isAfter(deadlineReminderDate, 'second');
+ }
+ }
+ // Find reviewers of the current incomplete phase
+ let accessRecordObj = accessRecord.toObject();
+ if (has(accessRecordObj, 'publisherObj.team.users')) {
+ let {
+ publisherObj: {
+ team: { users = [] },
+ },
+ } = accessRecordObj;
+ remainingReviewers = this.getRemainingReviewers(steps[relatedStepIndex], users);
+ remainingReviewerUserIds = [...remainingReviewers].map(user => user.id);
+ }
+ }
+
+ // Check if there is another step after the current related step
+ if (relatedStepIndex + 1 === steps.length) {
+ // If workflow completed
+ nextStepName = 'No next step';
+ // Calculate total duration for workflow
+ if (steps[relatedStepIndex].completed && !isEmpty(dateReviewStart.toString())) {
+ totalDuration = moment().diff(moment(dateReviewStart), 'days');
+ totalDuration = totalDuration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
+ }
+ } else {
+ // Get details of next step if this is not the final step
+ ({ stepName: nextStepName } = steps[relatedStepIndex + 1]);
+ let nextStepReviewers = this.getStepReviewers(steps[relatedStepIndex + 1]);
+ nextReviewerNames = [...nextStepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
+ nextReviewSections = [...steps[relatedStepIndex + 1].sections].map(section => constants.darPanelMapper[section]).join(', ');
+ let { deadline = 0 } = steps[relatedStepIndex + 1];
+ nextDeadline = deadline === 0 ? 'No deadline specified' : moment().add(deadline, 'days');
+ }
+ return {
+ workflowName,
+ steps,
+ stepName,
+ startDateTime,
+ endDateTime,
+ stepReviewers,
+ duration,
+ totalDuration,
+ reviewerNames,
+ stepReviewerUserIds,
+ reviewSections,
+ currentDeadline,
+ nextStepName,
+ nextReviewerNames,
+ nextReviewSections,
+ nextDeadline,
+ dateDeadline,
+ deadlineElapsed,
+ deadlineApproaching,
+ remainingReviewers,
+ remainingReviewerUserIds,
+ };
+ }
+
+ startWorkflow(accessRecord, requestingUserObjectId) {
+ const { publisherObj: { name: dataRequestPublisher }, _id, workflow } = accessRecord;
+ const reviewerList = workflow.steps[0].reviewers.map(reviewer => reviewer._id.toString());
+ const bpmContext = {
+ businessKey: _id,
+ dataRequestStatus: constants.applicationStatuses.INREVIEW,
+ dataRequestUserId: requestingUserObjectId.toString(),
+ dataRequestPublisher,
+ dataRequestStepName: workflow.steps[0].stepName,
+ notifyReviewerSLA: this.calculateStepDeadlineReminderDate(workflow.steps[0]),
+ reviewerList,
+ };
+ bpmController.postStartStepReview(bpmContext);
+ }
+}
| + ${!_.isEmpty(type) && type === 'admin' ? `A new ${resourceType} has been added and is ready for review` : ``} + ${!_.isEmpty(type) && type === 'author' ? `${subject}` : ``} + ${ + !_.isEmpty(type) && type === 'co-author' + ? `${resourceAuthor} added you as an author of the ${resourceType} ${resourceName}` + : `` + } + | +
|---|
|
+ + ${ + !_.isEmpty(type) && type === 'admin' + ? `${resourceName} ${resourceType} has been added and is pending a review. View and then either approve or reject via the link below.` + : `` + } + ${!_.isEmpty(type) && type === 'author' ? authorBody : ``} + ${ + !_.isEmpty(type) && type === 'co-author' + ? `${resourceAuthor} added you as an author of the ${resourceType} ${resourceName}` + : `` + } + + |
+
| + ${!_.isEmpty(type) && type === 'admin' ? `View ${resourceType}s dashboard` : ``} + ${!_.isEmpty(type) && type === 'author' ? `View ${resourceType}` : ``} + ${!_.isEmpty(type) && type === 'co-author' ? `View ${resourceType}` : ``} + | +
+ `;
+
const _generateEmailFooter = (recipient, allowUnsubscribe) => {
// 1. Generate HTML for unsubscribe link if allowed depending on context
@@ -1999,6 +2343,7 @@ export default {
generateAttachment: _generateAttachment,
//DAR
generateEmail: _generateEmail,
+ generateAmendEmail: _generateAmendEmail,
generateDARReturnedEmail: _generateDARReturnedEmail,
generateDARStatusChangedEmail: _generateDARStatusChangedEmail,
generateDARClonedEmail: _generateDARClonedEmail,
@@ -2012,6 +2357,7 @@ export default {
generateTeamNotificationEmail: _generateTeamNotificationEmail,
generateRemovedFromTeam: _generateRemovedFromTeam,
generateAddedToTeam: _generateAddedToTeam,
+ generateNewDARMessage: _generateNewDARMessage,
//Workflows
generateWorkflowAssigned: _generateWorkflowAssigned,
generateWorkflowCreated: _generateWorkflowCreated,
@@ -2019,8 +2365,10 @@ export default {
generateMetadataOnboardingSumbitted: _generateMetadataOnboardingSumbitted,
generateMetadataOnboardingApproved: _generateMetadataOnboardingApproved,
generateMetadataOnboardingRejected: _generateMetadataOnboardingRejected,
+ generateMetadataOnboardingDraftDeleted: _generateMetadataOnboardingDraftDeleted,
//generateMetadataOnboardingArchived: _generateMetadataOnboardingArchived,
//generateMetadataOnboardingUnArchived: _generateMetadataOnboardingUnArchived,
//Messages
generateMessageNotification: _generateMessageNotification,
+ generateEntityNotification: _generateEntityNotification,
};
diff --git a/src/resources/utilities/notificationBuilder.js b/src/resources/utilities/notificationBuilder.js
index d89b7878..5bb081ad 100644
--- a/src/resources/utilities/notificationBuilder.js
+++ b/src/resources/utilities/notificationBuilder.js
@@ -11,7 +11,7 @@ const triggerNotificationMessage = (messageRecipients, messageDescription, messa
messageID,
messageObjectID: typeof messageObjectID == 'number' ? messageObjectID : messageID,
messageTo: recipient,
- messageDataRequestID: messageType === 'data access request' ? messageObjectID : null,
+ messageDataRequestID: messageType === 'data access request' || messageType === 'data access message sent' ? messageObjectID : null,
publisherName,
datasetID: messageType === 'dataset approved' || messageType === 'dataset rejected' ? messageObjectID : null,
});
diff --git a/src/resources/workflow/dependency.js b/src/resources/workflow/dependency.js
new file mode 100644
index 00000000..263ece27
--- /dev/null
+++ b/src/resources/workflow/dependency.js
@@ -0,0 +1,5 @@
+import WorkflowRepository from './workflow.repository';
+import WorkflowService from './workflow.service';
+
+export const workflowRepository = new WorkflowRepository();
+export const workflowService = new WorkflowService(workflowRepository);
diff --git a/src/resources/workflow/workflow.controller.js b/src/resources/workflow/workflow.controller.js
index e3513c6a..f479a4c3 100644
--- a/src/resources/workflow/workflow.controller.js
+++ b/src/resources/workflow/workflow.controller.js
@@ -1,714 +1,304 @@
+import _ from 'lodash';
+import Mongoose from 'mongoose';
+
import { PublisherModel } from '../publisher/publisher.model';
import { DataRequestModel } from '../datarequest/datarequest.model';
import { WorkflowModel } from './workflow.model';
import teamController from '../team/team.controller';
import helper from '../utilities/helper.util';
import constants from '../utilities/constants.util';
-import emailGenerator from '../utilities/emailGenerator.util';
-import notificationBuilder from '../utilities/notificationBuilder';
-
-import moment from 'moment';
-import _ from 'lodash';
-import mongoose from 'mongoose';
+import Controller from '../base/controller';
-// GET api/v1/workflows/:id
-const getWorkflowById = async (req, res) => {
- try {
- // 1. Get the workflow from the database including the team members to check authorisation and the number of in-flight applications
- const workflow = await WorkflowModel.findOne({
- _id: req.params.id,
- }).populate([
- {
- path: 'publisher',
- select: 'team',
- populate: {
- path: 'team',
- select: 'members -_id',
- },
- },
- {
- path: 'steps.reviewers',
- model: 'User',
- select: '_id id firstname lastname',
- },
- {
- path: 'applications',
- select: 'aboutApplication',
- match: { applicationStatus: 'inReview' },
- },
- ]);
- if (!workflow) {
- return res.status(404).json({ success: false });
- }
- // 2. Check the requesting user is a manager of the custodian team
- let { _id: userId } = req.user;
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
- // 3. If not return unauthorised
- if (!authorised) {
- return res.status(401).json({ success: false });
- }
- // 4. Build workflow response
- let { active, _id, id, workflowName, version, steps, applications = [] } = workflow.toObject();
- applications = applications.map(app => {
- let { aboutApplication = {}, _id } = app;
- let { projectName = 'No project name' } = aboutApplication;
- return { projectName, _id };
- });
- // Set operation permissions
- let canDelete = applications.length === 0,
- canEdit = applications.length === 0;
- // 5. Return payload
- return res.status(200).json({
- success: true,
- workflow: {
- active,
- _id,
- id,
- workflowName,
- version,
- steps,
- applications,
- appCount: applications.length,
- canDelete,
- canEdit,
- },
- });
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred searching for the specified workflow',
- });
+export default class WorkflowController extends Controller {
+ constructor(workflowService) {
+ super(workflowService);
+ this.workflowService = workflowService;
}
-};
-// POST api/v1/workflows
-const createWorkflow = async (req, res) => {
- try {
- const { _id: userId, firstname, lastname } = req.user;
- // 1. Look at the payload for the publisher passed
- const { workflowName = '', publisher = '', steps = [] } = req.body;
- if (_.isEmpty(workflowName.trim()) || _.isEmpty(publisher.trim()) || _.isEmpty(steps)) {
- return res.status(400).json({
- success: false,
- message: 'You must supply a workflow name, publisher, and at least one step definition to create a workflow',
+ async getWorkflowById(req, res) {
+ try {
+ // 1. Get the workflow from the database including the team members to check authorisation and the number of in-flight applications
+ const workflow = await WorkflowModel.findOne({
+ _id: req.params.id,
+ }).populate([
+ {
+ path: 'publisher',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
+ },
+ {
+ path: 'steps.reviewers',
+ model: 'User',
+ select: '_id id firstname lastname',
+ },
+ {
+ path: 'applications',
+ select: 'aboutApplication',
+ match: { applicationStatus: 'inReview' },
+ },
+ ]);
+ if (!workflow) {
+ return res.status(404).json({ success: false });
+ }
+ // 2. Check the requesting user is a manager of the custodian team
+ let { _id: userId } = req.user;
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
+ // 3. If not return unauthorised
+ if (!authorised) {
+ return res.status(401).json({ success: false });
+ }
+ // 4. Build workflow response
+ let { active, _id, id, workflowName, version, steps, applications = [] } = workflow.toObject();
+ applications = applications.map(app => {
+ let { aboutApplication = {}, _id } = app;
+ let { projectName = 'No project name' } = aboutApplication;
+ return { projectName, _id };
});
- }
- // 2. Look up publisher and team
- const publisherObj = await PublisherModel.findOne({
- _id: publisher,
- }).populate({
- path: 'team members',
- populate: {
- path: 'users',
- select: '_id id email firstname lastname',
- },
- });
-
- if (!publisherObj) {
- return res.status(400).json({
+ // Set operation permissions
+ let canDelete = applications.length === 0,
+ canEdit = applications.length === 0;
+ // 5. Return payload
+ return res.status(200).json({
+ success: true,
+ workflow: {
+ active,
+ _id,
+ id,
+ workflowName,
+ version,
+ steps,
+ applications,
+ appCount: applications.length,
+ canDelete,
+ canEdit,
+ },
+ });
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
success: false,
- message: 'You must supply a valid publisher to create the workflow against',
+ message: 'An error occurred searching for the specified workflow',
});
}
- // 3. Check the requesting user is a manager of the custodian team
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, publisherObj.team.toObject(), userId);
+ }
- // 4. Refuse access if not authorised
- if (!authorised) {
- return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
- }
- // 5. Create new workflow model
- const id = helper.generatedNumericId();
- // 6. set workflow obj for saving
- let workflow = new WorkflowModel({
- id,
- workflowName,
- publisher,
- steps,
- createdBy: new mongoose.Types.ObjectId(userId),
- });
- // 7. save new workflow to db
- workflow.save(function (err) {
- if (err) {
+ async createWorkflow(req, res) {
+ try {
+ const { _id: userId, firstname, lastname } = req.user;
+ // 1. Look at the payload for the publisher passed
+ const { workflowName = '', publisher = '', steps = [] } = req.body;
+ if (_.isEmpty(workflowName.trim()) || _.isEmpty(publisher.trim()) || _.isEmpty(steps)) {
return res.status(400).json({
success: false,
- message: err.message,
+ message: 'You must supply a workflow name, publisher, and at least one step definition to create a workflow',
});
}
- // 8. populate the workflow with the needed fiedls for our new notification and email
- workflow.populate(
- {
- path: 'steps.reviewers',
- select: 'firstname lastname email -_id',
+ // 2. Look up publisher and team
+ const publisherObj = await PublisherModel.findOne({ //lgtm [js/sql-injection]
+ _id: publisher,
+ }).populate({
+ path: 'team members',
+ populate: {
+ path: 'users',
+ select: '_id id email firstname lastname',
},
- (err, doc) => {
- if (err) {
- // 9. if issue
- return res.status(400).json({
- success: false,
- message: err.message,
- });
- }
- // 10. set context
- let context = {
- publisherObj: publisherObj.team.toObject(),
- actioner: `${firstname} ${lastname}`,
- workflow: doc.toObject(),
- };
- // 11. Generate new notifications / emails for managers of the team only on creation of a workflow
- createNotifications(context, constants.notificationTypes.WORKFLOWCREATED);
- // 12. full complete return
- return res.status(201).json({
- success: true,
- workflow,
- });
- }
- );
- });
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred creating the workflow',
- });
- }
-};
+ });
-// PUT api/v1/workflows/:id
-const updateWorkflow = async (req, res) => {
- try {
- const { _id: userId } = req.user;
- const { id: workflowId } = req.params;
- // 1. Look up workflow
- let workflow = await WorkflowModel.findOne({
- _id: req.params.id,
- }).populate({
- path: 'publisher steps.reviewers',
- select: 'team',
- populate: {
- path: 'team',
- select: 'members -_id',
- },
- });
- if (!workflow) {
- return res.status(404).json({ success: false });
- }
- // 2. Check the requesting user is a manager of the custodian team
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
- // 3. Refuse access if not authorised
- if (!authorised) {
- return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
- }
- // 4. Ensure there are no in-review DARs with this workflow
- const applications = await DataRequestModel.countDocuments({
- workflowId,
- applicationStatus: 'inReview',
- });
- if (applications > 0) {
- return res.status(400).json({
- success: false,
- message: 'A workflow which is attached to applications currently in review cannot be edited',
+ if (!publisherObj) {
+ return res.status(400).json({
+ success: false,
+ message: 'You must supply a valid publisher to create the workflow against',
+ });
+ }
+ // 3. Check the requesting user is a manager of the custodian team
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, publisherObj.team.toObject(), userId);
+
+ // 4. Refuse access if not authorised
+ if (!authorised) {
+ return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
+ }
+ // 5. Create new workflow model
+ const id = helper.generatedNumericId();
+ // 6. set workflow obj for saving
+ let workflow = new WorkflowModel({
+ id,
+ workflowName,
+ publisher,
+ steps,
+ createdBy: new Mongoose.Types.ObjectId(userId),
});
- }
- // 5. Edit workflow
- const { workflowName = '', steps = [] } = req.body;
- let isDirty = false;
- // Check if workflow name updated
- if (!_.isEmpty(workflowName)) {
- workflow.workflowName = workflowName;
- isDirty = true;
- } // Check if steps updated
- if (!_.isEmpty(steps)) {
- workflow.steps = steps;
- isDirty = true;
- } // Perform save if changes have been made
- if (isDirty) {
- workflow.save(async err => {
+ // 7. save new workflow to db
+ workflow = await workflow.save().catch(err => {
if (err) {
- console.error(err.message);
return res.status(400).json({
success: false,
message: err.message,
});
- } else {
- // 7. Return workflow payload
- return res.status(204).json({
- success: true,
- workflow,
- });
}
});
- } else {
- return res.status(200).json({
+ // 8. populate the workflow with the needed fields for our new notification and email
+ const detailedWorkflow = await WorkflowModel.findById(workflow._id).populate({
+ path: 'steps.reviewers',
+ select: 'firstname lastname email -_id',
+ }).lean();
+ // 9. set context
+ let context = {
+ publisherObj: publisherObj.team.toObject(),
+ actioner: `${firstname} ${lastname}`,
+ workflow: detailedWorkflow,
+ };
+ // 10. Generate new notifications / emails for managers of the team only on creation of a workflow
+ this.workflowService.createNotifications(context, constants.notificationTypes.WORKFLOWCREATED);
+ // 11. full complete return
+ return res.status(201).json({
success: true,
+ workflow: detailedWorkflow,
+ });
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
+ success: false,
+ message: 'An error occurred creating the workflow',
});
}
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred editing the workflow',
- });
}
-};
-// DELETE api/v1/workflows/:id
-const deleteWorkflow = async (req, res) => {
- try {
- const { _id: userId } = req.user;
- const { id: workflowId } = req.params;
- // 1. Look up workflow
- const workflow = await WorkflowModel.findOne({
- _id: req.params.id,
- }).populate({
- path: 'publisher steps.reviewers',
- select: 'team',
- populate: {
- path: 'team',
- select: 'members -_id',
- },
- });
- if (!workflow) {
- return res.status(404).json({ success: false });
- }
- // 2. Check the requesting user is a manager of the custodian team
- let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
- // 3. Refuse access if not authorised
- if (!authorised) {
- return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
- }
- // 4. Ensure there are no in-review DARs with this workflow
- const applications = await DataRequestModel.countDocuments({
- workflowId,
- applicationStatus: 'inReview',
- });
- if (applications > 0) {
- return res.status(400).json({
- success: false,
- message: 'A workflow which is attached to applications currently in review cannot be deleted',
+ async updateWorkflow(req, res) {
+ try {
+ const { _id: userId } = req.user;
+ const { id: workflowId } = req.params;
+ // 1. Look up workflow
+ let workflow = await WorkflowModel.findOne({
+ _id: req.params.id,
+ }).populate({
+ path: 'publisher steps.reviewers',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
});
- }
- // 5. Delete workflow
- WorkflowModel.deleteOne({ _id: workflowId }, function (err) {
- if (err) {
- console.error(err.message);
+ if (!workflow) {
+ return res.status(404).json({ success: false });
+ }
+ // 2. Check the requesting user is a manager of the custodian team
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
+ // 3. Refuse access if not authorised
+ if (!authorised) {
+ return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
+ }
+ // 4. Ensure there are no in-review DARs with this workflow
+ const applications = await DataRequestModel.countDocuments({
+ workflowId,
+ applicationStatus: 'inReview',
+ });
+ if (applications > 0) {
return res.status(400).json({
success: false,
- message: 'An error occurred deleting the workflow',
+ message: 'A workflow which is attached to applications currently in review cannot be edited',
+ });
+ }
+ // 5. Edit workflow
+ const { workflowName = '', steps = [] } = req.body;
+ let isDirty = false;
+ // Check if workflow name updated
+ if (!_.isEmpty(workflowName)) {
+ workflow.workflowName = workflowName;
+ isDirty = true;
+ } // Check if steps updated
+ if (!_.isEmpty(steps)) {
+ workflow.steps = steps;
+ isDirty = true;
+ } // Perform save if changes have been made
+ if (isDirty) {
+ workflow.save(async err => {
+ if (err) {
+ console.error(err.message);
+ return res.status(400).json({
+ success: false,
+ message: err.message,
+ });
+ } else {
+ // 7. Return workflow payload
+ return res.status(204).json({
+ success: true,
+ workflow,
+ });
+ }
});
} else {
- // 7. Return workflow payload
- return res.status(204).json({
+ return res.status(200).json({
success: true,
});
}
- });
- } catch (err) {
- console.error(err.message);
- return res.status(500).json({
- success: false,
- message: 'An error occurred deleting the workflow',
- });
- }
-};
-
-const createNotifications = async (context, type = '') => {
- if (!_.isEmpty(type)) {
- // local variables set here
- let custodianManagers = [],
- managerUserIds = [],
- options = {},
- html = '';
-
- // deconstruct context
- let { publisherObj, workflow = {}, actioner = '' } = context;
-
- // switch over types
- switch (type) {
- case constants.notificationTypes.WORKFLOWCREATED:
- // 1. Get managers for publisher
- custodianManagers = teamController.getTeamMembersByRole(publisherObj, constants.roleTypes.MANAGER);
- // 2. Get managerIds for notifications
- managerUserIds = custodianManagers.map(user => user.id);
- // 3. deconstruct workflow
- let { workflowName = 'Workflow Title', _id, steps, createdAt } = workflow;
- // 4. setup options
- options = {
- actioner,
- workflowName,
- _id,
- steps,
- createdAt,
- };
- // 4. Create notifications for the managers only
- await notificationBuilder.triggerNotificationMessage(
- managerUserIds,
- `A new workflow of ${workflowName} has been created`,
- 'workflow',
- _id
- );
- // 5. Generate the email
- html = await emailGenerator.generateWorkflowCreated(options);
- // 6. Send email to custodian managers only within the team
- await emailGenerator.sendEmail(custodianManagers, constants.hdrukEmail, `A Workflow has been created`, html, false);
- break;
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
+ success: false,
+ message: 'An error occurred editing the workflow',
+ });
}
}
-};
-const calculateStepDeadlineReminderDate = step => {
- // Extract deadline and reminder offset in days from step definition
- let { deadline, reminderOffset } = step;
- // Subtract SLA reminder offset
- let reminderPeriod = +deadline - +reminderOffset;
- return `P${reminderPeriod}D`;
-};
-
-const workflowStepContainsManager = (reviewers, team) => {
- let managerExists = false;
- // 1. Extract team members
- let { members } = team;
- // 2. Iterate through each reviewer to check if they are a manager of the team
- reviewers.forEach(reviewer => {
- // 3. Find the current user
- let userMember = members.find(member => member.memberid.toString() === reviewer.toString());
- // 4. If the user was found check if they are a manager
- if (userMember) {
- let { roles } = userMember;
- if (roles.includes(constants.roleTypes.MANAGER)) {
- managerExists = true;
+ async deleteWorkflow(req, res) {
+ try {
+ const { _id: userId } = req.user;
+ const { id: workflowId } = req.params;
+ // 1. Look up workflow
+ const workflow = await WorkflowModel.findOne({
+ _id: req.params.id,
+ }).populate({
+ path: 'publisher steps.reviewers',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
+ });
+ if (!workflow) {
+ return res.status(404).json({ success: false });
}
- }
- });
- return managerExists;
-};
-
-const buildNextStep = (userId, application, activeStepIndex, override) => {
- // Check the current position of the application within its assigned workflow
- const finalStep = activeStepIndex === application.workflow.steps.length - 1;
- const requiredReviews = application.workflow.steps[activeStepIndex].reviewers.length;
- const completedReviews = application.workflow.steps[activeStepIndex].recommendations.length;
- const stepComplete = completedReviews === requiredReviews;
- // Establish base payload for Camunda
- // (1) phaseApproved is passed as true when the manager is overriding the current step/phase
- // this short circuits the review process in the workflow and closes any remaining user tasks
- // i.e. reviewers within the active step OR when the last reviewer in the step submits a vote
- // (2) managerApproved is passed as true when the manager is approving the entire application
- // from any point within the review process
- // (3) finalPhaseApproved is passed as true when the final step is completed naturally through all
- // reviewers casting their votes
- let bpmContext = {
- businessKey: application._id,
- dataRequestUserId: userId.toString(),
- managerApproved: override,
- phaseApproved: (override && !finalStep) || stepComplete,
- finalPhaseApproved: finalStep,
- stepComplete,
- };
- if (!finalStep) {
- // Extract the information for the next step defintion
- let { name: dataRequestPublisher } = application.publisherObj;
- let nextStep = application.workflow.steps[activeStepIndex + 1];
- let reviewerList = nextStep.reviewers.map(reviewer => reviewer._id.toString());
- let { stepName: dataRequestStepName } = nextStep;
- // Update Camunda payload with the next step information
- bpmContext = {
- ...bpmContext,
- dataRequestPublisher,
- dataRequestStepName,
- notifyReviewerSLA: calculateStepDeadlineReminderDate(nextStep),
- reviewerList,
- };
- }
- return bpmContext;
-};
-
-const getWorkflowCompleted = (workflow = {}) => {
- let workflowCompleted = false;
- if (!_.isEmpty(workflow)) {
- let { steps } = workflow;
- workflowCompleted = steps.every(step => step.completed);
- }
- return workflowCompleted;
-};
-
-const getActiveWorkflowStep = (workflow = {}) => {
- let activeStep = {};
- if (!_.isEmpty(workflow)) {
- let { steps } = workflow;
- activeStep = steps.find(step => {
- return step.active;
- });
- }
- return activeStep;
-};
-
-const getStepReviewers = (step = {}) => {
- let stepReviewers = [];
- // Attempt to get step reviewers if workflow passed
- if (!_.isEmpty(step)) {
- // Get active reviewers
- if (step) {
- ({ reviewers: stepReviewers } = step);
- }
- }
- return stepReviewers;
-};
-
-const getRemainingReviewers = (Step = {}, users) => {
- let { reviewers = [], recommendations = [] } = Step;
- let remainingActioners = reviewers.filter(reviewer => !recommendations.some(rec => rec.reviewer.toString() === reviewer._id.toString()));
- remainingActioners = [...users].filter(user => remainingActioners.some(actioner => actioner._id.toString() === user._id.toString()));
-
- return remainingActioners;
-};
-
-const getActiveStepStatus = (activeStep, users = [], userId = '') => {
- let reviewStatus = '',
- deadlinePassed = false,
- remainingActioners = [],
- decisionMade = false,
- decisionComments = '',
- decisionApproved = false,
- decisionDate = '',
- decisionStatus = '';
- let { stepName, deadline, startDateTime, reviewers = [], recommendations = [], sections = [] } = activeStep;
- let deadlineDate = moment(startDateTime).add(deadline, 'days');
- let diff = parseInt(deadlineDate.diff(new Date(), 'days'));
- if (diff > 0) {
- reviewStatus = `Deadline in ${diff} days`;
- } else if (diff < 0) {
- reviewStatus = `Deadline was ${Math.abs(diff)} days ago`;
- deadlinePassed = true;
- } else {
- reviewStatus = `Deadline is today`;
- }
- remainingActioners = reviewers.filter(reviewer => !recommendations.some(rec => rec.reviewer.toString() === reviewer._id.toString()));
- remainingActioners = users
- .filter(user => remainingActioners.some(actioner => actioner._id.toString() === user._id.toString()))
- .map(user => {
- let isCurrentUser = user._id.toString() === userId.toString();
- return `${user.firstname} ${user.lastname}${isCurrentUser ? ` (you)` : ``}`;
- });
-
- let isReviewer = reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
- let hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
-
- decisionMade = isReviewer && hasRecommended;
-
- if (decisionMade) {
- decisionStatus = 'Decision made for this phase';
- } else if (isReviewer) {
- decisionStatus = 'Decision required';
- } else {
- decisionStatus = '';
- }
-
- if (hasRecommended) {
- let recommendation = recommendations.find(rec => rec.reviewer.toString() === userId.toString());
- ({ comments: decisionComments, approved: decisionApproved, createdDate: decisionDate } = recommendation);
- }
-
- let reviewPanels = sections.map(section => constants.darPanelMapper[section]).join(', ');
-
- return {
- stepName,
- remainingActioners: remainingActioners.join(', '),
- deadlinePassed,
- isReviewer,
- reviewStatus,
- decisionMade,
- decisionApproved,
- decisionDate,
- decisionStatus,
- decisionComments,
- reviewPanels,
- };
-};
-
-const getWorkflowStatus = application => {
- let workflowStatus = {};
- let { workflow = {} } = application;
- if (!_.isEmpty(workflow)) {
- let { workflowName, steps } = workflow;
- // Find the active step in steps
- let activeStep = getActiveWorkflowStep(workflow);
- let activeStepIndex = steps.findIndex(step => {
- return step.active === true;
- });
- if (activeStep) {
- let { reviewStatus, deadlinePassed } = getActiveStepStatus(activeStep);
- //Update active step with review status
- steps[activeStepIndex] = {
- ...steps[activeStepIndex],
- reviewStatus,
- deadlinePassed,
- };
- }
- //Update steps with user friendly review sections
- let formattedSteps = [...steps].reduce((arr, item) => {
- let step = {
- ...item,
- sections: [...item.sections].map(section => constants.darPanelMapper[section]),
- };
- arr.push(step);
- return arr;
- }, []);
-
- workflowStatus = {
- workflowName,
- steps: formattedSteps,
- isCompleted: getWorkflowCompleted(workflow),
- };
- }
- return workflowStatus;
-};
-
-const getReviewStatus = (application, userId) => {
- let inReviewMode = false,
- reviewSections = [],
- isActiveStepReviewer = false,
- hasRecommended = false;
- // Get current application status
- let { applicationStatus } = application;
- // Check if the current user is a reviewer on the current step of an attached workflow
- let { workflow = {} } = application;
- if (!_.isEmpty(workflow)) {
- let { steps } = workflow;
- let activeStep = steps.find(step => {
- return step.active === true;
- });
- if (activeStep) {
- isActiveStepReviewer = activeStep.reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
- reviewSections = [...activeStep.sections];
-
- let { recommendations = [] } = activeStep;
- if (!_.isEmpty(recommendations)) {
- hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
+ // 2. Check the requesting user is a manager of the custodian team
+ let authorised = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, workflow.publisher.team.toObject(), userId);
+ // 3. Refuse access if not authorised
+ if (!authorised) {
+ return res.status(401).json({ status: 'failure', message: 'Unauthorised' });
}
- }
- }
- // Return active review mode if conditions apply
- if (applicationStatus === 'inReview' && isActiveStepReviewer) {
- inReviewMode = true;
- }
-
- return { inReviewMode, reviewSections, hasRecommended };
-};
-
-const getWorkflowEmailContext = (accessRecord, workflow, relatedStepIndex) => {
- // Extract workflow email variables
- const { dateReviewStart = '' } = accessRecord;
- const { workflowName, steps } = workflow;
- const { stepName, startDateTime = '', endDateTime = '', completed = false, deadline: stepDeadline = 0, reminderOffset = 0 } = steps[
- relatedStepIndex
- ];
- const stepReviewers = getStepReviewers(steps[relatedStepIndex]);
- const reviewerNames = [...stepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
- const reviewSections = [...steps[relatedStepIndex].sections].map(section => constants.darPanelMapper[section]).join(', ');
- const stepReviewerUserIds = [...stepReviewers].map(user => user.id);
- const currentDeadline = stepDeadline === 0 ? 'No deadline specified' : moment().add(stepDeadline, 'days');
- let nextStepName = '',
- nextReviewerNames = '',
- nextReviewSections = '',
- duration = '',
- totalDuration = '',
- nextDeadline = '',
- dateDeadline = '',
- deadlineElapsed = false,
- deadlineApproaching = false,
- remainingReviewers = [],
- remainingReviewerUserIds = [];
-
- // Calculate duration for step if it is completed
- if (completed) {
- if (!_.isEmpty(startDateTime.toString()) && !_.isEmpty(endDateTime.toString())) {
- duration = moment(endDateTime).diff(moment(startDateTime), 'days');
- duration = duration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
- }
- } else {
- //If related step is not completed, check if deadline has elapsed or is approaching
- if (!_.isEmpty(startDateTime.toString()) && stepDeadline != 0) {
- dateDeadline = moment(startDateTime).add(stepDeadline, 'days');
- deadlineElapsed = moment().isAfter(dateDeadline, 'second');
-
- // If deadline is not elapsed, check if it is within SLA period
- if (!deadlineElapsed && reminderOffset !== 0) {
- let deadlineReminderDate = moment(dateDeadline).subtract(reminderOffset, 'days');
- deadlineApproaching = moment().isAfter(deadlineReminderDate, 'second');
+ // 4. Ensure there are no in-review DARs with this workflow
+ const applications = await DataRequestModel.countDocuments({
+ workflowId,
+ applicationStatus: 'inReview',
+ });
+ if (applications > 0) {
+ return res.status(400).json({
+ success: false,
+ message: 'A workflow which is attached to applications currently in review cannot be deleted',
+ });
}
+ // 5. Delete workflow
+ WorkflowModel.deleteOne({ _id: workflowId }, function (err) {
+ if (err) {
+ console.error(err.message);
+ return res.status(400).json({
+ success: false,
+ message: 'An error occurred deleting the workflow',
+ });
+ } else {
+ // 7. Return workflow payload
+ return res.status(204).json({
+ success: true,
+ });
+ }
+ });
+ } catch (err) {
+ console.error(err.message);
+ return res.status(500).json({
+ success: false,
+ message: 'An error occurred deleting the workflow',
+ });
}
- // Find reviewers of the current incomplete phase
- let accessRecordObj = accessRecord.toObject();
- if (_.has(accessRecordObj, 'publisherObj.team.users')) {
- let {
- publisherObj: {
- team: { users = [] },
- },
- } = accessRecordObj;
- remainingReviewers = getRemainingReviewers(steps[relatedStepIndex], users);
- remainingReviewerUserIds = [...remainingReviewers].map(user => user.id);
- }
- }
-
- // Check if there is another step after the current related step
- if (relatedStepIndex + 1 === steps.length) {
- // If workflow completed
- nextStepName = 'No next step';
- // Calculate total duration for workflow
- if (steps[relatedStepIndex].completed && !_.isEmpty(dateReviewStart.toString())) {
- totalDuration = moment().diff(moment(dateReviewStart), 'days');
- totalDuration = totalDuration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
- }
- } else {
- // Get details of next step if this is not the final step
- ({ stepName: nextStepName } = steps[relatedStepIndex + 1]);
- let nextStepReviewers = getStepReviewers(steps[relatedStepIndex + 1]);
- nextReviewerNames = [...nextStepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
- nextReviewSections = [...steps[relatedStepIndex + 1].sections].map(section => constants.darPanelMapper[section]).join(', ');
- let { deadline = 0 } = steps[relatedStepIndex + 1];
- nextDeadline = deadline === 0 ? 'No deadline specified' : moment().add(deadline, 'days');
}
- return {
- workflowName,
- steps,
- stepName,
- startDateTime,
- endDateTime,
- stepReviewers,
- duration,
- totalDuration,
- reviewerNames,
- stepReviewerUserIds,
- reviewSections,
- currentDeadline,
- nextStepName,
- nextReviewerNames,
- nextReviewSections,
- nextDeadline,
- dateDeadline,
- deadlineElapsed,
- deadlineApproaching,
- remainingReviewers,
- remainingReviewerUserIds,
- };
-};
-
-export default {
- getWorkflowById: getWorkflowById,
- createWorkflow: createWorkflow,
- updateWorkflow: updateWorkflow,
- deleteWorkflow: deleteWorkflow,
- calculateStepDeadlineReminderDate: calculateStepDeadlineReminderDate,
- workflowStepContainsManager: workflowStepContainsManager,
- buildNextStep: buildNextStep,
- getWorkflowCompleted: getWorkflowCompleted,
- getActiveWorkflowStep: getActiveWorkflowStep,
- getStepReviewers: getStepReviewers,
- getActiveStepStatus: getActiveStepStatus,
- getWorkflowStatus: getWorkflowStatus,
- getReviewStatus: getReviewStatus,
- getWorkflowEmailContext: getWorkflowEmailContext,
- createNotifications: createNotifications,
-};
+}
diff --git a/src/resources/workflow/workflow.repository.js b/src/resources/workflow/workflow.repository.js
new file mode 100644
index 00000000..358fc61b
--- /dev/null
+++ b/src/resources/workflow/workflow.repository.js
@@ -0,0 +1,75 @@
+import Repository from '../base/repository';
+import { WorkflowModel } from './workflow.model';
+
+export default class WorkflowRepository extends Repository {
+ constructor() {
+ super(WorkflowModel);
+ this.workflowModel = WorkflowModel;
+ }
+
+ getWorkflowsByPublisher(id) {
+ return WorkflowModel.find({
+ publisher: id,
+ })
+ .populate([
+ {
+ path: 'publisher',
+ select: 'team',
+ populate: {
+ path: 'team',
+ select: 'members -_id',
+ },
+ },
+ {
+ path: 'steps.reviewers',
+ model: 'User',
+ select: '_id id firstname lastname',
+ },
+ {
+ path: 'applications',
+ select: 'aboutApplication',
+ match: { applicationStatus: 'inReview' },
+ },
+ ])
+ .lean();
+ }
+
+ getWorkflowById(id, options = {}) {
+ return WorkflowModel.findOne(
+ {
+ _id: id,
+ }, //lgtm [js/sql-injection]
+ null,
+ options
+ )
+ .populate([
+ {
+ path: 'steps.reviewers',
+ model: 'User',
+ select: '_id id firstname lastname email',
+ },
+ ])
+ .lean();
+ }
+
+ async assignWorkflowToApplication(accessRecord, workflowId) {
+ // Retrieve workflow using ID from database
+ const workflow = await this.getWorkflowById(workflowId, { lean: false });
+ if (!workflow) {
+ throw new Error('Workflow could not be found');
+ }
+ // Set first workflow step active and ensure all others are false
+ const workflowObj = workflow;
+ workflowObj.steps = workflowObj.steps.map(step => {
+ return { ...step, active: false };
+ });
+ workflowObj.steps[0].active = true;
+ workflowObj.steps[0].startDateTime = new Date();
+ // Update application with attached workflow
+ accessRecord.workflowId = workflowId;
+ accessRecord.workflow = workflowObj;
+ await accessRecord.save();
+
+ return accessRecord;
+ }
+}
diff --git a/src/resources/workflow/workflow.route.js b/src/resources/workflow/workflow.route.js
index 75910fb1..e2dd08b3 100644
--- a/src/resources/workflow/workflow.route.js
+++ b/src/resources/workflow/workflow.route.js
@@ -1,27 +1,52 @@
import express from 'express';
import passport from 'passport';
-import workflowController from './workflow.controller';
+import { logger } from '../utilities/logger';
+import WorkflowController from './workflow.controller';
+import { workflowService } from './dependency';
+
+const workflowController = new WorkflowController(workflowService);
+const logCategory = 'Workflow';
const router = express.Router();
// @route GET api/v1/workflows/:id
// @desc Fetch a workflow by id
// @access Private
-router.get('/:id', passport.authenticate('jwt'), workflowController.getWorkflowById);
+router.get(
+ '/:id',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Viewed a workflow instance details' }),
+ (req, res) => workflowController.getWorkflowById(req, res)
+);
// @route POST api/v1/workflows/
// @desc Create a new workflow
// @access Private
-router.post('/', passport.authenticate('jwt'), workflowController.createWorkflow);
+router.post(
+ '/',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Creating a new workflow definition' }),
+ (req, res) => workflowController.createWorkflow(req, res)
+);
// @route PUT api/v1/workflows/:id
// @desc Edit a workflow by id
// @access Private
-router.put('/:id', passport.authenticate('jwt'), workflowController.updateWorkflow);
+router.put(
+ '/:id',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Updating an existing workflow definition' }),
+ (req, res) => workflowController.updateWorkflow(req, res)
+);
// @route DELETE api/v1/workflows/
// @desc Delete a workflow by id
// @access Private
-router.delete('/:id', passport.authenticate('jwt'), workflowController.deleteWorkflow);
+router.delete(
+ '/:id',
+ passport.authenticate('jwt'),
+ logger.logRequestMiddleware({ logCategory, action: 'Deleting a workflow definition' }),
+ (req, res) => workflowController.deleteWorkflow(req, res)
+);
module.exports = router;
diff --git a/src/resources/workflow/workflow.service.js b/src/resources/workflow/workflow.service.js
new file mode 100644
index 00000000..6af0cfac
--- /dev/null
+++ b/src/resources/workflow/workflow.service.js
@@ -0,0 +1,538 @@
+import moment from 'moment';
+import { isEmpty, has } from 'lodash';
+
+import teamController from '../team/team.controller';
+import constants from '../utilities/constants.util';
+import emailGenerator from '../utilities/emailGenerator.util';
+import notificationBuilder from '../utilities/notificationBuilder';
+
+const bpmController = require('../bpmnworkflow/bpmnworkflow.controller');
+
+export default class WorkflowService {
+ constructor(workflowRepository) {
+ this.workflowRepository = workflowRepository;
+ }
+
+ getApplicationWorkflowStatusForUser(accessRecord, requestingUserObjectId) {
+ // Set the review mode if user is a custodian reviewing the current step
+ let { inReviewMode, reviewSections, hasRecommended } = this.getReviewStatus(accessRecord, requestingUserObjectId);
+ // Get the workflow/voting status
+ let workflow = this.getWorkflowStatus(accessRecord);
+ let isManager = false;
+ // Check if the current user can override the current step
+ if (has(accessRecord, 'publisherObj.team')) {
+ const { team } = accessRecord.publisherObj;
+ isManager = teamController.checkTeamPermissions(constants.roleTypes.MANAGER, team, requestingUserObjectId);
+ // Set the workflow override capability if there is an active step and user is a manager
+ if (!isEmpty(workflow)) {
+ workflow.canOverrideStep = !workflow.isCompleted && isManager;
+ }
+ }
+ return { inReviewMode, reviewSections, hasRecommended, isManager, workflow };
+ }
+
+ async getWorkflowsByPublisher(id) {
+ const workflows = await this.workflowRepository.getWorkflowsByPublisher(id);
+
+ const formattedWorkflows = [...workflows].map(workflow => {
+ let { active, _id, id, workflowName, version, applications = [], publisher } = workflow;
+ const formattedSteps = this.formatWorkflowSteps(workflow, 'displaySections');
+ return {
+ active,
+ _id,
+ id,
+ workflowName,
+ version,
+ steps: formattedSteps,
+ appCount: applications.length,
+ canDelete: applications.length === 0,
+ canEdit: applications.length === 0,
+ publisher,
+ };
+ });
+
+ return formattedWorkflows;
+ }
+
+ async assignWorkflowToApplication(accessRecord, workflowId) {
+ return this.workflowRepository.assignWorkflowToApplication(accessRecord, workflowId);
+ }
+
+ getWorkflowById(id){
+ return this.workflowRepository.getWorkflowById(id);
+ }
+
+ getWorkflowDetails(accessRecord, requestingUserId) {
+ if (!has(accessRecord, 'publisherObj.team.members')) return accessRecord;
+
+ let { workflow = {} } = accessRecord;
+
+ const activeStep = this.getActiveWorkflowStep(workflow);
+ accessRecord = this.getRemainingActioners(accessRecord, activeStep, requestingUserId);
+
+ if (isEmpty(workflow)) return accessRecord;
+
+ accessRecord.workflowName = workflow.workflowName;
+ accessRecord.workflowCompleted = this.getWorkflowCompleted(workflow);
+
+ if (isEmpty(activeStep)) return accessRecord;
+
+ const activeStepDetails = this.getActiveStepStatus(activeStep, requestingUserId);
+ accessRecord = { ...accessRecord, ...activeStepDetails };
+
+ accessRecord = this.setActiveStepReviewStatus(accessRecord);
+
+ accessRecord.workflow.steps = this.formatWorkflowSteps(workflow, 'sections');
+
+ return accessRecord;
+ }
+
+ formatWorkflowSteps(workflow, sectionsKey) {
+ // Set review section to display format
+ const { steps = [] } = workflow;
+ let formattedSteps = [...steps].reduce((arr, item) => {
+ let step = {
+ ...item,
+ [sectionsKey]: [...item.sections].map(section => constants.darPanelMapper[section]),
+ };
+ arr.push(step);
+ return arr;
+ }, []);
+ return [...formattedSteps];
+ }
+
+ setActiveStepReviewStatus(accessRecord) {
+ const { workflow } = accessRecord;
+ if (!workflow) return '';
+
+ let activeStepIndex = workflow.steps.findIndex(step => {
+ return step.active === true;
+ });
+
+ if (activeStepIndex === -1) return '';
+
+ accessRecord.workflow.steps[activeStepIndex].reviewStatus = accessRecord.reviewStatus;
+
+ return accessRecord;
+ }
+
+ getRemainingActioners(accessRecord, activeStep = {}, requestingUserId) {
+ let {
+ workflow = {},
+ applicationStatus,
+ publisherObj: { team },
+ } = accessRecord;
+
+ if (
+ applicationStatus === constants.applicationStatuses.SUBMITTED ||
+ (applicationStatus === constants.applicationStatuses.INREVIEW && isEmpty(workflow))
+ ) {
+ accessRecord.remainingActioners = this.getReviewManagers(team, requestingUserId).join(', ');
+ } else if (!isEmpty(workflow) && isEmpty(activeStep) && applicationStatus === constants.applicationStatuses.INREVIEW) {
+ remainingActioners = this.getReviewManagers(team, requestingUserId).join(', ');
+ accessRecord.reviewStatus = 'Final decision required';
+ } else {
+ accessRecord.remainingActioners = this.getRemainingReviewerNames(activeStep, team.users, requestingUserId);
+ }
+
+ return accessRecord;
+ }
+
+ getReviewManagers(team, requestingUserId) {
+ const { members = [], users = [] } = team;
+ const managers = members.filter(mem => {
+ return mem.roles.includes('manager');
+ });
+ return users
+ .filter(user => managers.some(manager => manager.memberid.toString() === user._id.toString()))
+ .map(user => {
+ const isCurrentUser = user._id.toString() === requestingUserId.toString();
+ return `${user.firstname} ${user.lastname}${isCurrentUser ? ` (you)` : ``}`;
+ });
+ }
+
+ async createNotifications(context, type = '') {
+ if (!isEmpty(type)) {
+ // local variables set here
+ let custodianManagers = [],
+ managerUserIds = [],
+ options = {},
+ html = '';
+
+ // deconstruct context
+ let { publisherObj, workflow = {}, actioner = '' } = context;
+
+ // switch over types
+ switch (type) {
+ case constants.notificationTypes.WORKFLOWCREATED:
+ // 1. Get managers for publisher
+ custodianManagers = teamController.getTeamMembersByRole(publisherObj, constants.roleTypes.MANAGER);
+ // 2. Get managerIds for notifications
+ managerUserIds = custodianManagers.map(user => user.id);
+ // 3. deconstruct workflow
+ let { workflowName = 'Workflow Title', _id, steps, createdAt } = workflow;
+ // 4. setup options
+ options = {
+ actioner,
+ workflowName,
+ _id,
+ steps,
+ createdAt,
+ };
+ // 4. Create notifications for the managers only
+ await notificationBuilder.triggerNotificationMessage(
+ managerUserIds,
+ `A new workflow of ${workflowName} has been created`,
+ 'workflow',
+ _id
+ );
+ // 5. Generate the email
+ html = await emailGenerator.generateWorkflowCreated(options);
+ // 6. Send email to custodian managers only within the team
+ await emailGenerator.sendEmail(custodianManagers, constants.hdrukEmail, `A Workflow has been created`, html, false);
+ break;
+ }
+ }
+ }
+
+ calculateStepDeadlineReminderDate(step) {
+ // Extract deadline and reminder offset in days from step definition
+ let { deadline, reminderOffset } = step;
+ // Subtract SLA reminder offset
+ let reminderPeriod = +deadline - +reminderOffset;
+ return `P${reminderPeriod}D`;
+ }
+
+ buildNextStep(userId, application, activeStepIndex, override) {
+ // Check the current position of the application within its assigned workflow
+ const finalStep = activeStepIndex === application.workflow.steps.length - 1;
+ const requiredReviews = application.workflow.steps[activeStepIndex].reviewers.length;
+ const completedReviews = application.workflow.steps[activeStepIndex].recommendations.length;
+ const stepComplete = completedReviews === requiredReviews;
+ // Establish base payload for Camunda
+ // (1) phaseApproved is passed as true when the manager is overriding the current step/phase
+ // this short circuits the review process in the workflow and closes any remaining user tasks
+ // i.e. reviewers within the active step OR when the last reviewer in the step submits a vote
+ // (2) managerApproved is passed as true when the manager is approving the entire application
+ // from any point within the review process
+ // (3) finalPhaseApproved is passed as true when the final step is completed naturally through all
+ // reviewers casting their votes
+ let bpmContext = {
+ businessKey: application._id,
+ dataRequestUserId: userId.toString(),
+ managerApproved: override,
+ phaseApproved: (override && !finalStep) || stepComplete,
+ finalPhaseApproved: finalStep,
+ stepComplete,
+ };
+ if (!finalStep) {
+ // Extract the information for the next step defintion
+ let { name: dataRequestPublisher } = application.publisherObj;
+ let nextStep = application.workflow.steps[activeStepIndex + 1];
+ let reviewerList = nextStep.reviewers.map(reviewer => reviewer._id.toString());
+ let { stepName: dataRequestStepName } = nextStep;
+ // Update Camunda payload with the next step information
+ bpmContext = {
+ ...bpmContext,
+ dataRequestPublisher,
+ dataRequestStepName,
+ notifyReviewerSLA: this.calculateStepDeadlineReminderDate(nextStep),
+ reviewerList,
+ };
+ }
+ return bpmContext;
+ }
+
+ getWorkflowCompleted(workflow = {}) {
+ let workflowCompleted = false;
+ if (!isEmpty(workflow)) {
+ let { steps } = workflow;
+ workflowCompleted = steps.every(step => step.completed);
+ }
+ return workflowCompleted;
+ }
+
+ getActiveWorkflowStep(workflow = {}) {
+ let activeStep = {};
+ if (!isEmpty(workflow)) {
+ let { steps } = workflow;
+ activeStep = steps.find(step => {
+ return step.active;
+ });
+ }
+ return activeStep;
+ }
+
+ getStepReviewers(step = {}) {
+ let stepReviewers = [];
+ // Attempt to get step reviewers if workflow passed
+ if (!isEmpty(step)) {
+ // Get active reviewers
+ if (step) {
+ ({ reviewers: stepReviewers } = step);
+ }
+ }
+ return stepReviewers;
+ }
+
+ getRemainingReviewers(step = {}, users) {
+ let { reviewers = [], recommendations = [] } = step;
+ let remainingActioners = reviewers.filter(
+ reviewer => !recommendations.some(rec => rec.reviewer.toString() === reviewer._id.toString())
+ );
+ remainingActioners = [...users].filter(user => remainingActioners.some(actioner => actioner._id.toString() === user._id.toString()));
+
+ return remainingActioners;
+ }
+
+ getRemainingReviewerNames(step = {}, users, requestingUserId) {
+ if (isEmpty(step)) return '';
+ let remainingActioners = this.getRemainingReviewers(step, users);
+
+ if (isEmpty(remainingActioners)) return '';
+
+ let remainingReviewerNames = remainingActioners.map(user => {
+ let isCurrentUser = user._id.toString() === requestingUserId.toString();
+ return `${user.firstname} ${user.lastname}${isCurrentUser ? ` (you)` : ``}`;
+ });
+
+ return remainingReviewerNames.join(', ');
+ }
+
+ getActiveStepStatus(activeStep, userId = '') {
+ let reviewStatus = '',
+ deadlinePassed = false,
+ decisionMade = false,
+ decisionComments = '',
+ decisionApproved = false,
+ decisionDate = '',
+ decisionStatus = '';
+ let { stepName = '', deadline, startDateTime, reviewers = [], recommendations = [], sections = [] } = activeStep;
+ let deadlineDate = moment(startDateTime).add(deadline, 'days');
+ let diff = parseInt(deadlineDate.diff(new Date(), 'days'));
+ if (diff > 0) {
+ reviewStatus = `Deadline in ${diff} days`;
+ } else if (diff < 0) {
+ reviewStatus = `Deadline was ${Math.abs(diff)} days ago`;
+ deadlinePassed = true;
+ } else {
+ reviewStatus = `Deadline is today`;
+ }
+
+ let isReviewer = reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
+ let hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
+
+ decisionMade = isReviewer && hasRecommended;
+
+ if (decisionMade) {
+ decisionStatus = 'Decision made for this phase';
+ } else if (isReviewer) {
+ decisionStatus = 'Decision required';
+ } else {
+ decisionStatus = '';
+ }
+
+ if (hasRecommended) {
+ let recommendation = recommendations.find(rec => rec.reviewer.toString() === userId.toString());
+ ({ comments: decisionComments, approved: decisionApproved, createdDate: decisionDate } = recommendation);
+ }
+
+ let reviewPanels = sections.map(section => constants.darPanelMapper[section]).join(', ');
+
+ return {
+ stepName,
+ deadlinePassed,
+ isReviewer,
+ reviewStatus,
+ decisionMade,
+ decisionApproved,
+ decisionDate,
+ decisionStatus,
+ decisionComments,
+ reviewPanels,
+ };
+ }
+
+ getWorkflowStatus(application) {
+ let workflowStatus = {};
+ let { workflow = {} } = application;
+ if (!isEmpty(workflow)) {
+ let { workflowName, steps } = workflow;
+ // Find the active step in steps
+ let activeStep = this.getActiveWorkflowStep(workflow);
+ let activeStepIndex = steps.findIndex(step => {
+ return step.active === true;
+ });
+ if (activeStep) {
+ let { reviewStatus, deadlinePassed } = this.getActiveStepStatus(activeStep);
+ //Update active step with review status
+ steps[activeStepIndex] = {
+ ...steps[activeStepIndex],
+ reviewStatus,
+ deadlinePassed,
+ };
+ }
+ //Update steps with user friendly review sections
+ let formattedSteps = [...steps].reduce((arr, item) => {
+ let step = {
+ ...item,
+ sections: [...item.sections].map(section => constants.darPanelMapper[section]),
+ };
+ arr.push(step);
+ return arr;
+ }, []);
+
+ workflowStatus = {
+ workflowName,
+ steps: formattedSteps,
+ isCompleted: this.getWorkflowCompleted(workflow),
+ };
+ }
+ return workflowStatus;
+ }
+
+ getReviewStatus(application, userId) {
+ let inReviewMode = false,
+ reviewSections = [],
+ isActiveStepReviewer = false,
+ hasRecommended = false;
+ // Get current application status
+ let { applicationStatus } = application;
+ // Check if the current user is a reviewer on the current step of an attached workflow
+ let { workflow = {} } = application;
+ if (!isEmpty(workflow)) {
+ let { steps } = workflow;
+ let activeStep = steps.find(step => {
+ return step.active === true;
+ });
+ if (activeStep) {
+ isActiveStepReviewer = activeStep.reviewers.some(reviewer => reviewer._id.toString() === userId.toString());
+ reviewSections = [...activeStep.sections];
+
+ let { recommendations = [] } = activeStep;
+ if (!isEmpty(recommendations)) {
+ hasRecommended = recommendations.some(rec => rec.reviewer.toString() === userId.toString());
+ }
+ }
+ }
+ // Return active review mode if conditions apply
+ if (applicationStatus === 'inReview' && isActiveStepReviewer) {
+ inReviewMode = true;
+ }
+
+ return { inReviewMode, reviewSections, hasRecommended };
+ }
+
+ getWorkflowEmailContext(accessRecord, relatedStepIndex = 0) {
+ // Extract workflow email variables
+ const { dateReviewStart = '', workflow = {} } = accessRecord;
+ const { workflowName, steps } = workflow;
+ const { stepName, startDateTime = '', endDateTime = '', completed = false, deadline: stepDeadline = 0, reminderOffset = 0 } = steps[
+ relatedStepIndex
+ ];
+ const stepReviewers = this.getStepReviewers(steps[relatedStepIndex]);
+ const reviewerNames = [...stepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
+ const reviewSections = [...steps[relatedStepIndex].sections].map(section => constants.darPanelMapper[section]).join(', ');
+ const stepReviewerUserIds = [...stepReviewers].map(user => user.id);
+ const currentDeadline = stepDeadline === 0 ? 'No deadline specified' : moment().add(stepDeadline, 'days');
+ let nextStepName = '',
+ nextReviewerNames = '',
+ nextReviewSections = '',
+ duration = '',
+ totalDuration = '',
+ nextDeadline = '',
+ dateDeadline = '',
+ deadlineElapsed = false,
+ deadlineApproaching = false,
+ remainingReviewers = [],
+ remainingReviewerUserIds = [];
+
+ // Calculate duration for step if it is completed
+ if (completed) {
+ if (!isEmpty(startDateTime.toString()) && !isEmpty(endDateTime.toString())) {
+ duration = moment(endDateTime).diff(moment(startDateTime), 'days');
+ duration = duration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
+ }
+ } else {
+ //If related step is not completed, check if deadline has elapsed or is approaching
+ if (!isEmpty(startDateTime.toString()) && stepDeadline != 0) {
+ dateDeadline = moment(startDateTime).add(stepDeadline, 'days');
+ deadlineElapsed = moment().isAfter(dateDeadline, 'second');
+
+ // If deadline is not elapsed, check if it is within SLA period
+ if (!deadlineElapsed && reminderOffset !== 0) {
+ let deadlineReminderDate = moment(dateDeadline).subtract(reminderOffset, 'days');
+ deadlineApproaching = moment().isAfter(deadlineReminderDate, 'second');
+ }
+ }
+ // Find reviewers of the current incomplete phase
+ let accessRecordObj = accessRecord.toObject();
+ if (has(accessRecordObj, 'publisherObj.team.users')) {
+ let {
+ publisherObj: {
+ team: { users = [] },
+ },
+ } = accessRecordObj;
+ remainingReviewers = this.getRemainingReviewers(steps[relatedStepIndex], users);
+ remainingReviewerUserIds = [...remainingReviewers].map(user => user.id);
+ }
+ }
+
+ // Check if there is another step after the current related step
+ if (relatedStepIndex + 1 === steps.length) {
+ // If workflow completed
+ nextStepName = 'No next step';
+ // Calculate total duration for workflow
+ if (steps[relatedStepIndex].completed && !isEmpty(dateReviewStart.toString())) {
+ totalDuration = moment().diff(moment(dateReviewStart), 'days');
+ totalDuration = totalDuration === 0 ? `Same day` : duration === 1 ? `1 day` : `${duration} days`;
+ }
+ } else {
+ // Get details of next step if this is not the final step
+ ({ stepName: nextStepName } = steps[relatedStepIndex + 1]);
+ let nextStepReviewers = this.getStepReviewers(steps[relatedStepIndex + 1]);
+ nextReviewerNames = [...nextStepReviewers].map(reviewer => `${reviewer.firstname} ${reviewer.lastname}`).join(', ');
+ nextReviewSections = [...steps[relatedStepIndex + 1].sections].map(section => constants.darPanelMapper[section]).join(', ');
+ let { deadline = 0 } = steps[relatedStepIndex + 1];
+ nextDeadline = deadline === 0 ? 'No deadline specified' : moment().add(deadline, 'days');
+ }
+ return {
+ workflowName,
+ steps,
+ stepName,
+ startDateTime,
+ endDateTime,
+ stepReviewers,
+ duration,
+ totalDuration,
+ reviewerNames,
+ stepReviewerUserIds,
+ reviewSections,
+ currentDeadline,
+ nextStepName,
+ nextReviewerNames,
+ nextReviewSections,
+ nextDeadline,
+ dateDeadline,
+ deadlineElapsed,
+ deadlineApproaching,
+ remainingReviewers,
+ remainingReviewerUserIds,
+ };
+ }
+
+ startWorkflow(accessRecord, requestingUserObjectId) {
+ const { publisherObj: { name: dataRequestPublisher }, _id, workflow } = accessRecord;
+ const reviewerList = workflow.steps[0].reviewers.map(reviewer => reviewer._id.toString());
+ const bpmContext = {
+ businessKey: _id,
+ dataRequestStatus: constants.applicationStatuses.INREVIEW,
+ dataRequestUserId: requestingUserObjectId.toString(),
+ dataRequestPublisher,
+ dataRequestStepName: workflow.steps[0].stepName,
+ notifyReviewerSLA: this.calculateStepDeadlineReminderDate(workflow.steps[0]),
+ reviewerList,
+ };
+ bpmController.postStartStepReview(bpmContext);
+ }
+}