gem-hunter

Unified error API for node.js SQL DB drivers

Contributions and suggestions are most welcome

Usage

const { wrapError, DBError, UniqueViolationError, NotNullViolationError } = require('db-errors');

function errorHandler(err) {
  // wrapError function takes any error and returns a DBError subclass instance if
  // the input was an error thrown by the supported database drivers. Otherwise
  // the input error is returned.
  err = wrapError(err);

  if (err instanceof UniqueViolationError) {
    console.log(
      `Unique constraint ${err.constraint} failed for table ${err.table} and columns ${err.columns}`
    );
  } else if (err instanceof NotNullViolationError) {
    console.log(`Not null constraint failed for table ${err.table} and column ${err.column}`);
  } else if (err instanceof DBError) {
    console.log(`Some unknown DB error ${dbError.nativeError}`);
  }
}

API

DBError

class DBError extends Error {
  // The error thrown by the database client.
  nativeError: Error;
}

ConstraintViolationError

class ConstraintViolationError extends DBError {
  // No own properties.
}

UniqueViolationError

class UniqueViolationError extends ConstraintViolationError {
  // The columns that failed.
  //
  // Available for: postgres, sqlite
  columns: string[];

  // The table that has the columns.
  //
  // Available for: postgres, sqlite
  table: string;

  // The constraint that was violated.
  //
  // Available for: postgres, mysql
  constraint: string;
}

NotNullViolationError

class NotNullViolationError extends ConstraintViolationError {
  // The column that failed.
  //
  // Available for: postgres, sqlite, mysql
  column: string;

  // The table that has the columns.
  //
  // Available for: postgres, sqlite
  table: string;
}

ForeignKeyViolationError

class ForeignKeyViolationError extends ConstraintViolationError {
  // The table that has the foreign key.
  //
  // Available for: postgres, mysql
  table: string;

  // The constraint that was violated.
  //
  // Available for: postgres, mysql
  constraint: string;
}

CheckViolationError

// This is not available for MySql since MySql doesn't have check constraints.
class CheckViolationError extends ConstraintViolationError {
  // The table that has the check constraint.
  //
  // Available for: postgres
  table: string;

  // The constraint that was violated.
  //
  // Available for: postgres
  constraint: string;
}

DataError

// Invalid data (string too long, invalid date etc.)
//
// NOTE: SQLite uses dynamic typing and doesn't throw this error.
class DataError extends DBError {
  // There is no easy way to parse data from these kind
  // of errors.
}

Development setup

docker-compose up
node setup-test-db.js

npm test