Merge pull request #3396 from SeedCompany/bugfix/valid-date-ranges

CarsonF · web-flow · commit b64bbe8d9bef · 2025-04-23T16:15:35.000-05:00
diff --git a/dbschema/common.gel b/dbschema/common.gel
@@ -18,7 +18,12 @@ module default {
        )
     )
   );
-  
+
+  function array_join_maybe(array: array<str>, delimiter: str) -> optional str using (
+    with joined := array_join(array, delimiter)
+    select if joined = "" then <str>{} else joined
+  );
+
   scalar type nanoid extending str;
   
   scalar type RichText extending json;
diff --git a/dbschema/migrations/00018-m1jf7p4.edgeql b/dbschema/migrations/00018-m1jf7p4.edgeql
diff --git a/src/common/exceptions/index.ts b/src/common/exceptions/index.ts
@@ -1,5 +1,6 @@
 export * from './exception';
 export * from './input.exception';
+export * from './range.exception';
 export * from './duplicate.exception';
 export * from './not-found.exception';
 export * from './not-implemented.exception';
diff --git a/src/common/exceptions/range.exception.ts b/src/common/exceptions/range.exception.ts
@@ -0,0 +1,7 @@
+import { InputException } from '~/common';
+
+export class RangeException extends InputException {
+  constructor(options?: { message?: string; field?: string; cause?: Error }) {
+    super(options?.message ?? `Invalid range`, options?.field, options?.cause);
+  }
+}
diff --git a/src/components/engagement/dto/engagement.dto.ts b/src/components/engagement/dto/engagement.dto.ts
@@ -81,6 +81,12 @@ class Engagement extends Interfaces {
   @Field(() => IProject)
   declare readonly parent: BaseNode;
 
+  readonly label: Readonly<{
+    project: string;
+    language: string | null;
+    intern: string | null;
+  }>;
+
   @Field(() => SecuredEngagementStatus, {
     middleware: [parentIdMiddleware],
   })
diff --git a/src/components/engagement/engagement.gel.repository.ts b/src/components/engagement/engagement.gel.repository.ts
@@ -63,19 +63,51 @@ const languageHydrate = e.shape(e.LanguageEngagement, (le) => ({
   ...baseHydrate(le),
   __typename: le.__type__.name,
   ...languageExtraHydrate,
+  label: e.select({
+    project: le.project.name,
+    language: le.language.name,
+    intern: e.cast(e.str, e.set()),
+  }),
 }));
 
 const internshipHydrate = e.shape(e.InternshipEngagement, (ie) => ({
   ...baseHydrate(ie),
   __typename: ie.__type__.name,
   ...internshipExtraHydrate,
+  label: e.select({
+    project: ie.project.name,
+    language: e.cast(e.str, e.set()),
+    intern: e.array_join_maybe(
+      e.array([ie.intern.displayFirstName, ie.intern.displayLastName]),
+      ' ',
+    ),
+  }),
 }));
 
-const hydrate = e.shape(e.Engagement, (engagement) => ({
-  ...baseHydrate(engagement),
-  ...e.is(e.LanguageEngagement, languageExtraHydrate),
-  ...e.is(e.InternshipEngagement, internshipExtraHydrate),
-}));
+const hydrate = e.shape(e.Engagement, (engagement) => {
+  const langEng = e.select(e.LanguageEngagement, () => ({
+    filter_single: { id: engagement.id },
+  }));
+  const internEng = e.select(e.InternshipEngagement, () => ({
+    filter_single: { id: engagement.id },
+  }));
+  return {
+    ...baseHydrate(engagement),
+    ...e.is(e.LanguageEngagement, languageExtraHydrate),
+    ...e.is(e.InternshipEngagement, internshipExtraHydrate),
+    label: e.select({
+      project: engagement.project.name,
+      language: langEng.language.name,
+      intern: e.array_join_maybe(
+        e.array([
+          internEng.intern.displayFirstName,
+          internEng.intern.displayLastName,
+        ]),
+        ' ',
+      ),
+    }),
+  };
+});
 
 export const ConcreteRepos = {
   LanguageEngagement: class LanguageEngagementRepository extends RepoFor(
diff --git a/src/components/engagement/engagement.repository.ts b/src/components/engagement/engagement.repository.ts
@@ -49,6 +49,7 @@ import {
   requestingUser,
   SortCol,
   sortWith,
+  textJoinMaybe,
   whereNotDeletedInChangeset,
 } from '~/core/database/query';
 import { Privileges } from '../authorization';
@@ -168,6 +169,7 @@ export class EngagementRepository extends CommonRepository {
           relation('out', '', 'mouEnd', ACTIVE),
           node('mouEnd'),
         ])
+        .apply(matchNames)
         .match([
           [
             node('project'),
@@ -193,6 +195,11 @@ export class EngagementRepository extends CommonRepository {
               step: 'step.value',
             },
             language: 'language { .id }',
+            label: {
+              project: 'projectName.value',
+              language: 'languageName.value',
+              intern: textJoinMaybe(['dfn.value', 'dln.value']),
+            },
             pnp: { id: 'props.pnp' },
             growthPlan: { id: 'props.growthPlan' },
             ceremony: 'ceremony { .id }',
diff --git a/src/components/engagement/engagement.service.ts b/src/components/engagement/engagement.service.ts
@@ -1,8 +1,11 @@
 import { forwardRef, Inject, Injectable } from '@nestjs/common';
 import {
+  CalendarDate,
   ID,
   InputException,
   ObjectView,
+  Range,
+  RangeException,
   SecuredList,
   Session,
   UnsecuredDto,
@@ -16,6 +19,7 @@ import {
   Logger,
   ResourceLoader,
 } from '~/core';
+import { AnyChangesOf } from '~/core/database/changes';
 import { Privileges } from '../authorization';
 import { CeremonyService } from '../ceremony';
 import { ProductService } from '../product';
@@ -67,6 +71,7 @@ export class EngagementService {
   ): Promise<LanguageEngagement> {
     await this.verifyCreateEngagement(input.projectId, session);
     this.verifyCreationStatus(input.status);
+    EngagementDateRangeException.throwIfInvalid(input);
 
     const engagement = await this.repo.createLanguageEngagement(
       input,
@@ -87,6 +92,7 @@ export class EngagementService {
   ): Promise<InternshipEngagement> {
     await this.verifyCreateEngagement(input.projectId, session);
     this.verifyCreationStatus(input.status);
+    EngagementDateRangeException.throwIfInvalid(input);
 
     const { id } = await this.repo.createInternshipEngagement(
       input,
@@ -172,6 +178,7 @@ export class EngagementService {
     this.privileges
       .for(session, LanguageEngagement, object)
       .verifyChanges(changes);
+    EngagementDateRangeException.throwIfInvalid(previous, changes);
 
     const updated = await this.repo.updateLanguage(
       {
@@ -218,6 +225,7 @@ export class EngagementService {
     this.privileges
       .for(session, InternshipEngagement, object)
       .verifyChanges(changes, { pathPrefix: 'engagement' });
+    EngagementDateRangeException.throwIfInvalid(previous, changes);
 
     const updated = await this.repo.updateInternship(
       { id: object.id, ...changes },
@@ -310,3 +318,33 @@ export class EngagementService {
     return ids.length > 0;
   }
 }
+
+class EngagementDateRangeException extends RangeException {
+  static throwIfInvalid(
+    current: Partial<
+      Pick<UnsecuredDto<Engagement>, 'startDateOverride' | 'endDateOverride'>
+    >,
+    changes: AnyChangesOf<Engagement> = {},
+  ) {
+    const start =
+      changes.startDateOverride !== undefined
+        ? changes.startDateOverride
+        : current.startDateOverride;
+    const end =
+      changes.endDateOverride !== undefined
+        ? changes.endDateOverride
+        : current.endDateOverride;
+    if (start && end && start > end) {
+      const field =
+        changes.endDateOverride !== undefined
+          ? 'engagement.endDateOverride'
+          : 'engagement.startDateOverride';
+      throw new EngagementDateRangeException({ start, end }, field);
+    }
+  }
+
+  constructor(readonly value: Range<CalendarDate>, readonly field: string) {
+    const message = "Engagement's start date must be before the end date";
+    super({ message, field });
+  }
+}
diff --git a/src/components/engagement/handlers/index.ts b/src/components/engagement/handlers/index.ts
@@ -1,3 +1,4 @@
+export * from './validate-eng-date-overrides-on-project-change.handler';
 export * from './set-initial-end-date.handler';
 export * from './update-engagement-status.handler';
 export * from './set-last-status-date.handler';
diff --git a/src/components/engagement/handlers/validate-eng-date-overrides-on-project-change.handler.ts b/src/components/engagement/handlers/validate-eng-date-overrides-on-project-change.handler.ts
@@ -0,0 +1,95 @@
+import { isNotFalsy, NonEmptyArray } from '@seedcompany/common';
+import { CalendarDate, ID, RangeException, type UnsecuredDto } from '~/common';
+import { EventsHandler, IEventHandler } from '~/core';
+import type { Project } from '../../project/dto';
+import { ProjectUpdatedEvent } from '../../project/events';
+import { EngagementService } from '../engagement.service';
+
+@EventsHandler(ProjectUpdatedEvent)
+export class ValidateEngDateOverridesOnProjectChangeHandlerSetLastStatusDate
+  implements IEventHandler<ProjectUpdatedEvent>
+{
+  constructor(private readonly engagements: EngagementService) {}
+
+  async handle(event: ProjectUpdatedEvent) {
+    const { changes, updated, session } = event;
+
+    if (changes.mouStart === undefined && changes.mouEnd === undefined) {
+      return;
+    }
+
+    const project = {
+      id: updated.id,
+      name: updated.name,
+      mouStart: updated.mouStart,
+      mouEnd: updated.mouEnd,
+    };
+    const engagements = await this.engagements.listAllByProjectId(
+      project.id,
+      session,
+    );
+    const errors = engagements
+      .flatMap<
+        EngagementDateOverrideConflictException['engagements'][0] | null
+      >((eng) => {
+        const common = {
+          id: eng.id,
+          label: (eng.label.language ?? eng.label.intern)!,
+        } as const;
+        const { startDateOverride: start, endDateOverride: end } = eng;
+        return [
+          project.mouStart && start && project.mouStart > start
+            ? {
+                ...common,
+                point: 'start' as const,
+                date: start,
+              }
+            : null,
+          project.mouEnd && end && project.mouEnd < end
+            ? {
+                ...common,
+                point: 'end' as const,
+                date: end,
+              }
+            : null,
+        ];
+      })
+      .filter(isNotFalsy);
+    if (errors.length === 0) {
+      return;
+    }
+    throw new EngagementDateOverrideConflictException(project, [
+      errors[0]!,
+      ...errors.slice(1),
+    ]);
+  }
+}
+
+class EngagementDateOverrideConflictException extends RangeException {
+  constructor(
+    readonly project: Pick<
+      UnsecuredDto<Project>,
+      'id' | 'name' | 'mouStart' | 'mouEnd'
+    >,
+    readonly engagements: NonEmptyArray<
+      Readonly<{
+        id: ID<'Engagement'>;
+        label: string;
+        point: 'start' | 'end';
+        date: CalendarDate;
+      }>
+    >,
+  ) {
+    const message = [
+      engagements.length === 1
+        ? 'An engagement has a date outside the new range'
+        : 'Some engagements have dates outside the new range',
+      ...engagements.map((eng) => {
+        const pointStr = eng.point === 'start' ? 'Start' : 'End';
+        const dateStr = eng.date.toISO();
+        return `  - ${pointStr} date of ${eng.label} is ${dateStr}`;
+      }),
+    ].join('\n');
+    super({ message });
+  }
+}
diff --git a/src/components/project/project.service.ts b/src/components/project/project.service.ts
@@ -1,6 +1,7 @@
 import { forwardRef, Inject, Injectable } from '@nestjs/common';
 import { Many } from '@seedcompany/common';
 import {
+  CalendarDate,
   ClientException,
   CreationFailed,
   EnhancedResource,
@@ -10,6 +11,8 @@ import {
   many,
   NotFoundException,
   ObjectView,
+  Range,
+  RangeException,
   ReadAfterCreationFailed,
   Role,
   SecuredList,
@@ -27,6 +30,7 @@ import {
   Logger,
 } from '~/core';
 import { Transactional } from '~/core/database';
+import { AnyChangesOf } from '~/core/database/changes';
 import { Privileges } from '../authorization';
 import { withoutScope } from '../authorization/dto';
 import { BudgetService } from '../budget';
@@ -101,6 +105,7 @@ export class ProjectService {
     input: CreateProject,
     session: Session,
   ): Promise<UnsecuredDto<Project>> {
+    ProjectDateRangeException.throwIfInvalid(input);
     if (input.type !== ProjectType.Internship && input.sensitivity) {
       throw new InputException(
         'Can only set sensitivity on Internship Projects',
@@ -290,6 +295,8 @@ export class ProjectService {
       return await this.readOneUnsecured(input.id, session, changeset);
     }
 
+    ProjectDateRangeException.throwIfInvalid(currentProject, changes);
+
     let updated = currentProject;
     if (changedStep) {
       await this.workflow.executeTransitionLegacy(
@@ -611,3 +618,23 @@ export class ProjectService {
     );
   }
 }
+
+class ProjectDateRangeException extends RangeException {
+  static throwIfInvalid(
+    current: Partial<Pick<UnsecuredDto<Project>, 'mouStart' | 'mouEnd'>>,
+    changes: AnyChangesOf<Project> = {},
+  ) {
+    const start =
+      changes.mouStart !== undefined ? changes.mouStart : current.mouStart;
+    const end = changes.mouEnd !== undefined ? changes.mouEnd : current.mouEnd;
+    if (start && end && start > end) {
+      const field = changes.mouEnd ? 'project.mouEnd' : 'project.mouStart';
+      throw new ProjectDateRangeException({ start, end }, field);
+    }
+  }
+
+  constructor(readonly value: Range<CalendarDate>, readonly field: string) {
+    const message = "Project's MOU start date must be before the MOU end date";
+    super({ message, field });
+  }
+}
diff --git a/src/core/database/query/cypher-functions.ts b/src/core/database/query/cypher-functions.ts

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,12 @@ module default {`
`18`	`18`	`)`
`19`	`19`	`)`
`20`	`20`	`);`
`21`		`-`
	`21`	`+`
	`22`	`+ function array_join_maybe(array: array<str>, delimiter: str) -> optional str using (`
	`23`	`+ with joined := array_join(array, delimiter)`
	`24`	`+ select if joined = "" then <str>{} else joined`
	`25`	`+ );`
	`26`	`+`
`22`	`27`	`scalar type nanoid extending str;`
`23`	`28`
`24`	`29`	`scalar type RichText extending json;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+export * from './validate-eng-date-overrides-on-project-change.handler';`
`1`	`2`	`export * from './set-initial-end-date.handler';`
`2`	`3`	`export * from './update-engagement-status.handler';`
`3`	`4`	`export * from './set-last-status-date.handler';`