Merge pull request #3392 from SeedCompany/dry-create-failed

Author: CarsonF

src/common/exceptions/creation-failed.exception.ts

@@ -0,0 +1,28 @@
+import { EnhancedResource } from '~/common';
+import type { ResourceLike } from '~/core';
+import { ServerException } from './exception';
+
+export class CreationFailed extends ServerException {
+  readonly resource: EnhancedResource<any>;
+  constructor(
+    resource: ResourceLike,
+    options?: { message?: string; cause?: Error },
+  ) {
+    const res = EnhancedResource.resolve(resource);
+    super(options?.message ?? `Failed to create ${res.name}`, options?.cause);
+    this.resource = res;
+  }
+}
+
+export class ReadAfterCreationFailed extends CreationFailed {
+  constructor(
+    resource: ResourceLike,
+    options?: { message?: string; cause?: Error },
+  ) {
+    const res = EnhancedResource.resolve(resource);
+    super(res, {
+      message: `Failed to retrieve ${res.name} after creation`,
+      ...options,
+    });
+  }
+}

src/common/exceptions/index.ts

@@ -7,3 +7,4 @@ export * from './unauthenticated.exception';
 export * from './unauthorized.exception';
 export * from './service-unavailable.exception';
 export * from './invalid-id-for-type.exception';
+export * from './creation-failed.exception';

src/common/resource.dto.ts

@@ -4,6 +4,7 @@ import {
   FnLike,
   mapValues,
   setInspectOnClass,
+  setToJson,
 } from '@seedcompany/common';
 import { LazyGetter as Once } from 'lazy-get-decorator';
 import { DateTime } from 'luxon';
@@ -106,6 +107,9 @@ export class EnhancedResource<T extends ResourceShape<any>> {
   >();
 
   static resolve(ref: ResourceLike) {
+    if (ref && typeof ref !== 'string') {
+      return EnhancedResource.of(ref);
+    }
     if (!EnhancedResource.resourcesHost) {
       throw new ServerException('Cannot resolve without ResourcesHost');
     }
@@ -295,6 +299,7 @@ export class EnhancedResource<T extends ResourceShape<any>> {
 setInspectOnClass(EnhancedResource, (res) => ({ collapsed }) => {
   return collapsed(res.name, 'Enhanced');
 });
+setToJson(EnhancedResource, (res) => ({ name: res.name }));
 
 export interface EnhancedRelation<TResourceStatic extends ResourceShape<any>> {
   readonly name: RelKey<TResourceStatic>;

src/components/budget/budget-record.repository.ts

@@ -2,11 +2,11 @@ import { Injectable } from '@nestjs/common';
 import { node, Query, relation } from 'cypher-query-builder';
 import { pickBy } from 'lodash';
 import {
+  CreationFailed,
   ID,
   labelForView,
   NotFoundException,
   ObjectView,
-  ServerException,
   Session,
   UnsecuredDto,
 } from '~/common';
@@ -69,7 +69,7 @@ export class BudgetRecordRepository extends DtoRepository<
       .return<{ id: ID }>('node.id as id')
       .first();
     if (!result) {
-      throw new ServerException('Failed to create a budget record');
+      throw new CreationFailed(BudgetRecord);
     }
     return result.id;
   }

src/components/budget/budget.repository.ts

@@ -2,11 +2,11 @@ import { Injectable } from '@nestjs/common';
 import { inArray, node, Query, relation } from 'cypher-query-builder';
 import { pickBy } from 'lodash';
 import {
+  CreationFailed,
   ID,
   labelForView,
   NotFoundException,
   ObjectView,
-  ServerException,
   Session,
   UnsecuredDto,
   viewOfChangeset,
@@ -64,7 +64,7 @@ export class BudgetRepository extends DtoRepository<
       .first();
 
     if (!result) {
-      throw new ServerException('Failed to create budget');
+      throw new CreationFailed(Budget);
     }
 
     return result.id;

src/components/budget/budget.service.ts

@@ -1,5 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import {
+  CreationFailed,
   DuplicateException,
   generateId,
   ID,
@@ -78,7 +79,7 @@ export class BudgetService {
         userId: session.userId,
         exception,
       });
-      throw new ServerException('Could not create budget', exception);
+      throw new CreationFailed(Budget, { cause: exception });
     }
   }
 
@@ -119,7 +120,7 @@ export class BudgetService {
         userId: session.userId,
         exception,
       });
-      throw new ServerException('Could not create Budget Record', exception);
+      throw new CreationFailed(BudgetRecord, { cause: exception });
     }
   }
 

