Merge pull request #3283 from SeedCompany/engagement-refactor

Refactor Engagement module / Prep for EdgeDB

Author: CarsonF

src/components/ceremony/handlers/create-engagement-default-ceremony.handler.ts

@@ -48,7 +48,7 @@ export class CreateEngagementDefaultCeremonyHandler
 
     event.engagement = {
       ...engagement,
-      ceremony: ceremonyId,
+      ceremony: { id: ceremonyId },
     };
   }
 }

src/components/ceremony/handlers/delete-engagement-default-ceremony.handler.ts

@@ -1,15 +1,22 @@
-import { EventsHandler, IEventHandler } from '~/core';
+import { ConfigService, EventsHandler, IEventHandler } from '~/core';
 import { EngagementWillDeleteEvent } from '../../engagement/events';
 import { CeremonyService } from '../ceremony.service';
 
 @EventsHandler(EngagementWillDeleteEvent)
 export class DetachEngagementRootDirectoryHandler
   implements IEventHandler<EngagementWillDeleteEvent>
 {
-  constructor(private readonly ceremonies: CeremonyService) {}
+  constructor(
+    private readonly ceremonies: CeremonyService,
+    private readonly config: ConfigService,
+  ) {}
 
   async handle({ engagement, session }: EngagementWillDeleteEvent) {
-    const ceremonyId = engagement?.ceremony?.value;
+    if (this.config.databaseEngine === 'edgedb') {
+      return;
+    }
+
+    const ceremonyId = engagement?.ceremony?.value?.id;
     if (!ceremonyId) {
       return;
     }

src/components/engagement/dto/engagement.dto.ts

@@ -7,28 +7,25 @@ import {
   DateInterval,
   DateTimeField,
   DbLabel,
-  ID,
   IntersectTypes,
   parentIdMiddleware,
   Resource,
   ResourceRelationsShape,
   Secured,
   SecuredBoolean,
   SecuredDateNullable,
-  SecuredDateTime,
+  SecuredDateTimeNullable,
   SecuredProps,
   SecuredRichTextNullable,
-  SecuredString,
+  SecuredStringNullable,
   Sensitivity,
   SensitivityField,
   UnsecuredDto,
 } from '~/common';
 import { BaseNode } from '~/core/database/results';
 import { e } from '~/core/edgedb';
 import { LinkTo, RegisterResource } from '~/core/resources';
-import { ScopedRole } from '../../authorization/dto';
 import { ChangesetAware } from '../../changeset/dto';
-import { DefinedFile } from '../../file/dto';
 import { Product, SecuredMethodologies } from '../../product/dto';
 import {
   InternshipProject,
@@ -80,7 +77,7 @@ class Engagement extends Interfaces {
   @DbLabel('EngagementStatus')
   readonly status: SecuredEngagementStatus;
 
-  readonly ceremony: Secured<ID>;
+  readonly ceremony: Secured<LinkTo<'Ceremony'>>;
 
   @Field({
     description: 'Translation / Growth Plan complete date',
@@ -119,25 +116,21 @@ class Engagement extends Interfaces {
 
   @Field()
   // Convert from date to datetime at migration
-  readonly lastSuspendedAt: SecuredDateTime;
+  readonly lastSuspendedAt: SecuredDateTimeNullable;
 
   @Field()
   // Convert from date to datetime at migration
-  readonly lastReactivatedAt: SecuredDateTime;
+  readonly lastReactivatedAt: SecuredDateTimeNullable;
 
   @Field({
     description: 'The last time the engagement status was modified',
   })
   // Convert from last terminated/completed at migration
-  readonly statusModifiedAt: SecuredDateTime;
+  readonly statusModifiedAt: SecuredDateTimeNullable;
 
   @DateTimeField()
   readonly modifiedAt: DateTime;
 
-  // A list of non-global roles the requesting user has available for this object.
-  // This is just a cache, to prevent extra db lookups within the same request.
-  declare readonly scope: ScopedRole[];
-
   @Field()
   readonly description: SecuredRichTextNullable;
 }
@@ -166,7 +159,7 @@ export class LanguageEngagement extends Engagement {
   @Field(() => TranslationProject)
   declare readonly parent: BaseNode;
 
-  readonly language: Secured<ID>;
+  readonly language: Secured<LinkTo<'Language'>>;
 
   @Field()
   readonly firstScripture: SecuredBoolean;
@@ -183,12 +176,12 @@ export class LanguageEngagement extends Engagement {
   readonly sentPrintingDate: SecuredDateNullable;
 
   @Field()
-  readonly paratextRegistryId: SecuredString;
+  readonly paratextRegistryId: SecuredStringNullable;
 
-  readonly pnp: DefinedFile;
+  readonly pnp: Secured<LinkTo<'File'> | null>;
 
   @Field()
-  readonly historicGoal: SecuredString;
+  readonly historicGoal: SecuredStringNullable;
 }
 
 @RegisterResource({ db: e.InternshipEngagement })
@@ -207,11 +200,11 @@ export class InternshipEngagement extends Engagement {
   @Field(() => InternshipProject)
   declare readonly parent: BaseNode;
 
-  readonly countryOfOrigin: Secured<ID | null>;
+  readonly countryOfOrigin: Secured<LinkTo<'Location'> | null>;
 
-  readonly intern: Secured<ID>;
+  readonly intern: Secured<LinkTo<'User'>>;
 
-  readonly mentor: Secured<ID | null>;
+  readonly mentor: Secured<LinkTo<'User'> | null>;
 
   @Field()
   @DbLabel('InternPosition')
@@ -221,7 +214,7 @@ export class InternshipEngagement extends Engagement {
   @DbLabel('ProductMethodology')
   readonly methodologies: SecuredMethodologies;
 
-  readonly growthPlan: DefinedFile;
+  readonly growthPlan: Secured<LinkTo<'File'> | null>;
 }
 
 export const engagementRange = (engagement: UnsecuredDto<Engagement>) =>