Add query diagnostics CLI

Author: zth

package-lock.json

@@ -48,6 +48,7 @@
     "io-ts-reporters": "^2.0.1",
     "nunjucks": "3.2.4",
     "pascal-case": "^3.1.1",
+    "pg": "^8.11.2",
     "pgtyped-rescript-query": "^3.0.1",
     "piscina": "^4.0.0",
     "tinypool": "^0.7.0",
@@ -58,6 +59,7 @@
     "@types/debug": "4.1.8",
     "@types/fs-extra": "11.0.1",
     "@types/nunjucks": "^3.1.3",
+    "@types/pg": "^8.10.2",
     "@types/yargs": "17.0.24",
     "rescript": "12.2.0"
   },

packages/cli/package.json

@@ -0,0 +1,77 @@
+import { jest } from '@jest/globals';
+import { parseSQLFile, queryASTToIR } from '@pgtyped/parser';
+import { getParameterLabels, runDiagnostics } from './diagnostics.js';
+
+const sqlFile = '../example/src/books/books.sql';
+
+describe('diagnostics', () => {
+  let logSpy: ReturnType<typeof jest.spyOn>;
+
+  beforeEach(() => {
+    logSpy = jest.spyOn(console, 'log').mockImplementation(() => undefined);
+  });
+
+  afterEach(() => {
+    logSpy.mockRestore();
+  });
+
+  test('lists query names without config', async () => {
+    await runDiagnostics(undefined, {
+      file: sqlFile,
+      list: true,
+      mode: 'explain',
+      format: 'text',
+    });
+
+    expect(logSpy).toHaveBeenCalledWith('FindBookById');
+    expect(logSpy).toHaveBeenCalledWith('InsertBooks');
+  });
+
+  test('prints processed SQL without config', async () => {
+    await runDiagnostics(undefined, {
+      file: sqlFile,
+      queryName: 'FindBookById',
+      sql: true,
+      mode: 'explain',
+      format: 'text',
+    });
+
+    expect(logSpy).toHaveBeenCalledWith('SELECT * FROM books WHERE id = $1');
+  });
+
+  test('keeps scalar parameter labels when params are supplied', () => {
+    const query = parseSQLFile(`
+      /* @name FindBookById */
+      SELECT * FROM books WHERE id = :id;
+    `).queries[0];
+
+    const labels = getParameterLabels(queryASTToIR(query, null), { id: 1 });
+
+    expect(labels.get(1)).toBe('id');
+  });
+
+  test('keeps spread-pick labels when params are supplied', () => {
+    const query = parseSQLFile(`
+      /*
+        @name InsertBooks
+        @param books -> ((rank!, name!)...)
+      */
+      INSERT INTO books (rank, name)
+      VALUES :books;
+    `).queries[0];
+
+    const labels = getParameterLabels(queryASTToIR(query, null), {
+      books: [
+        { rank: 1, name: 'one' },
+        { rank: 2, name: 'two' },
+      ],
+    });
+
+    expect([...labels.values()]).toEqual([
+      'books.rank',
+      'books.name',
+      'books.rank',
+      'books.name',
+    ]);
+  });
+});