src/components/ceremony/ceremony.repository.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { node, Query, relation } from 'cypher-query-builder';
-import { ID, ServerException, Session, UnsecuredDto } from '~/common';
+import { CreationFailed, ID, Session, UnsecuredDto } from '~/common';
 import { DtoRepository } from '~/core/database';
 import {
   ACTIVE,
@@ -38,7 +38,7 @@ export class CeremonyRepository extends DtoRepository<
       .first();
 
     if (!result) {
-      throw new ServerException('failed to create a ceremony');
+      throw new CreationFailed(Ceremony);
     }
     return result;
   }

src/components/comments/comment.service.ts

@@ -1,6 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { difference } from 'lodash';
 import {
+  CreationFailed,
   ID,
   InvalidIdForTypeException,
   isIdLike,
@@ -52,7 +53,7 @@ export class CommentService {
     try {
       const result = await this.repo.create(input, session);
       if (!result) {
-        throw new ServerException('Failed to create comment');
+        throw new CreationFailed(Comment);
       }
       dto = await this.repo.readOne(result.id);
     } catch (exception) {
@@ -66,7 +67,7 @@ export class CommentService {
         );
       }
 
-      throw new ServerException('Failed to create comment', exception);
+      throw new CreationFailed(Comment, { cause: exception });
     }
 
     const mentionees = this.mentionNotificationService.extract(dto);

src/components/engagement/engagement.repository.ts

@@ -12,13 +12,15 @@ import { difference, pickBy, upperFirst } from 'lodash';
 import { DateTime } from 'luxon';
 import { MergeExclusive } from 'type-fest';
 import {
+  CreationFailed,
   DuplicateException,
   generateId,
   ID,
   InputException,
   labelForView,
   NotFoundException,
   ObjectView,
+  ReadAfterCreationFailed,
   ServerException,
   Session,
   typenameForView,
@@ -268,7 +270,7 @@ export class EngagementRepository extends CommonRepository {
 
     const result = await query.first();
     if (!result) {
-      throw new ServerException('Could not create Language Engagement');
+      throw new CreationFailed(LanguageEngagement);
     }
 
     await this.files.createDefinedFile(
@@ -285,7 +287,11 @@ export class EngagementRepository extends CommonRepository {
       result.id,
       session,
       viewOfChangeset(changeset),
-    )) as UnsecuredDto<LanguageEngagement>;
+    ).catch((e) => {
+      throw e instanceof NotFoundException
+        ? new ReadAfterCreationFailed(LanguageEngagement)
+        : e;
+    })) as UnsecuredDto<LanguageEngagement>;
   }
 
   async createInternshipEngagement(
@@ -359,7 +365,7 @@ export class EngagementRepository extends CommonRepository {
         );
       }
 
-      throw new ServerException('Could not create Internship Engagement');
+      throw new CreationFailed(InternshipEngagement);
     }
 
     await this.files.createDefinedFile(
@@ -376,7 +382,11 @@ export class EngagementRepository extends CommonRepository {
       result.id,
       session,
       viewOfChangeset(changeset),
-    )) as UnsecuredDto<InternshipEngagement>;
+    ).catch((e) => {
+      throw e instanceof NotFoundException
+        ? new ReadAfterCreationFailed(InternshipEngagement)
+        : e;
+    })) as UnsecuredDto<InternshipEngagement>;
   }
 
   getActualLanguageChanges = getChanges(LanguageEngagement);

src/components/ethno-art/ethno-art.repository.ts

@@ -1,10 +1,12 @@
 import { Injectable } from '@nestjs/common';
 import { Query } from 'cypher-query-builder';
 import {
+  CreationFailed,
   DuplicateException,
   ID,
+  NotFoundException,
   PaginatedListType,
-  ServerException,
+  ReadAfterCreationFailed,
   Session,
   UnsecuredDto,
 } from '~/common';
@@ -55,7 +57,7 @@ export class EthnoArtRepository extends DtoRepository(EthnoArt) {
       .first();
 
     if (!result) {
-      throw new ServerException('Failed to create ethno art');
+      throw new CreationFailed(EthnoArt);
     }
 
     await this.scriptureRefsService.create(
@@ -64,7 +66,11 @@ export class EthnoArtRepository extends DtoRepository(EthnoArt) {
       session,
     );
 
-    return await this.readOne(result.id);
+    return await this.readOne(result.id).catch((e) => {
+      throw e instanceof NotFoundException
+        ? new ReadAfterCreationFailed(EthnoArt)
+        : e;
+    });
   }
 
   async update(input: UpdateEthnoArt) {