Project Workflow - PMs should not be able to bypass Consultant checks for Internships

dbschema/project.esdl

@@ -49,14 +49,10 @@ module default {
       );
     };
 
-    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);
+    step := .latestWorkflowEvent.to ?? Project::Step.EarlyConversations;
+    latestWorkflowEvent := (select .workflowEvents order by .at desc limit 1);
+    workflowEvents := .<project[is Project::WorkflowEvent];
 
     mouStart: cal::local_date;
     mouEnd: cal::local_date;
@@ -199,7 +195,30 @@ module Project {
       on target delete allow;
     };
   }
-
+
+  type WorkflowEvent {
+    required project: default::Project {
+      readonly := true;
+    };
+    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;
+    };
+  }
+
   scalar type Step extending enum<
     EarlyConversations,
     PendingConceptApproval,

package.json

@@ -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",

src/common/make-enum.ts

@@ -12,13 +12,18 @@ export type MadeEnum<
   Values extends string,
   ValueDeclaration = EnumValueDeclarationShape,
   Extra = unknown,
-> = {
-  readonly [Value in Values & string]: Value;
-} & EnumHelpers<
+> = EnumHelpers<
   Values,
   ValueDeclaration & ImplicitValueDeclarationShape<Values>
 > &
-  Readonly<Extra>;
+  Readonly<Extra> &
+  // Allow direct access to the values if they're strict.
+  // For generic `string` we don't allow this.
+  // This allows strict values to be compatible with generic values.
+  // MadeEnum<string> = MadeEnum<X>
+  (string extends Values
+    ? unknown // ignore addition
+    : { readonly [Value in Values & string]: Value });
 
 interface EnumOptions<
   ValueDeclaration extends EnumValueDeclarationShape,
