ref(node): Vendor generic-pool instrumentation

.oxlintrc.base.json

@@ -140,6 +140,12 @@
         "no-bitwise": "off"
       }
     },
+    {
+      "files": ["**/integrations/tracing/genericPool/vendored/**/*.ts"],
+      "rules": {
+        "typescript/no-explicit-any": "off"
+      }
+    },
     {
       "files": ["**/scenarios/**", "**/rollup-utils/**"],
       "rules": {

packages/node/package.json

@@ -72,7 +72,6 @@
     "@opentelemetry/instrumentation-connect": "0.57.0",
     "@opentelemetry/instrumentation-dataloader": "0.31.0",
     "@opentelemetry/instrumentation-fs": "0.33.0",
-    "@opentelemetry/instrumentation-generic-pool": "0.57.0",
     "@opentelemetry/instrumentation-graphql": "0.62.0",
     "@opentelemetry/instrumentation-hapi": "0.60.0",
     "@opentelemetry/instrumentation-http": "0.214.0",

packages/node/src/integrations/tracing/genericPool.ts → packages/node/src/integrations/tracing/genericPool/index.ts

@@ -1,4 +1,4 @@
-import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
+import { GenericPoolInstrumentation } from './vendored/instrumentation';
 import type { IntegrationFn } from '@sentry/core';
 import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';
 import { generateInstrumentOnce, instrumentWhenWrapped } from '@sentry/node-core';

packages/node/src/integrations/tracing/genericPool/vendored/instrumentation.ts

@@ -0,0 +1,160 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * NOTICE from the Sentry authors:
+ * - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-generic-pool
+ * - Upstream version: @opentelemetry/instrumentation-generic-pool@0.61.0
+ * - Minor TypeScript strictness adjustments for this repository's compiler settings
+ */
+/* eslint-disable */
+
+import * as api from '@opentelemetry/api';
+import {
+  InstrumentationBase,
+  InstrumentationConfig,
+  InstrumentationNodeModuleDefinition,
+  isWrapped,
+} from '@opentelemetry/instrumentation';
+
+import type * as genericPool from 'generic-pool';
+
+import { SDK_VERSION } from '@sentry/core';
+
+const MODULE_NAME = 'generic-pool';
+const PACKAGE_NAME = '@sentry/instrumentation-generic-pool';
+
+export class GenericPoolInstrumentation extends InstrumentationBase {
+  // only used for v2 - v2.3)
+  private _isDisabled = false;
+
+  constructor(config: InstrumentationConfig = {}) {
+    super(PACKAGE_NAME, SDK_VERSION, config);
+  }
+
+  init() {
+    return [
+      new InstrumentationNodeModuleDefinition(
+        MODULE_NAME,
+        ['>=3.0.0 <4'],
+        moduleExports => {
+          const Pool: any = moduleExports.Pool;
+          if (isWrapped(Pool.prototype.acquire)) {
+            this._unwrap(Pool.prototype, 'acquire');
+          }
+          this._wrap(Pool.prototype, 'acquire', this._acquirePatcher.bind(this));
+          return moduleExports;
+        },
+        moduleExports => {
+          const Pool: any = moduleExports.Pool;
+          this._unwrap(Pool.prototype, 'acquire');
+          return moduleExports;
+        },
+      ),
+      new InstrumentationNodeModuleDefinition(
+        MODULE_NAME,
+        ['>=2.4.0 <3'],
+        moduleExports => {
+          const Pool: any = moduleExports.Pool;
+          if (isWrapped(Pool.prototype.acquire)) {
+            this._unwrap(Pool.prototype, 'acquire');
+          }
+          this._wrap(Pool.prototype, 'acquire', this._acquireWithCallbacksPatcher.bind(this));
+          return moduleExports;
+        },
+        moduleExports => {
+          const Pool: any = moduleExports.Pool;
+          this._unwrap(Pool.prototype, 'acquire');
+          return moduleExports;
+        },
+      ),
+      new InstrumentationNodeModuleDefinition(
+        MODULE_NAME,
+        ['>=2.0.0 <2.4'],
+        moduleExports => {
+          this._isDisabled = false;
+          if (isWrapped(moduleExports.Pool)) {
+            this._unwrap(moduleExports, 'Pool');
+          }
+          this._wrap(moduleExports, 'Pool', this._poolWrapper.bind(this));
+          return moduleExports;
+        },
+        moduleExports => {
+          // since the object is created on the fly every time, we need to use
+          // a boolean switch here to disable the instrumentation
+          this._isDisabled = true;
+          return moduleExports;
+        },
+      ),
+    ];
+  }
+
+  private _acquirePatcher(original: genericPool.Pool<unknown>['acquire']) {
+    const instrumentation = this;
+    return function wrapped_acquire(this: genericPool.Pool<unknown>, ...args: any[]) {
+      const parent = api.context.active();
+      const span = instrumentation.tracer.startSpan('generic-pool.acquire', {}, parent);
+
+      return api.context.with(api.trace.setSpan(parent, span), () => {
+        return original.call(this, ...args).then(
+          (value: unknown) => {
+            span.end();
+            return value;
+          },
+          (err: unknown) => {
+            span.recordException(err as Error);
+            span.end();
+            throw err;
+          },
+        );
+      });
+    };
+  }
+
+  private _poolWrapper(original: any) {
+    const instrumentation = this;
+    return function wrapped_pool(this: any) {
+      const pool = original.apply(this, arguments);
+      instrumentation._wrap(pool, 'acquire', instrumentation._acquireWithCallbacksPatcher.bind(instrumentation));
+      return pool;
+    };
+  }
+
+  private _acquireWithCallbacksPatcher(original: any) {
+    const instrumentation = this;
+    return function wrapped_acquire(this: genericPool.Pool<unknown>, cb: Function, priority: number) {
+      // only used for v2 - v2.3
+      if (instrumentation._isDisabled) {
+        return original.call(this, cb, priority);
+      }
+      const parent = api.context.active();
+      const span = instrumentation.tracer.startSpan('generic-pool.acquire', {}, parent);
+
+      return api.context.with(api.trace.setSpan(parent, span), () => {
+        original.call(
+          this,
+          (err: unknown, client: unknown) => {
+            span.end();
+            // Not checking whether cb is a function because
+            // the original code doesn't do that either.
+            if (cb) {
+              return cb(err, client);
+            }
+          },
+          priority,
+        );
+      });
+    };
+  }
+}

yarn.lock

@@ -6231,13 +6231,6 @@
     "@opentelemetry/core" "^2.0.0"
     "@opentelemetry/instrumentation" "^0.214.0"
 
-"@opentelemetry/instrumentation-generic-pool@0.57.0":
-  version "0.57.0"
-  resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation-generic-pool/-/instrumentation-generic-pool-0.57.0.tgz#4220a2fc1974b40a989171a9b5f3d1eeab92683f"
-  integrity sha512-orhmlaK+ZIW9hKU+nHTbXrCSXZcH83AescTqmpamHRobRmYSQwRbD0a1odc0yAzuzOtxYiHiXAnpnIpaSSY7Ow==
-  dependencies:
-    "@opentelemetry/instrumentation" "^0.214.0"
-
 "@opentelemetry/instrumentation-graphql@0.62.0":
   version "0.62.0"
   resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation-graphql/-/instrumentation-graphql-0.62.0.tgz#dc2fc92c6be331c4f95b62a40983c8aedb8f9bf9"