fix(instrumentation-redis): properly implement getModuleDefinitions() in the merged-from-two RedisInstrumentation (#3025)

Author: DrewCorlin

packages/instrumentation-redis/package.json

@@ -19,7 +19,7 @@
     "prepublishOnly": "npm run compile",
     "tdd": "npm run test -- --watch-extensions ts --watch",
     "test-v2-v3": "nyc --no-clean mocha --require '@opentelemetry/contrib-test-utils' 'test/v2-v3/*.test.ts'",
-    "test": "nyc --no-clean mocha --require '@opentelemetry/contrib-test-utils' 'test/v4-v5/*.test.ts'",
+    "test": "nyc --no-clean mocha --require '@opentelemetry/contrib-test-utils' 'test/v4-v5/*.test.ts' 'test/*.test.ts'",
     "test:debug": "cross-env RUN_REDIS_TESTS=true mocha --inspect-brk --no-timeouts 'test/**/*.test.ts'",
     "test:with-services-env": "cross-env NODE_OPTIONS='-r dotenv/config' DOTENV_CONFIG_PATH=../../test/test-services.env npm test",
     "test-all-versions": "tav",

packages/instrumentation-redis/src/redis.ts

@@ -13,7 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { InstrumentationBase } from '@opentelemetry/instrumentation';
+import {
+  InstrumentationBase,
+  InstrumentationModuleDefinition,
+} from '@opentelemetry/instrumentation';
 import { RedisInstrumentationConfig } from './types';
 /** @knipignore */
 import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
@@ -56,6 +59,15 @@ export class RedisInstrumentation extends InstrumentationBase<RedisInstrumentati
 
   override init() {}
 
+  // Return underlying modules, as consumers (like https://github.com/DrewCorlin/opentelemetry-node-bundler-plugins) may
+  // expect them to be populated without knowing that this module wraps 2 instrumentations
+  override getModuleDefinitions(): InstrumentationModuleDefinition[] {
+    return [
+      ...this.instrumentationV2_V3.getModuleDefinitions(),
+      ...this.instrumentationV4_V5.getModuleDefinitions(),
+    ];
+  }
+
   override setTracerProvider(tracerProvider: TracerProvider) {
     super.setTracerProvider(tracerProvider);
     if (!this.initialized) {

packages/instrumentation-redis/test/redis.test.ts

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+import { RedisInstrumentation } from '../src';
+import * as assert from 'assert';
+
+describe('redis', () => {
+  it('Returns module definitions of sub-instrumentations', () => {
+    const instrumentation = new RedisInstrumentation();
+    const moduleDefinitions = instrumentation.getModuleDefinitions();
+    assert.ok(moduleDefinitions.length >= 1);
+  });
+});