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.

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

chore: clean up span naming #162

Merged
merged 3 commits into from
Jul 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ import { AttributeNames } from './enums/AttributeNames';
import { VERSION } from './version';

const ZONE_CONTEXT_KEY = 'OT_ZONE_CONTEXT';
const EVENT_CLICK_NAME = 'event_click:';
const EVENT_NAVIGATION_NAME = 'Navigation:';

/**
Expand Down Expand Up @@ -80,6 +79,12 @@ export class UserInteractionPlugin extends BasePlugin<unknown> {
}
}

/**
* Controls whether or not to create a span, based on the event type.
*/
protected _allowEventType(eventType: string): boolean {
return eventType === 'click';
}
/**
* Creates a new span
* @param element
Expand All @@ -95,9 +100,12 @@ export class UserInteractionPlugin extends BasePlugin<unknown> {
if (element.hasAttribute('disabled')) {
return undefined;
}
if (!this._allowEventType(eventName)) {
return undefined;
}
const xpath = getElementXPath(element, true);
try {
const span = this._tracer.startSpan(`${EVENT_CLICK_NAME} ${xpath}`, {
const span = this._tracer.startSpan(eventName, {
attributes: {
[AttributeNames.COMPONENT]: this.component,
[AttributeNames.EVENT_TYPE]: eventName,
Expand Down Expand Up @@ -147,17 +155,6 @@ export class UserInteractionPlugin extends BasePlugin<unknown> {
return context;
}

/**
* It gets the element that has been clicked when zone tries to run a new task
* @param task
*/
private _getClickedElement(task: AsyncTask): HTMLElement | undefined {
if (task.eventName === 'click') {
return task.target;
}
return undefined;
}

/**
* Increment number of tasks that are run within the same zone.
* This is needed to be able to end span when no more tasks left
Expand Down Expand Up @@ -245,7 +242,7 @@ export class UserInteractionPlugin extends BasePlugin<unknown> {
if (once) {
plugin.removePatchedListener(this, type, listener);
}
const span = plugin._createSpan(target, 'click');
const span = plugin._createSpan(target, type);
if (span) {
return plugin._tracer.withSpan(span, () => {
const result = listener.apply(target, args);
Expand Down Expand Up @@ -405,11 +402,11 @@ export class UserInteractionPlugin extends BasePlugin<unknown> {
applyThis?: any,
applyArgs?: any
): Zone {
const target: HTMLElement | undefined = plugin._getClickedElement(task);
const target: HTMLElement | undefined = task.target;
let span: api.Span | undefined;
const activeZone = this;
if (target) {
span = plugin._createSpan(target, 'click');
span = plugin._createSpan(target, task.eventName);
if (span) {
plugin._incrementTask(span);
return activeZone.run(() => {
Expand Down Expand Up @@ -568,6 +565,7 @@ export class UserInteractionPlugin extends BasePlugin<unknown> {
shimmer.unwrap(ZoneWithPrototype.prototype, 'cancelTask');
} else {
shimmer.unwrap(HTMLElement.prototype, 'addEventListener');
shimmer.unwrap(HTMLElement.prototype, 'removeEventListener');
}
this._unpatchHistoryApi();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export function fakeInteraction(
}

export function assertClickSpan(span: tracing.ReadableSpan, id = 'testBtn') {
assert.equal(span.name, `event_click: //*[@id="${id}"]`);
assert.equal(span.name, 'click');

const attributes = span.attributes;
assert.equal(attributes.component, 'user-interaction');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,11 @@ describe('UserInteractionPlugin', () => {
true,
'addEventListener should be wrapped'
);
assert.strictEqual(
isWrapped(HTMLElement.prototype.removeEventListener),
true,
'removeEventListener should be wrapped'
);

assert.strictEqual(
isWrapped(history.replaceState),
Expand Down Expand Up @@ -398,6 +403,11 @@ describe('UserInteractionPlugin', () => {
false,
'addEventListener should be unwrapped'
);
assert.strictEqual(
isWrapped(HTMLElement.prototype.removeEventListener),
false,
'removeEventListener should be unwrapped'
);

assert.strictEqual(
isWrapped(history.replaceState),
Expand Down