FEAT: NEW WORKFLOW ENGINE (#3160)

Co-authored-by: Joel <iamjoel007@gmail.com> Co-authored-by: Yeuoly <admin@srmxy.cn> Co-authored-by: JzoNg <jzongcode@gmail.com> Co-authored-by: StyleZhang <jasonapring2015@outlook.com> Co-authored-by: jyong <jyong@dify.ai> Co-authored-by: nite-knite <nkCoding@gmail.com> Co-authored-by: jyong <718720800@qq.com>
2024-04-08 18:51:46 +08:00
parent 2fb9850af5
commit 7753ba2d37
1161 changed files with 103836 additions and 10327 deletions
--- a/web/service/apps.ts
+++ b/web/service/apps.ts
@@ -1,6 +1,6 @@
 import type { Fetcher } from 'swr'
-import { del, get, post } from './base'
-import type { ApikeysListResponse, AppDailyConversationsResponse, AppDailyEndUsersResponse, AppDetailResponse, AppListResponse, AppStatisticsResponse, AppTemplatesResponse, AppTokenCostsResponse, AppVoicesListResponse, CreateApiKeyResponse, GenerationIntroductionResponse, UpdateAppModelConfigResponse, UpdateAppSiteCodeResponse, UpdateOpenAIKeyResponse, ValidateOpenAIKeyResponse } from '@/models/app'
+import { del, get, post, put } from './base'
+import type { ApikeysListResponse, AppDailyConversationsResponse, AppDailyEndUsersResponse, AppDetailResponse, AppListResponse, AppStatisticsResponse, AppTemplatesResponse, AppTokenCostsResponse, AppVoicesListResponse, CreateApiKeyResponse, GenerationIntroductionResponse, UpdateAppModelConfigResponse, UpdateAppSiteCodeResponse, UpdateOpenAIKeyResponse, ValidateOpenAIKeyResponse, WorkflowDailyConversationsResponse } from '@/models/app'
 import type { CommonResponse } from '@/models/common'
 import type { AppMode, ModelConfig } from '@/types/app'

@@ -16,8 +16,28 @@ export const fetchAppTemplates: Fetcher<AppTemplatesResponse, { url: string }> =
  return get<AppTemplatesResponse>(url)
 }

