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(user-interaction): event listeners have wrong this when listening for bubbled events #643

Merged
merged 6 commits into from Aug 31, 2021
Merged

fix(user-interaction): event listeners have wrong this when listening for bubbled events #643

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cf70bcb
fix(user-interaction): event listeners have wrong this when listening…
t2t2 Aug 26, 2021
96a3881
Merge branch 'main' into event-target-this
t2t2 Aug 26, 2021
86517cb
Merge branch 'main' into event-target-this
t2t2 Aug 27, 2021
3077123
Also fix this when span isn't generated
t2t2 Aug 27, 2021
0c21d38
Merge branch 'main' into event-target-this
dyladan Aug 27, 2021
f684015
Merge branch 'main' into event-target-this
dyladan Aug 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions plugins/web/opentelemetry-instrumentation-user-interaction/src/instrumentation.ts
View file
Open in desktop
Expand Up @@ -267,7 +267,7 @@ export class UserInteractionInstrumentation extends InstrumentationBase<unknown>
useCapture: any
) {
const once = useCapture && useCapture.once;
const patchedListener = (...args: any[]) => {
const patchedListener = function (this: HTMLElement, ...args: any[]) {
let parentSpan: api.Span | undefined;
const event: Event | undefined = args[0];
const target = event?.target;
Expand All @@ -285,14 +285,14 @@ export class UserInteractionInstrumentation extends InstrumentationBase<unknown>
return api.context.with(
api.trace.setSpan(api.context.active(), span),
() => {
const result = plugin._invokeListener(listener, target, args);
const result = plugin._invokeListener(listener, this, args);
// no zone so end span immediately
span.end();
return result;
}
);
} else {
return plugin._invokeListener(listener, target, args);
return plugin._invokeListener(listener, this, args);
}
};
if (plugin.addPatchedListener(this, type, listener, patchedListener)) {
Expand Down
17 changes: 16 additions & 1 deletion ...ns/web/opentelemetry-instrumentation-user-interaction/test/userInteraction.nozone.test.ts
View file
Open in desktop
Expand Up @@ -486,7 +486,11 @@ describe('UserInteractionInstrumentation', () => {
btn2.setAttribute('id', 'btn2');
root.appendChild(btn2);

root.addEventListener('click', event => {
const listenerThis: EventTarget[] = [];
root.addEventListener('click', function (event) {
// Assert here with failure would also affect other tests due to setTimeout bellow
listenerThis.push(this);

switch (event.target) {
case btn1:
getData(FILE_URL, () => {
Expand All @@ -506,6 +510,17 @@ describe('UserInteractionInstrumentation', () => {

sandbox.clock.tick(1000);
originalSetTimeout(() => {
assert.strictEqual(
listenerThis[0],
root,
'this inside event listener matches listened target (0)'
);
assert.strictEqual(
listenerThis[1],
root,
'this inside event listener matches listened target (1)'
);

assert.equal(exportSpy.args.length, 4, 'should export 4 spans');

const span1: tracing.ReadableSpan = exportSpy.args[0][0][0];
Expand Down