@clickup/ent-framework/src/ent/errors/EntUniqueKeyError.ts

A PostgreSQL graph-database-alike library with microsharding and row-level security

import { inspectCompact } from "../../internal/misc";

/**
 * Error: while inserting or updating, DB unique key was violated,
 * so the Ent was not mutated.
 */
export class EntUniqueKeyError extends Error {
  constructor(
    public readonly entName: string,
    public readonly input: unknown,
  ) {
    super(
      `${entName} mutation violates unique key constraint: ` +
        inspectCompact(input),
    );

    Object.defineProperty(this, "name", {
      value: this.constructor.name,
      writable: true,
      enumerable: false,
    });
  }

  /**
   * Returns a promise of T on success, and undefined in case unique key
   * violation happened during the promise resolution.
   */
  static async ignore<T>(promise: Promise<T>): Promise<T | undefined> {
    try {
      return await promise;
    } catch (e: unknown) {
      if (!(e instanceof this)) {
        throw e;
      }

      return undefined;
    }
  }
}