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

fix: redis instrumentation loses context when using callbacks #580

Merged
merged 8 commits into from
Aug 5, 2021
Merged

fix: redis instrumentation loses context when using callbacks #580

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
66044df
fix: redis instrumentation loses context when using callbacks
aspectom Jul 19, 2021
c479e46
fix: rename test
aspectom Jul 19, 2021
5fe0bc2
fix: merge new test into existing describe
aspectom Jul 19, 2021
89d8384
fix: refactor context.with as requested
aspectom Jul 19, 2021
860d515
fix: remove redundant callbackThis const
aspectom Jul 19, 2021
d4c24fe
fix: move originalContext to inside if
aspectom Jul 20, 2021
62d8430
Merge branch 'main' into fix-redis-instrumentation-callbacks
dyladan Jul 28, 2021
52e90d9
Merge branch 'main' into fix-redis-instrumentation-callbacks
obecny Aug 4, 2021
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
8 changes: 7 additions & 1 deletion plugins/node/opentelemetry-instrumentation-redis/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ export const getTracedInternalSendCommand = (

const originalCallback = arguments[0].callback;
if (originalCallback) {
const originalContext = context.active();
(arguments[0] as RedisCommand).callback = function callback<T>(
this: unknown,
err: Error | null,
Expand All @@ -146,7 +147,12 @@ export const getTracedInternalSendCommand = (
}

endSpan(span, err);
return originalCallback.apply(this, arguments);
return context.with(
originalContext,
originalCallback,
this,
...arguments
);
};
}
try {
Expand Down
10 changes: 10 additions & 0 deletions plugins/node/opentelemetry-instrumentation-redis/test/redis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,16 @@ describe('[email protected]', () => {
});
});
});

it('should invoke callback with original command context', () => {
const rootSpan = tracer.startSpan('test span');
context.with(trace.setSpan(context.active(), rootSpan), () => {
client.set('callbacksTestKey', 'value', () => {
const activeSpan = trace.getSpan(context.active());
assert.strictEqual(activeSpan, rootSpan);
});
});
});
});

describe('Removing instrumentation', () => {
Expand Down