@opentelemetry/instrumentation-pg - npm Package Compare versions

Comparing version 0.35.3 to 0.36.0

build/src/index.js

@@ -17,16 +17,7 @@ "use strict";
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./instrumentation"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./enums/AttributeNames"), exports);
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./instrumentation"), exports);
+(0, tslib_1.__exportStar)(require("./types"), exports);
+(0, tslib_1.__exportStar)(require("./enums/AttributeNames"), exports);
 //# sourceMappingURL=index.js.map

build/src/instrumentation.js

@@ -24,2 +24,3 @@ "use strict";
 const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const sql_common_1 = require("@opentelemetry/sql-common");
 const version_1 = require("./version");
@@ -124,11 +125,7 @@ const PG_POOL_COMPONENT = 'pg-pool';
                 // tracing, but only if args[0] has one of our expected shapes.
-                //
-                // TODO: remove the `as ...` casts below when the TS version is upgraded.
-                // Newer TS versions will use the result of firstArgIsQueryObjectWithText
-                // to properly narrow arg0, but TS 4.3.5 does not.
                 if (instrumentationConfig.addSqlCommenterCommentToQueries) {
                     args[0] = firstArgIsString
-                        ? utils.addSqlCommenterComment(span, arg0)
+                        ? (0, sql_common_1.addSqlCommenterComment)(span, arg0)
                         : firstArgIsQueryObjectWithText
-                            ? Object.assign(Object.assign({}, arg0), { text: utils.addSqlCommenterComment(span, arg0.text) }) : args[0];
+                            ? Object.assign(Object.assign({}, arg0), { text: (0, sql_common_1.addSqlCommenterComment)(span, arg0.text) }) : args[0];
                 }
@@ -135,0 +132,0 @@ // Bind callback (if any) to parent span (if any)

build/src/utils.d.ts

@@ -42,3 +42,2 @@ import { Span, Tracer } from '@opentelemetry/api';
 export declare function patchClientConnectCallback(span: Span, cb: Function): Function;
