Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(ioredis): fix instrumentation of ESM-imported ioredis #1694

Merged
merged 6 commits into from
Oct 17, 2023
Merged

fix(ioredis): fix instrumentation of ESM-imported ioredis #1694

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
62a1456
fix(ioredis): fix instrumentation of ESM-imported ioredis
trentm Sep 21, 2023
7bff58b
eslint style fix
trentm Sep 21, 2023
faea55c
Merge branch 'main' into trentm/issue1692-ioredis-esm
trentm Sep 27, 2023
fa28a93
Merge branch 'main' into trentm/issue1692-ioredis-esm
trentm Oct 4, 2023
cc31725
Merge branch 'main' into trentm/issue1692-ioredis-esm
trentm Oct 11, 2023
f6e6414
Merge branch 'main' into trentm/issue1692-ioredis-esm
pichlermarc Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions plugins/node/opentelemetry-instrumentation-ioredis/src/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,11 @@
new InstrumentationNodeModuleDefinition<any>(
'ioredis',
['>1', '<6'],
(moduleExports, moduleVersion?: string) => {
(module, moduleVersion?: string) => {
const moduleExports =
module[Symbol.toStringTag] === 'Module'
? module.default // ESM

Check warning on line 55 in plugins/node/opentelemetry-instrumentation-ioredis/src/instrumentation.ts

View check run for this annotation

Codecov / codecov/patch

plugins/node/opentelemetry-instrumentation-ioredis/src/instrumentation.ts#L55 

Added line #L55 was not covered by tests
: module; // CommonJS
blumamir marked this conversation as resolved.
Show resolved Hide resolved
diag.debug('Applying patch for ioredis');
if (isWrapped(moduleExports.prototype.sendCommand)) {
this._unwrap(moduleExports.prototype, 'sendCommand');
Expand All @@ -67,10 +71,14 @@
'connect',
this._patchConnection()
);
return moduleExports;
return module;
},
moduleExports => {
if (moduleExports === undefined) return;
module => {
if (module === undefined) return;
const moduleExports =
module[Symbol.toStringTag] === 'Module'
? module.default // ESM

Check warning on line 80 in plugins/node/opentelemetry-instrumentation-ioredis/src/instrumentation.ts

View check run for this annotation

Codecov / codecov/patch

plugins/node/opentelemetry-instrumentation-ioredis/src/instrumentation.ts#L80 

Added line #L80 was not covered by tests
: module; // CommonJS
diag.debug('Removing patch for ioredis');
this._unwrap(moduleExports.prototype, 'sendCommand');
this._unwrap(moduleExports.prototype, 'connect');
Expand All @@ -84,17 +92,17 @@
*/
private _patchSendCommand(moduleVersion?: string) {
return (original: Function) => {
return this.traceSendCommand(original, moduleVersion);
return this._traceSendCommand(original, moduleVersion);
};
}

private _patchConnection() {
return (original: Function) => {
return this.traceConnection(original);
return this._traceConnection(original);
};
}

private traceSendCommand = (original: Function, moduleVersion?: string) => {
private _traceSendCommand(original: Function, moduleVersion?: string) {
const instrumentation = this;
return function (this: RedisInterface, cmd?: IORedisCommand) {
if (arguments.length < 1 || typeof cmd !== 'object') {
Expand Down Expand Up @@ -178,9 +186,9 @@
throw error;
}
};
};
}

private traceConnection = (original: Function) => {
private _traceConnection(original: Function) {
const instrumentation = this;
return function (this: RedisInterface) {
const config =
Expand Down Expand Up @@ -213,5 +221,5 @@
throw error;
}
};
};
}
}
Loading