Merge pull request #3236 from SeedCompany/project-workflow

Author: CarsonF

dbschema/migrations/00010-m1sznh4.edgeql

@@ -0,0 +1,119 @@
+module Project {
+  type WorkflowEvent {
+    required project: default::Project {
+      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: Step {
+      readonly := true;
+    };
+    notes: default::RichText {
+      readonly := true;
+    };
+
+    trigger setProjectStep after insert for all do (
+      update default::Project
+      filter default::Project in __new__.project
+      set {
+        step := default::Project.latestWorkflowEvent.to ?? Project::Step.EarlyConversations
+      }
+    );
+    trigger refreshProjectStep after delete for all do (
+      update default::Project
+      filter default::Project in __old__.project
+      set {
+        step := default::Project.latestWorkflowEvent.to ?? Project::Step.EarlyConversations
+      }
+    );
+  }
+
+  scalar type Step extending enum<
+    EarlyConversations,
+    PendingConceptApproval,
+    PrepForConsultantEndorsement,
+    PendingConsultantEndorsement,
+    PrepForFinancialEndorsement,
+    PendingFinancialEndorsement,
+    FinalizingProposal,
+    PendingRegionalDirectorApproval,
+    PendingZoneDirectorApproval,
+    PendingFinanceConfirmation,
+    OnHoldFinanceConfirmation,
+    DidNotDevelop,
+    Rejected,
+    Active,
+    ActiveChangedPlan,
+    DiscussingChangeToPlan,
+    PendingChangeToPlanApproval,
+    PendingChangeToPlanConfirmation,
+    DiscussingSuspension,
+    PendingSuspensionApproval,
+    Suspended,
+    DiscussingReactivation,
+    PendingReactivationApproval,
+    DiscussingTermination,
+    PendingTerminationApproval,
+    FinalizingCompletion,
+    Terminated,
+    Completed,
+  >;
+
+  scalar type Status extending enum<
+    InDevelopment,
+    Active,
+    Terminated,
+    Completed,
+    DidNotDevelop,
+  >;
+
+  function statusFromStep(step: Step) -> Status
+    using (
+      with dev := {
+        Step.EarlyConversations,
+        Step.PendingConceptApproval,
+        Step.PrepForConsultantEndorsement,
+        Step.PendingConsultantEndorsement,
+        Step.PrepForFinancialEndorsement,
+        Step.PendingFinancialEndorsement,
+        Step.FinalizingProposal,
+        Step.PendingRegionalDirectorApproval,
+        Step.PendingZoneDirectorApproval,
+        Step.PendingFinanceConfirmation,
+        Step.OnHoldFinanceConfirmation,
+      },
+      active := {
+        Step.Active,
+        Step.ActiveChangedPlan,
+        Step.DiscussingChangeToPlan,
+        Step.PendingChangeToPlanApproval,
+        Step.PendingChangeToPlanConfirmation,
+        Step.DiscussingSuspension,
+        Step.PendingSuspensionApproval,
+        Step.Suspended,
+        Step.DiscussingReactivation,
+        Step.PendingReactivationApproval,
+        Step.DiscussingTermination,
+        Step.PendingTerminationApproval,
+        Step.FinalizingCompletion,
+      }
+    select
+      Status.InDevelopment if step in dev else
+      Status.Active        if step in active else
+      Status.DidNotDevelop if step = Step.DidNotDevelop else
+      Status.DidNotDevelop if step = Step.Rejected else
+      Status.Terminated    if step = Step.Terminated else
+      Status.Completed     if step = Step.Completed else
+      Status.InDevelopment
+    )
+}

dbschema/project-workflow.esdl

@@ -48,16 +48,21 @@ module default {
           )) else .departmentId
       );
     };
-    
+
     required step: Project::Step {
       default := Project::Step.EarlyConversations;
     };