-export declare function addSqlCommenterComment(span: Span, query: string): string;
 /**
@@ -45,0 +44,0 @@ * Attempt to get a message string from a thrown value, while being quite

build/src/utils.js

@@ -18,5 +18,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isObjectWithTextString = exports.getErrorMessage = exports.addSqlCommenterComment = exports.patchClientConnectCallback = exports.patchCallbackPGPool = exports.patchCallback = exports.handleExecutionResult = exports.handleConfigQuery = exports.shouldSkipInstrumentation = exports.getSemanticAttributesFromConnection = exports.getConnectionString = exports.getQuerySpanName = void 0;
+exports.isObjectWithTextString = exports.getErrorMessage = exports.patchClientConnectCallback = exports.patchCallbackPGPool = exports.patchCallback = exports.handleExecutionResult = exports.handleConfigQuery = exports.shouldSkipInstrumentation = exports.getSemanticAttributesFromConnection = exports.getConnectionString = exports.getQuerySpanName = void 0;
 const api_1 = require("@opentelemetry/api");
-const core_1 = require("@opentelemetry/core");
 const AttributeNames_1 = require("./enums/AttributeNames");
@@ -195,51 +194,2 @@ const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
 exports.patchClientConnectCallback = patchClientConnectCallback;
-// NOTE: This function currently is returning false-positives
-// in cases where comment characters appear in string literals
-// ("SELECT '-- not a comment';" would return true, although has no comment)
-function hasValidSqlComment(query) {
-    const indexOpeningDashDashComment = query.indexOf('--');
-    if (indexOpeningDashDashComment >= 0) {
-        return true;
-    }
-    const indexOpeningSlashComment = query.indexOf('/*');
-    if (indexOpeningSlashComment < 0) {
-        return false;
-    }
-    const indexClosingSlashComment = query.indexOf('*/');
-    return indexOpeningDashDashComment < indexClosingSlashComment;
-}
-// sqlcommenter specification (https://google.github.io/sqlcommenter/spec/#value-serialization)
-// expects us to URL encode based on the RFC 3986 spec (https://en.wikipedia.org/wiki/Percent-encoding),
-// but encodeURIComponent does not handle some characters correctly (! ' ( ) *),
-// which means we need special handling for this
-// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
-function fixedEncodeURIComponent(str) {
-    return encodeURIComponent(str).replace(/[!'()*]/g, c => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
-}
-function addSqlCommenterComment(span, query) {
-    if (typeof query !== 'string' || query.length === 0) {
-        return query;
-    }
-    // As per sqlcommenter spec we shall not add a comment if there already is a comment
-    // in the query
-    if (hasValidSqlComment(query)) {
-        return query;
-    }
-    const propagator = new core_1.W3CTraceContextPropagator();
-    const headers = {};
-    propagator.inject(api_1.trace.setSpan(api_1.ROOT_CONTEXT, span), headers, api_1.defaultTextMapSetter);
-    // sqlcommenter spec requires keys in the comment to be sorted lexicographically
-    const sortedKeys = Object.keys(headers).sort();
-    if (sortedKeys.length === 0) {
-        return query;
-    }
-    const commentString = sortedKeys
-        .map(key => {
-        const encodedValue = fixedEncodeURIComponent(headers[key]);
-        return `${key}='${encodedValue}'`;
-    })
-        .join(',');
-    return `${query} /*${commentString}*/`;
-}
-exports.addSqlCommenterComment = addSqlCommenterComment;
 /**
@@ -246,0 +196,0 @@ * Attempt to get a message string from a thrown value, while being quite

build/src/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.35.3";
+export declare const VERSION = "0.36.0";
 //# sourceMappingURL=version.d.ts.map

build/src/version.js

@@ -20,3 +20,3 @@ "use strict";
 // this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '0.35.3';
+exports.VERSION = '0.36.0';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@opentelemetry/instrumentation-pg",
-  "version": "0.35.3",
+  "version": "0.36.0",
   "description": "OpenTelemetry postgres automatic instrumentation package.",
@@ -58,3 +58,3 @@ "main": "build/src/index.js",
     "@opentelemetry/context-async-hooks": "^1.8.0",
-    "@opentelemetry/contrib-test-utils": "^0.33.4",
+    "@opentelemetry/contrib-test-utils": "^0.34.0",
     "@opentelemetry/sdk-trace-base": "^1.8.0",
@@ -79,9 +79,11 @@ "@opentelemetry/sdk-trace-node": "^1.8.0",
     "@opentelemetry/core": "^1.8.0",
-    "@opentelemetry/instrumentation": "^0.40.0",
+    "@opentelemetry/instrumentation": "^0.41.0",
     "@opentelemetry/semantic-conventions": "^1.0.0",
+    "@opentelemetry/sql-common": "^0.40.0",
     "@types/pg": "8.6.1",
-    "@types/pg-pool": "2.0.3"
+    "@types/pg-pool": "2.0.3",
+    "tslib": "^2.3.1"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pg#readme",
-  "gitHead": "efdfc727a49090accee7fea8ff93011b6b84c1e4"
+  "gitHead": "f81f8a76a8f0af2101c62dbc73cde442f875d833"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

98839

decreased by-6.74%

Dependency count

8

increased by33.33%

Lines of code

749

decreased by-7.76%

Dependency changes

• + Added@opentelemetry/sql-common@^0.40.0

• + Addedtslib@^2.3.1

• + Added@opentelemetry/instrumentation@0.41.2(transitive)

• + Added@opentelemetry/sql-common@0.40.1(transitive)

• + Addedacorn@8.14.0(transitive)

• + Addedacorn-import-assertions@1.9.0(transitive)

• + Addedcjs-module-lexer@1.4.1(transitive)

• + Addedimport-in-the-middle@1.4.2(transitive)

• + Addedtslib@2.8.1(transitive)

• - Removed@opentelemetry/instrumentation@0.40.0(transitive)

• - Removedimport-in-the-middle@1.3.5(transitive)

• Updated@opentelemetry/instrumentation@^0.41.0