Engagement Workflow v2

Author: Andre Turner

dbschema/engagement-workflow.esdl

@@ -0,0 +1,65 @@
+module Engagement {
+  type WorkflowEvent extending Project::ContextAware {
+    required engagement: default::Engagement {
+      readonly := true;
+      on target delete delete source;
+    };
+    required who: default::Actor {
+      readonly := true;
+      default := global default::currentActor;
+    };
+    required at: datetime {
+      readonly := true;
+      default := datetime_of_statement();
+    };
+    transitionKey: uuid {
+      readonly := true;
+    };
+    required to: Status {
+      readonly := true;
+    };
+    notes: default::RichText {
+      readonly := true;
+    };
+
+    trigger setEngagementStatus after insert for all do (
+      update default::Engagement
+      filter default::Engagement in __new__.engagement
+      set {
+        status := default::Engagement.latestWorkflowEvent.to ?? Engagement::Status.InDevelopment
+      }
+    );
+    trigger refreshEngagementStatus after delete for all do (
+      update default::Engagement
+      filter default::Engagement in __old__.engagement
+      set {
+        status := default::Engagement.latestWorkflowEvent.to ?? Engagement::Status.InDevelopment
+      }
+    );
+  }
+
+  scalar type Status extending enum<
+    InDevelopment,
+    DidNotDevelop,
+    Rejected,
+    
+    Active,
+    ActiveChangedPlan,
+    
+    DiscussingTermination,
+    DiscussingReactivation,
+    DiscussingChangeToPlan,
+    DiscussingSuspension,
+    Suspended,
+    
+    FinalizingCompletion,
+    Terminated,
+    Completed,
+    
+    # deprecated / legacy
+    Converted,
+    Unapproved,
+    Transferred,
+    NotRenewed,
+  >;
+}

dbschema/engagement.esdl

@@ -3,6 +3,15 @@ module default {
     required status: Engagement::Status {
       default := Engagement::Status.InDevelopment;
     }
+    latestWorkflowEvent := (select .workflowEvents order by .at desc limit 1);
+    workflowEvents := .<engagement[is Engagement::WorkflowEvent];
+    trigger assertMatchingLatestWorkflowEvent after insert, update for each do (
+      assert(
+        __new__.latestWorkflowEvent.to ?= __new__.status
+        or (not exists __new__.latestWorkflowEvent and __new__.status = Engagement::Status.InDevelopment),
+        message := "Engagement status must match the latest workflow event"
+      )
+    );
     statusModifiedAt: datetime {
       rewrite update using (datetime_of_statement() if .status != __old__.status else .statusModifiedAt);
     }
@@ -141,31 +150,6 @@ module default {
 }
 
 module Engagement {
-  scalar type Status extending enum<
-    InDevelopment,
-    DidNotDevelop,
-    Rejected,
-    
-    Active,
-    
-    DiscussingTermination,
-    DiscussingReactivation,
-    DiscussingChangeToPlan,
-    DiscussingSuspension,
-    
-    FinalizingCompletion,
-    ActiveChangedPlan,
-    Suspended,
-    
-    Terminated,
-    Completed,
-    
-    # deprecated / legacy
-    Converted,
-    Unapproved,
-    Transferred,
-    NotRenewed,
-  >;
 
   scalar type InternPosition extending enum<
     ConsultantInTraining,

dbschema/migrations/00012-m1pqxkv.edgeql

@@ -3,6 +3,14 @@ import { Policy, Role } from '../util';
 // NOTE: There could be other permissions for this role from other policies
 @Policy(Role.Controller, (r) => [
   // keep multiline format
+  r.EngagementWorkflowEvent.read.transitions(
+    'Reject',
+    'End Development',
+    'Approve to Active',
+    'Approve Change to Plan',
+    'Will Not Change Plan',
+    'Discussing Change to Plan -> Discussing Suspension',
+  ).execute,
   r.Organization.delete,
   r.Partner.delete,
   r.ProjectWorkflowEvent.read.transitions(

src/components/authorization/policies/by-role/controller.policy.ts

@@ -31,6 +31,10 @@ export const projectTransitions = () =>
       ]),
       r.LanguageEngagement.specifically((p) => p.paratextRegistryId.none),
     ),
+    r.EngagementWorkflowEvent.read.transitions(
+      'Not Ready for Completion',
+      'Complete',
+    ).execute,
     r.FieldRegion.read,
     r.FieldZone.read,
     r.FinancialReport.edit,

src/components/authorization/policies/by-role/financial-analyst.policy.ts

@@ -82,6 +82,23 @@ export const momentumProjectsTransitions = () =>
         p.paratextRegistryId.when(member).read,
       ]),
     ),
+    r.EngagementWorkflowEvent.read.transitions(
+      'Discuss Change To Plan',
+      'Discuss Suspension',
+      'Discuss Termination',
+      'Finalize Completion',
+      'Approve Change to Plan',
+      'Will Not Change Plan',
+      'Discussing Change to Plan -> Discussing Suspension',
+      'Will Not Suspend',
+      'Approve Suspension',
+      'Approve Reactivation',
+      'Discuss Reactivation',
+      'End Termination Discussion',
+      'Approve Termination',
+      'Not Ready for Completion',
+      'Complete',
+    ).execute,
     r.EthnologueLanguage.read,
     r.FieldRegion.read,
     r.FieldZone.read,

src/components/authorization/policies/by-role/project-manager.policy.ts

@@ -6,18 +6,17 @@ import { LanguageModule } from '../language/language.module';
 import { LocationModule } from '../location/location.module';
 import { ProductModule } from '../product/product.module';
 import { ProjectModule } from '../project/project.module';
-import { EngagementStatusResolver } from './engagement-status.resolver';
 import { EngagementLoader } from './engagement.loader';
 import { EngagementRepository } from './engagement.repository';
 import { EngagementResolver } from './engagement.resolver';
-import { EngagementRules } from './engagement.rules';
 import { EngagementService } from './engagement.service';
 import * as handlers from './handlers';
 import { InternshipEngagementResolver } from './internship-engagement.resolver';
 import { InternshipPositionResolver } from './internship-position.resolver';
 import { LanguageEngagementResolver } from './language-engagement.resolver';
 import { FixNullMethodologiesMigration } from './migrations/fix-null-methodologies.migration';
 import { EngagementProductConnectionResolver } from './product-connection.resolver';
+import { EngagementWorkflowModule } from './workflow/engagement-workflow.module';
 
 @Module({
   imports: [
@@ -28,15 +27,14 @@ import { EngagementProductConnectionResolver } from './product-connection.resolv
     forwardRef(() => LanguageModule),
     forwardRef(() => LocationModule),
     forwardRef(() => ProjectModule),
+    EngagementWorkflowModule,
   ],
   providers: [
     EngagementResolver,
     LanguageEngagementResolver,
     InternshipEngagementResolver,
-    EngagementStatusResolver,
     InternshipPositionResolver,
     EngagementProductConnectionResolver,
-    EngagementRules,
     EngagementService,
     EngagementRepository,
     EngagementLoader,