Usability improvements for Pongo shell

Added: - PostgreSQL connection check, - an option to set the prettifying and log level through shell params
event-driven-io · Oct 8, 2024 · 6f0f507 · 6f0f507
1 parent 5c95c90
commit 6f0f507
Show file tree

Hide file tree

Showing 10 changed files with 234 additions and 70 deletions.
diff --git a/src/package-lock.json b/src/package-lock.json
diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@event-driven-io/pongo-core",
-  "version": "0.15.3",
+  "version": "0.16.0-alpha.1",
   "description": "Pongo - Mongo with strong consistency on top of Postgres",
   "type": "module",
   "engines": {

diff --git a/src/packages/dumbo/src/core/schema/migrations.ts b/src/packages/dumbo/src/core/schema/migrations.ts
@@ -3,6 +3,7 @@ import {
   rawSql,
   singleOrNull,
   sql,
+  tracer,
   type SchemaComponent,
   type SQLExecutor,
 } from '..';
@@ -101,7 +102,10 @@ const runSQLMigration = async (
     await recordMigration(execute, newMigration);
     // console.log(`Migration "${newMigration.name}" applied successfully.`);
   } catch (error) {
-    console.error(`Failed to apply migration "${migration.name}":`, error);
+    tracer.error('migration-error', {
+      migationName: migration.name,
+      error: error,
+    });
     throw error;
   }
 };

diff --git a/src/packages/dumbo/src/core/tracing/index.ts b/src/packages/dumbo/src/core/tracing/index.ts
@@ -1,14 +1,10 @@
 import { JSONSerializer } from '../serializer';
-import { prettyPrintJson } from './printing';
+import { prettyJson } from './printing';
 
 export const tracer = () => {};
 
 export type LogLevel = 'DISABLED' | 'INFO' | 'LOG' | 'WARN' | 'ERROR';
 
-export type LogType = 'CONSOLE';
-
-export type LogStyle = 'RAW' | 'PRETTY';
-
 export const LogLevel = {
   DISABLED: 'DISABLED' as LogLevel,
   INFO: 'INFO' as LogLevel,
@@ -17,6 +13,15 @@ export const LogLevel = {
   ERROR: 'ERROR' as LogLevel,
 };
 
+export type LogType = 'CONSOLE';
+
+export type LogStyle = 'RAW' | 'PRETTY';
+
+export const LogStyle = {
+  RAW: 'RAW' as LogStyle,
+  PRETTY: 'PRETTY' as LogStyle,
+};
+
 const shouldLog = (logLevel: LogLevel): boolean => {
   const definedLogLevel = process.env.DUMBO_LOG_LEVEL ?? LogLevel.DISABLED;
 
@@ -59,7 +64,7 @@ const getTraceEventFormatter =
       case 'RAW':
         return JSONSerializer.serialize(event);
       case 'PRETTY':
-        return prettyPrintJson(event, true);
+        return prettyJson(event, { handleMultiline: true });
     }
   };
 

diff --git a/src/packages/dumbo/src/core/tracing/printing/pretty.ts b/src/packages/dumbo/src/core/tracing/printing/pretty.ts
@@ -31,7 +31,6 @@ const processString = (
   return COLOR_STRING(`"${str}"`);
 };
 
-// Function to format and colorize JSON by traversing it
 const formatJson = (
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   obj: any,
@@ -46,7 +45,6 @@ const formatJson = (
   if (typeof obj === 'number') return COLOR_NUMBER(String(obj));
   if (typeof obj === 'boolean') return COLOR_BOOLEAN(String(obj));
 
-  // Handle arrays
   if (Array.isArray(obj)) {
     const arrayItems = obj.map((item) =>
       formatJson(item, indentLevel + 1, handleMultiline),
@@ -70,7 +68,7 @@ const formatJson = (
   )}\n${indent}${COLOR_BRACKETS('}')}`;
 };
 
-export const prettyPrintJson = (
+export const prettyJson = (
   obj: unknown,
-  handleMultiline: boolean = false,
-): string => formatJson(obj, 0, handleMultiline);
+  options?: { handleMultiline?: boolean },
+): string => formatJson(obj, 0, options?.handleMultiline);
diff --git a/src/packages/dumbo/src/core/tracing/printing/pretty.unit.spec.ts b/src/packages/dumbo/src/core/tracing/printing/pretty.unit.spec.ts
@@ -1,7 +1,7 @@
 import assert from 'assert';
 import chalk from 'chalk';
 import { describe, it } from 'node:test';
-import { prettyPrintJson } from './pretty';
+import { prettyJson } from './pretty';
 
 // Define a basic test suite
 void describe('prettyPrintJson', () => {
@@ -19,7 +19,7 @@ void describe('prettyPrintJson', () => {
   "age": 30
 }`;
 
-    const output = prettyPrintJson(input, false); // Multiline handling off
+    const output = prettyJson(input, { handleMultiline: false }); // Multiline handling off
     assert.strictEqual(output, expectedOutput);
   });
 
@@ -37,7 +37,7 @@ void describe('prettyPrintJson', () => {
   "
 }`;
 
-    const output = prettyPrintJson(input, true); // Multiline handling on
+    const output = prettyJson(input, { handleMultiline: true }); // Multiline handling on
     assert.strictEqual(output, expectedOutput);
   });
 
@@ -64,7 +64,7 @@ void describe('prettyPrintJson', () => {
   }
 }`;
 
-    const output = prettyPrintJson(input, false); // Multiline handling off
+    const output = prettyJson(input, { handleMultiline: false }); // Multiline handling off
     assert.strictEqual(output, expectedOutput);
   });
 
