DRY distro emails & tweak notifier descriptions

Author: CarsonF

src/components/project/workflow/project-workflow.ts

@@ -13,7 +13,7 @@ import {
   ResolveParams,
 } from './transitions/dynamic-step';
 import {
-  EmailDistros,
+  EmailDistro,
   FinancialApprovers,
   TeamMembers,
 } from './transitions/notifiers';
@@ -22,6 +22,16 @@ import {
 // Therefore, these should generally flow down.
 // "Back" transitions should come before/above "forward" transitions.
 
+const Distros = {
+  Projects: EmailDistro('[email protected]'),
+  Approval: EmailDistro('[email protected]'),
+  Extension: EmailDistro('[email protected]'),
+  Revision: EmailDistro('[email protected]'),
+  Suspension: EmailDistro('[email protected]'),
+  Termination: EmailDistro('[email protected]'),
+  Closing: EmailDistro('[email protected]'),
+};
+
 export const ProjectWorkflow = defineWorkflow({
   id: '8297b9a1-b50b-4ec9-9021-a0347424b3ec',
   name: 'Project',
@@ -254,10 +264,7 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.Active,
     label: 'Confirm Project 🎉',
     type: Type.Approve,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Approval, Distros.Projects],
   },
   'Pending Finance Confirmation -> Pending Regional Director Approval': {
     from: Step.PendingFinanceConfirmation,
@@ -306,30 +313,21 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.DiscussingChangeToPlan,
     label: 'Discuss Change to Plan',
     type: Type.Neutral,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Extension, Distros.Revision],
   },
   'Active -> Discussing Termination': {
     from: [Step.Active, Step.ActiveChangedPlan],
     to: Step.DiscussingTermination,
     label: 'Discuss Termination',
     type: Type.Neutral,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Extension, Distros.Revision],
   },
   'Active -> Finalizing Completion': {
     from: [Step.Active, Step.ActiveChangedPlan],
     to: Step.FinalizingCompletion,
     label: 'Finalize Completion',
     type: Type.Approve,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Extension, Distros.Revision],
   },
 
   // Disucssing Change To Plan
@@ -338,27 +336,21 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.PendingChangeToPlanApproval,
     label: 'Submit for Approval',
     type: Type.Approve,
-    notifiers: [
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [Distros.Extension, Distros.Revision],
   },
   'Discussing Change To Plan -> Discussing Suspension': {
     from: Step.DiscussingChangeToPlan,
     to: Step.DiscussingSuspension,
     label: 'Discuss Suspension',
     type: Type.Neutral,
-    notifiers: [
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [Distros.Extension, Distros.Revision],
   },
   'Discussing Change To Plan -> Back To Active': {
     from: Step.DiscussingChangeToPlan,
     to: BackToActive,
     label: 'Will Not Change Plan',
     type: Type.Neutral,
-    notifiers: [
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [Distros.Extension, Distros.Revision],
   },
 
   // Pending Change To Plan Approval
@@ -367,30 +359,21 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.DiscussingChangeToPlan,
     label: 'Send Back for Corrections',
     type: Type.Reject,
-    notifiers: EmailDistros(
-      '[email protected]',
-      '[email protected]',
-    ),
+    notifiers: [Distros.Extension, Distros.Revision],
   },
   'Pending Change To Plan Approval -> Pending Change To Plan Confirmation': {
     from: Step.PendingChangeToPlanApproval,
     to: Step.PendingChangeToPlanConfirmation,
     label: 'Approve Change to Plan',
     type: Type.Approve,
-    notifiers: EmailDistros(
-      '[email protected]',
-      '[email protected]',
-    ),
+    notifiers: [Distros.Extension, Distros.Revision],
   },
   'Pending Change To Plan Approval -> Back To Active': {
     from: Step.PendingChangeToPlanApproval,
     to: BackToActive,
     label: 'Reject Change to Plan',
     type: Type.Reject,
-    notifiers: EmailDistros(
-      '[email protected]',
-      '[email protected]',
-    ),
+    notifiers: [Distros.Extension, Distros.Revision],
   },
 
   // Pending Change To Plan Confirmation
@@ -399,30 +382,21 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.DiscussingChangeToPlan,
     label: 'Send Back for Corrections',
     type: Type.Reject,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Extension, Distros.Revision],
   },
   'Pending Change To Plan Confirmation -> Active Changed Plan': {
     from: Step.PendingChangeToPlanConfirmation,
     to: Step.ActiveChangedPlan,
     label: 'Approve Change to Plan',
     type: Type.Approve,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Extension, Distros.Revision],
   },
   'Pending Change To Plan Confirmation -> Back To Active': {
     from: Step.PendingChangeToPlanConfirmation,
     to: BackToActive,
     label: 'Reject Change to Plan',
     type: Type.Reject,
-    notifiers: [
-      FinancialApprovers,
-      EmailDistros('[email protected]', '[email protected]'),
-    ],
+    notifiers: [FinancialApprovers, Distros.Extension, Distros.Revision],
   },
 
   // Discussing Suspension
