Skip to content

[Main][Task] 33497606: Add Tests for ClickAnalytics AutoCaptureHandler #2592

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
Karlie-777 merged 3 commits into from
Jun 25, 2025
Merged

[Main][Task] 33497606: Add Tests for ClickAnalytics AutoCaptureHandler #2592

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7df0a30
add click tests
Karlie-777 Jun 25, 2025
972baf7
udpate
Karlie-777 Jun 25, 2025
04d4dfb
update
Karlie-777 Jun 25, 2025
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
110 changes: 108 additions & 2 deletions extensions/applicationinsights-clickanalytics-js/Tests/Unit/src/ClickEventTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

import { Assert, AITestClass } from "@microsoft/ai-test-framework";
import { IConfig, utlCanUseLocalStorage } from "@microsoft/applicationinsights-common";
import { ITelemetryItem, AppInsightsCore, IPlugin, IConfiguration, DiagnosticLogger, hasDocument, isFunction, IAppInsightsCore} from '@microsoft/applicationinsights-core-js';
import { ITelemetryItem, AppInsightsCore, IPlugin, IConfiguration, DiagnosticLogger, hasDocument, isFunction, IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
import { ClickAnalyticsPlugin, BehaviorMapValidator, BehaviorValueValidator, BehaviorEnumValidator } from '../../../src/ClickAnalyticsPlugin';
import { PageAction } from "../../../src/events/PageAction";
import { DomContentHandler } from '../../../src/handlers/DomContentHandler';
import { IPageActionOverrideValues } from '../../../src/Interfaces/Datamodel';
import { IClickAnalyticsConfiguration, IPageActionOverrideValues } from '../../../src/Interfaces/Datamodel';
import { sanitizeUrl } from "../../../src/DataCollector";
import { DEFAULT_AI_BLOB_ATTRIBUTE_TAG, DEFAULT_DATA_PREFIX, DEFAULT_DONOT_TRACK_TAG } from "../../../src/common/Utils";
import { PropertiesPlugin } from "@microsoft/applicationinsights-properties-js";
Expand Down Expand Up @@ -165,6 +165,112 @@ export class ClickEventTest extends AITestClass {
}
});

this.testCase({
name: "autoCapture: click events are automatically captured and tracked",
useFakeTimers: true,
test: () => {
const config = {
coreData: {},
autoCapture: true,
dataTags: {
useDefaultContentNameOrId: true,
metaDataPrefix: "ha-",
customDataPrefix: "data-ha-",
aiBlobAttributeTag: "blob"
}
} as IClickAnalyticsConfiguration;
let clickAnalyticsPlugin = new ClickAnalyticsPlugin();
let core = new AppInsightsCore();
let channel = new ChannelPlugin();
core.initialize({
instrumentationKey: "testIkey",
extensionConfig: {
[clickAnalyticsPlugin.identifier]: config
}
} as IConfig & IConfiguration, [clickAnalyticsPlugin, channel]);
this.onDone(() => {
core.unload(false);
});

let spy = this.sandbox.spy(clickAnalyticsPlugin.core, "track");

let element = document.createElement("button");
element.setAttribute("id", "testAutoCaptureBtn");
element.setAttribute("data-ha-aN", "autoCaptureArea");
document.body.appendChild(element);

const mouseDownEvent = new MouseEvent("mousedown", { bubbles: true, cancelable: true });
element.dispatchEvent(mouseDownEvent);

this.clock.tick(500);

Assert.equal(true, spy.called, "track should be called on click event");
let calledEvent: ITelemetryItem = spy.getCall(0).args[0];
Assert.equal("testAutoCaptureBtn", calledEvent.baseData["name"]);

// Clean up
document.body.removeChild(element);
}
});

this.testCase({
name: "autoCapture: click events are automatically captured and tracked with customized config",
useFakeTimers: true,
test: () => {
const config = {
coreData: {},
autoCapture: true,
dataTags: {
useDefaultContentNameOrId: true,
metaDataPrefix: "ha-",
customDataPrefix: "data-ha-",
aiBlobAttributeTag: "blob"
},
trackElementTypes: "A"
} as IClickAnalyticsConfiguration;
let clickAnalyticsPlugin = new ClickAnalyticsPlugin();
let core = new AppInsightsCore();
let channel = new ChannelPlugin();
core.initialize({
instrumentationKey: "testIkey",
extensionConfig: {
[clickAnalyticsPlugin.identifier]: config
}
} as IConfig & IConfiguration, [clickAnalyticsPlugin, channel]);
this.onDone(() => {
core.unload(false);
});

let spy = this.sandbox.spy(clickAnalyticsPlugin.core, "track");

let element = document.createElement("a");
element.setAttribute("id", "testAutoCaptureA");
element.setAttribute("data-ha-aN", "autoCaptureArea");
document.body.appendChild(element);

let elementNotToTrack = document.createElement("button");
elementNotToTrack.setAttribute("id", "testAutoCaptureBtn");
elementNotToTrack.setAttribute("data-ha-aN", "autoCaptureArea");
document.body.appendChild(elementNotToTrack);

let mouseDownEvent = new MouseEvent("mousedown", { bubbles: true, cancelable: true });
element.dispatchEvent(mouseDownEvent);

let mouseDownEventNotToTrack = new MouseEvent("mousedown", { bubbles: true, cancelable: true });
elementNotToTrack.dispatchEvent(mouseDownEventNotToTrack);

this.clock.tick(500);

Assert.equal(true, spy.called, "track should be called on click event");
let calledEvent: ITelemetryItem = spy.getCall(0).args[0];
Assert.equal("testAutoCaptureA", calledEvent.baseData["name"]);

// Clean up
document.body.removeChild(element);
document.body.removeChild(elementNotToTrack);
}
});

this.testCase({
name: "trackPageView properties are correctly assigned (Empty)",
test: () => {
Expand Down