@@ -217,7 +222,7 @@ type NormalizedValueDeclaration<Declaration extends EnumValueDeclarationShape> =
 interface EnumHelpers<Values extends string, ValueDeclaration> {
   readonly values: ReadonlySet<Values>;
   readonly entries: ReadonlyArray<Readonly<ValueDeclaration>>;
-  readonly entry: (value: Values) => Readonly<ValueDeclaration>;
+  readonly entry: <V extends Values>(value: V) => Readonly<ValueDeclaration>;
   readonly has: <In extends string>(
     value: In & {},
   ) => value is In & Values & {};

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

@@ -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/controller.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/field-operations-director.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/financial-analyst.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,

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

@@ -93,6 +93,38 @@ const stepsUntilFinancialEndorsement = takeWhile(
       'Review Reject',
       'Review Approve',
     ).execute,
+    r.ProjectWorkflowEvent.read.transitions(
+      'Early Conversations -> Pending Regional Director Approval',
+      'Early Conversations -> Pending Concept Approval',
+      'Early Conversations -> Did Not Develop',
+      'Prep for Consultant Endorsement -> Pending Consultant Endorsement',
+      'Prep for Consultant & Financial Endorsement & Finalizing Proposal -> Pending Concept Approval',
+      'Prep for Consultant & Financial Endorsement & Finalizing Proposal -> Did Not Develop',
+      'Pending Consultant Endorsement -> Prep for Financial Endorsement With Consultant Endorsement',
+      'Pending Consultant Endorsement -> Prep for Financial Endorsement Without Consultant Endorsement',
+      'Prep for Financial Endorsement -> Pending Financial Endorsement',
+      'Prep for Financial Endorsement & Finalizing Proposal -> Pending Consultant Endorsement',
+      'Finalizing Proposal -> Pending Regional Director Approval',
+      'Finalizing Proposal -> Pending Financial Endorsement',
+      'Active -> Discussing Change To Plan',
+      'Active -> Discussing Termination',
+      'Active -> Finalizing Completion',
+      'Discussing Change To Plan -> Pending Change To Plan Approval',
+      'Discussing Change To Plan -> Discussing Suspension',
+      'Discussing Change To Plan -> Back To Active',
+      'Pending Change To Plan Approval -> Discussing Change To Plan',
+      'Pending Change To Plan Approval -> Pending Change To Plan Confirmation',
+      'Pending Change To Plan Approval -> Back To Active',
+      'Discussing Suspension -> Pending Suspension Approval',
+      'Discussing Suspension -> Back To Active',
+      'Suspended -> Discussing Reactivation',
+      'Suspended & Discussing Reactivation -> Discussing Termination',
+      'Discussing Reactivation -> Pending Reactivation Approval',
+      'Discussing Termination -> Pending Termination Approval',
+      'Discussing Termination -> Back To Most Recent',
+      'Finalizing Completion -> Back To Active',
+      'Finalizing Completion -> Completed',
+    ).execute,
     r.Project.read.create
       .when(member)
       .edit.specifically((p) => [

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

@@ -8,5 +8,26 @@ import { member, Policy, Role, sensMediumOrLower } from '../util';
   r.Project.when(member).edit.specifically(
     (p) => p.rootDirectory.edit.when(sensMediumOrLower).read,
   ),
+  r.ProjectWorkflowEvent.read.transitions(
+    'Early Conversations -> Pending Finance Confirmation',
+    'Pending Concept Approval -> Prep for Consultant Endorsement',
+    'Pending Concept Approval -> Early Conversations',
+    'Pending Concept Approval -> Rejected',
+    'Pending Regional Director Approval -> Early Conversations',
+    'Pending Regional Director Approval -> Pending Finance Confirmation',
+    'Pending Regional Director Approval -> Pending Zone Director Approval',
+    'Pending Regional Director Approval -> Finalizing Proposal',
+    'Pending Regional Director Approval -> Did Not Develop',
+    'Pending Regional Director Approval -> Rejected',
+    'Pending Suspension Approval -> Discussing Suspension',
+    'Pending Suspension Approval -> Suspended',
+    'Pending Suspension Approval -> Back To Active',
+    'Pending Reactivation Approval -> Active Changed Plan',
+    'Pending Reactivation Approval -> Discussing Reactivation',
+    'Pending Reactivation Approval -> Discussing Termination',
+    'Pending Termination Approval -> Terminated',
+    'Pending Termination Approval -> Discussing Termination',
+    'Pending Termination Approval -> Back To Most Recent',
+  ).execute,
 ])
 export class RegionalDirectorPolicy {}

src/components/progress-report/workflow/dto/workflow-transition.dto.ts

@@ -1,10 +1,8 @@
 import { Field, ObjectType } from '@nestjs/graphql';
 import { ID, IdField } from '~/common';
-import { TransitionType } from '../../../project/dto';
+import { TransitionType } from '../../../workflow/dto';
 import { ProgressReportStatus } from '../../dto';
 
-export { TransitionType };
-
 @ObjectType()
 export abstract class ProgressReportWorkflowTransition {
   @IdField()

src/components/progress-report/workflow/progress-report-workflow.flowchart.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import open from 'open';
-import pako from 'pako';
+import { deflateSync as deflate } from 'zlib';
 import { ProgressReportStatus as Status } from '../dto';
 import { Transitions } from './transitions';
 
@@ -77,8 +77,7 @@ export class ProgressReportWorkflowFlowchart {
   }
 
   private compressAndB64encode(str: string) {
-    const data = Buffer.from(str, 'utf8');
-    const compressed = pako.deflate(data, { level: 9 });
+    const compressed = deflate(str, { level: 9 });
     const result = Buffer.from(compressed)
       .toString('base64')
       .replace(/\+/g, '-')

src/components/progress-report/workflow/transitions.ts

@@ -1,11 +1,9 @@
 import { mapValues } from '@seedcompany/common';
 import { createHash } from 'crypto';
 import { ID, Many, maybeMany, Role } from '~/common';
+import { TransitionType as Type } from '../../workflow/dto';
 import { ProgressReportStatus as Status } from '../dto';
-import {
-  ProgressReportWorkflowTransition as PublicTransition,
-  TransitionType as Type,
-} from './dto/workflow-transition.dto';
+import { ProgressReportWorkflowTransition as PublicTransition } from './dto/workflow-transition.dto';
 
 // This also controls the order shown in the UI.
 // Therefore, these should generally flow down.

src/components/project/dto/project-step.enum.ts

@@ -1,4 +1,4 @@
-import { Field, ObjectType } from '@nestjs/graphql';
+import { ObjectType } from '@nestjs/graphql';
 import { EnumType, makeEnum, SecuredEnum } from '~/common';
 
 export type ProjectStep = EnumType<typeof ProjectStep>;
@@ -13,7 +13,10 @@ export const ProjectStep = makeEnum({
     'PendingFinancialEndorsement',
     'FinalizingProposal',
     'PendingRegionalDirectorApproval',
-    'PendingZoneDirectorApproval',
+    {
+      value: 'PendingZoneDirectorApproval',
+      label: 'Pending Field Operations Approval',
+    },
     'PendingFinanceConfirmation',
     'OnHoldFinanceConfirmation',
     'DidNotDevelop',
@@ -40,27 +43,3 @@ export const ProjectStep = makeEnum({
   description: SecuredEnum.descriptionFor('a project step'),
 })
 export class SecuredProjectStep extends SecuredEnum(ProjectStep) {}
-
-export type TransitionType = EnumType<typeof TransitionType>;
-export const TransitionType = makeEnum({
-  name: 'TransitionType',
-  values: ['Neutral', 'Approve', 'Reject'],
-});
-
-@ObjectType()
-export abstract class ProjectStepTransition {
-  @Field(() => ProjectStep)
-  to: ProjectStep;
-
-  @Field()
-  label: string;
-
-  @Field(() => TransitionType)
-  type: TransitionType;
-
-  @Field(() => Boolean, { defaultValue: false })
-  disabled?: boolean;
-
-  @Field(() => String, { nullable: true })
-  disabledReason?: string;
-}