base.ts 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584
  1. import { API_PREFIX, IS_CE_EDITION, PUBLIC_API_PREFIX } from '@/config'
  2. import Toast from '@/app/components/base/toast'
  3. import type { AnnotationReply, MessageEnd, MessageReplace, ThoughtItem } from '@/app/components/app/chat/type'
  4. import type { VisionFile } from '@/types/app'
  5. import type {
  6. IterationFinishedResponse,
  7. IterationNextedResponse,
  8. IterationStartedResponse,
  9. NodeFinishedResponse,
  10. NodeStartedResponse,
  11. TextChunkResponse,
  12. TextReplaceResponse,
  13. WorkflowFinishedResponse,
  14. WorkflowStartedResponse,
  15. } from '@/types/workflow'
  16. import { removeAccessToken } from '@/app/components/share/utils'
  17. const TIME_OUT = 100000
  18. const ContentType = {
  19. json: 'application/json',
  20. stream: 'text/event-stream',
  21. form: 'application/x-www-form-urlencoded; charset=UTF-8',
  22. download: 'application/octet-stream', // for download
  23. upload: 'multipart/form-data', // for upload
  24. }
  25. const baseOptions = {
  26. method: 'GET',
  27. mode: 'cors',
  28. credentials: 'include', // always send cookies、HTTP Basic authentication.
  29. headers: new Headers({
  30. 'Content-Type': ContentType.json,
  31. }),
  32. redirect: 'follow',
  33. }
  34. export type IOnDataMoreInfo = {
  35. conversationId?: string
  36. taskId?: string
  37. messageId: string
  38. errorMessage?: string
  39. errorCode?: string
  40. }
  41. export type IOnData = (message: string, isFirstMessage: boolean, moreInfo: IOnDataMoreInfo) => void
  42. export type IOnThought = (though: ThoughtItem) => void
  43. export type IOnFile = (file: VisionFile) => void
  44. export type IOnMessageEnd = (messageEnd: MessageEnd) => void
  45. export type IOnMessageReplace = (messageReplace: MessageReplace) => void
  46. export type IOnAnnotationReply = (messageReplace: AnnotationReply) => void
  47. export type IOnCompleted = (hasError?: boolean, errorMessage?: string) => void
  48. export type IOnError = (msg: string, code?: string) => void
  49. export type IOnWorkflowStarted = (workflowStarted: WorkflowStartedResponse) => void
  50. export type IOnWorkflowFinished = (workflowFinished: WorkflowFinishedResponse) => void
  51. export type IOnNodeStarted = (nodeStarted: NodeStartedResponse) => void
  52. export type IOnNodeFinished = (nodeFinished: NodeFinishedResponse) => void
  53. export type IOnIterationStarted = (workflowStarted: IterationStartedResponse) => void
  54. export type IOnIterationNexted = (workflowStarted: IterationNextedResponse) => void
  55. export type IOnIterationFinished = (workflowFinished: IterationFinishedResponse) => void
  56. export type IOnTextChunk = (textChunk: TextChunkResponse) => void
  57. export type IOnTextReplace = (textReplace: TextReplaceResponse) => void
  58. export type IOtherOptions = {
  59. isPublicAPI?: boolean
  60. bodyStringify?: boolean
  61. needAllResponseContent?: boolean
  62. deleteContentType?: boolean
  63. silent?: boolean
  64. onData?: IOnData // for stream
  65. onThought?: IOnThought
  66. onFile?: IOnFile
  67. onMessageEnd?: IOnMessageEnd
  68. onMessageReplace?: IOnMessageReplace
  69. onError?: IOnError
  70. onCompleted?: IOnCompleted // for stream
  71. getAbortController?: (abortController: AbortController) => void
  72. onWorkflowStarted?: IOnWorkflowStarted
  73. onWorkflowFinished?: IOnWorkflowFinished
  74. onNodeStarted?: IOnNodeStarted
  75. onNodeFinished?: IOnNodeFinished
  76. onIterationStart?: IOnIterationStarted
  77. onIterationNext?: IOnIterationNexted
  78. onIterationFinish?: IOnIterationFinished
  79. onTextChunk?: IOnTextChunk
  80. onTextReplace?: IOnTextReplace
  81. }
  82. type ResponseError = {
  83. code: string
  84. message: string
  85. status: number
  86. }
  87. type FetchOptionType = Omit<RequestInit, 'body'> & {
  88. params?: Record<string, any>
  89. body?: BodyInit | Record<string, any> | null
  90. }
  91. function unicodeToChar(text: string) {
  92. if (!text)
  93. return ''
  94. return text.replace(/\\u[0-9a-f]{4}/g, (_match, p1) => {
  95. return String.fromCharCode(parseInt(p1, 16))
  96. })
  97. }
  98. function requiredWebSSOLogin() {
  99. globalThis.location.href = `/webapp-signin?redirect_url=${globalThis.location.pathname}`
  100. }
  101. export function format(text: string) {
  102. let res = text.trim()
  103. if (res.startsWith('\n'))
  104. res = res.replace('\n', '')
  105. return res.replaceAll('\n', '<br/>').replaceAll('```', '')
  106. }
  107. const handleStream = (
  108. response: Response,
  109. onData: IOnData,
  110. onCompleted?: IOnCompleted,
  111. onThought?: IOnThought,
  112. onMessageEnd?: IOnMessageEnd,
  113. onMessageReplace?: IOnMessageReplace,
  114. onFile?: IOnFile,
  115. onWorkflowStarted?: IOnWorkflowStarted,
  116. onWorkflowFinished?: IOnWorkflowFinished,
  117. onNodeStarted?: IOnNodeStarted,
  118. onNodeFinished?: IOnNodeFinished,
  119. onIterationStart?: IOnIterationStarted,
  120. onIterationNext?: IOnIterationNexted,
  121. onIterationFinish?: IOnIterationFinished,
  122. onTextChunk?: IOnTextChunk,
  123. onTextReplace?: IOnTextReplace,
  124. ) => {
  125. if (!response.ok)
  126. throw new Error('Network response was not ok')
  127. const reader = response.body?.getReader()
  128. const decoder = new TextDecoder('utf-8')
  129. let buffer = ''
  130. let bufferObj: Record<string, any>
  131. let isFirstMessage = true
  132. function read() {
  133. let hasError = false
  134. reader?.read().then((result: any) => {
  135. if (result.done) {
  136. onCompleted && onCompleted()
  137. return
  138. }
  139. buffer += decoder.decode(result.value, { stream: true })
  140. const lines = buffer.split('\n')
  141. try {
  142. lines.forEach((message) => {
  143. if (message.startsWith('data: ')) { // check if it starts with data:
  144. try {
  145. bufferObj = JSON.parse(message.substring(6)) as Record<string, any>// remove data: and parse as json
  146. }
  147. catch (e) {
  148. // mute handle message cut off
  149. onData('', isFirstMessage, {
  150. conversationId: bufferObj?.conversation_id,
  151. messageId: bufferObj?.message_id,
  152. })
  153. return
  154. }
  155. if (bufferObj.status === 400 || !bufferObj.event) {
  156. onData('', false, {
  157. conversationId: undefined,
  158. messageId: '',
  159. errorMessage: bufferObj?.message,
  160. errorCode: bufferObj?.code,
  161. })
  162. hasError = true
  163. onCompleted?.(true, bufferObj?.message)
  164. return
  165. }
  166. if (bufferObj.event === 'message' || bufferObj.event === 'agent_message') {
  167. // can not use format here. Because message is splited.
  168. onData(unicodeToChar(bufferObj.answer), isFirstMessage, {
  169. conversationId: bufferObj.conversation_id,
  170. taskId: bufferObj.task_id,
  171. messageId: bufferObj.id,
  172. })
  173. isFirstMessage = false
  174. }
  175. else if (bufferObj.event === 'agent_thought') {
  176. onThought?.(bufferObj as ThoughtItem)
  177. }
  178. else if (bufferObj.event === 'message_file') {
  179. onFile?.(bufferObj as VisionFile)
  180. }
  181. else if (bufferObj.event === 'message_end') {
  182. onMessageEnd?.(bufferObj as MessageEnd)
  183. }
  184. else if (bufferObj.event === 'message_replace') {
  185. onMessageReplace?.(bufferObj as MessageReplace)
  186. }
  187. else if (bufferObj.event === 'workflow_started') {
  188. onWorkflowStarted?.(bufferObj as WorkflowStartedResponse)
  189. }
  190. else if (bufferObj.event === 'workflow_finished') {
  191. onWorkflowFinished?.(bufferObj as WorkflowFinishedResponse)
  192. }
  193. else if (bufferObj.event === 'node_started') {
  194. onNodeStarted?.(bufferObj as NodeStartedResponse)
  195. }
  196. else if (bufferObj.event === 'node_finished') {
  197. onNodeFinished?.(bufferObj as NodeFinishedResponse)
  198. }
  199. else if (bufferObj.event === 'iteration_started') {
  200. onIterationStart?.(bufferObj as IterationStartedResponse)
  201. }
  202. else if (bufferObj.event === 'iteration_next') {
  203. onIterationNext?.(bufferObj as IterationNextedResponse)
  204. }
  205. else if (bufferObj.event === 'iteration_completed') {
  206. onIterationFinish?.(bufferObj as IterationFinishedResponse)
  207. }
  208. else if (bufferObj.event === 'text_chunk') {
  209. onTextChunk?.(bufferObj as TextChunkResponse)
  210. }
  211. else if (bufferObj.event === 'text_replace') {
  212. onTextReplace?.(bufferObj as TextReplaceResponse)
  213. }
  214. }
  215. })
  216. buffer = lines[lines.length - 1]
  217. }
  218. catch (e) {
  219. onData('', false, {
  220. conversationId: undefined,
  221. messageId: '',
  222. errorMessage: `${e}`,
  223. })
  224. hasError = true
  225. onCompleted?.(true, e as string)
  226. return
  227. }
  228. if (!hasError)
  229. read()
  230. })
  231. }
  232. read()
  233. }
  234. const baseFetch = <T>(
  235. url: string,
  236. fetchOptions: FetchOptionType,
  237. {
  238. isPublicAPI = false,
  239. bodyStringify = true,
  240. needAllResponseContent,
  241. deleteContentType,
  242. getAbortController,
  243. silent,
  244. }: IOtherOptions,
  245. ): Promise<T> => {
  246. const options: typeof baseOptions & FetchOptionType = Object.assign({}, baseOptions, fetchOptions)
  247. if (getAbortController) {
  248. const abortController = new AbortController()
  249. getAbortController(abortController)
  250. options.signal = abortController.signal
  251. }
  252. if (isPublicAPI) {
  253. const sharedToken = globalThis.location.pathname.split('/').slice(-1)[0]
  254. const accessToken = localStorage.getItem('token') || JSON.stringify({ [sharedToken]: '' })
  255. let accessTokenJson = { [sharedToken]: '' }
  256. try {
  257. accessTokenJson = JSON.parse(accessToken)
  258. }
  259. catch (e) {
  260. }
  261. options.headers.set('Authorization', `Bearer ${accessTokenJson[sharedToken]}`)
  262. }
  263. else {
  264. const accessToken = localStorage.getItem('console_token') || ''
  265. options.headers.set('Authorization', `Bearer ${accessToken}`)
  266. }
  267. if (deleteContentType) {
  268. options.headers.delete('Content-Type')
  269. }
  270. else {
  271. const contentType = options.headers.get('Content-Type')
  272. if (!contentType)
  273. options.headers.set('Content-Type', ContentType.json)
  274. }
  275. const urlPrefix = isPublicAPI ? PUBLIC_API_PREFIX : API_PREFIX
  276. let urlWithPrefix = `${urlPrefix}${url.startsWith('/') ? url : `/${url}`}`
  277. const { method, params, body } = options
  278. // handle query
  279. if (method === 'GET' && params) {
  280. const paramsArray: string[] = []
  281. Object.keys(params).forEach(key =>
  282. paramsArray.push(`${key}=${encodeURIComponent(params[key])}`),
  283. )
  284. if (urlWithPrefix.search(/\?/) === -1)
  285. urlWithPrefix += `?${paramsArray.join('&')}`
  286. else
  287. urlWithPrefix += `&${paramsArray.join('&')}`
  288. delete options.params
  289. }
  290. if (body && bodyStringify)
  291. options.body = JSON.stringify(body)
  292. // Handle timeout
  293. return Promise.race([
  294. new Promise((resolve, reject) => {
  295. setTimeout(() => {
  296. reject(new Error('request timeout'))
  297. }, TIME_OUT)
  298. }),
  299. new Promise((resolve, reject) => {
  300. globalThis.fetch(urlWithPrefix, options as RequestInit)
  301. .then((res) => {
  302. const resClone = res.clone()
  303. // Error handler
  304. if (!/^(2|3)\d{2}$/.test(String(res.status))) {
  305. const bodyJson = res.json()
  306. switch (res.status) {
  307. case 401: {
  308. if (isPublicAPI) {
  309. return bodyJson.then((data: ResponseError) => {
  310. if (!silent)
  311. Toast.notify({ type: 'error', message: data.message })
  312. if (data.code === 'web_sso_auth_required')
  313. requiredWebSSOLogin()
  314. if (data.code === 'unauthorized') {
  315. removeAccessToken()
  316. globalThis.location.reload()
  317. }
  318. return Promise.reject(data)
  319. })
  320. }
  321. const loginUrl = `${globalThis.location.origin}/signin`
  322. bodyJson.then((data: ResponseError) => {
  323. if (data.code === 'init_validate_failed' && IS_CE_EDITION && !silent)
  324. Toast.notify({ type: 'error', message: data.message, duration: 4000 })
  325. else if (data.code === 'not_init_validated' && IS_CE_EDITION)
  326. globalThis.location.href = `${globalThis.location.origin}/init`
  327. else if (data.code === 'not_setup' && IS_CE_EDITION)
  328. globalThis.location.href = `${globalThis.location.origin}/install`
  329. else if (location.pathname !== '/signin' || !IS_CE_EDITION)
  330. globalThis.location.href = loginUrl
  331. else if (!silent)
  332. Toast.notify({ type: 'error', message: data.message })
  333. }).catch(() => {
  334. // Handle any other errors
  335. globalThis.location.href = loginUrl
  336. })
  337. break
  338. }
  339. case 403:
  340. bodyJson.then((data: ResponseError) => {
  341. if (!silent)
  342. Toast.notify({ type: 'error', message: data.message })
  343. if (data.code === 'already_setup')
  344. globalThis.location.href = `${globalThis.location.origin}/signin`
  345. })
  346. break
  347. // fall through
  348. default:
  349. bodyJson.then((data: ResponseError) => {
  350. if (!silent)
  351. Toast.notify({ type: 'error', message: data.message })
  352. })
  353. }
  354. return Promise.reject(resClone)
  355. }
  356. // handle delete api. Delete api not return content.
  357. if (res.status === 204) {
  358. resolve({ result: 'success' })
  359. return
  360. }
  361. // return data
  362. const data: Promise<T> = options.headers.get('Content-type') === ContentType.download ? res.blob() : res.json()
  363. resolve(needAllResponseContent ? resClone : data)
  364. })
  365. .catch((err) => {
  366. if (!silent)
  367. Toast.notify({ type: 'error', message: err })
  368. reject(err)
  369. })
  370. }),
  371. ]) as Promise<T>
  372. }
  373. export const upload = (options: any, isPublicAPI?: boolean, url?: string, searchParams?: string): Promise<any> => {
  374. const urlPrefix = isPublicAPI ? PUBLIC_API_PREFIX : API_PREFIX
  375. let token = ''
  376. if (isPublicAPI) {
  377. const sharedToken = globalThis.location.pathname.split('/').slice(-1)[0]
  378. const accessToken = localStorage.getItem('token') || JSON.stringify({ [sharedToken]: '' })
  379. let accessTokenJson = { [sharedToken]: '' }
  380. try {
  381. accessTokenJson = JSON.parse(accessToken)
  382. }
  383. catch (e) {
  384. }
  385. token = accessTokenJson[sharedToken]
  386. }
  387. else {
  388. const accessToken = localStorage.getItem('console_token') || ''
  389. token = accessToken
  390. }
  391. const defaultOptions = {
  392. method: 'POST',
  393. url: (url ? `${urlPrefix}${url}` : `${urlPrefix}/files/upload`) + (searchParams || ''),
  394. headers: {
  395. Authorization: `Bearer ${token}`,
  396. },
  397. data: {},
  398. }
  399. options = {
  400. ...defaultOptions,
  401. ...options,
  402. headers: { ...defaultOptions.headers, ...options.headers },
  403. }
  404. return new Promise((resolve, reject) => {
  405. const xhr = options.xhr
  406. xhr.open(options.method, options.url)
  407. for (const key in options.headers)
  408. xhr.setRequestHeader(key, options.headers[key])
  409. xhr.withCredentials = true
  410. xhr.responseType = 'json'
  411. xhr.onreadystatechange = function () {
  412. if (xhr.readyState === 4) {
  413. if (xhr.status === 201)
  414. resolve(xhr.response)
  415. else
  416. reject(xhr)
  417. }
  418. }
  419. xhr.upload.onprogress = options.onprogress
  420. xhr.send(options.data)
  421. })
  422. }
  423. export const ssePost = (
  424. url: string,
  425. fetchOptions: FetchOptionType,
  426. {
  427. isPublicAPI = false,
  428. onData,
  429. onCompleted,
  430. onThought,
  431. onFile,
  432. onMessageEnd,
  433. onMessageReplace,
  434. onWorkflowStarted,
  435. onWorkflowFinished,
  436. onNodeStarted,
  437. onNodeFinished,
  438. onIterationStart,
  439. onIterationNext,
  440. onIterationFinish,
  441. onTextChunk,
  442. onTextReplace,
  443. onError,
  444. getAbortController,
  445. }: IOtherOptions,
  446. ) => {
  447. const abortController = new AbortController()
  448. const options = Object.assign({}, baseOptions, {
  449. method: 'POST',
  450. signal: abortController.signal,
  451. }, fetchOptions)
  452. const contentType = options.headers.get('Content-Type')
  453. if (!contentType)
  454. options.headers.set('Content-Type', ContentType.json)
  455. getAbortController?.(abortController)
  456. const urlPrefix = isPublicAPI ? PUBLIC_API_PREFIX : API_PREFIX
  457. const urlWithPrefix = `${urlPrefix}${url.startsWith('/') ? url : `/${url}`}`
  458. const { body } = options
  459. if (body)
  460. options.body = JSON.stringify(body)
  461. globalThis.fetch(urlWithPrefix, options as RequestInit)
  462. .then((res) => {
  463. if (!/^(2|3)\d{2}$/.test(String(res.status))) {
  464. res.json().then((data: any) => {
  465. Toast.notify({ type: 'error', message: data.message || 'Server Error' })
  466. if (isPublicAPI) {
  467. if (data.code === 'web_sso_auth_required')
  468. requiredWebSSOLogin()
  469. if (data.code === 'unauthorized') {
  470. removeAccessToken()
  471. globalThis.location.reload()
  472. }
  473. }
  474. })
  475. onError?.('Server Error')
  476. return
  477. }
  478. return handleStream(res, (str: string, isFirstMessage: boolean, moreInfo: IOnDataMoreInfo) => {
  479. if (moreInfo.errorMessage) {
  480. onError?.(moreInfo.errorMessage, moreInfo.errorCode)
  481. if (moreInfo.errorMessage !== 'AbortError: The user aborted a request.')
  482. Toast.notify({ type: 'error', message: moreInfo.errorMessage })
  483. return
  484. }
  485. onData?.(str, isFirstMessage, moreInfo)
  486. }, onCompleted, onThought, onMessageEnd, onMessageReplace, onFile, onWorkflowStarted, onWorkflowFinished, onNodeStarted, onNodeFinished, onIterationStart, onIterationNext, onIterationFinish, onTextChunk, onTextReplace)
  487. }).catch((e) => {
  488. if (e.toString() !== 'AbortError: The user aborted a request.')
  489. Toast.notify({ type: 'error', message: e })
  490. onError?.(e)
  491. })
  492. }
  493. // base request
  494. export const request = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  495. return baseFetch<T>(url, options, otherOptions || {})
  496. }
  497. // request methods
  498. export const get = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  499. return request<T>(url, Object.assign({}, options, { method: 'GET' }), otherOptions)
  500. }
  501. // For public API
  502. export const getPublic = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  503. return get<T>(url, options, { ...otherOptions, isPublicAPI: true })
  504. }
  505. export const post = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  506. return request<T>(url, Object.assign({}, options, { method: 'POST' }), otherOptions)
  507. }
  508. export const postPublic = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  509. return post<T>(url, options, { ...otherOptions, isPublicAPI: true })
  510. }
  511. export const put = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  512. return request<T>(url, Object.assign({}, options, { method: 'PUT' }), otherOptions)
  513. }
  514. export const putPublic = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  515. return put<T>(url, options, { ...otherOptions, isPublicAPI: true })
  516. }
  517. export const del = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  518. return request<T>(url, Object.assign({}, options, { method: 'DELETE' }), otherOptions)
  519. }
  520. export const delPublic = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  521. return del<T>(url, options, { ...otherOptions, isPublicAPI: true })
  522. }
  523. export const patch = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  524. return request<T>(url, Object.assign({}, options, { method: 'PATCH' }), otherOptions)
  525. }
  526. export const patchPublic = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
  527. return patch<T>(url, options, { ...otherOptions, isPublicAPI: true })
  528. }