Merge pull request #2914 from SeedCompany/0680-progress-explanation-change

Author: CarsonF

src/components/progress-report/variance-explanation/migrations/rename.migration.ts

@@ -0,0 +1,26 @@
+import { node, relation } from 'cypher-query-builder';
+import { BaseMigration, Migration } from '~/core';
+import { ACTIVE } from '~/core/database/query';
+
+@Migration('2023-10-12T11:00:00')
+export class RenameReasonOptionMigration extends BaseMigration {
+  async up() {
+    await this.db
+      .query()
+      .match([
+        node('', 'ProgressReportVarianceExplanation'),
+        relation('out', '', 'reasons', ACTIVE),
+        node('reason', 'Property'),
+      ])
+      .raw('where any(x in reason.value where x = $old)', {
+        old: 'Partner organization issues currently being addressed.',
+      })
+      .setValues({
+        'reason.value': [
+          'Partner organization issues currently being addressed',
+        ],
+      })
+      .return('count(reason) as count')
+      .executeAndLogStats();
+  }
+}

src/components/progress-report/variance-explanation/reason-options.ts

@@ -1,4 +1,5 @@
 import { Field, ObjectType } from '@nestjs/graphql';
+import { stripIndent } from 'common-tags';
 import { LazyGetter as Once } from 'lazy-get-decorator';
 import { DataObject, JsonSet } from '~/common';
 
@@ -14,19 +15,34 @@ export class ProgressReportVarianceExplanationReasonOptions extends DataObject {
     return new JsonSet([...this.behind, ...this.onTime, ...this.ahead]);
   }
 
+  @Field(() => [String], {
+    description: stripIndent`
+      A list of deprecated options.
+      If an option is deprecated, it is not available for selection/saving.
+      This allows rendering old options while enforcing a soft migration
+      to new values.
+    `,
+  })
+  readonly deprecated: ReadonlySet<string> = new JsonSet([
+    'Delayed activities; activities did not occur; slow start of project',
+  ]);
+
   @Field(() => [String])
   readonly behind: ReadonlySet<string> = new JsonSet([
     'Delayed activities; activities did not occur; slow start of project',
     'Team is being trained at start of project; they expect to catch up by end of project',
     'Delayed hiring and/or replacement of personnel',
     'Economic/political/civil instability or unrest',
     'Late or delayed partner reporting',
-    'Partner organization issues currently being addressed.',
+    'Partner organization issues currently being addressed',
     'Health issues with team members or their families',
     'Team member passed away',
     'Security breach/teams in hiding',
     'Unstable internet',
     'Checking delayed because translation consultants not available',
+    'Natural disaster prevented team from working',
+    'Activities did not occur, rescheduled for later date',
+    'Slow start to project, but team expects to catch up',
   ]);
 
   @Field(() => [String])

src/components/progress-report/variance-explanation/variance-explanation.module.ts

@@ -1,4 +1,5 @@
 import { Module } from '@nestjs/common';
+import { RenameReasonOptionMigration } from './migrations/rename.migration';
 import { ProgressReportVarianceExplanationLoader } from './variance-explanation.loader';
 import { ProgressReportVarianceExplanationRepository } from './variance-explanation.repository';
 import {
@@ -14,6 +15,7 @@ import { ProgressReportVarianceExplanationService } from './variance-explanation
     ProgressReportVarianceExplanationLoader,
     ProgressReportVarianceExplanationService,
     ProgressReportVarianceExplanationRepository,
+    RenameReasonOptionMigration,
   ],
 })
 export class ProgressReportVarianceExplanationModule {}

src/components/progress-report/variance-explanation/variance-explanation.service.ts

@@ -1,8 +1,14 @@
 import { Injectable } from '@nestjs/common';
-import { mapFromList, NotFoundException, Session } from '~/common';
+import {
+  InputException,
+  mapFromList,
+  NotFoundException,
+  Session,
+} from '~/common';
 import { ResourceLoader } from '~/core';
 import { Privileges } from '../../authorization';
 import { ProgressReport } from '../dto';
+import { ProgressReportVarianceExplanationReasonOptions as ReasonOptions } from './reason-options';
 import {
   ProgressReportVarianceExplanation as VarianceExplanation,
   ProgressReportVarianceExplanationInput as VarianceExplanationInput,
@@ -50,6 +56,18 @@ export class ProgressReportVarianceExplanationService {
       return report;
     }
 
+    // Don't allow changing to a deprecated reason.
+    // Here to be nice and allow updating the comments even if the current
+    // reason is deprecated.
+    if (
+      changes.reasons?.some((r) => ReasonOptions.instance.deprecated.has(r))
+    ) {
+      throw new InputException(
+        'Reason is deprecated and cannot be used',
+        'reasons',
+      );
+    }
+
     this.privilegesFor(session, report).verifyChanges(changes);
 
     await this.repo.update(report.id, changes, session);