Skip to content

fix(mysql): bind get connection callback to active context #562

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

Merged
vmarchaud merged 4 commits into from
Aug 14, 2021
Merged

fix(mysql): bind get connection callback to active context #562

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25b93b1
fix(mysql): bind get connection callback to active context
sstone1 Jul 5, 2021
5f192b8
fix(mysql): address review comments from @flarna, @blumamir
Aug 11, 2021
0c73381
fix(mysql): fix linting errors
Aug 11, 2021
54b3191
Merge branch 'main' into issue-561
vmarchaud Aug 14, 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
Next Next commit
fix(mysql): bind get connection callback to active context 
Signed-off-by: Simon Stone <simonstone1@gmail.com>
  • Loading branch information
@sstone1
sstone1 authored and Simon Stone committed Aug 10, 2021
commit 25b93b1585ef7d1540814f379fb4d1296a4f60a0
13 changes: 11 additions & 2 deletions plugins/node/opentelemetry-instrumentation-mysql/src/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@
* limitations under the License.
*/

import { diag, Span, SpanKind, SpanStatusCode } from '@opentelemetry/api';
import {
context,
diag,
Span,
SpanKind,
SpanStatusCode,
} from '@opentelemetry/api';
import {
InstrumentationBase,
InstrumentationNodeModuleDefinition,
Expand Down Expand Up @@ -203,6 +209,7 @@ export class MySQLInstrumentation extends InstrumentationBase<

private _getConnectionCallbackPatchFn(cb: Function, format: formatType) {
const thisPlugin = this;
const activeContext = context.active();
return function () {
if (arguments[1]) {
// this is the callback passed into a query
Expand All @@ -216,7 +223,9 @@ export class MySQLInstrumentation extends InstrumentationBase<
}
}
if (typeof cb === 'function') {
cb(...arguments);
context.with(activeContext, () => {
cb(...arguments);
});
}
};
}
Expand Down
48 changes: 48 additions & 0 deletions plugins/node/opentelemetry-instrumentation-mysql/test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,30 @@ describe('mysql@2.x', () => {
});
});
});

it('should propagate active context to callback', done => {
const parentSpan = provider.getTracer('default').startSpan('test span');
context.with(trace.setSpan(context.active(), parentSpan), () => {
pool.getConnection((err, connection) => {
assert.ifError(err);
assert.ok(connection);
const sql = 'SELECT ? as solution';
connection.query(sql, 1, (err, res) => {
assert.ifError(err);
assert.ok(res);
assert.strictEqual(res[0].solution, 1);
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 1);
const querySpan = spans[0];
assert.strictEqual(
querySpan.parentSpanId,
parentSpan.spanContext().spanId
);
done();
});
});
Copy link
Member

@blumamir blumamir Jul 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a very verbose way to check that the context is correctly set in the callback.
Alternative and more direct option is to extract trace.getSpan(context.active()) in the callback and compare it to parentSpan

Copy link
Contributor Author

@sstone1 sstone1 Aug 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@blumamir thanks, I've changed the test.

});
});
});

describe('#PoolCluster', () => {
Expand Down Expand Up @@ -600,6 +624,30 @@ describe('mysql@2.x', () => {
}
);
});

it('should propagate active context to callback', done => {
const parentSpan = provider.getTracer('default').startSpan('test span');
context.with(trace.setSpan(context.active(), parentSpan), () => {
poolCluster.getConnection((err, connection) => {
assert.ifError(err);
assert.ok(connection);
const sql = 'SELECT ? as solution';
connection.query(sql, 1, (err, res) => {
assert.ifError(err);
assert.ok(res);
assert.strictEqual(res[0].solution, 1);
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 1);
const querySpan = spans[0];
assert.strictEqual(
querySpan.parentSpanId,
parentSpan.spanContext().spanId
);
done();
});
});
});
});
});
});

Expand Down