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>

web/app/components/workflow/hooks/use-checklist.ts

@@ -0,0 +1,152 @@
+import {
+  useCallback,
+  useMemo,
+} from 'react'
+import { useTranslation } from 'react-i18next'
+import { useStoreApi } from 'reactflow'
+import type {
+  Edge,
+  Node,
+} from '../types'
+import { BlockEnum } from '../types'
+import { useStore } from '../store'
+import {
+  getToolCheckParams,
+  getValidTreeNodes,
+} from '../utils'
+import { MAX_TREE_DEEPTH } from '../constants'
+import type { ToolNodeType } from '../nodes/tool/types'
+import { useIsChatMode } from './use-workflow'
+import { useNodesExtraData } from './use-nodes-data'
+import { useToastContext } from '@/app/components/base/toast'
+import { CollectionType } from '@/app/components/tools/types'
+import { useGetLanguage } from '@/context/i18n'
+
+export const useChecklist = (nodes: Node[], edges: Edge[]) => {
+  const { t } = useTranslation()
+  const language = useGetLanguage()
+  const nodesExtraData = useNodesExtraData()
+  const isChatMode = useIsChatMode()
+  const buildInTools = useStore(s => s.buildInTools)
+  const customTools = useStore(s => s.customTools)
+
+  const needWarningNodes = useMemo(() => {
+    const list = []
+    const { validNodes } = getValidTreeNodes(nodes, edges)
+
+    for (let i = 0; i < nodes.length; i++) {
+      const node = nodes[i]
+      let toolIcon
+      let moreDataForCheckValid
+
+      if (node.data.type === BlockEnum.Tool) {
+        const { provider_type } = node.data
+        const isBuiltIn = provider_type === CollectionType.builtIn
+
+        moreDataForCheckValid = getToolCheckParams(node.data as ToolNodeType, buildInTools, customTools, language)
+        if (isBuiltIn)
+          toolIcon = buildInTools.find(tool => tool.id === node.data.provider_id)?.icon
+
+        if (!isBuiltIn)
+          toolIcon = customTools.find(tool => tool.id === node.data.provider_id)?.icon
+      }
+      const { errorMessage } = nodesExtraData[node.data.type].checkValid(node.data, t, moreDataForCheckValid)
+
+      if (errorMessage || !validNodes.find(n => n.id === node.id)) {
+        list.push({
+          id: node.id,
+          type: node.data.type,
+          title: node.data.title,
+          toolIcon,
+          unConnected: !validNodes.find(n => n.id === node.id),
+          errorMessage,
+        })
+      }
+    }
+
+    if (isChatMode && !nodes.find(node => node.data.type === BlockEnum.Answer)) {
+      list.push({
+        id: 'answer-need-added',
+        type: BlockEnum.Answer,
+        title: t('workflow.blocks.answer'),
+        errorMessage: t('workflow.common.needAnswerNode'),
+      })
+    }
+
+    if (!isChatMode && !nodes.find(node => node.data.type === BlockEnum.End)) {
+      list.push({
+        id: 'end-need-added',
+        type: BlockEnum.End,
+        title: t('workflow.blocks.end'),
+        errorMessage: t('workflow.common.needEndNode'),
+      })
+    }
+
+    return list
+  }, [t, nodes, edges, nodesExtraData, buildInTools, customTools, language, isChatMode])
+
+  return needWarningNodes
+}
+
+export const useChecklistBeforePublish = () => {
+  const { t } = useTranslation()
+  const language = useGetLanguage()
+  const buildInTools = useStore(s => s.buildInTools)
+  const customTools = useStore(s => s.customTools)
+  const { notify } = useToastContext()
+  const isChatMode = useIsChatMode()
+  const store = useStoreApi()
+  const nodesExtraData = useNodesExtraData()
+
+  const handleCheckBeforePublish = useCallback(() => {
+    const {
+      getNodes,
+      edges,
+    } = store.getState()
+    const nodes = getNodes()
+    const {
+      validNodes,
+      maxDepth,
+    } = getValidTreeNodes(nodes, edges)
+
+    if (maxDepth > MAX_TREE_DEEPTH) {
+      notify({ type: 'error', message: t('workflow.common.maxTreeDepth', { depth: MAX_TREE_DEEPTH }) })
+      return false
+    }
+
+    for (let i = 0; i < nodes.length; i++) {
+      const node = nodes[i]
+      let moreDataForCheckValid
+      if (node.data.type === BlockEnum.Tool)
+        moreDataForCheckValid = getToolCheckParams(node.data as ToolNodeType, buildInTools, customTools, language)
+
+      const { errorMessage } = nodesExtraData[node.data.type as BlockEnum].checkValid(node.data, t, moreDataForCheckValid)
+
+      if (errorMessage) {
+        notify({ type: 'error', message: `[${node.data.title}] ${errorMessage}` })
+        return false
+      }
+
+      if (!validNodes.find(n => n.id === node.id)) {
+        notify({ type: 'error', message: `[${node.data.title}] ${t('workflow.common.needConnecttip')}` })
+        return false
+      }
+    }
+
+    if (isChatMode && !nodes.find(node => node.data.type === BlockEnum.Answer)) {
+      notify({ type: 'error', message: t('workflow.common.needAnswerNode') })
+      return false
+    }
+
+    if (!isChatMode && !nodes.find(node => node.data.type === BlockEnum.End)) {
+      notify({ type: 'error', message: t('workflow.common.needEndNode') })
+      return false
+    }
+
+    return true
+  }, [nodesExtraData, notify, t, store, isChatMode, buildInTools, customTools, language])
+
+  return {
+    handleCheckBeforePublish,
+  }
+}