-    required stepChangedAt: datetime {
-      default := .createdAt;
-      rewrite update using (datetime_of_statement() if .step != __old__.step else .stepChangedAt);
-    }
-    property status := Project::statusFromStep(.step);
-    
+    status := Project::statusFromStep(.step);
+    latestWorkflowEvent := (select .workflowEvents order by .at desc limit 1);
+    workflowEvents := .<project[is Project::WorkflowEvent];
+    trigger assertMatchingLatestWorkflowEvent after insert, update for each do (
+      assert(
+        __new__.latestWorkflowEvent.to ?= __new__.step
+        or (not exists __new__.latestWorkflowEvent and __new__.step = Project::Step.EarlyConversations),
+        message := "Project step must match the latest workflow event"
+      )
+    );
+
     mouStart: cal::local_date;
     mouEnd: cal::local_date;
     constraint expression on (.mouEnd >= .mouStart);
@@ -199,83 +204,4 @@ module Project {
       on target delete allow;
     };
   }
-  
-  scalar type Step extending enum<
-    EarlyConversations,
-    PendingConceptApproval,
-    PrepForConsultantEndorsement,
-    PendingConsultantEndorsement,
-    PrepForFinancialEndorsement,
-    PendingFinancialEndorsement,
-    FinalizingProposal,
-    PendingRegionalDirectorApproval,
-    PendingZoneDirectorApproval,
-    PendingFinanceConfirmation,
-    OnHoldFinanceConfirmation,
-    DidNotDevelop,
-    Rejected,
-    Active,
-    ActiveChangedPlan,
-    DiscussingChangeToPlan,
-    PendingChangeToPlanApproval,
-    PendingChangeToPlanConfirmation,
-    DiscussingSuspension,
-    PendingSuspensionApproval,
-    Suspended,
-    DiscussingReactivation,
-    PendingReactivationApproval,
-    DiscussingTermination,
-    PendingTerminationApproval,
-    FinalizingCompletion,
-    Terminated,
-    Completed,
-  >;
-  
-  scalar type Status extending enum<
-    InDevelopment,
-    Active,
-    Terminated,
-    Completed,
-    DidNotDevelop,
-  >;
-  
-  function statusFromStep(step: Step) -> Status
-    using (
-      with dev := {
-        Step.EarlyConversations,
-        Step.PendingConceptApproval,
-        Step.PrepForConsultantEndorsement,
-        Step.PendingConsultantEndorsement,
-        Step.PrepForFinancialEndorsement,
-        Step.PendingFinancialEndorsement,
-        Step.FinalizingProposal,
-        Step.PendingRegionalDirectorApproval,
-        Step.PendingZoneDirectorApproval,
-        Step.PendingFinanceConfirmation,
-        Step.OnHoldFinanceConfirmation,
-      },
-      active := {
-        Step.Active,
-        Step.ActiveChangedPlan,
-        Step.DiscussingChangeToPlan,
-        Step.PendingChangeToPlanApproval,
-        Step.PendingChangeToPlanConfirmation,
-        Step.DiscussingSuspension,
-        Step.PendingSuspensionApproval,
-        Step.Suspended,
-        Step.DiscussingReactivation,
-        Step.PendingReactivationApproval,
-        Step.DiscussingTermination,
-        Step.PendingTerminationApproval,
-        Step.FinalizingCompletion,
-      }
-    select
-      Status.InDevelopment if step in dev else
-      Status.Active        if step in active else
-      Status.DidNotDevelop if step = Step.DidNotDevelop else
-      Status.DidNotDevelop if step = Step.Rejected else
-      Status.Terminated    if step = Step.Terminated else
-      Status.Completed     if step = Step.Completed else
-      Status.InDevelopment
-    )
 }

dbschema/project.esdl

