fixup pg-pool ESM test; align POSTGRES_DB value used for local and CI testing of instrumentation-pg

This also fixes a couple missing 'pool.end()' calls in pg-pool.test.ts that would
result in a 10s hang at the end of testing.

Author: trentm

packages/opentelemetry-test-utils/src/test-utils.ts

@@ -43,7 +43,7 @@ const dockerRunCmds = {
   mysql:
     'docker run --rm -d --name otel-mysql -p 33306:3306 -e MYSQL_ROOT_PASSWORD=rootpw -e MYSQL_DATABASE=test_db -e MYSQL_USER=otel -e MYSQL_PASSWORD=secret mysql:5.7 --log_output=TABLE --general_log=ON',
   postgres:
-    'docker run --rm -d --name otel-postgres -p 54320:5432 -e POSTGRES_PASSWORD=postgres postgres:16-alpine',
+    'docker run --rm -d --name otel-postgres -p 54320:5432 -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=otel_pg_database postgres:16-alpine',
   redis: 'docker run --rm -d --name otel-redis -p 63790:6379 redis:alpine',
 };
 

plugins/node/opentelemetry-instrumentation-pg/test/fixtures/use-pg-pool.mjs

@@ -26,7 +26,7 @@ import { PgInstrumentation } from '../../build/src/index.js';
 const CONFIG = {
   user: process.env.POSTGRES_USER || 'postgres',
   password: process.env.POSTGRES_PASSWORD || 'postgres',
-  database: process.env.POSTGRES_DB || 'postgres',
+  database: process.env.POSTGRES_DB || 'otel_pg_database',
   host: process.env.POSTGRES_HOST || 'localhost',
   port: process.env.POSTGRES_PORT
     ? parseInt(process.env.POSTGRES_PORT, 10)
@@ -39,20 +39,21 @@ const sdk = createTestNodeSdk({
 });
 sdk.start();
 
-import pool from 'pg-pool';
-const pgPool = new pool(CONFIG);
+import Pool from 'pg-pool';
+const pgPool = new Pool(CONFIG);
 
 const tracer = trace.getTracer();
 
 await tracer.startActiveSpan('test-span', async span => {
-  pgPool.connect((connectErr, _, release) => {
-    assert.ifError(connectErr)
-    pgPool.query('SELECT NOW()', (err, res) => {
-      assert.ok(res);
-      assert.ifError(err)
-    });
-    release();
+  const client = await pgPool.connect();
+  try {
+    const res = await pgPool.query('SELECT NOW()');
+    assert.ok(res);
+    console.log('rows:', res.rows);
+  } finally {
+    client.release();
+    pgPool.end();
     span.end();
     sdk.shutdown();
-  });
+  }
 });

plugins/node/opentelemetry-instrumentation-pg/test/fixtures/use-pg.mjs

@@ -26,7 +26,7 @@ import { PgInstrumentation } from '../../build/src/index.js';
 const CONFIG = {
   user: process.env.POSTGRES_USER || 'postgres',
   password: process.env.POSTGRES_PASSWORD || 'postgres',
-  database: process.env.POSTGRES_DB || 'postgres',
+  database: process.env.POSTGRES_DB || 'otel_pg_database',
   host: process.env.POSTGRES_HOST || 'localhost',
   port: process.env.POSTGRES_PORT
     ? parseInt(process.env.POSTGRES_PORT, 10)

plugins/node/opentelemetry-instrumentation-pg/test/pg-pool.test.ts

@@ -650,6 +650,12 @@ describe('pg-pool', () => {
 
     it('should not add duplicate event listeners to PgPool events', done => {
       const poolAux: pgPool<pg.Client> = new pgPool(CONFIG);
+
+      const finish = () => {
+        poolAux.end();
+        done();
+      }
+
       let completed = 0;
       poolAux.connect((err, client, release) => {
         if (err) {
@@ -687,7 +693,7 @@ describe('pg-pool', () => {
 
         completed++;
         if (completed >= 2) {
-          done();
+          finish();
         }
       });
 
@@ -727,7 +733,7 @@ describe('pg-pool', () => {
 
         completed++;
         if (completed >= 2) {
-          done();
+          finish();
         }
       });
     });
@@ -808,6 +814,8 @@ describe('pg-pool', () => {
             1,
             'expected to have 1 used connection'
           );
+
+          poolAux.end();
           done();
         });
       });
@@ -817,6 +825,12 @@ describe('pg-pool', () => {
       const pool1: pgPool<pg.Client> = new pgPool(CONFIG);
       const pool2: pgPool<pg.Client> = new pgPool(CONFIG);
 
+      const finish = () => {
+        pool1.end();
+        pool2.end();
+        done();
+      }
+
       let completed = 0;
       pool1.connect((err, client, release) => {
         if (err) {
@@ -862,7 +876,7 @@ describe('pg-pool', () => {
 
         completed++;
         if (completed >= 2) {
-          done();
+          finish();
         }
       });
 
@@ -910,7 +924,7 @@ describe('pg-pool', () => {
 
         completed++;
         if (completed >= 2) {
-          done();
+          finish();
         }
       });
     });
@@ -937,14 +951,24 @@ describe('pg-pool (ESM)', () => {
       checkCollector: (collector: testUtils.TestCollector) => {
         const spans = collector.sortedSpans;
 
-        assert.strictEqual(spans.length, 3);
-
-        assert.strictEqual(spans[0].name, 'pgPool.connect');
-        assert.strictEqual(spans[0].kind, 3);
-        assert.strictEqual(spans[1].name, 'test-span');
-        assert.strictEqual(spans[1].kind, 1);
-        assert.strictEqual(spans[2].name, 'pgPool.query:SELECT NOW()');
-        assert.strictEqual(spans[2].kind, 3);
+        assert.strictEqual(spans.length, 6);
+
+        let span = spans.shift()!;
+        assert.strictEqual(span.name, 'test-span');
+        assert.strictEqual(span.kind, 1 /* OtlpSpanKind.INTERNAL */);
+        const expectedRemainingSpanNames = [
+          // I believe two sets of `*.connect` spans because pg-pool opens
+          // two connections to start.
+          'pg-pool.connect',
+          'pg.connect',
+          'pg-pool.connect',
+          'pg.connect',
+          'pg.query:SELECT otel_pg_database'
+        ];
+        for (let expectedName of expectedRemainingSpanNames) {
+          span = spans.shift()!;
+          assert.strictEqual(span.name, expectedName);
+        }
       },
     });
   });