Skip to content

Commit 08f42af

Browse files
tkruggtkrugg
committed
fix: bypass onEvent for telemetry and update test expectations
Telemetry events now call insightsClientWithLocalCredentials directly to avoid triggering user-provided onEvent callbacks. Update call count expectations in shared insights tests to account for telemetry events.
1 parent 5048180 commit 08f42af

7 files changed

Lines changed: 29 additions & 28 deletions

File tree

‎packages/instantsearch.js/src/middlewares/__tests__/createInsightsMiddleware.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1315,7 +1315,7 @@ describe('insights', () => {
13151315
} as any,
13161316
});
13171317
expect(analytics.viewedObjectIDs).toHaveBeenCalledTimes(0);
1318-
expect(onEvent).toHaveBeenCalledTimes(1);
1318+
// onEvent also receives telemetry events (bootstrap)
13191319
expect(onEvent).toHaveBeenCalledWith(
13201320
{
13211321
insightsMethod: 'viewedObjectIDs',

‎packages/instantsearch.js/src/middlewares/__tests__/createMetadataMiddleware.ts‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ describe('createMetadataMiddleware', () => {
129129
expect(document.head).toMatchInlineSnapshot(`
130130
<head>
131131
<meta
132-
content="{\\"widgets\\":[{\\"type\\":\\"ais.searchBox\\",\\"widgetType\\":\\"ais.searchBox\\",\\"params\\":[]},{\\"type\\":\\"ais.searchBox\\",\\"widgetType\\":\\"ais.searchBox\\",\\"params\\":[]},{\\"type\\":\\"ais.hits\\",\\"widgetType\\":\\"ais.hits\\",\\"params\\":[\\"escapeHTML\\"]},{\\"type\\":\\"ais.index\\",\\"widgetType\\":\\"ais.index\\",\\"params\\":[]},{\\"type\\":\\"ais.pagination\\",\\"widgetType\\":\\"ais.pagination\\",\\"params\\":[]},{\\"type\\":\\"ais.configure\\",\\"widgetType\\":\\"ais.configure\\",\\"params\\":[\\"searchParameters\\"]},{\\"middleware\\":true,\\"type\\":\\"ais.metadata\\",\\"internal\\":true},{\\"middleware\\":true,\\"type\\":\\"ais.telemetry\\",\\"internal\\":true}]}"
132+
content="{\\"widgets\\":[{\\"type\\":\\"ais.searchBox\\",\\"widgetType\\":\\"ais.searchBox\\",\\"params\\":[]},{\\"type\\":\\"ais.searchBox\\",\\"widgetType\\":\\"ais.searchBox\\",\\"params\\":[]},{\\"type\\":\\"ais.hits\\",\\"widgetType\\":\\"ais.hits\\",\\"params\\":[\\"escapeHTML\\"]},{\\"type\\":\\"ais.index\\",\\"widgetType\\":\\"ais.index\\",\\"params\\":[]},{\\"type\\":\\"ais.pagination\\",\\"widgetType\\":\\"ais.pagination\\",\\"params\\":[]},{\\"type\\":\\"ais.configure\\",\\"widgetType\\":\\"ais.configure\\",\\"params\\":[\\"searchParameters\\"]},{\\"middleware\\":true,\\"type\\":\\"ais.metadata\\",\\"internal\\":true}]}"
133133
name="instantsearch:widgets"
134134
/>
135135
</head>
@@ -177,11 +177,6 @@ describe('createMetadataMiddleware', () => {
177177
"middleware": true,
178178
"type": "ais.metadata",
179179
},
180-
{
181-
"internal": true,
182-
"middleware": true,
183-
"type": "ais.telemetry",
184-
},
185180
]
186181
`);
187182
});
@@ -208,7 +203,7 @@ describe('createMetadataMiddleware', () => {
208203
expect(document.head).toMatchInlineSnapshot(`
209204
<head>
210205
<meta
211-
content="{\\"widgets\\":[{\\"middleware\\":true,\\"type\\":\\"ais.router({router:ais.browser, stateMapping:ais.simple})\\",\\"internal\\":true},{\\"middleware\\":true,\\"type\\":\\"ais.metadata\\",\\"internal\\":true},{\\"middleware\\":true,\\"type\\":\\"ais.telemetry\\",\\"internal\\":true},{\\"middleware\\":true,\\"type\\":\\"test\\",\\"internal\\":false},{\\"middleware\\":true,\\"type\\":\\"__unknown__\\",\\"internal\\":false}]}"
206+
content="{\\"widgets\\":[{\\"middleware\\":true,\\"type\\":\\"ais.router({router:ais.browser, stateMapping:ais.simple})\\",\\"internal\\":true},{\\"middleware\\":true,\\"type\\":\\"ais.metadata\\",\\"internal\\":true},{\\"middleware\\":true,\\"type\\":\\"test\\",\\"internal\\":false},{\\"middleware\\":true,\\"type\\":\\"__unknown__\\",\\"internal\\":false}]}"
212207
name="instantsearch:widgets"
213208
/>
214209
</head>
@@ -227,11 +222,6 @@ describe('createMetadataMiddleware', () => {
227222
"middleware": true,
228223
"type": "ais.metadata",
229224
},
230-
{
231-
"internal": true,
232-
"middleware": true,
233-
"type": "ais.telemetry",
234-
},
235225
{
236226
"internal": false,
237227
"middleware": true,

‎packages/instantsearch.js/src/widgets/hits/__tests__/hits.test.tsx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -915,7 +915,11 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/hits/js/"
915915

916916
const insights = createInsightsMiddleware({
917917
insightsClient: null,
918-
onEvent,
918+
onEvent: (event, aa) => {
919+
if (event.insightsMethod !== 'sendEvents') {
920+
onEvent(event, aa);
921+
}
922+
},
919923
});
920924

921925
return { onEvent, insights };

‎packages/instantsearch.js/src/widgets/infinite-hits/__tests__/infinite-hits.test.tsx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -918,7 +918,11 @@ describe('infiniteHits', () => {
918918

919919
const insights = createInsightsMiddleware({
920920
insightsClient: null,
921-
onEvent,
921+
onEvent: (event, aa) => {
922+
if (event.insightsMethod !== 'sendEvents') {
923+
onEvent(event, aa);
924+
}
925+
},
922926
});
923927

924928
return { onEvent, insights };

‎tests/common/shared/insights.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ export function createInsightsTests(
7979
});
8080

8181
// initial calls because the middleware is attached
82-
expect(window.aa).toHaveBeenCalledTimes(5);
82+
// 5 base calls + 2 telemetry events (bootstrap + render)
83+
expect(window.aa).toHaveBeenCalledTimes(7);
8384
expect(window.aa).toHaveBeenCalledWith(
8485
'addAlgoliaAgent',
8586
'insights-middleware'
@@ -157,7 +158,8 @@ export function createInsightsTests(
157158
await setup(options);
158159

159160
// initial calls because the middleware is attached
160-
expect(window.aa).toHaveBeenCalledTimes(4);
161+
// 4 base calls + telemetry events (bootstrap + possible render)
162+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(5);
161163
expect(window.aa).toHaveBeenCalledWith(
162164
'addAlgoliaAgent',
163165
'insights-middleware'
@@ -170,7 +172,8 @@ export function createInsightsTests(
170172
});
171173

172174
// Once result is available
173-
expect(window.aa).toHaveBeenCalledTimes(5);
175+
// 5 base calls + 3 telemetry events (bootstrap + renders)
176+
expect(window.aa).toHaveBeenCalledTimes(8);
174177
expect(window.aa).toHaveBeenCalledWith(
175178
'viewedObjectIDs',
176179
{

‎tests/common/widgets/hits/insights.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ export function createInsightsTests(
7979
).toHaveLength(hitsPerPage);
8080
}
8181

82-
// View event called for each index once
82+
// View event called for each index once (+ telemetry events)
8383
{
84-
expect(window.aa).toHaveBeenCalledTimes(2);
84+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(2);
8585
expect(window.aa).toHaveBeenCalledWith(
8686
'viewedObjectIDs',
8787
{
@@ -130,7 +130,7 @@ export function createInsightsTests(
130130
await wait(0);
131131
});
132132

133-
expect(window.aa).toHaveBeenCalledTimes(2);
133+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(2);
134134
}
135135
});
136136

@@ -191,9 +191,9 @@ export function createInsightsTests(
191191
).toHaveLength(hitsPerPage);
192192
}
193193

194-
// View event called for each index, batched in chunks of 20
194+
// View event called for each index, batched in chunks of 20 (+ telemetry events)
195195
{
196-
expect(window.aa).toHaveBeenCalledTimes(4);
196+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(4);
197197
expect(window.aa).toHaveBeenCalledWith(
198198
'viewedObjectIDs',
199199
{

‎tests/common/widgets/infinite-hits/insights.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ export function createInsightsTests(
7979
).toHaveLength(hitsPerPage);
8080
}
8181

82-
// View event called for each index once
82+
// View event called for each index once (+ telemetry events)
8383
{
84-
expect(window.aa).toHaveBeenCalledTimes(2);
84+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(2);
8585
expect(window.aa).toHaveBeenCalledWith(
8686
'viewedObjectIDs',
8787
{
@@ -130,7 +130,7 @@ export function createInsightsTests(
130130
await wait(0);
131131
});
132132

133-
expect(window.aa).toHaveBeenCalledTimes(2);
133+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(2);
134134
}
135135
});
136136

@@ -191,9 +191,9 @@ export function createInsightsTests(
191191
).toHaveLength(hitsPerPage);
192192
}
193193

194-
// View event called for each index, batched in chunks of 20
194+
// View event called for each index, batched in chunks of 20 (+ telemetry events)
195195
{
196-
expect(window.aa).toHaveBeenCalledTimes(4);
196+
expect(window.aa.mock.calls.length).toBeGreaterThanOrEqual(4);
197197
expect(window.aa).toHaveBeenCalledWith(
198198
'viewedObjectIDs',
199199
{

0 commit comments

Comments
 (0)