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/nodes/template-transform/default.ts

@@ -0,0 +1,38 @@
+import { BlockEnum } from '../../types'
+import type { NodeDefault } from '../../types'
+import type { TemplateTransformNodeType } from './types'
+import { ALL_CHAT_AVAILABLE_BLOCKS, ALL_COMPLETION_AVAILABLE_BLOCKS } from '@/app/components/workflow/constants'
+const i18nPrefix = 'workflow.errorMsg'
+
+const nodeDefault: NodeDefault<TemplateTransformNodeType> = {
+  defaultValue: {
+    variables: [],
+  },
+  getAvailablePrevNodes(isChatMode: boolean) {
+    const nodes = isChatMode
+      ? ALL_CHAT_AVAILABLE_BLOCKS
+      : ALL_COMPLETION_AVAILABLE_BLOCKS.filter(type => type !== BlockEnum.End)
+    return nodes
+  },
+  getAvailableNextNodes(isChatMode: boolean) {
+    const nodes = isChatMode ? ALL_CHAT_AVAILABLE_BLOCKS : ALL_COMPLETION_AVAILABLE_BLOCKS
+    return nodes
+  },
+  checkValid(payload: TemplateTransformNodeType, t: any) {
+    let errorMessages = ''
+    const { template, variables } = payload
+
+    if (!errorMessages && variables.filter(v => !v.variable).length > 0)
+      errorMessages = t(`${i18nPrefix}.fieldRequired`, { field: t(`${i18nPrefix}.fields.variable`) })
+    if (!errorMessages && variables.filter(v => !v.value_selector.length).length > 0)
+      errorMessages = t(`${i18nPrefix}.fieldRequired`, { field: t(`${i18nPrefix}.fields.variableValue`) })
+    if (!errorMessages && !template)
+      errorMessages = t(`${i18nPrefix}.fieldRequired`, { field: t('workflow.nodes.templateTransform.code') })
+    return {
+      isValid: !errorMessages,
+      errorMessage: errorMessages,
+    }
+  },
+}
+
+export default nodeDefault

web/app/components/workflow/nodes/template-transform/node.tsx

@@ -0,0 +1,13 @@
+import type { FC } from 'react'
+import React from 'react'
+import type { TemplateTransformNodeType } from './types'
+import type { NodeProps } from '@/app/components/workflow/types'
+
+const Node: FC<NodeProps<TemplateTransformNodeType>> = () => {
+  return (
+    // No summary content
+    <div></div>
+  )
+}
+
+export default React.memo(Node)

web/app/components/workflow/nodes/template-transform/panel.tsx

@@ -0,0 +1,119 @@
+import type { FC } from 'react'
+import React from 'react'
+import { useTranslation } from 'react-i18next'
+import { CodeLanguage } from '../code/types'
+import useConfig from './use-config'
+import type { TemplateTransformNodeType } from './types'
+import VarList from '@/app/components/workflow/nodes/_base/components/variable/var-list'
+import AddButton from '@/app/components/base/button/add-button'
+import Field from '@/app/components/workflow/nodes/_base/components/field'
+import Split from '@/app/components/workflow/nodes/_base/components/split'
+import CodeEditor from '@/app/components/workflow/nodes/_base/components/editor/code-editor'
+import OutputVars, { VarItem } from '@/app/components/workflow/nodes/_base/components/output-vars'
+import { HelpCircle } from '@/app/components/base/icons/src/vender/line/general'
+import type { NodePanelProps } from '@/app/components/workflow/types'
+import BeforeRunForm from '@/app/components/workflow/nodes/_base/components/before-run-form'
+import ResultPanel from '@/app/components/workflow/run/result-panel'
+
+const i18nPrefix = 'workflow.nodes.templateTransform'
+
+const Panel: FC<NodePanelProps<TemplateTransformNodeType>> = ({
+  id,
+  data,
+}) => {
+  const { t } = useTranslation()
+
+  const {
+    readOnly,
+    inputs,
+    handleVarListChange,
+    handleAddVariable,
+    handleCodeChange,
+    filterVar,
+    // single run
+    isShowSingleRun,
+    hideSingleRun,
+    runningStatus,
+    handleRun,
+    handleStop,
+    varInputs,
+    inputVarValues,
+    setInputVarValues,
+    runResult,
+  } = useConfig(id, data)
+
+  return (
+    <div className='mt-2'>
+      <div className='px-4 pb-4 space-y-4'>
+
+        <Field
+          title={t(`${i18nPrefix}.inputVars`)}
+          operations={
+            !readOnly ? <AddButton onClick={handleAddVariable} /> : undefined
+          }
+        >
+          <VarList
+            nodeId={id}
+            readonly={readOnly}
+            list={inputs.variables}
+            onChange={handleVarListChange}
+            filterVar={filterVar}
+          />
+        </Field>
+        <Split />
+        <CodeEditor
+          readOnly={readOnly}
+          language={CodeLanguage.python3}
+          title={
+            <div className='uppercase'>{t(`${i18nPrefix}.code`)}</div>
+          }
+          headerRight={
+            <div className='flex items-center'>
+              <a
+                className='flex items-center space-x-0.5 h-[18px] text-xs font-normal text-gray-500'
+                href="https://jinja.palletsprojects.com/en/3.1.x/templates/"
+                target='_blank'>
+                <span>{t(`${i18nPrefix}.codeSupportTip`)}</span>
+                <HelpCircle className='w-3 h-3' />
+              </a>
+              <div className='mx-1.5 w-px h-3 bg-gray-200'></div>
+            </div>
+          }
+          value={inputs.template}
+          onChange={handleCodeChange}
+        />
+      </div>
+      <Split />
+      <div className='px-4 pt-4 pb-2'>
+        <OutputVars>
+          <>
+            <VarItem
+              name='output'
+              type='string'
+              description={t(`${i18nPrefix}.outputVars.output`)}
+            />
+          </>
+        </OutputVars>
+      </div>
+      {isShowSingleRun && (
+        <BeforeRunForm
+          nodeName={inputs.title}
+          onHide={hideSingleRun}
+          forms={[
+            {
+              inputs: varInputs,
+              values: inputVarValues,
+              onChange: setInputVarValues,
+            },
+          ]}
+          runningStatus={runningStatus}
+          onRun={handleRun}
+          onStop={handleStop}
+          result={<ResultPanel {...runResult} showSteps={false} />}
+        />
+      )}
+    </div>
+  )
+}
+
+export default React.memo(Panel)