@@ -85,7 +85,7 @@ void describe('prettyPrintJson', () => {
   "active": true
 }`;
 
-    const output = prettyPrintJson(input, false); // Multiline handling off
+    const output = prettyJson(input, { handleMultiline: false }); // Multiline handling off
     assert.strictEqual(output, expectedOutput);
   });
 
@@ -102,7 +102,7 @@ void describe('prettyPrintJson', () => {
   "tags": null
 }`;
 
-    const output = prettyPrintJson(input, false); // Multiline handling off
+    const output = prettyJson(input, { handleMultiline: false }); // Multiline handling off
     assert.strictEqual(output, expectedOutput);
   });
 
@@ -121,7 +121,7 @@ void describe('prettyPrintJson', () => {
   "
 }`;
 
-    const output = prettyPrintJson(input, true); // Multiline handling on
+    const output = prettyJson(input, { handleMultiline: true }); // Multiline handling on
     console.log(output);
     assert.strictEqual(output, expectedOutput);
   });

diff --git a/src/packages/dumbo/src/postgres/pg/connections/connection.ts b/src/packages/dumbo/src/postgres/pg/connections/connection.ts
@@ -77,3 +77,47 @@ export function nodePostgresConnection(
     ? nodePostgresClientConnection(options)
     : nodePostgresPoolClientConnection(options);
 }
+
+export type ConnectionCheckResult =
+  | { successful: true }
+  | {
+      successful: false;
+      code: string | undefined;
+      errorType: 'ConnectionRefused' | 'Authentication' | 'Unknown';
+      error: unknown;
+    };
+
+export const checkConnection = async (
+  connectionString: string,
+): Promise<ConnectionCheckResult> => {
+  const client = new pg.Client({
+    connectionString: connectionString,
+  });
+
+  try {
+    await client.connect();
+    return { successful: true };
+  } catch (error) {
+    const code =
+      error instanceof Error &&
+      'code' in error &&
+      typeof error.code === 'string'
+        ? error.code
+        : undefined;
+
+    return {
+      successful: false,
+      errorType:
+        code === 'ECONNREFUSED'
+          ? 'ConnectionRefused'
+          : code === '28P01'
+            ? 'Authentication'
+            : 'Unknown',
+      code,
+      error,
+    };
+  } finally {
+    // Ensure the client is closed properly if connected
+    await client.end();
+  }
+};
diff --git a/src/packages/dumbo/src/postgres/pg/connections/pool.ts b/src/packages/dumbo/src/postgres/pg/connections/pool.ts
@@ -2,20 +2,21 @@ import pg from 'pg';
 import {
   createConnectionPool,
   JSONSerializer,
+  tracer,
   type ConnectionPool,
 } from '../../../core';
 import {
   defaultPostgreSqlDatabase,
   getDatabaseNameOrDefault,
 } from '../../core';
+import { setNodePostgresTypeParser } from '../serialization';
 import {
   nodePostgresConnection,
   NodePostgresConnectorType,
   type NodePostgresClientConnection,
   type NodePostgresConnector,
   type NodePostgresPoolClientConnection,
 } from './connection';
-import { setNodePostgresTypeParser } from '../serialization';
 
 export type NodePostgresNativePool =
   ConnectionPool<NodePostgresPoolClientConnection>;
@@ -291,8 +292,7 @@ export const onEndPool = async (lookupKey: string, pool: pg.Pool) => {
   try {
     await pool.end();
   } catch (error) {
-    console.log(`Error while closing the connection pool: ${lookupKey}`);
-    console.log(error);
+    tracer.error('connection-closing-error', { lookupKey, error });
   }
   pools.delete(lookupKey);
 };

diff --git a/src/packages/pongo/package.json b/src/packages/pongo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@event-driven-io/pongo",
-  "version": "0.15.3",
+  "version": "0.16.0-alpha.1",
   "description": "Pongo - Mongo with strong consistency on top of Postgres",
   "type": "module",
   "scripts": {