test(node): Add tests for knexIntegration

Set up postgres for testing.
Update span attributes to be named under 'knex'.

Signed-off-by: Kaung Zin Hein <[email protected]>

Author: Zen-cronic

dev-packages/node-integration-tests/suites/tracing/knex/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.9'
+
+services:
+  db:
+    image: postgres:13
+    restart: always
+    container_name: integration-tests-knex
+    ports:
+      - '5445:5432'
+    environment:
+      POSTGRES_USER: test
+      POSTGRES_PASSWORD: test
+      POSTGRES_DB: tests

dev-packages/node-integration-tests/suites/tracing/knex/scenario.js

@@ -0,0 +1,63 @@
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+});
+
+// Stop the process from exiting before the transaction is sent
+setInterval(() => {}, 1000);
+
+const knex = require('knex').default;
+
+async function run() {
+  await Sentry.startSpan(
+    {
+      name: 'Test Transaction',
+      op: 'transaction',
+    },
+    async () => {
+      try {
+        const pgKnex = knex({
+          client: 'pg',
+          connection: {
+            host: 'localhost',
+            port: 5445,
+            user: 'test',
+            password: 'test',
+            database: 'tests',
+          },
+        });
+
+        await pgKnex.schema.createTable('User', table => {
+          table.increments('id').notNullable().primary({ constraintName: 'User_pkey' });
+          table.timestamp('createdAt', { precision: 3 }).notNullable().defaultTo(pgKnex.fn.now(3));
+          table.text('email').notNullable();
+          table.text('name').notNullable();
+        });
+
+        await pgKnex('User').insert({ name: 'bob', email: '[email protected]' });
+        await pgKnex('User').select('*');
+        // await client
+        //   .query(
+        //     'CREATE TABLE "User" ("id" SERIAL NOT NULL,"createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,"email" TEXT NOT NULL,"name" TEXT,CONSTRAINT "User_pkey" PRIMARY KEY ("id"));',
+        //   )
+        //   .catch(() => {
+        //     // if this is not a fresh database, the table might already exist
+        //   });
+
+        // await client.query('');
+        // await client.query('INSERT INTO "User" ("email", "name") VALUES ($1, $2)', ['tim', '[email protected]']);
+        // await client.query('SELECT * FROM "User"');
+      } finally {
+        // await client.end();
+      }
+    },
+  );
+}
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();

dev-packages/node-integration-tests/suites/tracing/knex/test.ts

@@ -0,0 +1,77 @@
+import { createRunner } from '../../../utils/runner';
+
+jest.setTimeout(75000);
+
+describe('knex auto instrumentation', () => {
+  test('should auto-instrument `knex` package', done => {
+    const EXPECTED_TRANSACTION = {
+      transaction: 'Test Transaction',
+      spans: expect.arrayContaining([
+        expect.objectContaining({
+          data: expect.objectContaining({
+            'db.system': 'knex',
+            'db.name': 'tests',
+            'sentry.origin': 'auto.db.otel.knex',
+            'sentry.op': 'db',
+            'net.peer.name': 'localhost',
+            'net.peer.port': 5445,
+          }),
+          status: 'ok',
+          description: 'pg.connect',
+          origin: 'auto.db.otel.knex',
+        }),
+        expect.objectContaining({
+          data: expect.objectContaining({
+            'db.system': 'knex',
+            'db.name': 'tests',
+            'db.statement':
+              'create table "User" ("id" serial primary key, "createdAt" timestamptz(3) not null default CURRENT_TIMESTAMP(3), "email" text not null, "name" text not null)',
+            'sentry.origin': 'auto.db.otel.knex',
+            'sentry.op': 'db',
+            'net.peer.name': 'localhost',
+            'net.peer.port': 5445,
+          }),
+          status: 'ok',
+          description:
+            'create table "User" ("id" serial primary key, "createdAt" timestamptz(3) not null default CURRENT_TIMESTAMP(3), "email" text not null, "name" text not null)',
+          origin: 'auto.db.otel.knex',
+        }),
+        expect.objectContaining({
+          data: expect.objectContaining({
+            'db.system': 'knex',
+            'db.name': 'tests',
+            'db.statement': 'insert into "User" ("email", "name") values (?, ?)',
+            'sentry.origin': 'auto.db.otel.knex',
+            'sentry.op': 'db',
+            'net.peer.name': 'localhost',
+            'net.peer.port': 5445,
+          }),
+          status: 'ok',
+          // In the otel spans, the placeholders (e.g., `$1`) are replaced by a `?`.
+          description: 'insert into "User" ("email", "name") values (?, ?)',
+          origin: 'auto.db.otel.knex',
+        }),
+
+        expect.objectContaining({
+          data: expect.objectContaining({
+            'db.operation': 'select',
+            'db.sql.table': 'User',
+            'db.system': 'knex',
+            'db.name': 'tests',
+            'db.statement': 'select * from "User"',
+            'sentry.origin': 'auto.db.otel.knex',
+            'sentry.op': 'db',
+          }),
+          status: 'ok',
+          description: 'select * from "User"',
+          origin: 'auto.db.otel.knex',
+        }),
+      ]),
+    };
+
+    createRunner(__dirname, 'scenario.js')
+      .withDockerCompose({ workingDirectory: [__dirname], readyMatches: ['port 5432'] })
+      .expect({ transaction: EXPECTED_TRANSACTION })
+      .start(done);
+  });
+});

packages/node/src/integrations/tracing/knex.ts

@@ -1,5 +1,5 @@
 import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
-import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
+import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration } from '@sentry/core';
 import type { IntegrationFn } from '@sentry/types';
 import { generateInstrumentOnce } from '../../otel/instrument';
 
@@ -16,12 +16,8 @@ const _knexIntegration = (() => {
 
     setup(client) {
       client.on('spanStart', span => {
-        const spanJSON = spanToJSON(span);
-
-        const spanDescription = spanJSON.description;
-        console.log('[Knex]: span description: ', spanDescription);
-
         span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
+        span.setAttribute('db.system', 'knex');
       });
     },
   };