Add deprecated group to reason options to allow old reasons to be slowly moved away from

Author: CarsonF

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,6 +15,16 @@ 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([]);
+
   @Field(() => [String])
   readonly behind: ReadonlySet<string> = new JsonSet([
     'Delayed activities; activities did not occur; slow start of project',

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);