feat: separate tables and operations (#77)

Author: tomer-friedman

docs/jest-otel/syntax/db-pg.mdx

@@ -30,7 +30,8 @@ So, a complete assertion can look like:
 expectTrace(traceloop.serviceByName('orders-service'))
   .toQueryPostgreSQL()
   .withDatabaseName('postgres')
-  .withOperationAndTable('INSERT', 'orders')
+  .withOperations('INSERT')
+  .withTables('orders')
   .withStatement(
     /INSERT INTO orders \(id, price_in_cents\) VALUES \('[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}', [0-9]+\)/,
     { compareType: COMPARE_TYPE.REGEX },

package-lock.json

@@ -38,7 +38,8 @@
     "@opentelemetry/semantic-conventions": "^1.10.1",
     "@traceloop/otel-proto": "^0.6.0",
     "axios": "^1.3.4",
-    "deep-equal": "^2.2.0"
+    "deep-equal": "^2.2.0",
+    "node-sql-parser": "^4.7.0"
   },
   "devDependencies": {
     "@types/deep-equal": "^1.0.1",

packages/expect-opentelemetry/package.json

@@ -24,7 +24,8 @@ describe('postgresql query', () => {
     expectTrace(traceloop.serviceByName('orders-service'))
       .toQueryPostgreSQL()
       .withDatabaseName('postgres', { compareType: COMPARE_TYPE.EQUALS })
-      .withOperationAndTable('INSERT', 'orders')
+      .withOperations('INSERT')
+      .withTables('orders')
       .withStatement(
         /INSERT INTO orders \(id, price_in_cents\) VALUES \('[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}', [0-9]+\)/,
         { compareType: COMPARE_TYPE.REGEX },

packages/expect-opentelemetry/src/matchers/service/to-query-postgresql.test.ts

@@ -1,5 +1,6 @@
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
 import { opentelemetry } from '@traceloop/otel-proto';
+import { Parser } from 'node-sql-parser';
 import {
   CompareOptions,
   filterByAttributeStringValue,
@@ -9,6 +10,7 @@ export class PostgreSQLQuery {
   constructor(
     readonly spans: opentelemetry.proto.trace.v1.ISpan[],
     private readonly serviceName: string,
+    private parser = new Parser(),
   ) {}
 
   withDatabaseName(name: string | RegExp, options?: CompareOptions) {
@@ -45,9 +47,33 @@ export class PostgreSQLQuery {
     return new PostgreSQLQuery(filteredSpans, this.serviceName);
   }
 
-  withOperationAndTable(operation: string, table: string) {
-    const regex = new RegExp(`${operation}.*${table}`, 'i'); // case insensitive
+  withOperations(...operations: string[]) {
+    const filteredSpans = this.spans.filter((span) => {
+      const statement = span.attributes?.find(
+        (attribute) => attribute.key === SemanticAttributes.DB_STATEMENT,
+      )?.value?.stringValue;
+
+      if (!statement) {
+        return false;
+      }
+
+      const lowerCaseStatement = statement.toLowerCase();
+
+      return operations.every((operation) =>
+        lowerCaseStatement.includes(operation.toLowerCase()),
+      );
+    });
 
+    if (filteredSpans.length === 0) {
+      throw new Error(
+        `No query by ${this.serviceName} to postgresql with operations ${operations} was found`,
+      );
+    }
+
+    return new PostgreSQLQuery(filteredSpans, this.serviceName);
+  }
+
+  withTables(...tables: string[]) {
     const filteredSpans = this.spans.filter((span) => {
       const statement = span.attributes?.find(
         (attribute) => attribute.key === SemanticAttributes.DB_STATEMENT,
@@ -57,15 +83,25 @@ export class PostgreSQLQuery {
         return false;
       }
 
-      return regex.test(statement);
+      const allTablesInStatement = this.parser
+        .tableList(prepareQuery(statement), { database: 'PostgresQL' })
+        .map((table) => table.split('::')[2].trim());
+
+      return tables.every((table) =>
+        allTablesInStatement.includes(table.toLowerCase()),
+      );
     });
 
     if (filteredSpans.length === 0) {
       throw new Error(
-        `No query by ${this.serviceName} to postgresql with operation ${operation} and table ${table} was found`,
+        `No query by ${this.serviceName} to postgresql with tables ${tables} was found`,
       );
     }
 
     return new PostgreSQLQuery(filteredSpans, this.serviceName);
   }
 }
+
+const prepareQuery = (
+  query: string, // remove double quotes and replace %s with 111
+) => query.replace(/"/g, '').replace(/%s/g, '111').toLocaleLowerCase();