@@ -111,7 +111,7 @@ export default (async function ({ e, db, print }) {
     return;
   }
 
-  for (const { type, ...project } of newProjects) {
+  for (const { type, step, ...project } of newProjects) {
     const insertQ = e.insert(e[`${type}Project`], {
       ...project,
       ...mapValues.fromList(
@@ -137,6 +137,12 @@ export default (async function ({ e, db, print }) {
       set: { projects: projectRef },
     }));
     await pcQuery.run(db);
+
+    if (step !== 'EarlyConversations') {
+      await e
+        .insert(e.Project.WorkflowEvent, { project: projectRef, to: step })
+        .run(db);
+    }
   }
   print({ 'Added Projects': newProjects.map((t) => t.name) });
 } satisfies SeedFn);

dbschema/seeds/008.projects.ts

@@ -90,7 +90,6 @@
     "nanoid": "^4.0.2",
     "neo4j-driver": "^5.20.0",
     "p-retry": "^5.1.2",
-    "pako": "^2.1.0",
     "pkg-up": "^4.0.0",
     "plur": "^5.1.0",
     "prismjs-terminal": "^1.2.3",
@@ -125,7 +124,6 @@
     "@types/lodash": "^4.14.200",
     "@types/luxon": "^3.3.3",
     "@types/node": "^20.12.5",
-    "@types/pako": "^2.0.2",
     "@types/prismjs": "^1.26.2",
     "@types/react": "^18.2.33",
     "@types/stack-trace": "^0.0.32",

package.json

@@ -38,5 +38,9 @@ import { member, Policy, Role } from '../util';
   ]),
   r.Unavailability.read,
   r.User.read.create,
+  r.ProjectWorkflowEvent.read.transitions(
+    'Pending Consultant Endorsement -> Prep for Financial Endorsement With Consultant Endorsement',
+    'Pending Consultant Endorsement -> Prep for Financial Endorsement Without Consultant Endorsement',
+  ).execute,
 ])
 export class ConsultantPolicy {}

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

@@ -5,5 +5,16 @@ import { Policy, Role } from '../util';
   // keep multiline format
   r.Organization.delete,
   r.Partner.delete,
+  r.ProjectWorkflowEvent.read.transitions(
+    'Pending & On Hold Finance Confirmation -> Active',
+    'Pending Finance Confirmation -> Pending Regional Director Approval',
+    'Pending Finance Confirmation -> Did Not Develop',
+    'Pending Finance Confirmation -> On Hold Finance Confirmation',
+    'Pending & On Hold Finance Confirmation -> Finalizing Proposal',
+    'Pending & On Hold Finance Confirmation -> Rejected',
+    'Pending Change To Plan Confirmation -> Discussing Change To Plan',
+    'Pending Change To Plan Confirmation -> Active Changed Plan',
+    'Pending Change To Plan Confirmation -> Back To Active',
+  ).execute,
 ])
 export class ControllerPolicy {}

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

@@ -15,6 +15,11 @@ import { Policy, Role } from '../util';
   r.Product.edit.create.delete,
   r.Project.edit,
   r.ProjectMember.edit.create.delete,
+  r.ProjectWorkflowEvent.read.transitions(
+    'Pending Zone Director Approval -> Pending Finance Confirmation',
+    'Pending Zone Director Approval -> Finalizing Proposal',
+    'Pending Zone Director Approval -> Rejected',
+  ).execute,
   r.PeriodicReport.edit,
   r.StepProgress.edit,
 ])

src/components/authorization/policies/by-role/field-operations-director.policy.ts

@@ -61,6 +61,12 @@ import {
       ])
       .children((c) => c.posts.edit),
     r.ProjectMember.read.when(member).edit.create.delete,
+    r.ProjectWorkflowEvent.read.transitions(
+      'Pending Financial Endorsement -> Finalizing Proposal With Financial Endorsement',
+      'Pending Financial Endorsement -> Finalizing Proposal Without Financial Endorsement',
+      'Finalizing Completion -> Back To Active',
+      'Finalizing Completion -> Completed',
+    ).execute,
     r.PeriodicReport.read.when(member).edit,
     r.StepProgress.read,
     r.Unavailability.read,