Merge pull request #3057 from SeedCompany/edgedb/convert-not-found-errors

Author: CarsonF

src/common/exceptions/duplicate.exception.ts

@@ -1,8 +1,4 @@
 import { ArgumentsHost } from '@nestjs/common';
-import {
-  GqlContextType as ContextKey,
-  GqlExecutionContext,
-} from '@nestjs/graphql';
 import { lowerCase, upperFirst } from 'lodash';
 import type { ExclusivityViolationError } from '~/core/edgedb';
 import { InputException } from './input.exception';
@@ -27,38 +23,14 @@ export class DuplicateException extends InputException {
 
     // Attempt to add path prefix automatically to the property name, based
     // on given GQL input.
-    if (context && context.getType<ContextKey>() === 'graphql') {
-      let gqlArgs = GqlExecutionContext.create(context as any).getArgs();
-
-      // unwind single `input` argument, based on our own conventions
-      if (Object.keys(gqlArgs).length === 1 && 'input' in gqlArgs) {
-        gqlArgs = gqlArgs.input;
-      }
-
-      const flattened = flattenObject(gqlArgs);
-      // Guess the correct path based on property name.
-      // This kinda assumes the property name will be unique amongst all the input.
-      const guessedPath = Object.keys(flattened).find(
-        (path) => property === path || path.endsWith('.' + property),
-      );
-      property = guessedPath ?? property;
-    }
+    // This kinda assumes the property name will be unique amongst all the input.
+    const guessedPath = Object.keys(
+      InputException.getFlattenInput(context),
+    ).find((path) => property === path || path.endsWith('.' + property));
+    property = guessedPath ?? property;
 
     const ex = new DuplicateException(property, message, exception);
     ex.stack = exception.stack;
     return ex;
   }
 }
-
-const flattenObject = (obj: object, prefix = '') => {
-  const result: Record<string, any> = {};
-  for (const [key, value] of Object.entries(obj)) {
-    if (value && typeof value === 'object' && !Array.isArray(value)) {
-      const nestedObj = flattenObject(value, prefix + key + '.');
-      Object.assign(result, nestedObj);
-    } else {
-      result[prefix + key] = value;
-    }
-  }
-  return result;
-};

src/common/exceptions/input.exception.ts

@@ -1,3 +1,8 @@
+import { ArgumentsHost } from '@nestjs/common';
+import {
+  GqlContextType as ContextKey,
+  GqlExecutionContext,
+} from '@nestjs/graphql';
 import { ClientException } from './exception';
 
 export type InputExceptionArgs =
@@ -104,4 +109,35 @@ export class InputException extends ClientException {
     }
     return [message, field, previous] as const;
   }
+
+  static getFlattenInput(context?: ArgumentsHost) {
+    if (!context || context.getType<ContextKey>() !== 'graphql') {
+      return {};
+    }
+    const gqlContext =
+      context instanceof GqlExecutionContext
+        ? context
+        : GqlExecutionContext.create(context as any);
+    let gqlArgs = gqlContext.getArgs();
+
+    // unwind single `input` argument, based on our own conventions
+    if (Object.keys(gqlArgs).length === 1 && 'input' in gqlArgs) {
+      gqlArgs = gqlArgs.input;
+    }
+
+    return flattenObject(gqlArgs);
+  }
 }
+
+const flattenObject = (obj: object, prefix = '') => {
+  const result: Record<string, any> = {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (value && typeof value === 'object' && !Array.isArray(value)) {
+      const nestedObj = flattenObject(value, prefix + key + '.');
+      Object.assign(result, nestedObj);
+    } else {
+      result[prefix + key] = value;
+    }
+  }
+  return result;
+};

src/core/exception/exception.normalizer.ts

@@ -6,7 +6,13 @@ import {
   GqlContextType as ContextKey,
   GqlExecutionContext,
 } from '@nestjs/graphql';
-import { isNotFalsy, setHas, setOf, simpleSwitch } from '@seedcompany/common';
+import {
+  entries,
+  isNotFalsy,
+  setHas,
+  setOf,
+  simpleSwitch,
+} from '@seedcompany/common';
 import * as Edge from 'edgedb';
 import * as EdgeDBTags from 'edgedb/dist/errors/tags.js';
 import { GraphQLError, GraphQLResolveInfo } from 'graphql';
@@ -17,11 +23,14 @@ import {
   Exception,
   getParentTypes,
   getPreviousList,
+  InputException,
   JsonSet,
+  NotFoundException,
 } from '~/common';
 import type { ConfigService } from '~/core';
 import * as Neo from '../database/errors';
 import { ExclusivityViolationError } from '../edgedb/exclusivity-violation.error';
+import { ResourcesHost } from '../resources/resources.host';
 import { isSrcFrame } from './is-src-frame';
 import { normalizeFramePath } from './normalize-frame-path';
 
@@ -35,7 +44,10 @@ export interface ExceptionJson {
 
 @Injectable()
 export class ExceptionNormalizer {
-  constructor(@Inject('CONFIG') private readonly config?: ConfigService) {}
+  constructor(
+    @Inject('CONFIG') private readonly config?: ConfigService,
+    private readonly resources?: ResourcesHost,
+  ) {}
 
   normalize(ex: Error, context?: ArgumentsHost): ExceptionJson {
     const {
@@ -114,13 +126,22 @@ export class ExceptionNormalizer {
       };
     }
 
+    const gqlContext =
+      context &&
+      context.getType<ContextKey>() === 'graphql' &&
+      // schema input validation errors don't create an execution context correctly
+      !(ex instanceof GraphQLError)
+        ? GqlExecutionContext.create(context as any)
+        : undefined;
+
+    ex = this.wrapIDNotFoundError(ex, gqlContext);
+
     if (ex instanceof ExclusivityViolationError) {
-      ex = DuplicateException.fromDB(ex, context);
+      ex = DuplicateException.fromDB(ex, gqlContext);
     } else if (ex instanceof Edge.EdgeDBError) {
       // Mask actual DB error with a nicer user error message.
       let message = 'Failed';
-      if (context && context.getType<ContextKey>() === 'graphql') {
-        const gqlContext = GqlExecutionContext.create(context as any);
+      if (gqlContext) {
         const info = gqlContext.getInfo<GraphQLResolveInfo>();
         if (info.operation.operation === 'mutation') {
           message += ` to ${lowerCase(info.fieldName)}`;
@@ -161,6 +182,43 @@ export class ExceptionNormalizer {
     return { codes: ['Server'] };
   }
 
+  /**
+   * Convert ID not found database errors from user input
+   * to user input NotFound error with that input path.
+   */
+  private wrapIDNotFoundError(
+    ex: Error,
+    gqlContext: GqlExecutionContext | undefined,
+  ) {
+    if (!(ex instanceof Edge.CardinalityViolationError)) {
+      return ex;
+    }
+
+    const matched = ex.message.match(/'(.+)' with id '(.+)' does not exist/);
+    if (!matched) {
+      return ex;
+    }
+    const [_, type, id] = matched;
+
+    const inputPath = entries(InputException.getFlattenInput(gqlContext)).find(
+      ([_, value]) => value === id,
+    )?.[0];
+    if (!inputPath) {
+      return ex;
+    }
+
+    const typeName = this.resources
+      ? this.resources.getByEdgeDB(type).name
+      : type;
+    const wrapped = new NotFoundException(
+      `${typeName} could not be found`,
+      inputPath,
+      ex,
+    );
+    wrapped.stack = ex.stack;
+    return wrapped;
+  }
+
   private httpException(ex: Nest.HttpException) {
     const res = ex.getResponse();
     const {