Fix error logging errors (#200)

Author: benjie

.eslintrc.js

@@ -13,7 +13,7 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2018,
     sourceType: "module",
-    project: "tsconfig.lint.json",
+    project: "tsconfig.json",
   },
   env: {
     node: true,

.github/workflows/ci.yml

@@ -45,4 +45,4 @@ jobs:
       - run: psql "${TEST_ROOT_DATABASE_URL}" -c "CREATE USER someone WITH LOGIN PASSWORD 'something';"
       - run: yarn clean
       - run: yarn prepack
-      - run: yarn jest -i --ci
+      - run: FORCE_COLOR=1 yarn jest -i --ci

__tests__/__snapshots__/migrate.test.ts.snap

@@ -1,5 +1,29 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`handles errors during migration gracefully 1`] = `[error: division by zero]`;
+
+exports[`handles errors during migration gracefully 2`] = `
+"
+🛑 Error occurred whilst processing migration
+    error: division by zero
+        at ~/node_modules/pg/lib/client.js:[LINE]:[COL]
+        at processTicksAndRejections (node:internal/process/task_queues:[LINE]:[COL])
+        at runQueryWithErrorInstrumentation (~/src/instrumentation.ts:[LINE]:[COL])
+        at ~/src/migration.ts:[LINE]:[COL]
+        at withAdvisoryLock (~/src/pgReal.ts:[LINE]:[COL])
+        at runCommittedMigration (~/src/migration.ts:[LINE]:[COL])
+        at ~/src/commands/migrate.ts:[LINE]:[COL]
+        at withAdvisoryLock (~/src/pgReal.ts:[LINE]:[COL])
+        at ~/src/commands/migrate.ts:[LINE]:[COL]
+        at withClient (~/src/pgReal.ts:[LINE]:[COL])
+        at _migrate (~/src/commands/migrate.ts:[LINE]:[COL])
+        at Object.<anonymous> (~/__tests__/migrate.test.ts:[LINE]:[COL])
+
+    Severity:	ERROR
+    Code:    	22012
+,[object Object]"
+`;
+
 exports[`refuses to run migration with invalid hash 1`] = `"Hash for 000002.sql does not match - sha1:cbed240dda7dfa510ff785783bbe6af7743b3a11 !== sha1:bddc1ead3310dc1c42cdc7f63537ebdff2e9fd7b; has the file been tampered with?"`;
 
 exports[`runs migrations 1`] = `

__tests__/migrate.test.ts

@@ -3,6 +3,7 @@ import "./helpers"; // Has side-effects; must come first
 import mockFs from "mock-fs";
 
 import { migrate } from "../src";
+import { logDbError } from "../src/instrumentation";
 import { withClient } from "../src/pg";
 import { ParsedSettings, parseSettings } from "../src/settings";
 import { makeMigrations, resetDb, settings } from "./helpers";
@@ -137,3 +138,49 @@ it("will run a migration with invalid hash if told to do so", async () => {
     expect(enums).toMatchSnapshot();
   }
 });
+
+it("handles errors during migration gracefully", async () => {
+  mockFs({
+    "migrations/current.sql": ``,
+    "migrations/committed/000001.sql": `\
+--! Previous: -
+--! Hash: sha1:2fd4e1c67a2d28fced849ee1bb76e7391b93eb12
+--! AllowInvalidHash
+
+drop table if exists frogs;
+
+create table frogs (
+  id serial primary key,
+  name text not null,
+  speckled bool not null
+);
+
+select 1/0;
+
+comment on table frogs is 'Ribbit';
+`,
+  });
+
+  let err: any;
+  try {
+    await migrate(settings);
+  } catch (e) {
+    err = e;
+  }
+  expect(err).toBeTruthy();
+  expect(err.message).toMatch(/division by zero/);
+  expect(err).toMatchSnapshot();
+
+  const parsedSettings = await parseSettings(settings);
+  const mock = jest.fn();
+  parsedSettings.logger.error = mock;
+
+  logDbError(parsedSettings, err);
+  expect(mock).toHaveBeenCalledTimes(1);
+  const call = mock.mock.calls[0];
+  expect(
+    String(call)
+      .replaceAll(process.cwd(), "~")
+      .replace(/:[0-9]+:[0-9]+($|\))/gm, ":[LINE]:[COL]$1"),
+  ).toMatchSnapshot();
+});

package.json

@@ -8,12 +8,13 @@
     "lint:deps": "depcheck --ignores @types/jest,@types/json5,@types/node,@types/mock-fs,@types/pg,@types/yargs,eslint_d,mock-fs,tslib",
     "lint:fix": "eslint --ext .js,.jsx,.ts,.tsx,.graphql . --fix; prettier --ignore-path .eslintignore --write '**/*.{js,jsx,ts,tsx,graphql,md,json}'",
     "prettier:check": "prettier --ignore-path .eslintignore --check '**/*.{js,jsx,ts,tsx,graphql,md,json}'",
-    "prepack": "tsc && chmod +x dist/cli.js",
+    "tsc": "tsc -p tsconfig.build.json",
+    "prepack": "npm run tsc && chmod +x dist/cli.js",
     "clean": "rm -Rf dist",
-    "test": "yarn lint && yarn run lint:deps && yarn run test:only --ci",
+    "test": "yarn lint && yarn run lint:deps && FORCE_COLOR=1 yarn run test:only --ci",
     "test:only": "jest -i",
     "version": "yarn prepack && ./scripts/update-docs.js && node ./scripts/version.mjs && git add README.md src/version.ts",
-    "watch": "mkdir -p dist && touch dist/cli.js && chmod +x dist/cli.js && tsc --watch"
+    "watch": "mkdir -p dist && touch dist/cli.js && chmod +x dist/cli.js && npm run tsc --watch"
   },
   "bin": {
     "graphile-migrate": "./dist/cli.js"

src/instrumentation.ts

@@ -1,4 +1,4 @@
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { QueryResultRow } from "pg";
 
 import indent from "./indent";

tsconfig.build.json

@@ -0,0 +1,23 @@
+{
+  "extends": "@tsconfig/node18/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "declarationDir": "./dist",
+    "outDir": "./dist",
+    "declaration": true,
+    "allowJs": false,
+    "sourceMap": true,
+    "pretty": true,
+    "importHelpers": true,
+    "experimentalDecorators": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedParameters": false,
+    "noUnusedLocals": false,
+    "preserveWatchOutput": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["**/__mocks__/*"]
+}

tsconfig.json

@@ -1,23 +1,8 @@
 {
-  "extends": "@tsconfig/node18/tsconfig.json",
+  "extends": "./tsconfig.build.json",
+  "include": ["src/**/*", "__tests__/**/*", "*.js", "./.*.js"],
+  "exclude": [],
   "compilerOptions": {
-    "rootDir": "src",
-    "declarationDir": "./dist",
-    "outDir": "./dist",
-    "declaration": true,
-    "allowJs": false,
-    "sourceMap": true,
-    "pretty": true,
-    "importHelpers": true,
-    "experimentalDecorators": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUnusedParameters": false,
-    "noUnusedLocals": false,
-    "preserveWatchOutput": true,
-    "sourceMap": true,
+    "noEmit": true,
   },
-  "include": ["src/**/*"],
-  "exclude": ["**/__mocks__/*"],
 }