Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

8.6 KB
Raw Blame
import type { ToolNodeType } from '../types'
import type { ResourceVarInputs } from '@/app/components/workflow/nodes/_base/types'
import type { InputVar } from '@/app/components/workflow/types'
import { useQueryClient } from '@tanstack/react-query'
import { capitalize } from 'es-toolkit/string'
import { produce } from 'immer'
import { useCallback, useEffect, useMemo, useState } from 'react'
import { useLanguage } from '@/app/components/header/account-setting/model-provider-page/hooks'
import { CollectionType } from '@/app/components/tools/types'
import {
  getConfiguredValue,
  toolParametersToFormSchemas,
} from '@/app/components/tools/utils/to-form-schema'
import { getToolListQueryKey } from '@/app/components/tools/utils/tool-list-query-key'
import useNodeCrud from '@/app/components/workflow/nodes/_base/hooks/use-node-crud'
import { useWorkflowStore } from '@/app/components/workflow/store'
import { updateBuiltInToolCredential } from '@/service/tools'
import { useNodesReadOnly } from '../../../hooks/use-workflow'
import { isToolAuthorizationRequired } from '../auth'
import { normalizeJsonSchemaType } from '../output-schema-utils'
import useCurrentToolCollection from './use-current-tool-collection'

const formatDisplayType = (output: Record<string, unknown>): string => {
  const normalizedType = normalizeJsonSchemaType(output) || 'Unknown'
  return capitalize(normalizedType)
}

