1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
import type { Logger, LoggerFactory } from '@amp/web-apps-logger/src/types';
import { IMPRESSION_CONTEXT_NAME } from './constants';
import { createSvelteImpressionAction } from './utils/svelte/impressions-svelte-action';
import type {
AppImpressionModel,
ImpressionSettings,
ImpressionsInstance,
} from './types';
import type {
ImpressionObserver,
newInstanceWithMetricsConfig,
} from '@amp-metrics/mt-impressions-observer';
import type { ClickstreamProcessor } from '@amp-metrics/mt-metricskit-processor-clickstream';
/**
* Adapter class to handle interactions with
* metricsKit impression observer.
*/
export class Impressions implements ImpressionsInstance {
private readonly logger: Logger;
private impressionObserverInstance: ImpressionObserver | undefined;
private hasInitialized: boolean = false;
private impressionDataMap: Map<HTMLElement, any> = new Map();
private currentSnapshot: Record<string, unknown>[] = [];
private readonly impressionSettings: ImpressionSettings | undefined;
constructor(
loggerFactory: LoggerFactory,
context: Map<string, unknown>,
settings?: ImpressionSettings,
) {
this.logger = loggerFactory.loggerFor(IMPRESSION_CONTEXT_NAME);
this.impressionSettings = settings;
context.set(IMPRESSION_CONTEXT_NAME, this);
}
async init(
makeImpressionObserver: typeof newInstanceWithMetricsConfig,
clickStreamInstance: ClickstreamProcessor,
) {
if (this.hasInitialized) {
this.logger.warn(
'Ignoring, Impressions.init() can only be called once',
);
return;
}
const options = { root: document, rootMargin: '0px' };
const config = clickStreamInstance.config;
const impressionObserver: ImpressionObserver =
await makeImpressionObserver(config, options);
impressionObserver.setDelegate({
extractImpressionInfo: (domNode: HTMLElement) => {
const dataMap = this.impressionDataMap;
const nodeMetricData = dataMap.get(domNode);
if (nodeMetricData) {
const impressionData = nodeMetricData.impressionMetrics;
impressionData.location =
clickStreamInstance.utils.eventFields.buildLocationStructure(
domNode,
(node: HTMLElement) => {
const metrics = dataMap.get(node);
if (metrics?.location) {
return metrics.location;
}
return;
},
);
return impressionData;
} else {
this.logger.warn('no impression data found for', domNode);
}
},
});
this.impressionObserverInstance = impressionObserver;
this.impressionDataMap.forEach((_value, node) => {
this.logger.debug('observing deffered node', node);
this.impressionObserverInstance?.observe(node);
});
this.hasInitialized = true;
this.logger.debug('impressions initialized');
}
get settings() {
return this.impressionSettings;
}
isEnabled(event: 'click' | 'exit' | 'impressions'): boolean {
if (this.impressionSettings?.captureType === 'jet') {
return (
this.impressionSettings?.metricsKitEvents?.includes(event) ??
false
);
}
return true;
}
consumeImpressions(): Record<string, unknown>[] | undefined {
if (this.hasInitialized) {
this.logger.debug('consuming impression metrics');
return this.impressionObserverInstance?.consumeImpressions();
}
this.logger.warn('impressions not avaiable yet');
return;
}
captureSnapshotImpression(): Record<string, unknown>[] | undefined {
const snapshot =
this.impressionObserverInstance?.snapshotImpressions() ?? [];
// if the current page already transitioned. fallback to the snapshot we captured before transition
if (snapshot.length === 0) {
return this.getSnapshotImpression();
}
return snapshot;
}
getSnapshotImpression(): Record<string, unknown>[] | undefined {
if (this.hasInitialized) {
return this.currentSnapshot;
}
this.logger.warn('impressions not avaiable yet');
return;
}
setCurrentSnapshot(): void {
if (this.hasInitialized) {
this.logger.debug('capturing impression snapshot');
this.currentSnapshot =
this.impressionObserverInstance?.snapshotImpressions() ?? [];
} else {
this.logger.warn('impressions not avaiable yet');
}
}
get nodeList() {
const impressionClass = this;
return new Proxy(impressionClass.impressionDataMap, {
get(target, prop, receiver) {
const orginalFn = Reflect.get(target, prop, receiver);
// overriding 'set' to also be able to observe
if (prop === 'set') {
return (
node: HTMLElement,
value: Record<string, unknown>,
) => {
if (impressionClass.hasInitialized) {
impressionClass.logger.debug(
'observing',
node,
value,
);
impressionClass.impressionObserverInstance?.observe(
node,
);
}
return orginalFn.bind(target)(node, value);
};
}
// overriding 'delete' to also be able to unobserve
if (prop === 'delete') {
return (node: HTMLElement) => {
if (impressionClass.hasInitialized) {
impressionClass.logger.debug('unobserve', node);
impressionClass.impressionObserverInstance?.unobserve(
node,
);
}
return orginalFn.bind(target)(node);
};
}
return orginalFn.bind(target);
},
set(target, prop, value) {
return Reflect.set(target, prop, value);
},
});
}
}
/**
* Server Noop for above
*/
class ServerNoopImpressions implements ImpressionsInstance {
readonly nodeList: WeakMap<any, any>;
constructor() {
this.nodeList = new WeakMap();
}
setCurrentSnapshot(): void {}
}
/**
* Gets the current Impression instance from the Svelte context.
*
* @return The current instance of Impression
*/
export function generateBrowserImpressionsContextGetter(
getContext: (context: string) => unknown,
): () => AppImpressionModel {
return function getImpressions(): AppImpressionModel {
const impressions = getContext(IMPRESSION_CONTEXT_NAME) as
| Impressions
| undefined;
if (!impressions) {
const noopImpressions = new ServerNoopImpressions();
return {
captureImpressions: (_node: any, _impressionsData: any) => {
return {
destroy() {},
};
},
impressions: noopImpressions,
};
}
return {
captureImpressions: createSvelteImpressionAction(impressions),
impressions,
};
};
}
/**
* Server No-op for generateImpressionsContextGetter
*
*/
export function generateServerImpressionsContextGetter(
_getContext: (context: string) => unknown,
): () => AppImpressionModel {
const impressions = new ServerNoopImpressions();
return () => ({
captureImpressions: (_node: any, _impressionsData: any) => {
return {
destroy() {},
};
},
impressions,
});
}
|
