11import { expect , test , vi } from 'vitest' ;
22
3+ import type { EndRequest , Requester } from '../../client-common/src/types' ;
34import { LogLevelEnum } from '../../client-common/src/types' ;
45import { createConsoleLogger } from '../../logger-console/src/logger' ;
56import { algoliasearch , apiClientVersion } from '../builds/node' ;
@@ -24,6 +25,111 @@ test('forwards node search helpers', () => {
2425 } ) . not . toThrow ( ) ;
2526} ) ;
2627
28+ function createRecordingRequester ( ) : { requester : Requester ; requests : EndRequest [ ] } {
29+ const requests : EndRequest [ ] = [ ] ;
30+
31+ return {
32+ requests,
33+ requester : {
34+ send ( request : EndRequest ) {
35+ requests . push ( request ) ;
36+ let content = JSON . stringify ( { taskID : 42 , objectIDs : [ ] , updatedAt : '2026-01-01T00:00:00Z' } ) ;
37+ if ( request . url . includes ( '/task/' ) ) {
38+ content = JSON . stringify ( { status : 'published' , updatedAt : '2026-01-01T00:00:00Z' } ) ;
39+ } else if ( request . url . includes ( '/push/' ) ) {
40+ content = JSON . stringify ( { runID : 'run-1' , eventID : 'event-1' , message : 'pushed' } ) ;
41+ } else if ( request . url . includes ( '/events/' ) ) {
42+ content = JSON . stringify ( {
43+ eventID : 'event-1' ,
44+ runID : 'run-1' ,
45+ status : 'succeeded' ,
46+ type : 'record' ,
47+ batchSize : 1 ,
48+ publishedAt : '2026-01-01T00:00:00Z' ,
49+ } ) ;
50+ }
51+
52+ return Promise . resolve ( { content, isTimedOut : false , status : 200 } ) ;
53+ } ,
54+ } ,
55+ } ;
56+ }
57+
58+ test ( 'chunkedBatch shares one request-id across its batch calls and task polls' , async ( ) => {
59+ const { requester, requests } = createRecordingRequester ( ) ;
60+ const client = algoliasearch ( 'APP_ID' , 'API_KEY' , { requester } ) ;
61+ const objects = Array . from ( { length : 1500 } , ( _ , i ) => ( { objectID : `${ i } ` } ) ) ;
62+
63+ await client . chunkedBatch ( { indexName : 'foo' , objects, waitForTasks : true } ) ;
64+
65+ expect ( requests ) . toHaveLength ( 4 ) ;
66+ const ids = requests . map ( ( request ) => request . headers [ 'request-id' ] ) ;
67+ expect ( ids [ 0 ] ) . toMatch ( / ^ [ 0 - 9 A - Z a - z ] { 11 } $ / ) ;
68+ expect ( new Set ( ids ) . size ) . toBe ( 1 ) ;
69+ } ) ;
70+
71+ test ( 'replaceAllObjects shares one request-id across copy, batch, wait and move' , async ( ) => {
72+ const { requester, requests } = createRecordingRequester ( ) ;
73+ const client = algoliasearch ( 'APP_ID' , 'API_KEY' , { requester } ) ;
74+
75+ await client . replaceAllObjects ( { indexName : 'foo' , objects : [ { objectID : '1' } ] } ) ;
76+
77+ expect ( requests ) . toHaveLength ( 8 ) ;
78+ const ids = requests . map ( ( request ) => request . headers [ 'request-id' ] ) ;
79+ expect ( ids [ 0 ] ) . toMatch ( / ^ [ 0 - 9 A - Z a - z ] { 11 } $ / ) ;
80+ expect ( new Set ( ids ) . size ) . toBe ( 1 ) ;
81+ } ) ;
82+
83+ test ( 'replaceAllObjectsWithTransformation shares one request-id across its search calls and sends none to ingestion' , async ( ) => {
84+ const { requester, requests } = createRecordingRequester ( ) ;
85+ const client = algoliasearch ( 'APP_ID' , 'API_KEY' , {
86+ requester,
87+ transformationOptions : { region : 'eu' , requester } ,
88+ } ) ;
89+
90+ await client . replaceAllObjectsWithTransformation ( { indexName : 'foo' , objects : [ { objectID : '1' } ] } ) ;
91+
92+ const searchRequests = requests . filter ( ( request ) => request . url . includes ( 'algolia.net' ) ) ;
93+ const ingestionRequests = requests . filter ( ( request ) => request . url . includes ( 'data.eu.algolia.com' ) ) ;
94+
95+ expect ( requests ) . toHaveLength ( 8 ) ;
96+ expect ( searchRequests ) . toHaveLength ( 6 ) ;
97+ expect ( ingestionRequests ) . toHaveLength ( 2 ) ;
98+
99+ const searchIds = searchRequests . map ( ( request ) => request . headers [ 'request-id' ] ) ;
100+ expect ( searchIds [ 0 ] ) . toMatch ( / ^ [ 0 - 9 A - Z a - z ] { 11 } $ / ) ;
101+ expect ( new Set ( searchIds ) . size ) . toBe ( 1 ) ;
102+
103+ for ( const request of ingestionRequests ) {
104+ expect ( request . headers [ 'request-id' ] ) . toBeUndefined ( ) ;
105+ expect ( new URL ( request . url ) . searchParams . get ( 'x-algolia-request-id' ) ) . toBeNull ( ) ;
106+ }
107+ } ) ;
108+
109+ test ( 'each helper invocation mints a fresh request-id' , async ( ) => {
110+ const { requester, requests } = createRecordingRequester ( ) ;
111+ const client = algoliasearch ( 'APP_ID' , 'API_KEY' , { requester } ) ;
112+
113+ await client . chunkedBatch ( { indexName : 'foo' , objects : [ { objectID : '1' } ] } ) ;
114+ await client . chunkedBatch ( { indexName : 'foo' , objects : [ { objectID : '1' } ] } ) ;
115+
116+ expect ( requests ) . toHaveLength ( 2 ) ;
117+ expect ( requests [ 0 ] . headers [ 'request-id' ] ) . not . toBe ( requests [ 1 ] . headers [ 'request-id' ] ) ;
118+ } ) ;
119+
120+ test ( 'a caller-supplied request-id flows through helpers untouched' , async ( ) => {
121+ const { requester, requests } = createRecordingRequester ( ) ;
122+ const client = algoliasearch ( 'APP_ID' , 'API_KEY' , { requester } ) ;
123+
124+ await client . chunkedBatch (
125+ { indexName : 'foo' , objects : [ { objectID : '1' } ] , waitForTasks : true } ,
126+ { headers : { 'request-id' : 'CallerChose' } } ,
127+ ) ;
128+
129+ expect ( requests ) . toHaveLength ( 2 ) ;
130+ expect ( requests . map ( ( request ) => request . headers [ 'request-id' ] ) ) . toEqual ( [ 'CallerChose' , 'CallerChose' ] ) ;
131+ } ) ;
132+
27133test ( 'with logger' , async ( ) => {
28134 const consoleInfo = vi . spyOn ( console , 'info' ) . mockImplementation ( ( ) => { } ) ;
29135
0 commit comments