fix(instrumentation): remove dependency on the shimmer module

doc/contributing/dependencies.md

@@ -23,7 +23,7 @@ An exception is granted for dependencies on `@opentelemetry/api`, which, if used
 
 ## Third-Party Library Dependencies
 
-Packages categorized as third-party and listed under the `"dependencies"` section (e.g., @grpc/grpc-js, @grpc/proto-loader, shimmer, etc.) should remain unpinned and utilize the caret (`^`) symbol. This approach offers several advantages:
+Packages categorized as third-party and listed under the `"dependencies"` section (e.g., @grpc/grpc-js, @grpc/proto-loader, etc.) should remain unpinned and utilize the caret (`^`) symbol. This approach offers several advantages:
 
 - Our users could get bug fixes of those 3rd-party packages easily, without waiting for us to update our library.
 - In cases where multiple packages have dependencies on different versions of the same package, npm will opt for the most recent version, saving space and preventing potential disruptions.

experimental/CHANGELOG.md

@@ -14,6 +14,8 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 
 ### :bug: Bug Fixes
 
+* fix(instrumentation): remove dependency on the shimmer module [#5652](https://github.com/open-telemetry/opentelemetry-js/pull/5652) @cjihrig
+
 ### :books: Documentation
 
 ### :house: Internal

experimental/packages/opentelemetry-instrumentation/LICENSES/shimmer/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2013-2019, Forrest L Norvell
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

experimental/packages/opentelemetry-instrumentation/README.md

@@ -245,6 +245,8 @@ Instrumentations for external modules (e.g. express, mongodb,...) hooks the `req
 
 Apache 2.0 - See [LICENSE][license-url] for more information.
 
+Third-party licenses and copyright notices can be found in the [LICENSES directory](./LICENSES).
+
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

experimental/packages/opentelemetry-instrumentation/package.json

@@ -35,6 +35,7 @@
     "hook.mjs",
     "doc",
     "LICENSE",
+    "LICENSES/**/*",
     "README.md"
   ],
   "scripts": {
@@ -71,10 +72,8 @@
   },
   "dependencies": {
     "@opentelemetry/api-logs": "0.201.1",
-    "@types/shimmer": "^1.2.0",
     "import-in-the-middle": "^1.8.1",
-    "require-in-the-middle": "^7.1.1",
-    "shimmer": "^1.2.1"
+    "require-in-the-middle": "^7.1.1"
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.3.0"

experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts

@@ -26,7 +26,7 @@ import {
   Span,
 } from '@opentelemetry/api';
 import { Logger, LoggerProvider, logs } from '@opentelemetry/api-logs';
-import * as shimmer from 'shimmer';
+import * as shimmer from './shimmer';
 import {
   InstrumentationModuleDefinition,
   Instrumentation,

experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts

@@ -18,7 +18,7 @@ import * as types from '../../types';
 import * as path from 'path';
 import { types as utilTypes } from 'util';
 import { satisfies } from '../../semver';
-import { wrap, unwrap, massWrap, massUnwrap } from 'shimmer';
+import { wrap, unwrap, massWrap, massUnwrap } from '../../shimmer';
 import { InstrumentationAbstract } from '../../instrumentation';
 import {
   RequireInTheMiddleSingleton,

experimental/packages/opentelemetry-instrumentation/src/shimmer.ts

@@ -0,0 +1,197 @@
+/*
+ * 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.
+ */
+
+/*
+ * BSD 2-Clause License
+ *
+ * Copyright (c) 2013-2019, Forrest L Norvell
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* Modified by OpenTelemetry Authors
+ *  - converted to TypeScript
+ *  - aligned with style-guide
+ */
+
+import { ShimWrapped } from './types';
+
+// Default to complaining loudly when things don't go according to plan.
+// eslint-disable-next-line no-console
+let logger: typeof console.error = console.error.bind(console);
+
+// Sets a property on an object, preserving its enumerability.
+// This function assumes that the property is already writable.
+function defineProperty(obj: object, name: PropertyKey, value: unknown): void {
+  const enumerable =
+    !!obj[name as keyof typeof obj] &&
+    Object.prototype.propertyIsEnumerable.call(obj, name);
+
+  Object.defineProperty(obj, name, {
+    configurable: true,
+    enumerable,
+    writable: true,
+    value,
+  });
+}
+
+export const wrap = <Nodule extends object, FieldName extends keyof Nodule>(
+  nodule: Nodule,
+  name: FieldName,
+  wrapper: (original: Nodule[FieldName], name: FieldName) => Nodule[FieldName]
+): ShimWrapped | undefined => {
+  if (!nodule || !nodule[name]) {
+    logger('no original function ' + String(name) + ' to wrap');
+    return;
+  }
+
+  if (!wrapper) {
+    logger('no wrapper function');
+    logger(new Error().stack);
+    return;
+  }
+
+  const original = nodule[name];
+
+  if (typeof original !== 'function' || typeof wrapper !== 'function') {
+    logger('original object and wrapper must be functions');
+    return;
+  }
+
+  const wrapped = wrapper(original, name) as object;
+
+  defineProperty(wrapped, '__original', original);
+  defineProperty(wrapped, '__unwrap', () => {
+    if (nodule[name] === wrapped) {
+      defineProperty(nodule, name, original);
+    }
+  });
+  defineProperty(wrapped, '__wrapped', true);
+  defineProperty(nodule, name, wrapped);
+  return wrapped as ShimWrapped;
+};
+
+export const massWrap = <Nodule extends object, FieldName extends keyof Nodule>(
+  nodules: Nodule[],
+  names: FieldName[],
+  wrapper: (original: Nodule[FieldName]) => Nodule[FieldName]
+): void => {
+  if (!nodules) {
+    logger('must provide one or more modules to patch');
+    logger(new Error().stack);
+    return;
+  } else if (!Array.isArray(nodules)) {
+    nodules = [nodules];
+  }
+
+  if (!(names && Array.isArray(names))) {
+    logger('must provide one or more functions to wrap on modules');
+    return;
+  }
+
+  nodules.forEach(nodule => {
+    names.forEach(name => {
+      wrap(nodule, name, wrapper);
+    });
+  });
+};
+
+export const unwrap = <Nodule extends object>(
+  nodule: Nodule,
+  name: keyof Nodule
+): void => {
+  if (!nodule || !nodule[name]) {
+    logger('no function to unwrap.');
+    logger(new Error().stack);
+    return;
+  }
+
+  const wrapped = nodule[name] as unknown as ShimWrapped;
+
+  if (!wrapped.__unwrap) {
+    logger(
+      'no original to unwrap to -- has ' +
+        String(name) +
+        ' already been unwrapped?'
+    );
+  } else {
+    wrapped.__unwrap();
+    return;
+  }
+};
+
+export const massUnwrap = <Nodule extends object>(
+  nodules: Nodule[],
+  names: Array<keyof Nodule>
+): void => {
+  if (!nodules) {
+    logger('must provide one or more modules to patch');
+    logger(new Error().stack);
+    return;
+  } else if (!Array.isArray(nodules)) {
+    nodules = [nodules];
+  }
+
+  if (!(names && Array.isArray(names))) {
+    logger('must provide one or more functions to unwrap on modules');
+    return;
+  }
+
+  nodules.forEach(nodule => {
+    names.forEach(name => {
+      unwrap(nodule, name);
+    });
+  });
+};
+
+export interface ShimmerOptions {
+  logger?: typeof console.error;
+}
+
+export default function shimmer(options: ShimmerOptions): void {
+  if (options && options.logger) {
+    if (typeof options.logger !== 'function') {
+      logger("new logger isn't a function, not replacing");
+    } else {
+      logger = options.logger;
+    }
+  }
+}
+
+shimmer.wrap = wrap;
+shimmer.massWrap = massWrap;
+shimmer.unwrap = unwrap;
+shimmer.massUnwrap = massUnwrap;