@@ -431,14 +405,14 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.PendingSuspensionApproval,
     label: 'Submit for Approval',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
   'Discussing Suspension -> Back To Active': {
     from: Step.DiscussingSuspension,
     to: BackToActive,
     label: 'Will Not Suspend',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
 
   // Pending Suspension Approval
@@ -447,21 +421,21 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.DiscussingSuspension,
     label: 'Send Back for Corrections',
     type: Type.Reject,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
   'Pending Suspension Approval -> Suspended': {
     from: Step.PendingSuspensionApproval,
     to: Step.Suspended,
     label: 'Approve Suspension',
     type: Type.Approve,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
   'Pending Suspension Approval -> Back To Active': {
     from: Step.PendingSuspensionApproval,
     to: BackToActive,
     label: 'Reject Suspension',
     type: Type.Reject,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
 
   // Suspended
@@ -470,14 +444,14 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.DiscussingReactivation,
     label: 'Discuss Reactivation',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
   'Suspended & Discussing Reactivation -> Discussing Termination': {
     from: [Step.Suspended, Step.DiscussingReactivation],
     to: Step.DiscussingTermination,
     label: 'Discuss Termination',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
 
   // Discussing Reactivation
@@ -486,7 +460,7 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.PendingReactivationApproval,
     label: 'Submit for Approval',
     type: Type.Approve,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
 
   // Pending Reactivation Approval
@@ -495,21 +469,21 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.ActiveChangedPlan,
     label: 'Approve Reactivation',
     type: Type.Approve,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
   'Pending Reactivation Approval -> Discussing Reactivation': {
     from: Step.PendingReactivationApproval,
     to: Step.DiscussingReactivation,
     label: 'Send Back for Corrections',
     type: Type.Reject,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
   'Pending Reactivation Approval -> Discussing Termination': {
     from: Step.PendingReactivationApproval,
     to: Step.DiscussingTermination,
     label: 'Discuss Termination',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Suspension,
   },
 
   // Discussing Termination
@@ -518,7 +492,7 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.PendingTerminationApproval,
     label: 'Submit for Approval',
     type: Type.Approve,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Termination,
   },
   'Discussing Termination -> Back To Most Recent': {
     from: Step.DiscussingTermination,
@@ -530,7 +504,7 @@ export const ProjectWorkflow = defineWorkflow({
     ),
     label: 'Will Not Terminate',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Termination,
   },
 
   // Pending Termination Approval
@@ -539,14 +513,14 @@ export const ProjectWorkflow = defineWorkflow({
     to: Step.Terminated,
     label: 'Approve Termination',
     type: Type.Approve,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Termination,
   },
   'Pending Termination Approval -> Discussing Termination': {
     from: Step.PendingTerminationApproval,
     to: Step.DiscussingTermination,
     label: 'Send Back for Corrections',
     type: Type.Reject,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Termination,
   },
   'Pending Termination Approval -> Back To Most Recent': {
     from: Step.PendingTerminationApproval,
@@ -558,7 +532,7 @@ export const ProjectWorkflow = defineWorkflow({
     ),
     label: 'Will Not Terminate',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Termination,
   },
 
   // Finalizing Completion
@@ -567,14 +541,14 @@ export const ProjectWorkflow = defineWorkflow({
     to: BackToActive,
     label: 'Still Working',
     type: Type.Neutral,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Closing,
   },
   'Finalizing Completion -> Completed': {
     from: Step.FinalizingCompletion,
     to: Step.Completed,
     label: 'Complete 🎉',
     type: Type.Approve,
     conditions: RequireOngoingEngagementsToBeFinalizingCompletion,
-    notifiers: EmailDistros('[email protected]'),
+    notifiers: Distros.Closing,
   },
 });

src/components/project/workflow/transitions/notifiers.ts

@@ -8,7 +8,7 @@ import { ResolveParams } from './dynamic-step';
 type Notifier = TransitionNotifier<ResolveParams>;
 
 export const TeamMembers: Notifier = {
-  description: 'The project members',
+  description: 'Project members',
   async resolve({ project, moduleRef }) {
     return await moduleRef
       .get(ProjectMemberRepository, { strict: false })
@@ -17,7 +17,9 @@ export const TeamMembers: Notifier = {
 };
 
 export const TeamMembersWithRole = (...roles: Role[]): Notifier => ({
-  description: 'The project members',
+  description: `Project members with one of these roles: ${roles
+    .map((r) => Role.entry(r).label)
+    .join(', ')}`,
   async resolve({ project, moduleRef }) {
     return await moduleRef
       .get(ProjectMemberRepository, { strict: false })
@@ -26,21 +28,21 @@ export const TeamMembersWithRole = (...roles: Role[]): Notifier => ({
 });
 
 export const FinancialApprovers: Notifier = {
-  description: 'All financial approvers according to the project type',
+  description: 'Financial approvers for the project type',
   async resolve({ project, moduleRef }) {
     const repo = moduleRef.get(FinancialApproverRepository, { strict: false });
     const approvers = await repo.read(project.type);
     return approvers.map((approver) => approver.user);
   },
 };
 
-export const EmailDistros = (...emails: string[]): Notifier => ({
-  description: `These email addresses: ${emails.join(', ')}`,
+export const EmailDistro = (email: string): Notifier => ({
+  description: email,
   resolve({ moduleRef }) {
     const config = moduleRef.get(ConfigService, { strict: false });
     if (!config.email.notifyDistributionLists) {
       return [];
     }
-    return emails.map((email) => ({ email }));
+    return { email };
   },
 });