-export const createApp: Fetcher<AppDetailResponse, { name: string; icon: string; icon_background: string; mode: AppMode; config?: ModelConfig }> = ({ name, icon, icon_background, mode, config }) => {
-  return post<AppDetailResponse>('apps', { body: { name, icon, icon_background, mode, model_config: config } })
+export const createApp: Fetcher<AppDetailResponse, { name: string; icon: string; icon_background: string; mode: AppMode; description?: string; config?: ModelConfig }> = ({ name, icon, icon_background, mode, description, config }) => {
+  return post<AppDetailResponse>('apps', { body: { name, icon, icon_background, mode, description, model_config: config } })
+}
+
+export const updateAppInfo: Fetcher<AppDetailResponse, { appID: string; name: string; icon: string; icon_background: string; description: string }> = ({ appID, name, icon, icon_background, description }) => {
+  return put<AppDetailResponse>(`apps/${appID}`, { body: { name, icon, icon_background, description } })
+}
+
+export const copyApp: Fetcher<AppDetailResponse, { appID: string; name: string; icon: string; icon_background: string; mode: AppMode; description?: string }> = ({ appID, name, icon, icon_background, mode, description }) => {
+  return post<AppDetailResponse>(`apps/${appID}/copy`, { body: { name, icon, icon_background, mode, description } })
+}
+
+export const exportAppConfig: Fetcher<{ data: string }, string> = (appID) => {
+  return get<{ data: string }>(`apps/${appID}/export`)
+}
+
+export const importApp: Fetcher<AppDetailResponse, { data: string; name?: string; description?: string; icon?: string; icon_background?: string }> = ({ data, name, description, icon, icon_background }) => {
+  return post<AppDetailResponse>('apps/import', { body: { data, name, description, icon, icon_background } })
+}
+
+export const switchApp: Fetcher<{ new_app_id: string }, { appID: string; name: string; icon: string; icon_background: string }> = ({ appID, name, icon, icon_background }) => {
+  return post<{ new_app_id: string }>(`apps/${appID}/convert-to-workflow`, { body: { name, icon, icon_background } })
 }

 export const deleteApp: Fetcher<CommonResponse, string> = (appID) => {
@@ -49,6 +69,10 @@ export const getAppDailyConversations: Fetcher<AppDailyConversationsResponse, {
  return get<AppDailyConversationsResponse>(url, { params })
 }

+export const getWorkflowDailyConversations: Fetcher<WorkflowDailyConversationsResponse, { url: string; params: Record<string, any> }> = ({ url, params }) => {
+  return get<WorkflowDailyConversationsResponse>(url, { params })
+}
+
 export const getAppStatistics: Fetcher<AppStatisticsResponse, { url: string; params: Record<string, any> }> = ({ url, params }) => {
  return get<AppStatisticsResponse>(url, { params })
 }
--- a/web/service/base.ts
+++ b/web/service/base.ts
@@ -2,6 +2,14 @@ import { API_PREFIX, IS_CE_EDITION, PUBLIC_API_PREFIX } from '@/config'
 import Toast from '@/app/components/base/toast'
 import type { AnnotationReply, MessageEnd, MessageReplace, ThoughtItem } from '@/app/components/app/chat/type'
 import type { VisionFile } from '@/types/app'
+import type {
+  NodeFinishedResponse,
+  NodeStartedResponse,
+  TextChunkResponse,
+  TextReplaceResponse,
+  WorkflowFinishedResponse,
+  WorkflowStartedResponse,
+} from '@/types/workflow'
 const TIME_OUT = 100000

 const ContentType = {
@@ -36,14 +44,22 @@ export type IOnFile = (file: VisionFile) => void
 export type IOnMessageEnd = (messageEnd: MessageEnd) => void
 export type IOnMessageReplace = (messageReplace: MessageReplace) => void
 export type IOnAnnotationReply = (messageReplace: AnnotationReply) => void
-export type IOnCompleted = (hasError?: boolean) => void
+export type IOnCompleted = (hasError?: boolean, errorMessage?: string) => void
 export type IOnError = (msg: string, code?: string) => void

-type IOtherOptions = {
+export type IOnWorkflowStarted = (workflowStarted: WorkflowStartedResponse) => void
+export type IOnWorkflowFinished = (workflowFinished: WorkflowFinishedResponse) => void
+export type IOnNodeStarted = (nodeStarted: NodeStartedResponse) => void
+export type IOnNodeFinished = (nodeFinished: NodeFinishedResponse) => void
+export type IOnTextChunk = (textChunk: TextChunkResponse) => void
+export type IOnTextReplace = (textReplace: TextReplaceResponse) => void
+
+export type IOtherOptions = {
  isPublicAPI?: boolean
  bodyStringify?: boolean
  needAllResponseContent?: boolean
  deleteContentType?: boolean
+  silent?: boolean
  onData?: IOnData // for stream
  onThought?: IOnThought
  onFile?: IOnFile
@@ -52,6 +68,13 @@ type IOtherOptions = {
  onError?: IOnError
  onCompleted?: IOnCompleted // for stream
  getAbortController?: (abortController: AbortController) => void
+
+  onWorkflowStarted?: IOnWorkflowStarted
+  onWorkflowFinished?: IOnWorkflowFinished
+  onNodeStarted?: IOnNodeStarted
+  onNodeFinished?: IOnNodeFinished
+  onTextChunk?: IOnTextChunk
+  onTextReplace?: IOnTextReplace
 }

 type ResponseError = {
@@ -82,7 +105,21 @@ export function format(text: string) {
  return res.replaceAll('\n', '<br/>').replaceAll('```', '')
 }

-const handleStream = (response: Response, onData: IOnData, onCompleted?: IOnCompleted, onThought?: IOnThought, onMessageEnd?: IOnMessageEnd, onMessageReplace?: IOnMessageReplace, onFile?: IOnFile) => {
+const handleStream = (
+  response: Response,
+  onData: IOnData,
+  onCompleted?: IOnCompleted,
+  onThought?: IOnThought,
+  onMessageEnd?: IOnMessageEnd,
+  onMessageReplace?: IOnMessageReplace,
+  onFile?: IOnFile,
+  onWorkflowStarted?: IOnWorkflowStarted,
+  onWorkflowFinished?: IOnWorkflowFinished,
+  onNodeStarted?: IOnNodeStarted,
+  onNodeFinished?: IOnNodeFinished,
+  onTextChunk?: IOnTextChunk,
+  onTextReplace?: IOnTextReplace,
+) => {
  if (!response.ok)
    throw new Error('Network response was not ok')

@@ -122,7 +159,7 @@ const handleStream = (response: Response, onData: IOnData, onCompleted?: IOnComp
                errorCode: bufferObj?.code,
              })
              hasError = true
-              onCompleted?.(true)
+              onCompleted?.(true, bufferObj?.message)
              return
            }
            if (bufferObj.event === 'message' || bufferObj.event === 'agent_message') {
@@ -146,6 +183,24 @@ const handleStream = (response: Response, onData: IOnData, onCompleted?: IOnComp
            else if (bufferObj.event === 'message_replace') {
              onMessageReplace?.(bufferObj as MessageReplace)
            }
+            else if (bufferObj.event === 'workflow_started') {
+              onWorkflowStarted?.(bufferObj as WorkflowStartedResponse)
+            }
+            else if (bufferObj.event === 'workflow_finished') {
+              onWorkflowFinished?.(bufferObj as WorkflowFinishedResponse)
+            }
+            else if (bufferObj.event === 'node_started') {
+              onNodeStarted?.(bufferObj as NodeStartedResponse)
+            }
+            else if (bufferObj.event === 'node_finished') {
+              onNodeFinished?.(bufferObj as NodeFinishedResponse)
+            }
+            else if (bufferObj.event === 'text_chunk') {
+              onTextChunk?.(bufferObj as TextChunkResponse)
+            }
+            else if (bufferObj.event === 'text_replace') {
+              onTextReplace?.(bufferObj as TextReplaceResponse)
+            }
          }
        })
        buffer = lines[lines.length - 1]
@@ -157,7 +212,7 @@ const handleStream = (response: Response, onData: IOnData, onCompleted?: IOnComp
          errorMessage: `${e}`,
        })
        hasError = true
-        onCompleted?.(true)
+        onCompleted?.(true, e as string)
        return
      }
      if (!hasError)
@@ -176,6 +231,7 @@ const baseFetch = <T>(
    needAllResponseContent,
    deleteContentType,
    getAbortController,
+    silent,
  }: IOtherOptions,
 ): Promise<T> => {
  const options: typeof baseOptions & FetchOptionType = Object.assign({}, baseOptions, fetchOptions)
@@ -250,13 +306,14 @@ const baseFetch = <T>(
              case 401: {
                if (isPublicAPI) {
                  return bodyJson.then((data: ResponseError) => {
-                    Toast.notify({ type: 'error', message: data.message })
+                    if (!silent)
+                      Toast.notify({ type: 'error', message: data.message })
                    return Promise.reject(data)
                  })
                }
                const loginUrl = `${globalThis.location.origin}/signin`
                bodyJson.then((data: ResponseError) => {
-                  if (data.code === 'init_validate_failed' && IS_CE_EDITION)
+                  if (data.code === 'init_validate_failed' && IS_CE_EDITION && !silent)
                    Toast.notify({ type: 'error', message: data.message, duration: 4000 })
                  else if (data.code === 'not_init_validated' && IS_CE_EDITION)
                    globalThis.location.href = `${globalThis.location.origin}/init`
@@ -264,7 +321,7 @@ const baseFetch = <T>(
                    globalThis.location.href = `${globalThis.location.origin}/install`
                  else if (location.pathname !== '/signin' || !IS_CE_EDITION)
                    globalThis.location.href = loginUrl
-                  else
+                  else if (!silent)
                    Toast.notify({ type: 'error', message: data.message })
                }).catch(() => {
                  // Handle any other errors
@@ -275,7 +332,8 @@ const baseFetch = <T>(
              }
              case 403:
                bodyJson.then((data: ResponseError) => {
-                  Toast.notify({ type: 'error', message: data.message })
+                  if (!silent)
+                    Toast.notify({ type: 'error', message: data.message })
                  if (data.code === 'already_setup')
                    globalThis.location.href = `${globalThis.location.origin}/signin`
                })
@@ -283,7 +341,8 @@ const baseFetch = <T>(
              // fall through
              default:
                bodyJson.then((data: ResponseError) => {
-                  Toast.notify({ type: 'error', message: data.message })
+                  if (!silent)
+                    Toast.notify({ type: 'error', message: data.message })
                })
            }
            return Promise.reject(resClone)
@@ -301,7 +360,8 @@ const baseFetch = <T>(
          resolve(needAllResponseContent ? resClone : data)
        })
        .catch((err) => {
-          Toast.notify({ type: 'error', message: err })
+          if (!silent)
+            Toast.notify({ type: 'error', message: err })
          reject(err)
        })
    }),
@@ -361,7 +421,27 @@ export const upload = (options: any, isPublicAPI?: boolean, url?: string, search
  })
 }

-export const ssePost = (url: string, fetchOptions: FetchOptionType, { isPublicAPI = false, onData, onCompleted, onThought, onFile, onMessageEnd, onMessageReplace, onError, getAbortController }: IOtherOptions) => {
+export const ssePost = (
+  url: string,
+  fetchOptions: FetchOptionType,
+  {
+    isPublicAPI = false,
+    onData,
+    onCompleted,
+    onThought,
+    onFile,
+    onMessageEnd,
+    onMessageReplace,
+    onWorkflowStarted,
+    onWorkflowFinished,
+    onNodeStarted,
+    onNodeFinished,
+    onTextChunk,
+    onTextReplace,
+    onError,
+    getAbortController,
+  }: IOtherOptions,
+) => {
  const abortController = new AbortController()

  const options = Object.assign({}, baseOptions, {
@@ -399,7 +479,7 @@ export const ssePost = (url: string, fetchOptions: FetchOptionType, { isPublicAP
          return
        }
        onData?.(str, isFirstMessage, moreInfo)
-      }, onCompleted, onThought, onMessageEnd, onMessageReplace, onFile)
+      }, onCompleted, onThought, onMessageEnd, onMessageReplace, onFile, onWorkflowStarted, onWorkflowFinished, onNodeStarted, onNodeFinished, onTextChunk, onTextReplace)
    }).catch((e) => {
      if (e.toString() !== 'AbortError: The user aborted a request.')
        Toast.notify({ type: 'error', message: e })
--- a/web/service/debug.ts
+++ b/web/service/debug.ts
@@ -99,5 +99,5 @@ export const fetchTextGenerationMessge = ({
  appId,
  messageId,
 }: { appId: string; messageId: string }) => {
-  return get<Promise<{ message: [] }>>(`/apps/${appId}/messages/${messageId}`)
+  return get<Promise<any>>(`/apps/${appId}/messages/${messageId}`)
 }
--- a/web/service/log.ts
+++ b/web/service/log.ts
@@ -15,7 +15,11 @@ import type {
  LogMessageAnnotationsResponse,
  LogMessageFeedbacksRequest,
  LogMessageFeedbacksResponse,
+  WorkflowLogsRequest,
+  WorkflowLogsResponse,
+  WorkflowRunDetailResponse,
 } from '@/models/log'
+import type { NodeTracingListResponse } from '@/types/workflow'

 export const fetchConversationList: Fetcher<ConversationListResponse, { name: string; appId: string; params?: Record<string, any> }> = ({ appId, params }) => {
  return get<ConversationListResponse>(`/console/api/apps/${appId}/messages`, params)
@@ -57,3 +61,15 @@ export const updateLogMessageAnnotations: Fetcher<LogMessageAnnotationsResponse,
 export const fetchAnnotationsCount: Fetcher<AnnotationsCountResponse, { url: string }> = ({ url }) => {
  return get<AnnotationsCountResponse>(url)
 }
+
+export const fetchWorkflowLogs: Fetcher<WorkflowLogsResponse, { url: string; params?: WorkflowLogsRequest }> = ({ url, params }) => {
+  return get<WorkflowLogsResponse>(url, { params })
+}
+
+export const fetchRunDetail = ({ appID, runID }: { appID: string; runID: string }) => {
+  return get<WorkflowRunDetailResponse>(`/apps/${appID}/workflow-runs/${runID}`)
+}
+
+export const fetchTracingList: Fetcher<NodeTracingListResponse, { url: string }> = ({ url }) => {
+  return get<NodeTracingListResponse>(url)
+}
--- a/web/service/share.ts
+++ b/web/service/share.ts
@@ -1,4 +1,4 @@
-import type { IOnCompleted, IOnData, IOnError, IOnFile, IOnMessageEnd, IOnMessageReplace, IOnThought } from './base'
+import type { IOnCompleted, IOnData, IOnError, IOnFile, IOnMessageEnd, IOnMessageReplace, IOnNodeFinished, IOnNodeStarted, IOnThought, IOnWorkflowFinished, IOnWorkflowStarted } from './base'
 import {
  del as consoleDel, get as consoleGet, patch as consolePatch, post as consolePost,
  delPublic as del, getPublic as get, patchPublic as patch, postPublic as post, ssePost,
@@ -65,6 +65,30 @@ export const sendCompletionMessage = async (body: Record<string, any>, { onData,
  }, { onData, onCompleted, isPublicAPI: !isInstalledApp, onError, onMessageReplace })
 }

+export const sendWorkflowMessage = async (
+  body: Record<string, any>,
+  {
+    onWorkflowStarted,
+    onNodeStarted,
+    onNodeFinished,
+    onWorkflowFinished,
+  }: {
+    onWorkflowStarted: IOnWorkflowStarted
+    onNodeStarted: IOnNodeStarted
+    onNodeFinished: IOnNodeFinished
+    onWorkflowFinished: IOnWorkflowFinished
+  },
+  isInstalledApp: boolean,
+  installedAppId = '',
+) => {
+  return ssePost(getUrl('workflows/run', isInstalledApp, installedAppId), {
+    body: {
+      ...body,
+      response_mode: 'streaming',
+    },
+  }, { onNodeStarted, onWorkflowStarted, onWorkflowFinished, isPublicAPI: !isInstalledApp, onNodeFinished })
+}
+
 export const fetchAppInfo = async () => {
  return get('/site') as Promise<AppData>
 }
--- a/web/service/tools.ts
+++ b/web/service/tools.ts
@@ -1,5 +1,6 @@
 import { get, post } from './base'
 import type { Collection, CustomCollectionBackend, CustomParamSchema, Tool, ToolCredential } from '@/app/components/tools/types'
+import type { ToolWithProvider } from '@/app/components/workflow/types'

 export const fetchCollectionList = () => {
  return get<Collection[]>('/workspaces/current/tool-providers')
@@ -21,6 +22,9 @@ export const fetchBuiltInToolCredentialSchema = (collectionName: string) => {
  return get<ToolCredential[]>(`/workspaces/current/tool-provider/builtin/${collectionName}/credentials_schema`)
 }

+export const fetchBuiltInToolCredential = (collectionName: string) => {
+  return get<ToolCredential[]>(`/workspaces/current/tool-provider/builtin/${collectionName}/credentials`)
+}
 export const updateBuiltInToolCredential = (collectionName: string, credential: Record<string, any>) => {
  return post(`/workspaces/current/tool-provider/builtin/${collectionName}/update`, {
    body: {
@@ -86,3 +90,11 @@ export const testAPIAvailable = (payload: any) => {
    },
  })
 }
+
+export const fetchAllBuiltInTools = () => {
+  return get<ToolWithProvider[]>('/workspaces/current/tools/builtin')
+}
+
+export const fetchAllCustomTools = () => {
+  return get<ToolWithProvider[]>('/workspaces/current/tools/api')
+}
--- a/web/service/workflow.ts
+++ b/web/service/workflow.ts
@@ -0,0 +1,52 @@
+import type { Fetcher } from 'swr'
+import { get, post } from './base'
+import type { CommonResponse } from '@/models/common'
+import type {
+  ChatRunHistoryResponse,
+  FetchWorkflowDraftResponse,
+  NodesDefaultConfigsResponse,
+  WorkflowRunHistoryResponse,
+} from '@/types/workflow'
+import type { BlockEnum } from '@/app/components/workflow/types'
+
+export const fetchWorkflowDraft: Fetcher<FetchWorkflowDraftResponse, string> = (url) => {
+  return get<FetchWorkflowDraftResponse>(url, {}, { silent: true })
+}
+
+export const syncWorkflowDraft = ({ url, params }: { url: string; params: Pick<FetchWorkflowDraftResponse, 'graph' | 'features'> }) => {
+  return post<CommonResponse & { updated_at: number }>(url, { body: params })
+}
+
+export const fetchNodesDefaultConfigs: Fetcher<NodesDefaultConfigsResponse, string> = (url) => {
+  return get<NodesDefaultConfigsResponse>(url)
+}
+
+export const fetchWorkflowRunHistory: Fetcher<WorkflowRunHistoryResponse, string> = (url) => {
+  return get<WorkflowRunHistoryResponse>(url)
+}
+
+export const fetcChatRunHistory: Fetcher<ChatRunHistoryResponse, string> = (url) => {
+  return get<ChatRunHistoryResponse>(url)
+}
+
+export const singleNodeRun = (appId: string, nodeId: string, params: object) => {
+  return post(`apps/${appId}/workflows/draft/nodes/${nodeId}/run`, { body: params })
+}
+
+export const publishWorkflow = (url: string) => {
+  return post<CommonResponse & { created_at: number }>(url)
+}
+
+export const fetchPublishedWorkflow: Fetcher<FetchWorkflowDraftResponse, string> = (url) => {
+  return get<FetchWorkflowDraftResponse>(url)
+}
+
+export const stopWorkflowRun = (url: string) => {
+  return post<CommonResponse>(url)
+}
+
+export const fetchNodeDefault = (appId: string, blockType: BlockEnum, query = {}) => {
+  return get(`apps/${appId}/workflows/default-workflow-block-configs/${blockType}`, {
+    params: { q: JSON.stringify(query) },
+  })
+}