Merge pull request #3241 from SeedCompany/project-workflow

Project Workflow v2 Polish - Transition Names & Auth

Author: CarsonF

dbschema/migrations/00011-m1ohpds.edgeql

@@ -1,5 +1,5 @@
 module Project {
-  type WorkflowEvent {
+  type WorkflowEvent extending ContextAware {
     required project: default::Project {
       readonly := true;
       on target delete delete source;

dbschema/project-workflow.esdl

@@ -8,10 +8,12 @@ module default {
     Mixin::Pinnable,
     Mixin::Taggable
   {
+    type := <Project::Type>.__type__.name[9:-7];
+
     overloaded name {
       constraint exclusive;
     };
-    
+
     overloaded required ownSensitivity: Sensitivity {
       annotation description := "The sensitivity of the project. \
         This is user settable for internships and calculated for translation projects";

dbschema/project.esdl

@@ -140,7 +140,11 @@ export default (async function ({ e, db, print }) {
 
     if (step !== 'EarlyConversations') {
       await e
-        .insert(e.Project.WorkflowEvent, { project: projectRef, to: step })
+        .insert(e.Project.WorkflowEvent, {
+          project: projectRef,
+          projectContext: projectRef.projectContext,
+          to: step,
+        })
         .run(db);
     }
   }

dbschema/seeds/008.projects.ts

@@ -1,4 +1,5 @@
 import { member, Policy, Role, sensMediumOrLower, sensOnlyLow } from '../util';
+import * as Consultant from './consultant.policy';
 
 // NOTE: There could be other permissions for this role from other policies
 @Policy(Role.ConsultantManager, (r) => [
@@ -28,7 +29,6 @@ import { member, Policy, Role, sensMediumOrLower, sensOnlyLow } from '../util';
   ]),
   r.Project.read
     .specifically((p) => [
-      p.many('step', 'stepChangedAt').edit,
       p
         .many(
           'financialReportPeriod',
@@ -41,6 +41,7 @@ import { member, Policy, Role, sensMediumOrLower, sensOnlyLow } from '../util';
       p.rootDirectory.whenAny(member, sensMediumOrLower).edit,
     ])
     .children((c) => [c.posts.edit]),
+  r.ProjectWorkflowEvent.transitions(Consultant.projectTransitions).execute,
   [
     r.PeriodicReport,
     r.ProgressReportCommunityStory,

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

@@ -1,5 +1,12 @@
+import { ProjectWorkflow } from '../../../project/workflow/project-workflow';
 import { member, Policy, Role } from '../util';
 
+export const projectTransitions = () =>
+  ProjectWorkflow.pickNames(
+    'Consultant Endorses Proposal',
+    'Consultant Opposes Proposal',
+  );
+
 // NOTE: There could be other permissions for this role from other policies
 @Policy([Role.Consultant, Role.ConsultantManager], (r) => [
   [
@@ -33,14 +40,12 @@ import { member, Policy, Role } from '../util';
   r.NarrativeReport.when(member).edit.create,
   r.Organization.specifically((p) => p.address.none),
   r.Partner.specifically((p) => p.pointOfContact.none),
-  r.Project.when(member).specifically((p) => [
-    p.many('step', 'stepChangedAt', 'rootDirectory').edit,
-  ]),
+  r.Project.when(member).specifically((p) => p.rootDirectory.edit),
   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',
+  r.ProjectWorkflowEvent.read.whenAll(
+    member,
+    r.ProjectWorkflowEvent.isTransitions(projectTransitions),
   ).execute,
 ])
 export class ConsultantPolicy {}

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

@@ -6,15 +6,15 @@ import { Policy, Role } from '../util';
   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',
+    'Finance Approves Proposal',
+    'Finance Holds for Confirmation',
+    'Finance Requests Proposal Changes',
+    'Finance Requests Multiplication Changes',
+    'Finance Rejects Proposal',
+    'Finance Ends Development',
+    'Finance Approves Change To Plan',
+    'Finance Requests Changes for Change To Plan',
+    'Finance Rejects Change To Plan',
   ).execute,
 ])
 export class ControllerPolicy {}

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

@@ -16,9 +16,9 @@ import { Policy, Role } from '../util';
   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',
+    'Field Ops Approves Proposal',
+    'Field Ops Requests Proposal Changes',
+    'Field Ops Rejects Proposal',
   ).execute,
   r.PeriodicReport.edit,
   r.StepProgress.edit,

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

@@ -1,4 +1,5 @@
 import { member, Policy, Role, sensMediumOrLower } from '../util';
+import * as FA from './financial-analyst.policy';
 
 // NOTE: There could be other permissions for this role from other policies
 @Policy([Role.LeadFinancialAnalyst, Role.Controller], (r) => [
@@ -35,6 +36,7 @@ import { member, Policy, Role, sensMediumOrLower } from '../util';
       'financialReportReceivedAt',
     ).edit,
   ]),
+  r.ProjectWorkflowEvent.transitions(FA.projectTransitions).execute,
   r.ProjectMember.edit.create.delete,
 ])
 export class FinancialAnalystLeadPolicy {}

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

@@ -1,3 +1,4 @@
+import { ProjectWorkflow } from '../../../project/workflow/project-workflow';
 import {
   inherit,
   member,
@@ -7,6 +8,14 @@ import {
   sensOnlyLow,
 } from '../util';
 
+export const projectTransitions = () =>
+  ProjectWorkflow.pickNames(
+    'Finance Endorses Proposal',
+    'Finance Opposes Proposal',
+    'Not Ready for Completion',
+    'Complete',
+  );
+
 // NOTE: There could be other permissions for this role from other policies
 @Policy(
   [Role.FinancialAnalyst, Role.LeadFinancialAnalyst, Role.Controller],
@@ -61,11 +70,9 @@ 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',
+    r.ProjectWorkflowEvent.read.whenAll(
+      member,
+      r.ProjectWorkflowEvent.isTransitions(projectTransitions),
     ).execute,
     r.PeriodicReport.read.when(member).edit,
     r.StepProgress.read,