-
Notifications
You must be signed in to change notification settings - Fork 982
/
useChatSession.ts
386 lines (343 loc) · 11.5 KB
/
useChatSession.ts
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
import { debounce } from 'lodash';
import { useCallback, useContext, useEffect } from 'react';
import {
useRecoilState,
useRecoilValue,
useResetRecoilState,
useSetRecoilState
} from 'recoil';
import io from 'socket.io-client';
import {
actionState,
askUserState,
audioConnectionState,
callFnState,
chatProfileState,
chatSettingsInputsState,
chatSettingsValueState,
currentThreadIdState,
elementState,
firstUserInteraction,
isAiSpeakingState,
loadingState,
messagesState,
sessionIdState,
sessionState,
tasklistState,
threadIdToResumeState,
tokenCountState,
wavRecorderState,
wavStreamPlayerState
} from 'src/state';
import {
IAction,
IElement,
IMessageElement,
IStep,
ITasklistElement,
IThread
} from 'src/types';
import {
addMessage,
deleteMessageById,
updateMessageById,
updateMessageContentById
} from 'src/utils/message';
import { OutputAudioChunk } from './types/audio';
import { ChainlitContext } from './context';
import type { IToken } from './useChatData';
const useChatSession = () => {
const client = useContext(ChainlitContext);
const sessionId = useRecoilValue(sessionIdState);
const [session, setSession] = useRecoilState(sessionState);
const setIsAiSpeaking = useSetRecoilState(isAiSpeakingState);
const setAudioConnection = useSetRecoilState(audioConnectionState);
const resetChatSettingsValue = useResetRecoilState(chatSettingsValueState);
const setFirstUserInteraction = useSetRecoilState(firstUserInteraction);
const setLoading = useSetRecoilState(loadingState);
const wavStreamPlayer = useRecoilValue(wavStreamPlayerState);
const wavRecorder = useRecoilValue(wavRecorderState);
const setMessages = useSetRecoilState(messagesState);
const setAskUser = useSetRecoilState(askUserState);
const setCallFn = useSetRecoilState(callFnState);
const setElements = useSetRecoilState(elementState);
const setTasklists = useSetRecoilState(tasklistState);
const setActions = useSetRecoilState(actionState);
const setChatSettingsInputs = useSetRecoilState(chatSettingsInputsState);
const setTokenCount = useSetRecoilState(tokenCountState);
const [chatProfile, setChatProfile] = useRecoilState(chatProfileState);
const idToResume = useRecoilValue(threadIdToResumeState);
const [currentThreadId, setCurrentThreadId] =
useRecoilState(currentThreadIdState);
// Use currentThreadId as thread id in websocket header
useEffect(() => {
if (session?.socket) {
session.socket.io.opts.extraHeaders!['X-Chainlit-Thread-Id'] =
currentThreadId || '';
}
}, [currentThreadId]);
const _connect = useCallback(
({
userEnv,
accessToken,
requireWebSocket = false
}: {
userEnv: Record<string, string>;
accessToken?: string;
requireWebSocket?: boolean;
}) => {
const { protocol, host, pathname } = new URL(client.httpEndpoint);
const uri = `${protocol}//${host}`;
const path =
pathname && pathname !== '/'
? `${pathname}/ws/socket.io`
: '/ws/socket.io';
const socket = io(uri, {
path,
extraHeaders: {
Authorization: accessToken || '',
'X-Chainlit-Client-Type': client.type,
'X-Chainlit-Session-Id': sessionId,
'X-Chainlit-Thread-Id': idToResume || '',
'user-env': JSON.stringify(userEnv),
'X-Chainlit-Chat-Profile': chatProfile
? encodeURIComponent(chatProfile)
: ''
}
});
setSession((old) => {
old?.socket?.removeAllListeners();
old?.socket?.close();
return {
socket
};
});
const onConnect = () => {
socket.emit('connection_successful');
setSession((s) => ({ ...s!, error: false }));
};
const onConnectError = () => {
setSession((s) => ({ ...s!, error: true }));
};
// https://socket.io/docs/v4/how-it-works/#upgrade-mechanism
// Require WebSocket when connecting to backend
if (requireWebSocket) {
// https://socket.io/docs/v4/client-socket-instance/#socketio
// 'connect' event is emitted when the underlying connection is established with polling transport
// 'upgrade' event is emitted when the underlying connection is upgraded to WebSocket and polling request is stopped.
const engine = socket.io.engine;
// https://github.com/socketio/socket.io/tree/main/packages/engine.io-client#events
engine.once('upgrade', () => {
// Set session on connect event, otherwise user can not interact with text input UI.
// Upgrade event is required to make sure user won't interact with the session before websocket upgrade success
socket.on('connect', onConnect);
});
// Socket.io will not retry upgrade request.
// Retry upgrade to websocket when error can only be done via reconnect.
// This will not be an issue for users if they are using persistent sticky session.
// In case they are using soft session affinity like Istio, then sometimes upgrade request will fail
engine.once('upgradeError', () => {
onConnectError();
setTimeout(() => {
socket.removeAllListeners();
socket.close();
_connect({
userEnv,
accessToken,
requireWebSocket
});
}, 500);
});
} else {
socket.on('connect', onConnect);
}
socket.on('connect_error', onConnectError);
socket.on('task_start', () => {
setLoading(true);
});
socket.on('task_end', () => {
setLoading(false);
});
socket.on('reload', () => {
socket.emit('clear_session');
window.location.reload();
});
socket.on('audio_connection', async (state: 'on' | 'off') => {
if (state === 'on') {
let isFirstChunk = true;
const startTime = Date.now();
const mimeType = 'pcm16';
// Connect to microphone
await wavRecorder.begin();
await wavStreamPlayer.connect();
await wavRecorder.record(async (data) => {
const elapsedTime = Date.now() - startTime;
socket.emit('audio_chunk', {
isStart: isFirstChunk,
mimeType,
elapsedTime,
data: data.mono
});
isFirstChunk = false;
});
wavStreamPlayer.onStop = () => setIsAiSpeaking(false);
} else {
await wavRecorder.end();
await wavStreamPlayer.interrupt();
}
setAudioConnection(state);
});
socket.on('audio_chunk', (chunk: OutputAudioChunk) => {
wavStreamPlayer.add16BitPCM(chunk.data, chunk.track);
setIsAiSpeaking(true);
});
socket.on('audio_interrupt', () => {
wavStreamPlayer.interrupt();
});
socket.on('resume_thread', (thread: IThread) => {
let messages: IStep[] = [];
for (const step of thread.steps) {
messages = addMessage(messages, step);
}
if (thread.metadata?.chat_profile) {
setChatProfile(thread.metadata?.chat_profile);
}
setMessages(messages);
const elements = thread.elements || [];
setTasklists(
(elements as ITasklistElement[]).filter((e) => e.type === 'tasklist')
);
setElements(
(elements as IMessageElement[]).filter(
(e) => ['avatar', 'tasklist'].indexOf(e.type) === -1
)
);
});
socket.on('new_message', (message: IStep) => {
setMessages((oldMessages) => addMessage(oldMessages, message));
});
socket.on(
'first_interaction',
(event: { interaction: string; thread_id: string }) => {
setFirstUserInteraction(event.interaction);
setCurrentThreadId(event.thread_id);
}
);
socket.on('update_message', (message: IStep) => {
setMessages((oldMessages) =>
updateMessageById(oldMessages, message.id, message)
);
});
socket.on('delete_message', (message: IStep) => {
setMessages((oldMessages) =>
deleteMessageById(oldMessages, message.id)
);
});
socket.on('stream_start', (message: IStep) => {
setMessages((oldMessages) => addMessage(oldMessages, message));
});
socket.on(
'stream_token',
({ id, token, isSequence, isInput }: IToken) => {
setMessages((oldMessages) =>
updateMessageContentById(
oldMessages,
id,
token,
isSequence,
isInput
)
);
}
);
socket.on('ask', ({ msg, spec }, callback) => {
setAskUser({ spec, callback });
setMessages((oldMessages) => addMessage(oldMessages, msg));
setLoading(false);
});
socket.on('ask_timeout', () => {
setAskUser(undefined);
setLoading(false);
});
socket.on('clear_ask', () => {
setAskUser(undefined);
});
socket.on('call_fn', ({ name, args }, callback) => {
setCallFn({ name, args, callback });
});
socket.on('clear_call_fn', () => {
setCallFn(undefined);
});
socket.on('call_fn_timeout', () => {
setCallFn(undefined);
});
socket.on('chat_settings', (inputs: any) => {
setChatSettingsInputs(inputs);
resetChatSettingsValue();
});
socket.on('element', (element: IElement) => {
if (!element.url && element.chainlitKey) {
element.url = client.getElementUrl(element.chainlitKey, sessionId);
}
if (element.type === 'tasklist') {
setTasklists((old) => {
const index = old.findIndex((e) => e.id === element.id);
if (index === -1) {
return [...old, element];
} else {
return [...old.slice(0, index), element, ...old.slice(index + 1)];
}
});
} else {
setElements((old) => {
const index = old.findIndex((e) => e.id === element.id);
if (index === -1) {
return [...old, element];
} else {
return [...old.slice(0, index), element, ...old.slice(index + 1)];
}
});
}
});
socket.on('remove_element', (remove: { id: string }) => {
setElements((old) => {
return old.filter((e) => e.id !== remove.id);
});
setTasklists((old) => {
return old.filter((e) => e.id !== remove.id);
});
});
socket.on('action', (action: IAction) => {
setActions((old) => [...old, action]);
});
socket.on('remove_action', (action: IAction) => {
setActions((old) => {
const index = old.findIndex((a) => a.id === action.id);
if (index === -1) return old;
return [...old.slice(0, index), ...old.slice(index + 1)];
});
});
socket.on('token_usage', (count: number) => {
setTokenCount((old) => old + count);
});
},
[setSession, sessionId, chatProfile]
);
const connect = useCallback(debounce(_connect, 200), [_connect]);
const disconnect = useCallback(() => {
if (session?.socket) {
session.socket.removeAllListeners();
session.socket.close();
}
}, [session]);
return {
connect,
disconnect,
session,
sessionId,
chatProfile,
idToResume,
setChatProfile
};
};
export { useChatSession };