@equinor/fusion-framework-module-analytics 3.0.8-next.0 → 3.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -5
- package/README.md +214 -22
- package/dist/esm/version.js +1 -1
- package/dist/esm/version.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/types/version.d.ts +1 -1
- package/package.json +9 -13
- package/src/version.ts +1 -1
- package/dist/esm/__tests__/MockAnalyticsAdapter.test.js +0 -91
- package/dist/esm/__tests__/MockAnalyticsAdapter.test.js.map +0 -1
- package/dist/esm/__tests__/mock/analytics-mock-adapter.test.js +0 -60
- package/dist/esm/__tests__/mock/analytics-mock-adapter.test.js.map +0 -1
- package/dist/esm/mock/MockAnalyticsAdapter.js +0 -134
- package/dist/esm/mock/MockAnalyticsAdapter.js.map +0 -1
- package/dist/esm/mock/index.js +0 -26
- package/dist/esm/mock/index.js.map +0 -1
- package/dist/types/__tests__/MockAnalyticsAdapter.test.d.ts +0 -1
- package/dist/types/__tests__/mock/analytics-mock-adapter.test.d.ts +0 -1
- package/dist/types/mock/MockAnalyticsAdapter.d.ts +0 -76
- package/dist/types/mock/index.d.ts +0 -25
- package/docs/adapters.md +0 -79
- package/docs/collectors.md +0 -91
- package/docs/testing.md +0 -87
- package/docs/tracking-events.md +0 -16
- package/src/__tests__/MockAnalyticsAdapter.test.ts +0 -127
- package/src/__tests__/mock/analytics-mock-adapter.test.ts +0 -79
- package/src/mock/MockAnalyticsAdapter.ts +0 -178
- package/src/mock/index.ts +0 -29
- package/vitest.config.ts +0 -11
package/dist/types/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "3.0.8
|
|
1
|
+
export declare const version = "3.0.8";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@equinor/fusion-framework-module-analytics",
|
|
3
|
-
"version": "3.0.8
|
|
3
|
+
"version": "3.0.8",
|
|
4
4
|
"description": "Fusion module for collecting and exporting application analytics using OpenTelemetry standards",
|
|
5
5
|
"main": "dist/esm/index.js",
|
|
6
6
|
"type": "module",
|
|
@@ -20,10 +20,6 @@
|
|
|
20
20
|
"./logExporters": {
|
|
21
21
|
"import": "./dist/esm/logExporters/index.js",
|
|
22
22
|
"types": "./dist/types/logExporters/index.d.ts"
|
|
23
|
-
},
|
|
24
|
-
"./mock": {
|
|
25
|
-
"import": "./dist/esm/mock/index.js",
|
|
26
|
-
"types": "./dist/types/mock/index.d.ts"
|
|
27
23
|
}
|
|
28
24
|
},
|
|
29
25
|
"types": "dist/types/index.d.ts",
|
|
@@ -53,19 +49,19 @@
|
|
|
53
49
|
"rxjs": "^7.8.1",
|
|
54
50
|
"uuid": "^14.0.0",
|
|
55
51
|
"zod": "^4.4.3",
|
|
56
|
-
"@equinor/fusion-framework-module": "6.1.
|
|
57
|
-
"@equinor/fusion-framework-module-
|
|
58
|
-
"@equinor/fusion-framework-module-
|
|
59
|
-
"@equinor/fusion-framework-module-
|
|
60
|
-
"@equinor/fusion-framework-module-
|
|
52
|
+
"@equinor/fusion-framework-module": "6.1.2",
|
|
53
|
+
"@equinor/fusion-framework-module-app": "8.0.5",
|
|
54
|
+
"@equinor/fusion-framework-module-context": "8.0.3",
|
|
55
|
+
"@equinor/fusion-framework-module-event": "6.0.1",
|
|
56
|
+
"@equinor/fusion-framework-module-http": "8.0.5"
|
|
61
57
|
},
|
|
62
58
|
"devDependencies": {
|
|
63
59
|
"typescript": "^7.0.2",
|
|
64
|
-
"vitest": "^4.1.
|
|
65
|
-
"@equinor/fusion-observable": "^9.
|
|
60
|
+
"vitest": "^4.1.0",
|
|
61
|
+
"@equinor/fusion-observable": "^9.2.0"
|
|
66
62
|
},
|
|
67
63
|
"peerDependencies": {
|
|
68
|
-
"@equinor/fusion-observable": "9.
|
|
64
|
+
"@equinor/fusion-observable": "9.2.0"
|
|
69
65
|
},
|
|
70
66
|
"scripts": {
|
|
71
67
|
"build": "tsc -b",
|
package/src/version.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
// Generated by genversion.
|
|
2
|
-
export const version = '3.0.8
|
|
2
|
+
export const version = '3.0.8';
|
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
import { describe, it, expect, vi, afterEach } from 'vitest';
|
|
2
|
-
import { MockAnalyticsAdapter } from '../mock/MockAnalyticsAdapter.js';
|
|
3
|
-
const createEvent = (name, overrides = {}) => ({
|
|
4
|
-
name,
|
|
5
|
-
value: null,
|
|
6
|
-
...overrides,
|
|
7
|
-
});
|
|
8
|
-
describe('MockAnalyticsAdapter', () => {
|
|
9
|
-
afterEach(() => {
|
|
10
|
-
vi.useRealTimers();
|
|
11
|
-
});
|
|
12
|
-
it('records events via registerAnalytic and returns them from getAnalytics', () => {
|
|
13
|
-
const adapter = new MockAnalyticsAdapter();
|
|
14
|
-
adapter.registerAnalytic(createEvent('button-click'));
|
|
15
|
-
adapter.registerAnalytic(createEvent('page-view'));
|
|
16
|
-
expect(adapter.getAnalytics().map((e) => e.name)).toEqual(['button-click', 'page-view']);
|
|
17
|
-
});
|
|
18
|
-
it('filters getAnalytics by a single name, an array, and a predicate', () => {
|
|
19
|
-
const adapter = new MockAnalyticsAdapter();
|
|
20
|
-
adapter.registerAnalytic(createEvent('button-click', { attributes: { section: 'header' } }));
|
|
21
|
-
adapter.registerAnalytic(createEvent('page-view'));
|
|
22
|
-
expect(adapter.getAnalytics('button-click')).toHaveLength(1);
|
|
23
|
-
expect(adapter.getAnalytics(['button-click', 'page-view'])).toHaveLength(2);
|
|
24
|
-
expect(adapter.getAnalytics((e) => e.attributes?.section === 'header')).toHaveLength(1);
|
|
25
|
-
});
|
|
26
|
-
it('resolves waitForAnalytic immediately when a matching event is already recorded', async () => {
|
|
27
|
-
const adapter = new MockAnalyticsAdapter();
|
|
28
|
-
adapter.registerAnalytic(createEvent('button-click'));
|
|
29
|
-
const event = await adapter.waitForAnalytic('button-click');
|
|
30
|
-
expect(event.name).toBe('button-click');
|
|
31
|
-
});
|
|
32
|
-
it('resolves waitForAnalytic when a matching event is recorded later', async () => {
|
|
33
|
-
const adapter = new MockAnalyticsAdapter();
|
|
34
|
-
const promise = adapter.waitForAnalytic('button-click');
|
|
35
|
-
adapter.registerAnalytic(createEvent('page-view'));
|
|
36
|
-
adapter.registerAnalytic(createEvent('button-click'));
|
|
37
|
-
const event = await promise;
|
|
38
|
-
expect(event.name).toBe('button-click');
|
|
39
|
-
});
|
|
40
|
-
it('resolves waitForAnalytic via predicate matcher', async () => {
|
|
41
|
-
const adapter = new MockAnalyticsAdapter();
|
|
42
|
-
const promise = adapter.waitForAnalytic((e) => e.attributes?.id === 42);
|
|
43
|
-
adapter.registerAnalytic(createEvent('button-click', { attributes: { id: 1 } }));
|
|
44
|
-
adapter.registerAnalytic(createEvent('button-click', { attributes: { id: 42 } }));
|
|
45
|
-
const event = await promise;
|
|
46
|
-
expect(event.attributes?.id).toBe(42);
|
|
47
|
-
});
|
|
48
|
-
it('rejects when the timeout elapses before a matching event is recorded', async () => {
|
|
49
|
-
vi.useFakeTimers();
|
|
50
|
-
const adapter = new MockAnalyticsAdapter();
|
|
51
|
-
const promise = adapter.waitForAnalytic('button-click', { timeout: 500 });
|
|
52
|
-
vi.advanceTimersByTime(501);
|
|
53
|
-
await expect(promise).rejects.toThrow('waitForAnalytic timed out after 500ms');
|
|
54
|
-
});
|
|
55
|
-
it('rejects when the AbortSignal fires before a matching event', async () => {
|
|
56
|
-
const adapter = new MockAnalyticsAdapter();
|
|
57
|
-
const controller = new AbortController();
|
|
58
|
-
const promise = adapter.waitForAnalytic('button-click', { signal: controller.signal });
|
|
59
|
-
controller.abort();
|
|
60
|
-
await expect(promise).rejects.toThrow();
|
|
61
|
-
});
|
|
62
|
-
it('rejects immediately when passed an already-aborted signal', async () => {
|
|
63
|
-
const adapter = new MockAnalyticsAdapter();
|
|
64
|
-
const controller = new AbortController();
|
|
65
|
-
controller.abort();
|
|
66
|
-
await expect(adapter.waitForAnalytic('button-click', { signal: controller.signal })).rejects.toThrow();
|
|
67
|
-
});
|
|
68
|
-
it('rejects pending waitForAnalytic calls when the adapter is disposed', async () => {
|
|
69
|
-
const adapter = new MockAnalyticsAdapter();
|
|
70
|
-
const promise = adapter.waitForAnalytic('button-click');
|
|
71
|
-
adapter[Symbol.dispose]();
|
|
72
|
-
await expect(promise).rejects.toThrow('disposed before a matching event was recorded');
|
|
73
|
-
});
|
|
74
|
-
it('rejects instead of hanging when a predicate matcher throws on a future event', async () => {
|
|
75
|
-
const adapter = new MockAnalyticsAdapter();
|
|
76
|
-
const boom = new Error('predicate boom');
|
|
77
|
-
const promise = adapter.waitForAnalytic(() => {
|
|
78
|
-
throw boom;
|
|
79
|
-
});
|
|
80
|
-
adapter.registerAnalytic(createEvent('button-click'));
|
|
81
|
-
await expect(promise).rejects.toThrow(boom);
|
|
82
|
-
});
|
|
83
|
-
it('does not interfere with events recorded by another adapter instance', () => {
|
|
84
|
-
const adapterA = new MockAnalyticsAdapter();
|
|
85
|
-
const adapterB = new MockAnalyticsAdapter();
|
|
86
|
-
adapterA.registerAnalytic(createEvent('button-click'));
|
|
87
|
-
expect(adapterA.getAnalytics()).toHaveLength(1);
|
|
88
|
-
expect(adapterB.getAnalytics()).toHaveLength(0);
|
|
89
|
-
});
|
|
90
|
-
});
|
|
91
|
-
//# sourceMappingURL=MockAnalyticsAdapter.test.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"MockAnalyticsAdapter.test.js","sourceRoot":"","sources":["../../../src/__tests__/MockAnalyticsAdapter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAGvE,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,SAAS,GAA4B,EAAE,EAAkB,EAAE,CAAC,CAAC;IAC9F,IAAI;IACJ,KAAK,EAAE,IAAI;IACX,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE3C,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;QAEnD,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC3C,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7F,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;QAEnD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC5E,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,KAAK,IAAI,EAAE;QAC9F,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC3C,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QAEtD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAE5D,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE3C,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QACxD,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;QACnD,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC;QAE5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE3C,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACxE,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACjF,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAClF,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC;QAE5B,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,EAAE,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE3C,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;QAC1E,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QAEzC,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QACvF,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,UAAU,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,MAAM,CACV,OAAO,CAAC,eAAe,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CACvE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE3C,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QACxD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAE1B,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,+CAA+C,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;QAC5F,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAEzC,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE;YAC3C,MAAM,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QAEtD,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,MAAM,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE5C,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QAEvD,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
-
import { ModulesConfigurator } from '@equinor/fusion-framework-module';
|
|
3
|
-
import { Subject } from 'rxjs';
|
|
4
|
-
import { enableAnalytics } from '../../enable-analytics.js';
|
|
5
|
-
import { ConsoleAnalyticsAdapter } from '../../adapters/ConsoleAnalyticsAdapter.js';
|
|
6
|
-
import { MockAnalyticsAdapter } from '../../mock/MockAnalyticsAdapter.js';
|
|
7
|
-
/**
|
|
8
|
-
* Initializes the analytics module through the real module system, with a
|
|
9
|
-
* `MockAnalyticsAdapter` registered alongside whatever the test configures.
|
|
10
|
-
*
|
|
11
|
-
* @remarks
|
|
12
|
-
* Deliberately avoids hand-building an `AnalyticsProvider`. Testing the
|
|
13
|
-
* adapter's own logic in isolation (see `MockAnalyticsAdapter.test.ts`) can't
|
|
14
|
-
* prove it actually receives events through the real configure -> initialize
|
|
15
|
-
* -> collector/adapter dispatch pipeline every other adapter goes through.
|
|
16
|
-
*
|
|
17
|
-
* @param configure - Optional callback to register additional adapters/collectors.
|
|
18
|
-
* @returns The real `IAnalyticsProvider` instance and the recording adapter.
|
|
19
|
-
*/
|
|
20
|
-
const initializeWith = async (configure) => {
|
|
21
|
-
const recorder = new MockAnalyticsAdapter();
|
|
22
|
-
const configurator = new ModulesConfigurator([]);
|
|
23
|
-
enableAnalytics(configurator, (builder) => {
|
|
24
|
-
builder.setAdapter('mock', async () => recorder);
|
|
25
|
-
configure?.(builder);
|
|
26
|
-
});
|
|
27
|
-
const instances = await configurator.initialize();
|
|
28
|
-
const provider = instances.analytics;
|
|
29
|
-
return { provider, recorder };
|
|
30
|
-
};
|
|
31
|
-
describe('MockAnalyticsAdapter (through the real analytics module)', () => {
|
|
32
|
-
it('observes events pushed via provider.trackAnalytic', async () => {
|
|
33
|
-
const { provider, recorder } = await initializeWith();
|
|
34
|
-
provider.trackAnalytic({ name: 'button-click', value: 'save' });
|
|
35
|
-
expect(recorder.getAnalytics('button-click')).toHaveLength(1);
|
|
36
|
-
});
|
|
37
|
-
it('observes events emitted by a real registered collector', async () => {
|
|
38
|
-
const clicks$ = new Subject();
|
|
39
|
-
const { recorder } = await initializeWith((builder) => {
|
|
40
|
-
builder.setCollector('clicks', async () => clicks$);
|
|
41
|
-
});
|
|
42
|
-
clicks$.next({ name: 'window-click', value: 42 });
|
|
43
|
-
const event = await recorder.waitForAnalytic('window-click');
|
|
44
|
-
expect(event.value).toBe(42);
|
|
45
|
-
});
|
|
46
|
-
it('does not interfere with other adapters registered alongside it', async () => {
|
|
47
|
-
const logSpy = vi.spyOn(console, 'log').mockImplementation(() => undefined);
|
|
48
|
-
const { provider, recorder } = await initializeWith((builder) => {
|
|
49
|
-
builder.setAdapter('console', async () => new ConsoleAnalyticsAdapter());
|
|
50
|
-
});
|
|
51
|
-
provider.trackAnalytic({ name: 'page-view', value: null });
|
|
52
|
-
expect(recorder.getAnalytics('page-view')).toHaveLength(1);
|
|
53
|
-
expect(logSpy).toHaveBeenCalledWith('Analytics::Adapter::Console', {
|
|
54
|
-
name: 'page-view',
|
|
55
|
-
value: null,
|
|
56
|
-
});
|
|
57
|
-
logSpy.mockRestore();
|
|
58
|
-
});
|
|
59
|
-
});
|
|
60
|
-
//# sourceMappingURL=analytics-mock-adapter.test.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"analytics-mock-adapter.test.js","sourceRoot":"","sources":["../../../../src/__tests__/mock/analytics-mock-adapter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAK1E;;;;;;;;;;;;GAYG;AACH,MAAM,cAAc,GAAG,KAAK,EAC1B,SAAqD,EACsB,EAAE;IAC7E,MAAM,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC5C,MAAM,YAAY,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAEjD,eAAe,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE;QACxC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC;QACjD,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC;IAClD,MAAM,QAAQ,GAAI,SAA0D,CAAC,SAAS,CAAC;IAEvF,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAChC,CAAC,CAAC;AAEF,QAAQ,CAAC,0DAA0D,EAAE,GAAG,EAAE;IACxE,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,EAAE,CAAC;QAEtD,QAAQ,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAEhE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAkB,CAAC;QAC9C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAElD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAC7D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5E,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,CAAC,CAAC,OAAO,EAAE,EAAE;YAC9D,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,uBAAuB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3D,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,6BAA6B,EAAE;YACjE,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QAEH,MAAM,CAAC,WAAW,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
import { Subject, filter } from 'rxjs';
|
|
2
|
-
/**
|
|
3
|
-
* An {@link IAnalyticsAdapter} that records every tracked event in-memory instead
|
|
4
|
-
* of exporting it to a backend, for asserting on analytics in tests.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Register it like any other adapter via {@link IAnalyticsConfigurator.setAdapter};
|
|
8
|
-
* it does not interfere with other adapters registered alongside it.
|
|
9
|
-
*
|
|
10
|
-
* @template T - Analytics event type, defaults to {@link AnalyticsEvent}.
|
|
11
|
-
*
|
|
12
|
-
* @example
|
|
13
|
-
* ```ts
|
|
14
|
-
* import { MockAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/mock';
|
|
15
|
-
*
|
|
16
|
-
* const recorder = new MockAnalyticsAdapter();
|
|
17
|
-
* enableAnalytics(configurator, (builder) => {
|
|
18
|
-
* builder.setAdapter('mock', async () => recorder);
|
|
19
|
-
* });
|
|
20
|
-
*
|
|
21
|
-
* // ...later, in a test
|
|
22
|
-
* const event = await recorder.waitForAnalytic('button-click');
|
|
23
|
-
* expect(event.attributes?.section).toBe('header');
|
|
24
|
-
* ```
|
|
25
|
-
*/
|
|
26
|
-
export class MockAnalyticsAdapter {
|
|
27
|
-
#events = [];
|
|
28
|
-
#events$ = new Subject();
|
|
29
|
-
/**
|
|
30
|
-
* Records the event so it is visible to {@link getAnalytics} and any pending
|
|
31
|
-
* {@link waitForAnalytic} calls.
|
|
32
|
-
*
|
|
33
|
-
* @param event - The analytics event to record.
|
|
34
|
-
*/
|
|
35
|
-
registerAnalytic(event) {
|
|
36
|
-
this.#events.push(event);
|
|
37
|
-
this.#events$.next(event);
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Returns recorded events matching `matcher`, in dispatch order.
|
|
41
|
-
*
|
|
42
|
-
* @param matcher - Event name, array of names, or a predicate. Omit to get every recorded event.
|
|
43
|
-
* @returns Matching recorded events.
|
|
44
|
-
*/
|
|
45
|
-
getAnalytics(matcher) {
|
|
46
|
-
// No matcher: return every event recorded so far.
|
|
47
|
-
if (matcher === undefined)
|
|
48
|
-
return [...this.#events];
|
|
49
|
-
// Narrow down to events accepted by the matcher.
|
|
50
|
-
return this.#events.filter((event) => this.#matches(event, matcher));
|
|
51
|
-
}
|
|
52
|
-
/**
|
|
53
|
-
* Waits for the next event matching `matcher`, resolving immediately if a
|
|
54
|
-
* matching event was already recorded.
|
|
55
|
-
*
|
|
56
|
-
* @param matcher - Event name, array of names, or a predicate.
|
|
57
|
-
* @param options - Optional timeout (ms) or AbortSignal.
|
|
58
|
-
* @returns A promise that resolves with the first matching event.
|
|
59
|
-
*/
|
|
60
|
-
waitForAnalytic(matcher, options) {
|
|
61
|
-
// Already recorded: resolve immediately rather than only watching future events.
|
|
62
|
-
const recorded = this.#events.find((event) => this.#matches(event, matcher));
|
|
63
|
-
// Already recorded: resolve immediately rather than only watching future events.
|
|
64
|
-
if (recorded)
|
|
65
|
-
return Promise.resolve(recorded);
|
|
66
|
-
return new Promise((resolve, reject) => {
|
|
67
|
-
const { timeout: ms, signal } = options ?? {};
|
|
68
|
-
// Fail fast without subscribing when the caller already aborted.
|
|
69
|
-
if (signal?.aborted) {
|
|
70
|
-
reject(signal.reason ?? new DOMException('Aborted', 'AbortError'));
|
|
71
|
-
return;
|
|
72
|
-
}
|
|
73
|
-
let timer;
|
|
74
|
-
// Declared before subscribing so `complete` can reach it even when the
|
|
75
|
-
// adapter is already disposed and fires synchronously during `subscribe`.
|
|
76
|
-
let sub;
|
|
77
|
-
const cleanup = () => {
|
|
78
|
-
clearTimeout(timer);
|
|
79
|
-
sub?.unsubscribe();
|
|
80
|
-
};
|
|
81
|
-
// Only forward events accepted by the matcher to the subscriber below.
|
|
82
|
-
sub = this.#events$.pipe(filter((event) => this.#matches(event, matcher))).subscribe({
|
|
83
|
-
next: (event) => {
|
|
84
|
-
cleanup();
|
|
85
|
-
resolve(event);
|
|
86
|
-
},
|
|
87
|
-
// A throwing predicate matcher surfaces here instead of hanging the promise forever.
|
|
88
|
-
error: (err) => {
|
|
89
|
-
cleanup();
|
|
90
|
-
reject(err);
|
|
91
|
-
},
|
|
92
|
-
complete: () => {
|
|
93
|
-
cleanup();
|
|
94
|
-
reject(new Error('MockAnalyticsAdapter disposed before a matching event was recorded'));
|
|
95
|
-
},
|
|
96
|
-
});
|
|
97
|
-
// Only arm a timeout when the caller opted in.
|
|
98
|
-
if (ms !== undefined) {
|
|
99
|
-
timer = setTimeout(() => {
|
|
100
|
-
cleanup();
|
|
101
|
-
reject(new Error(`waitForAnalytic timed out after ${ms}ms`));
|
|
102
|
-
}, ms);
|
|
103
|
-
}
|
|
104
|
-
// Only wire abort handling when the caller passed a signal.
|
|
105
|
-
if (signal) {
|
|
106
|
-
signal.addEventListener('abort', () => {
|
|
107
|
-
cleanup();
|
|
108
|
-
reject(signal.reason ?? new DOMException('Aborted', 'AbortError'));
|
|
109
|
-
}, { once: true });
|
|
110
|
-
}
|
|
111
|
-
});
|
|
112
|
-
}
|
|
113
|
-
/**
|
|
114
|
-
* Tests whether `event` satisfies `matcher`.
|
|
115
|
-
*
|
|
116
|
-
* @param event - Event to test.
|
|
117
|
-
* @param matcher - Event name, array of names, or a predicate.
|
|
118
|
-
* @returns Whether `event` matches.
|
|
119
|
-
*/
|
|
120
|
-
#matches(event, matcher) {
|
|
121
|
-
// String matcher: compare event name directly.
|
|
122
|
-
if (typeof matcher === 'string')
|
|
123
|
-
return event.name === matcher;
|
|
124
|
-
// Array matcher: match against any of the given names.
|
|
125
|
-
if (Array.isArray(matcher))
|
|
126
|
-
return matcher.includes(event.name);
|
|
127
|
-
return matcher(event);
|
|
128
|
-
}
|
|
129
|
-
/** Completes the internal event stream, rejecting any pending `waitForAnalytic` calls. */
|
|
130
|
-
[Symbol.dispose]() {
|
|
131
|
-
this.#events$.complete();
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
//# sourceMappingURL=MockAnalyticsAdapter.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"MockAnalyticsAdapter.js","sourceRoot":"","sources":["../../../src/mock/MockAnalyticsAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAqB,MAAM,MAAM,CAAC;AAgC1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,oBAAoB;IAG/B,OAAO,GAAQ,EAAE,CAAC;IAClB,QAAQ,GAAG,IAAI,OAAO,EAAK,CAAC;IAE5B;;;;;OAKG;IACH,gBAAgB,CAAC,KAAQ;QACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,OAAkC;QAC7C,kDAAkD;QAClD,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,iDAAiD;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,OAAiC,EAAE,OAAgC;QACjF,iFAAiF;QACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7E,iFAAiF;QACjF,IAAI,QAAQ;YAAE,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE/C,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;YAE9C,iEAAiE;YACjE,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;gBACpB,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;gBACnE,OAAO;YACT,CAAC;YAED,IAAI,KAAgD,CAAC;YACrD,uEAAuE;YACvE,0EAA0E;YAC1E,IAAI,GAA6B,CAAC;YAElC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,GAAG,EAAE,WAAW,EAAE,CAAC;YACrB,CAAC,CAAC;YAEF,uEAAuE;YACvE,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACnF,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;oBACd,OAAO,EAAE,CAAC;oBACV,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjB,CAAC;gBACD,qFAAqF;gBACrF,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;oBACb,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;gBACD,QAAQ,EAAE,GAAG,EAAE;oBACb,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC,CAAC;gBAC1F,CAAC;aACF,CAAC,CAAC;YAEH,+CAA+C;YAC/C,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBACtB,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,IAAI,KAAK,CAAC,mCAAmC,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC/D,CAAC,EAAE,EAAE,CAAC,CAAC;YACT,CAAC;YAED,4DAA4D;YAC5D,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,gBAAgB,CACrB,OAAO,EACP,GAAG,EAAE;oBACH,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;gBACrE,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAQ,EAAE,OAAiC;QAClD,+CAA+C;QAC/C,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC;QAC/D,uDAAuD;QACvD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,0FAA0F;IAC1F,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;CACF"}
|
package/dist/esm/mock/index.js
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Mock analytics adapter for tests: records tracked events in-memory instead
|
|
3
|
-
* of exporting them to a backend.
|
|
4
|
-
*
|
|
5
|
-
* @remarks
|
|
6
|
-
* Register it like any other {@link IAnalyticsAdapter} via
|
|
7
|
-
* {@link IAnalyticsConfigurator.setAdapter} — it observes tracked events
|
|
8
|
-
* alongside real adapters without affecting their delivery.
|
|
9
|
-
*
|
|
10
|
-
* @example
|
|
11
|
-
* ```ts
|
|
12
|
-
* import { MockAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/mock';
|
|
13
|
-
*
|
|
14
|
-
* const recorder = new MockAnalyticsAdapter();
|
|
15
|
-
* enableAnalytics(configurator, (builder) => {
|
|
16
|
-
* builder.setAdapter('mock', async () => recorder);
|
|
17
|
-
* });
|
|
18
|
-
*
|
|
19
|
-
* const event = await recorder.waitForAnalytic('button-click');
|
|
20
|
-
* expect(event.attributes?.section).toBe('header');
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @packageDocumentation
|
|
24
|
-
*/
|
|
25
|
-
export { MockAnalyticsAdapter, } from './MockAnalyticsAdapter.js';
|
|
26
|
-
//# sourceMappingURL=index.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/mock/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,EACL,oBAAoB,GAGrB,MAAM,2BAA2B,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import type { IAnalyticsAdapter } from '../adapters/AnalyticsAdapter.interface.js';
|
|
2
|
-
import type { AnalyticsEvent } from '../types.js';
|
|
3
|
-
/**
|
|
4
|
-
* Selects which recorded events {@link MockAnalyticsAdapter.waitForAnalytic} or
|
|
5
|
-
* {@link MockAnalyticsAdapter.getAnalytics} act on.
|
|
6
|
-
*
|
|
7
|
-
* - `string` — matches `event.name` exactly.
|
|
8
|
-
* - `string[]` — matches if `event.name` is any of the given entries.
|
|
9
|
-
* - `(event) => boolean` — arbitrary predicate over the full event.
|
|
10
|
-
*/
|
|
11
|
-
export type AnalyticsEventMatcher<T extends AnalyticsEvent = AnalyticsEvent> = string | string[] | ((event: T) => boolean);
|
|
12
|
-
/** Options accepted by {@link MockAnalyticsAdapter.waitForAnalytic}. */
|
|
13
|
-
export interface WaitForAnalyticOptions {
|
|
14
|
-
/**
|
|
15
|
-
* Maximum time in milliseconds to wait for a matching event.
|
|
16
|
-
* When elapsed the returned promise rejects.
|
|
17
|
-
*/
|
|
18
|
-
timeout?: number;
|
|
19
|
-
/**
|
|
20
|
-
* AbortSignal that can cancel the wait early.
|
|
21
|
-
* When aborted the returned promise rejects with the signal's reason.
|
|
22
|
-
*/
|
|
23
|
-
signal?: AbortSignal;
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* An {@link IAnalyticsAdapter} that records every tracked event in-memory instead
|
|
27
|
-
* of exporting it to a backend, for asserting on analytics in tests.
|
|
28
|
-
*
|
|
29
|
-
* @remarks
|
|
30
|
-
* Register it like any other adapter via {@link IAnalyticsConfigurator.setAdapter};
|
|
31
|
-
* it does not interfere with other adapters registered alongside it.
|
|
32
|
-
*
|
|
33
|
-
* @template T - Analytics event type, defaults to {@link AnalyticsEvent}.
|
|
34
|
-
*
|
|
35
|
-
* @example
|
|
36
|
-
* ```ts
|
|
37
|
-
* import { MockAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/mock';
|
|
38
|
-
*
|
|
39
|
-
* const recorder = new MockAnalyticsAdapter();
|
|
40
|
-
* enableAnalytics(configurator, (builder) => {
|
|
41
|
-
* builder.setAdapter('mock', async () => recorder);
|
|
42
|
-
* });
|
|
43
|
-
*
|
|
44
|
-
* // ...later, in a test
|
|
45
|
-
* const event = await recorder.waitForAnalytic('button-click');
|
|
46
|
-
* expect(event.attributes?.section).toBe('header');
|
|
47
|
-
* ```
|
|
48
|
-
*/
|
|
49
|
-
export declare class MockAnalyticsAdapter<T extends AnalyticsEvent = AnalyticsEvent> implements IAnalyticsAdapter<T> {
|
|
50
|
-
#private;
|
|
51
|
-
/**
|
|
52
|
-
* Records the event so it is visible to {@link getAnalytics} and any pending
|
|
53
|
-
* {@link waitForAnalytic} calls.
|
|
54
|
-
*
|
|
55
|
-
* @param event - The analytics event to record.
|
|
56
|
-
*/
|
|
57
|
-
registerAnalytic(event: T): void;
|
|
58
|
-
/**
|
|
59
|
-
* Returns recorded events matching `matcher`, in dispatch order.
|
|
60
|
-
*
|
|
61
|
-
* @param matcher - Event name, array of names, or a predicate. Omit to get every recorded event.
|
|
62
|
-
* @returns Matching recorded events.
|
|
63
|
-
*/
|
|
64
|
-
getAnalytics(matcher?: AnalyticsEventMatcher<T>): T[];
|
|
65
|
-
/**
|
|
66
|
-
* Waits for the next event matching `matcher`, resolving immediately if a
|
|
67
|
-
* matching event was already recorded.
|
|
68
|
-
*
|
|
69
|
-
* @param matcher - Event name, array of names, or a predicate.
|
|
70
|
-
* @param options - Optional timeout (ms) or AbortSignal.
|
|
71
|
-
* @returns A promise that resolves with the first matching event.
|
|
72
|
-
*/
|
|
73
|
-
waitForAnalytic(matcher: AnalyticsEventMatcher<T>, options?: WaitForAnalyticOptions): Promise<T>;
|
|
74
|
-
/** Completes the internal event stream, rejecting any pending `waitForAnalytic` calls. */
|
|
75
|
-
[Symbol.dispose](): void;
|
|
76
|
-
}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Mock analytics adapter for tests: records tracked events in-memory instead
|
|
3
|
-
* of exporting them to a backend.
|
|
4
|
-
*
|
|
5
|
-
* @remarks
|
|
6
|
-
* Register it like any other {@link IAnalyticsAdapter} via
|
|
7
|
-
* {@link IAnalyticsConfigurator.setAdapter} — it observes tracked events
|
|
8
|
-
* alongside real adapters without affecting their delivery.
|
|
9
|
-
*
|
|
10
|
-
* @example
|
|
11
|
-
* ```ts
|
|
12
|
-
* import { MockAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/mock';
|
|
13
|
-
*
|
|
14
|
-
* const recorder = new MockAnalyticsAdapter();
|
|
15
|
-
* enableAnalytics(configurator, (builder) => {
|
|
16
|
-
* builder.setAdapter('mock', async () => recorder);
|
|
17
|
-
* });
|
|
18
|
-
*
|
|
19
|
-
* const event = await recorder.waitForAnalytic('button-click');
|
|
20
|
-
* expect(event.attributes?.section).toBe('header');
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @packageDocumentation
|
|
24
|
-
*/
|
|
25
|
-
export { MockAnalyticsAdapter, type AnalyticsEventMatcher, type WaitForAnalyticOptions, } from './MockAnalyticsAdapter.js';
|
package/docs/adapters.md
DELETED
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# Adapters
|
|
2
|
-
|
|
3
|
-
Adapters implement `IAnalyticsAdapter` and are responsible for processing and
|
|
4
|
-
sending analytics data to their destinations. All adapters support async
|
|
5
|
-
initialisation and will be initialised automatically when the provider starts.
|
|
6
|
-
|
|
7
|
-
## ConsoleAnalyticsAdapter
|
|
8
|
-
|
|
9
|
-
Logs every analytics event to the browser console. Useful for development and
|
|
10
|
-
debugging. No configuration required.
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
builder.setAdapter('console', async () => new ConsoleAnalyticsAdapter());
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## FusionAnalyticsAdapter
|
|
17
|
-
|
|
18
|
-
Forwards analytics events to an OpenTelemetry-compatible log endpoint via a
|
|
19
|
-
bundled `LoggerProvider`.
|
|
20
|
-
|
|
21
|
-
Configuration options:
|
|
22
|
-
|
|
23
|
-
| Option | Type | Description |
|
|
24
|
-
|---|---|---|
|
|
25
|
-
| `portalId` | `string` | Portal identifier included in every log record |
|
|
26
|
-
| `logExporter` | `OTLPExporterBase` | OTLP log exporter for transport |
|
|
27
|
-
|
|
28
|
-
### Using `OTLPLogExporter` (direct HTTP)
|
|
29
|
-
|
|
30
|
-
```typescript
|
|
31
|
-
import { OTLPLogExporter } from '@equinor/fusion-framework-module-analytics/logExporters';
|
|
32
|
-
import { FusionAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/adapters';
|
|
33
|
-
|
|
34
|
-
builder.setAdapter('fusion-log', async () => {
|
|
35
|
-
const logExporter = new OTLPLogExporter({
|
|
36
|
-
url: 'https://example.com/v1/logs',
|
|
37
|
-
headers: { 'Content-Type': 'application/json' },
|
|
38
|
-
});
|
|
39
|
-
return new FusionAnalyticsAdapter({ portalId: 'my-portal', logExporter });
|
|
40
|
-
});
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Using `FusionOTLPLogExporter` (service discovery HTTP client)
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
import { FusionOTLPLogExporter } from '@equinor/fusion-framework-module-analytics/logExporters';
|
|
47
|
-
import { FusionAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/adapters';
|
|
48
|
-
|
|
49
|
-
builder.setAdapter('fusion', async (args) => {
|
|
50
|
-
if (args.hasModule('serviceDiscovery')) {
|
|
51
|
-
const sd = await args.requireInstance('serviceDiscovery');
|
|
52
|
-
const httpClient = await sd.createClient('analytics');
|
|
53
|
-
const logExporter = new FusionOTLPLogExporter(httpClient);
|
|
54
|
-
return new FusionAnalyticsAdapter({ portalId: 'my-portal', logExporter });
|
|
55
|
-
}
|
|
56
|
-
console.error('Service discovery unavailable — analytics adapter not created');
|
|
57
|
-
});
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
## Creating a Custom Adapter
|
|
61
|
-
|
|
62
|
-
Implement `IAnalyticsAdapter` and register it with `setAdapter`:
|
|
63
|
-
|
|
64
|
-
```typescript
|
|
65
|
-
import type { IAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/adapters';
|
|
66
|
-
import type { AnalyticsEvent } from '@equinor/fusion-framework-module-analytics';
|
|
67
|
-
|
|
68
|
-
class MyRemoteAdapter implements IAnalyticsAdapter {
|
|
69
|
-
registerAnalytic(event: AnalyticsEvent): void {
|
|
70
|
-
navigator.sendBeacon('/analytics', JSON.stringify(event));
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
[Symbol.dispose](): void {
|
|
74
|
-
// cleanup if needed
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
builder.setAdapter('remote', async () => new MyRemoteAdapter());
|
|
79
|
-
```
|