web/app/components/workflow/nodes/template-transform/types.ts

@@ -0,0 +1,6 @@
+import type { CommonNodeType, Variable } from '@/app/components/workflow/types'
+
+export type TemplateTransformNodeType = CommonNodeType & {
+  variables: Variable[]
+  template: string
+}

web/app/components/workflow/nodes/template-transform/use-config.ts

@@ -0,0 +1,100 @@
+import { useCallback, useEffect } from 'react'
+import produce from 'immer'
+import useVarList from '../_base/hooks/use-var-list'
+import type { Var } from '../../types'
+import { VarType } from '../../types'
+import { useStore } from '../../store'
+import type { TemplateTransformNodeType } from './types'
+import useNodeCrud from '@/app/components/workflow/nodes/_base/hooks/use-node-crud'
+import useOneStepRun from '@/app/components/workflow/nodes/_base/hooks/use-one-step-run'
+import {
+  useNodesReadOnly,
+} from '@/app/components/workflow/hooks'
+
+const useConfig = (id: string, payload: TemplateTransformNodeType) => {
+  const { nodesReadOnly: readOnly } = useNodesReadOnly()
+  const defaultConfig = useStore(s => s.nodesDefaultConfigs)[payload.type]
+
+  const { inputs, setInputs } = useNodeCrud<TemplateTransformNodeType>(id, payload)
+  const { handleVarListChange, handleAddVariable } = useVarList<TemplateTransformNodeType>({
+    inputs,
+    setInputs,
+  })
+
+  useEffect(() => {
+    if (inputs.template)
+      return
+
+    const isReady = defaultConfig && Object.keys(defaultConfig).length > 0
+    if (isReady) {
+      setInputs({
+        ...inputs,
+        ...defaultConfig,
+      })
+    }
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [defaultConfig])
+
+  const handleCodeChange = useCallback((template: string) => {
+    const newInputs = produce(inputs, (draft: any) => {
+      draft.template = template
+    })
+    setInputs(newInputs)
+  }, [inputs, setInputs])
+
+  // single run
+  const {
+    isShowSingleRun,
+    hideSingleRun,
+    toVarInputs,
+    runningStatus,
+    handleRun,
+    handleStop,
+    runInputData,
+    setRunInputData,
+    runResult,
+  } = useOneStepRun<TemplateTransformNodeType>({
+    id,
+    data: inputs,
+    defaultRunInputData: {},
+  })
+  const varInputs = toVarInputs(inputs.variables)
+
+  const inputVarValues = (() => {
+    const vars: Record<string, any> = {}
+    Object.keys(runInputData)
+      .forEach((key) => {
+        vars[key] = runInputData[key]
+      })
+    return vars
+  })()
+
+  const setInputVarValues = useCallback((newPayload: Record<string, any>) => {
+    setRunInputData(newPayload)
+  }, [setRunInputData])
+
+  const filterVar = useCallback((varPayload: Var) => {
+    return [VarType.string, VarType.number, VarType.object, VarType.array, VarType.arrayNumber, VarType.arrayString, VarType.arrayObject].includes(varPayload.type)
+  }, [])
+
+  return {
+    readOnly,
+    inputs,
+    handleVarListChange,
+    handleAddVariable,
+    handleCodeChange,
+    filterVar,
+    // single run
+    isShowSingleRun,
+    hideSingleRun,
+    runningStatus,
+    handleRun,
+    handleStop,
+    varInputs,
+    inputVarValues,
+    setInputVarValues,
+    runResult,
+  }
+}
+
+export default useConfig

web/app/components/workflow/nodes/template-transform/utils.ts

@@ -0,0 +1,5 @@
+import type { TemplateTransformNodeType } from './types'
+
+export const checkNodeValid = (payload: TemplateTransformNodeType) => {
+  return true
+}