feat: add the ability to execute status actions when the proposal status is updated manually (#1441)

Author: jekabs-karklins

apps/backend/src/mutations/ProposalMutations.ts

@@ -541,51 +541,60 @@ export default class ProposalMutations {
     agent: UserWithRole | null,
     args: ChangeProposalsStatusInput
   ): Promise<Proposals | Rejection> {
-    const { workflowStatusId: statusId, proposalPks } = args;
+    const {
+      workflowStatusId: statusId,
+      proposalPks,
+      statusActionsWorkflowConnectionId,
+    } = args;
 
     const result = await this.proposalDataSource.changeProposalsWorkflowStatus(
       statusId,
       proposalPks.map((proposalPk) => proposalPk)
     );
 
     if (result.proposals.length === proposalPks.length) {
-      const fullProposals = await Promise.all(
-        proposalPks.map(async (proposalPk) => {
-          const fullProposal = result.proposals.find(
-            (updatedProposal) => updatedProposal.primaryKey === proposalPk
-          );
-
-          if (!fullProposal) {
-            return null;
-          }
-
-          const proposalWorkflow =
-            await this.callDataSource.getProposalWorkflowByCall(
-              fullProposal.callId
+      // Only run status actions if a specific workflow connection was provided
+      if (statusActionsWorkflowConnectionId) {
+        const fullProposals = await Promise.all(
+          proposalPks.map(async (proposalPk) => {
+            const fullProposal = result.proposals.find(
+              (updatedProposal) => updatedProposal.primaryKey === proposalPk
             );
 
-          if (!proposalWorkflow) {
-            return rejection(
-              `No propsal workflow found for the specific proposal call with id: ${fullProposal.callId}`,
-              {
-                agent,
-                args,
-              }
-            );
-          }
+            if (!fullProposal) {
+              return null;
+            }
 
-          return {
-            ...fullProposal,
-          };
-        })
-      );
+            const proposalWorkflow =
+              await this.callDataSource.getProposalWorkflowByCall(
+                fullProposal.callId
+              );
+
+            if (!proposalWorkflow) {
+              return rejection(
+                `No propsal workflow found for the specific proposal call with id: ${fullProposal.callId}`,
+                {
+                  agent,
+                  args,
+                }
+              );
+            }
 
-      const statusEngineReadyProposals = fullProposals.filter(
-        (item): item is WorkflowEngineProposalType => !!item
-      );
+            return {
+              ...fullProposal,
+              prevStatusId: fullProposal.workflowStatusId,
+              workflowStatusConnectionId: statusActionsWorkflowConnectionId,
+            };
+          })
+        );
 
-      // NOTE: After proposal status change we need to run the status engine and execute the actions on the selected status.
-      proposalStatusActionEngine(statusEngineReadyProposals);
+        const statusEngineReadyProposals = fullProposals.filter(
+          (item): item is WorkflowEngineProposalType => !!item
+        );
+
+        // NOTE: After proposal status change we need to run the status engine and execute the actions on the selected status.
+        proposalStatusActionEngine(statusEngineReadyProposals);
+      }
     } else {
       rejection('Could not change statuses to all of the selected proposals', {
         result,

apps/backend/src/queries/StatusActionQueries.ts

@@ -28,7 +28,7 @@ export default class StatusActionQueries {
     public emailTemplateDataSource: EmailTemplateDataSource
   ) {}
 
-  @Authorized([Roles.USER_OFFICER])
+  @Authorized([Roles.USER_OFFICER, Roles.INSTRUMENT_SCIENTIST])
   async getStatusAction(agent: UserWithRole | null, actionId: number) {
     const statusAction = await this.dataSource.getStatusAction(actionId);
 
@@ -42,15 +42,15 @@ export default class StatusActionQueries {
     return statusActions;
   }
 
-  @Authorized([Roles.USER_OFFICER])
+  @Authorized([Roles.USER_OFFICER, Roles.INSTRUMENT_SCIENTIST])
   async getConnectionStatusActions(
     agent: UserWithRole | null,
     { workflowConnectionId }: { workflowConnectionId: number }
   ) {
     return this.dataSource.getConnectionStatusActions(workflowConnectionId);
   }
 
-  @Authorized([Roles.USER_OFFICER])
+  @Authorized([Roles.USER_OFFICER, Roles.INSTRUMENT_SCIENTIST])
   async getStatusActionConfig(
     agent: UserWithRole | null,
     statusAction: StatusAction

apps/backend/src/queries/WorkflowQueries.ts

@@ -17,7 +17,7 @@ export default class WorkflowQueries {
     public emailService: MailService
   ) {}
 
-  @Authorized([Roles.USER_OFFICER])
+  @Authorized([Roles.USER_OFFICER, Roles.INSTRUMENT_SCIENTIST])
   async getWorkflow(
     agent: UserWithRole | null,
     id: number,

apps/backend/src/resolvers/mutations/ChangeProposalsStatusMutation.ts

@@ -18,6 +18,14 @@ export class ChangeProposalsStatusInput {
 
   @Field(() => [Int])
   public proposalPks: number[];
+
+  /**
+   * The workflow connection whose status actions (emails, RabbitMQ messages,
+   * PDF generation) should run after the status change. Omit to change the
+   * proposal status WITHOUT running any status actions.
+   */
+  @Field(() => Int, { nullable: true })
+  public statusActionsWorkflowConnectionId?: number;
 }
 
 @Resolver()

apps/e2e/cypress/e2e/proposals.cy.ts

@@ -2,9 +2,11 @@ import { faker } from '@faker-js/faker';
 import {
   AllocationTimeUnits,
   DataType,
+  EmailStatusActionRecipients,
   FeatureId,
   ProposalEndStatus,
   SettingsId,
+  StatusActionType,
   TemplateCategoryId,
   TemplateGroupId,
   WorkflowType,
@@ -143,6 +145,7 @@ context('Proposal tests', () => {
           cy.addStatusToWorkflow({
             statusId: initialDBData.proposalStatuses.feasibilityReview.id,
             workflowId: result.createWorkflow.id,
+            posY: 200,
           });
           createdWorkflowId = result.createWorkflow.id;
         }
@@ -896,6 +899,79 @@ context('Proposal tests', () => {
         );
     });
 
+    it('User officer should be able to opt-in to run status actions when changing status', () => {
+      const statusActionConfig = {
+        recipientsWithEmailTemplate: [
+          {
+            recipient: {
+              name: EmailStatusActionRecipients.PI,
+              description: '',
+            },
+            emailTemplate: {
+              id: initialDBData.emailTemplates.template1.id,
+              name: initialDBData.emailTemplates.template1.name,
+            },
+            combineEmails: true,
+          },
+        ],
+      };
+
+      // Add a status with a connection from DRAFT and attach a status action
+      cy.addStatusToWorkflow({
+        statusId: initialDBData.proposalStatuses.feasibilityReview.id,
+        workflowId: initialDBData.workflows.defaultWorkflow.id,
+        prevId:
+          initialDBData.workflows.defaultWorkflow.workflowStatuses.draft.id,
+        posX: 0,
+        posY: 200,
+      }).then((result) => {
+        cy.addConnectionStatusActions({
+          actions: [
+            {
+              actionId: 1,
+              actionType: StatusActionType.EMAIL,
+              config: JSON.stringify(statusActionConfig),
+            },
+          ],
+          connectionId: result.createWorkflowConnection.id,
+          workflowId: initialDBData.workflows.defaultWorkflow.id,
+        });
+      });
+
+      cy.login('officer');
+      cy.visit('/');
+
+      cy.contains(newProposalTitle).parent().find('[type="checkbox"]').check();
+
+      cy.get('[data-cy="change-proposal-status"]').click();
+
+      cy.finishedLoading();
+
+      cy.get('[role="presentation"] .MuiDialogContent-root').as('dialog');
+
+      // Select the status that has a connection with actions
+      cy.get('@dialog').find('#selectedWorkflowStatusId-input').click();
+      cy.get('[role="listbox"]')
+        .contains(initialDBData.proposalStatuses.feasibilityReview.name)
+        .click();
+
+      // The run status actions checkbox should appear and be unchecked
+      cy.get('[data-cy="run-status-actions-checkbox"] input')
+        .should('exist')
+        .should('not.be.checked');
+
+      // Check it to opt-in to running status actions
+      cy.get('[data-cy="run-status-actions-checkbox"] input').check();
+
+      // Should be able to submit the status change
+      cy.get('[data-cy="submit-proposal-status-change"]').click();
+
+      cy.notification({
+        variant: 'success',
+        text: 'status changed successfully',
+      });
+    });
+
     it('Should be able to delete proposal', () => {
       cy.login('user1', initialDBData.roles.user);
       cy.visit('/');

apps/e2e/cypress/e2e/settings.cy.ts

@@ -1596,7 +1596,7 @@ context('Settings tests', () => {
       cy.get('[data-cy^="status_ESF_IS_REVIEW"]').should('exist');
     });
 
-    it('User Officer should be able to select events that are triggering change to ESF workflow status', () => {
+    it.only('User Officer should be able to select events that are triggering change to ESF workflow status', () => {
       cy.login('officer');
       cy.visit('/');
 
@@ -1625,7 +1625,9 @@ context('Settings tests', () => {
 
       cy.reload();
 
-      cy.get(`[aria-label="Edge from AWAITING_ESF to ESF_IS_REVIEW"]`).click();
+      cy.get(`[aria-label="Edge from AWAITING_ESF to ESF_IS_REVIEW"]`).click({
+        force: true,
+      });
 
       cy.get('[data-cy="status-events-and-actions-modal"]').should('exist');
       cy.contains(Event.EXPERIMENT_ESF_SUBMITTED).click();
@@ -1642,7 +1644,9 @@ context('Settings tests', () => {
         .contains(Event.EXPERIMENT_ESF_SUBMITTED)
         .should('exist');
 
-      cy.get(`[aria-label="Edge from AWAITING_ESF to ESF_IS_REVIEW"]`).click();
+      cy.get(`[aria-label="Edge from AWAITING_ESF to ESF_IS_REVIEW"]`).click({
+        force: true,
+      });
 
       cy.get('[data-cy="status-events-and-actions-modal"]').should('exist');
       cy.contains(Event.EXPERIMENT_ESF_APPROVED_BY_IS).click();