const useConfig = (id: string, payload: ToolNodeType) => {
  const workflowStore = useWorkflowStore()
  const { nodesReadOnly: readOnly } = useNodesReadOnly()

  const language = useLanguage()
  const { inputs, setInputs: doSetInputs } = useNodeCrud<ToolNodeType>(id, payload)
  /*
   * tool_configurations: tool setting, not dynamic setting (form type = form)
   * tool_parameters: tool dynamic setting(form type = llm)
   */
  const { provider_id, provider_type, tool_name, tool_configurations, tool_parameters } = inputs
  const isBuiltIn = provider_type === CollectionType.builtIn
  const { currCollection } = useCurrentToolCollection(provider_type, provider_id)

  // Auth
  const isShowAuthBtn = isToolAuthorizationRequired(provider_type, currCollection)
  const [showSetAuth, setShowSetAuth] = useState(false)

  const queryClient = useQueryClient()
  const handleSaveAuth = useCallback(
    async (value: any) => {
      await updateBuiltInToolCredential(currCollection?.name as string, value)

      const toolListQueryKey = getToolListQueryKey(provider_type)
      if (toolListQueryKey) queryClient.invalidateQueries({ queryKey: toolListQueryKey })
      setShowSetAuth(false)
    },
    [currCollection?.name, provider_type, queryClient],
  )

  const currTool = useMemo(() => {
    return currCollection?.tools.find((tool) => tool.name === tool_name)
  }, [currCollection, tool_name])
  const formSchemas = useMemo(() => {
    return currTool ? toolParametersToFormSchemas(currTool.parameters) : []
  }, [currTool])
  const toolInputVarSchema = useMemo(() => {
    return formSchemas.filter((item) => item.form === 'llm')
  }, [formSchemas])
  // use setting
  const toolSettingSchema = useMemo(() => {
    return formSchemas.filter((item) => item.form !== 'llm')
  }, [formSchemas])
  const hasShouldTransferTypeSettingInput = toolSettingSchema.some(
    (item) => item.type === 'boolean' || item.type === 'number-input',
  )

  const setInputs = useCallback(
    (value: ToolNodeType) => {
      if (!hasShouldTransferTypeSettingInput) {
        doSetInputs(value)
        return
      }
      const newInputs = produce(value, (draft) => {
        const newConfig = { ...draft.tool_configurations }
        Object.keys(draft.tool_configurations).forEach((key) => {
          const schema = formSchemas.find((item) => item.variable === key)
          const value = newConfig[key]
          if (schema?.type === 'boolean') {
            if (typeof value === 'string') newConfig[key] = value === 'true' || value === '1'

            if (typeof value === 'number') newConfig[key] = value === 1
          }

          if (schema?.type === 'number-input') {
            if (typeof value === 'string' && value !== '') newConfig[key] = Number.parseFloat(value)
          }
        })
        draft.tool_configurations = newConfig
      })
      doSetInputs(newInputs)
    },
    [doSetInputs, formSchemas, hasShouldTransferTypeSettingInput],
  )
  const [notSetDefaultValue, setNotSetDefaultValue] = useState(false)
  const toolSettingValue = useMemo(() => {
    if (notSetDefaultValue) return tool_configurations
    return getConfiguredValue(tool_configurations, toolSettingSchema)
  }, [notSetDefaultValue, toolSettingSchema, tool_configurations])
  const setToolSettingValue = useCallback(
    (value: Record<string, any>) => {
      setNotSetDefaultValue(true)
      setInputs({
        ...inputs,
        tool_configurations: value,
      })
    },
    [inputs, setInputs],
  )

  const formattingParameters = useCallback(() => {
    const inputsWithDefaultValue = produce(inputs, (draft) => {
      if (!draft.tool_configurations || Object.keys(draft.tool_configurations).length === 0) {
        const configuredToolSettings = getConfiguredValue(
          tool_configurations,
          toolSettingSchema,
        ) as ResourceVarInputs
        if (Object.keys(configuredToolSettings).length > 0)
          draft.tool_configurations = configuredToolSettings
      }
      if (!draft.tool_parameters || Object.keys(draft.tool_parameters).length === 0) {
        const configuredToolParameters = getConfiguredValue(
          tool_parameters,
          toolInputVarSchema,
        ) as ResourceVarInputs
        if (Object.keys(configuredToolParameters).length > 0)
          draft.tool_parameters = configuredToolParameters
      }
    })
    return inputsWithDefaultValue
  }, [inputs, toolInputVarSchema, toolSettingSchema, tool_configurations, tool_parameters])

  useEffect(() => {
    if (!currTool) return
    const inputsWithDefaultValue = formattingParameters()
    if (inputsWithDefaultValue === inputs) return

    const { setControlPromptEditorRerenderKey } = workflowStore.getState()
    setInputs(inputsWithDefaultValue)
    const rerenderTimeout = setTimeout(() => setControlPromptEditorRerenderKey(Date.now()))

    return () => {
      clearTimeout(rerenderTimeout)
    }
  }, [currTool, formattingParameters, inputs, setInputs, workflowStore])

  // setting when call
  const setInputVar = useCallback(
    (value: ResourceVarInputs) => {
      setInputs({
        ...inputs,
        tool_parameters: value,
      })
    },
    [inputs, setInputs],
  )

  const isLoading = currTool && (isBuiltIn ? !currCollection : false)

  const getMoreDataForCheckValid = () => {
    return {
      toolInputsSchema: (() => {
        const formInputs: InputVar[] = []
        toolInputVarSchema.forEach((item: any) => {
          formInputs.push({
            label: item.label[language] || item.label.en_US,
            variable: item.variable,
            type: item.type,
            required: item.required,
          })
        })
        return formInputs
      })(),
      notAuthed: isShowAuthBtn,
      toolSettingSchema,
      language,
    }
  }

  const outputSchema = useMemo(() => {
    const res: any[] = []
    const output_schema = currTool?.output_schema
    if (!output_schema || !output_schema.properties) return res

    Object.keys(output_schema.properties).forEach((outputKey) => {
      const output = output_schema.properties[outputKey]
      const type = output.type
      if (type === 'object') {
        res.push({
          name: outputKey,
          value: output,
        })
      } else {
        const normalizedType = normalizeJsonSchemaType(output)
        res.push({
          name: outputKey,
          type:
            normalizedType === 'array'
              ? `Array[${output.items ? formatDisplayType(output.items) : 'Unknown'}]`
              : formatDisplayType(output),
          description: output.description,
        })
      }
    })
    return res
  }, [currTool])

  const hasObjectOutput = useMemo(() => {
    const output_schema = currTool?.output_schema
    if (!output_schema || !output_schema.properties) return false
    const properties = output_schema.properties
    return Object.keys(properties).some((key) => properties[key].type === 'object')
  }, [currTool])

  return {
    readOnly,
    inputs,
    currTool,
    toolSettingSchema,
    toolSettingValue,
    setToolSettingValue,
    toolInputVarSchema,
    setInputVar,
    currCollection,
    isShowAuthBtn,
    showSetAuth,
    showSetAuthModal: () => setShowSetAuth(true),
    hideSetAuthModal: () => setShowSetAuth(false),
    handleSaveAuth,
    isLoading,
    outputSchema,
    hasObjectOutput,
    getMoreDataForCheckValid,
  }
}

export default useConfig