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.

25.3 KB
Raw Blame
'use client'

import type { AppMode } from '@dify/contracts/api/console/apps/types.gen'
import type { AccessControlAssignment } from './chip-status'
import type { AccessControlDraft } from './draft'
import type { AppIconProps } from '@/app/components/base/app-icon'
import type { AccessControlSaveProperties } from '@/features/network-access/analytics'
import type { IpPolicyFormSession } from '@/features/network-access/policy-editor/policy-form-analytics'
import {
  AlertDialog,
  AlertDialogCancelButton,
  AlertDialogConfirmButton,
  AlertDialogContent,
  AlertDialogDescription,
  AlertDialogFooter,
  AlertDialogTitle,
} from '@langgenius/dify-ui/alert-dialog'
import { Popover, PopoverContent, PopoverTrigger } from '@langgenius/dify-ui/popover'
import { Tooltip, TooltipContent, TooltipTrigger } from '@langgenius/dify-ui/tooltip'
import { isDefinedError } from '@orpc/client'
import { skipToken, useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
import { useAtomValue } from 'jotai'
import { useQueryState } from 'nuqs'
import { useRef, useState } from 'react'
import { useTranslation } from 'react-i18next'
import {
  pricingQueryParamName,
  pricingQueryParser,
} from '@/app/components/billing/pricing/query-params'
import {
  settingsQueryParamName,
  settingsQueryParser,
} from '@/app/components/header/account-setting/query-params'
import {
  getAccessControlFailReason,
  getIpPolicyFailReason,
  getProtectedAccessPoints,
  trackNetworkAccessEvent,
} from '@/features/network-access/analytics'
import {
  canManageNetworkAccessPoliciesAtom,
  canReadNetworkAccessAtom,
  canViewNetworkAccessStatusAtom,
} from '@/features/network-access/permissions'
import { IpPolicyDialog } from '@/features/network-access/policy-editor'
import { startIpPolicyForm } from '@/features/network-access/policy-editor/policy-form-analytics'
import { consoleQuery } from '@/service/console'
import { AccessControlChipAffix } from './chip-affix'
import { getAccessControlChipState, getAccessControlStatusChipState } from './chip-status'
import { AccessControlConfigPanel } from './config-panel'
import { AccessControlDowngradePanel } from './downgrade-panel'
import { canSaveAccessControl, isAccessControlDraftEqual } from './draft'
import { AccessControlFreePaywall } from './free-paywall'
import {
  accessPointsFromScopes,
  draftFromBinding,
  getAvailableAccessPoints,
} from './network-access'
import { AccessControlStatusPanel } from './status-panel'

export type AccessControlAppIcon = AppIconProps['icon']

type AccessControlEntryProps = {
  appId: string
  appMode: AppMode
  appIcon: AccessControlAppIcon
  canEditBinding: boolean
  isPublished: boolean
}

type GtagHandler = (command: 'event', action: 'click_upgrade_btn', payload: { loc: string }) => void

export function AccessControlEntry(props: AccessControlEntryProps) {
  const canRead = useAtomValue(canReadNetworkAccessAtom)
  const canViewStatus = useAtomValue(canViewNetworkAccessStatusAtom)
  if (!canRead) return canViewStatus ? <AccessControlStatusOnlyEntry appId={props.appId} /> : null
  return <AccessControlSession key={`${props.appId}:${props.canEditBinding}`} {...props} />
}

function AccessControlStatusOnlyEntry({ appId }: { appId: string }) {
  const { t } = useTranslation(['deployments'])
  const statusQuery = useQuery(
    consoleQuery.apps.byAppId.networkAccessGroup.status.get.queryOptions({
      input: { params: { app_id: appId } },
      enabled: Boolean(appId),
      retry: false,
    }),
  )
  if (!statusQuery.data) return null

  const chip = getAccessControlStatusChipState(statusQuery.data)
  const label = t(($) => $['studio.accessControl.entryLabel'], { ns: 'deployments' })
  return (
    <button
      type="button"
      disabled
      className="flex h-8 shrink-0 items-center gap-1.5 rounded-md border-[0.5px] border-divider-deep px-2.5 shadow-xs"
    >
      <span aria-hidden className="i-ri-shield-keyhole-line size-4 text-text-secondary" />
      <span className="system-sm-medium text-text-secondary">{label}</span>
      <AccessControlChipAffix
        kind={chip.kind}
        coveredCount={chip.coveredCount}
        inServiceCount={chip.inServiceCount}
      />
    </button>
  )
}

function AccessControlSession({
  appId,
  appMode,
  appIcon,
  canEditBinding,
  isPublished,
}: AccessControlEntryProps) {
  const { t } = useTranslation(['common', 'deployments'])
  const queryClient = useQueryClient()
  const canRead = useAtomValue(canReadNetworkAccessAtom)
  const canManagePolicies = useAtomValue(canManageNetworkAccessPoliciesAtom)
  const [_pricing, setPricing] = useQueryState(pricingQueryParamName, pricingQueryParser)
  const [_settingsDestination, setSettingsDestination] = useQueryState(
    settingsQueryParamName,
    settingsQueryParser,
  )
  const canFetchNetworkAccess = canRead && Boolean(appId)
  const groupsQuery = useQuery(
    consoleQuery.workspaces.current.networkAccessGroups.get.queryOptions({
      enabled: canFetchNetworkAccess,
      retry: false,
    }),
  )
  const bindingQuery = useQuery(
    consoleQuery.apps.byAppId.networkAccessGroup.get.queryOptions({
      input: { params: { app_id: appId } },
      context: { silent: true },
      retry: false,
      enabled: canFetchNetworkAccess && Boolean(appId),
    }),
  )
  const updateBinding = useMutation(
    consoleQuery.apps.byAppId.networkAccessGroup.put.mutationOptions(),
  )
  const createGroup = useMutation(
    consoleQuery.workspaces.current.networkAccessGroups.post.mutationOptions(),
  )
  const [open, setOpen] = useState(false)
  const panelRef = useRef<HTMLDivElement>(null)
  const [view, setView] = useState<'config' | 'status'>('status')
  const [showBack, setShowBack] = useState(false)
  const [draft, setDraft] = useState<AccessControlDraft | null>(null)
  const [policyFormSession, setPolicyFormSession] = useState<IpPolicyFormSession | null>(null)
  const [policySelectOpen, setPolicySelectOpen] = useState(false)
  const [confirmation, setConfirmation] = useState<{
    draft: AccessControlDraft
    clientIp: string
    policyVersion: number
    changed: boolean
  } | null>(null)
  const saveAttemptRef = useRef(0)
  const editingRef = useRef(false)
  const policyDialogSessionRef = useRef(0)
  const selectedPolicyId = draft ? draft.selectedPolicyId : bindingQuery.data?.binding?.group_id
  const checkCurrentIp =
    consoleQuery.workspaces.current.networkAccessGroups.byGroupId.checkCurrentIp.get
  const ipCheck = useQuery(
    checkCurrentIp.queryOptions({
      input: selectedPolicyId ? { params: { group_id: selectedPolicyId } } : skipToken,
      enabled:
        canFetchNetworkAccess &&
        canEditBinding &&
        bindingQuery.data?.entitled === true &&
        open &&
        view === 'config',
      context: { silent: true },
      staleTime: 0,
      retry: false,
    }),
  )
  const saveCheck = useMutation(checkCurrentIp.mutationOptions({ context: { silent: true } }))

  if (!canFetchNetworkAccess) return null
  if (groupsQuery.isPending || bindingQuery.isPending) return null
  if (groupsQuery.isError || bindingQuery.isError || !groupsQuery.data || !bindingQuery.data)
    return null
  if (!Array.isArray(bindingQuery.data.available_access_points)) return null
  const availableAccessPoints = getAvailableAccessPoints(bindingQuery.data.available_access_points)
  if (!availableAccessPoints.length) return null

  const label = t(($) => $['studio.accessControl.entryLabel'], { ns: 'deployments' })
  const groups = groupsQuery.data.groups
  const binding = bindingQuery.data.binding
  const policies = groups.map((group) => ({
    id: group.id,
    name: group.name,
    allowed_cidrs: group.allowed_cidrs,
  }))
  const baseline = draftFromBinding(binding, availableAccessPoints)
  const entitled = bindingQuery.data.entitled
  const canMutate = canRead && canEditBinding && entitled
  const resolvedDraft = canMutate ? (draft ?? baseline) : baseline
  const assignment: AccessControlAssignment | null = binding?.group_id
    ? {
        policyId: binding.group_id,
        policyName: groups.find((group) => group.id === binding.group_id)?.name ?? binding.group_id,
        scopes: baseline.scopes,
        effectiveEnabled: bindingQuery.data.effective_enabled,
      }
    : null
  const dirty = !isAccessControlDraftEqual(resolvedDraft, baseline, availableAccessPoints)
  const canSave = canSaveAccessControl({
    draft: resolvedDraft,
    baseline,
    availableAccessPoints,
  })
  const chip = getAccessControlChipState({ entitled, assignment, availableAccessPoints })
  const showPaywall = chip.kind === 'pro' && !assignment
  const showDowngrade = Boolean(assignment) && !entitled
  const showStatus = Boolean(assignment) && entitled && (!canMutate || view === 'status')
  const analyticsContext = {
    app_id: appId,
    app_mode: appMode,
    access_point_total: availableAccessPoints.length,
  }

  const tooltip = showDowngrade
    ? t(($) => $['studio.accessControl.tooltipDowngraded'], { ns: 'deployments' })
    : chip.kind === 'pro'
      ? t(($) => $['studio.accessControl.tooltipPro'], { ns: 'deployments' })
      : chip.kind === 'paused'
        ? t(($) => $['studio.accessControl.tooltipPaused'], {
            ns: 'deployments',
          })
        : chip.kind === 'on'
          ? t(($) => $['studio.accessControl.tooltipAllProtected'], {
              ns: 'deployments',
              total: chip.inServiceCount,
            })
          : chip.kind === 'partial'
            ? t(($) => $['studio.accessControl.tooltipProtected'], {
                ns: 'deployments',
                n: chip.coveredCount,
                total: chip.inServiceCount,
              })
            : t(($) => $['studio.accessControl.tooltipOff'], { ns: 'deployments' })

  const handleTurnOn = () => {
    trackNetworkAccessEvent('access_control_upgrade_click', {
      ...analyticsContext,
      plan_state: showDowngrade ? 'lapsed' : 'sandbox',
    })
    void setPricing('open')
    const gtag = (window as Window & { gtag?: GtagHandler }).gtag
    if (gtag) gtag('event', 'click_upgrade_btn', { loc: 'access-control-paywall' })
  }

  const discardDraft = () => {
    editingRef.current = false
    saveAttemptRef.current += 1
    saveCheck.reset()
    setConfirmation(null)
    setPolicySelectOpen(false)
    setDraft(null)
    setShowBack(false)
  }

  const abandonEditing = (method: 'cancel' | 'back' | 'dismiss') => {
    if (editingRef.current && !updateBinding.isPending)
      trackNetworkAccessEvent('access_control_interaction', {
        ...analyticsContext,
        action: 'edit_abandoned',
        abandon_method: method,
      })
    editingRef.current = false
  }

  const handleCancel = () => {
    abandonEditing('cancel')
    discardDraft()
    if (assignment) {
      setView('status')
      return
    }
    setOpen(false)
  }

  const handleBack = () => {
    abandonEditing('back')
    discardDraft()
    setView('status')
  }

  const handleCreatePolicy = () => {
    if (!canMutate || !canManagePolicies) return
    policyDialogSessionRef.current += 1
    setOpen(false)
    setPolicyFormSession(
      startIpPolicyForm({
        mode: 'create',
        source: groups.length ? 'access_control_dropdown' : 'access_control_empty_state',
        app_id: appId,
        app_mode: appMode,
      }),
    )
  }

  const handleManagePolicies = () => {
    trackNetworkAccessEvent('access_control_interaction', {
      ...analyticsContext,
      action: 'manage_policies_clicked',
    })
    editingRef.current = false
    setOpen(false)
    void setSettingsDestination('ip-policies')
  }

  const handlePolicyDialogOpenChange = (nextOpen: boolean) => {
    if (nextOpen) return
    policyDialogSessionRef.current += 1
    setPolicyFormSession(null)
    setOpen(true)
  }

  const persistBinding = (
    {
      enabled,
      groupId,
      accessPoints,
    }: {
      enabled: boolean
      groupId: string | null
      accessPoints: ReturnType<typeof accessPointsFromScopes>
    },
    onSuccess?: () => void,
    analytics?: AccessControlSaveProperties,
  ) => {
    if (!canMutate || updateBinding.isPending) return

    void updateBinding
      .mutateAsync(
        {
          params: { app_id: appId },
          body: {
            enabled,
            group_id: groupId,
            access_points: accessPoints,
            expected_version: binding?.version ?? 0,
          },
        },
        {
          onSuccess: (data) => {
            queryClient.setQueryData(
              consoleQuery.apps.byAppId.networkAccessGroup.get.queryKey({
                input: { params: { app_id: appId } },
              }),
              (current) => (current ? { ...current, ...data } : current),
            )
            onSuccess?.()
          },
          onError: (error) => {
            if (!isDefinedError(error) || error.code !== 'network_access_version_conflict') return
            void queryClient.invalidateQueries({
              queryKey: consoleQuery.apps.byAppId.networkAccessGroup.get.queryKey({
                input: { params: { app_id: appId } },
              }),
            })
            void queryClient.invalidateQueries({
              queryKey: consoleQuery.workspaces.current.networkAccessGroups.get.queryKey(),
            })
          },
        },
      )
      .then(
        () => {
          if (analytics)
            trackNetworkAccessEvent('access_control_save', { ...analytics, result: 'success' })
        },
        (error: unknown) => {
          if (analytics)
            trackNetworkAccessEvent('access_control_save', {
              ...analytics,
              result: 'failed',
              fail_reason: getAccessControlFailReason(error),
            })
        },
      )
  }

  const saveDraft = (nextDraft: AccessControlDraft, currentIpIncluded: boolean) => {
    if (!nextDraft.selectedPolicyId) return
    const protectedAccessPoints = getProtectedAccessPoints(
      accessPointsFromScopes(nextDraft.scopes, availableAccessPoints),
    )
    persistBinding(
      {
        enabled: true,
        groupId: nextDraft.selectedPolicyId,
        accessPoints: accessPointsFromScopes(nextDraft.scopes, availableAccessPoints),
      },
      () => {
        discardDraft()
        setView('status')
        setOpen(true)
      },
      {
        ...analyticsContext,
        is_first_config: binding === null,
        policy_id: nextDraft.selectedPolicyId,
        protected_access_points: protectedAccessPoints,
        protected_count: protectedAccessPoints.length,
        is_current_ip_included: currentIpIncluded,
      },
    )
  }

  const handleSave = (acceptedVersion?: number) => {
    const nextDraft = confirmation?.draft ?? resolvedDraft
    if (
      !canMutate ||
      !canSave ||
      !nextDraft.selectedPolicyId ||
      saveCheck.isPending ||
      updateBinding.isPending
    )
      return
    const groupId = nextDraft.selectedPolicyId
    const attempt = ++saveAttemptRef.current
    saveCheck.mutate(
      { params: { group_id: groupId } },
      {
        onSuccess: (check) => {
          if (saveAttemptRef.current !== attempt) return
          queryClient.setQueryData(
            checkCurrentIp.queryKey({ input: { params: { group_id: groupId } } }),
            check,
          )
          if (isPublished && !check.allowed && acceptedVersion !== check.policy_version) {
            setConfirmation({
              draft: nextDraft,
              clientIp: check.client_ip,
              policyVersion: check.policy_version,
              changed: acceptedVersion !== undefined,
            })
            setOpen(false)
            return
          }
          setConfirmation(null)
          saveDraft(nextDraft, check.allowed)
        },
      },
    )
  }

  const handleEnabledChange = (enabled: boolean) => {
    if (!canMutate || updateBinding.isPending || !binding?.group_id) return
    persistBinding(
      { enabled, groupId: binding.group_id, accessPoints: binding.access_points },
      () => {
        discardDraft()
        setView('status')
      },
    )
  }

  const startEditing = (editEntry: 'first_config' | 'preview_edit' | 'draft_restored') => {
    if (!canMutate) return
    editingRef.current = true
    trackNetworkAccessEvent('access_control_interaction', {
      ...analyticsContext,
      action: 'edit_started',
      edit_entry: editEntry,
    })
  }

  return (
    <>
      <Tooltip>
        <Popover
          open={open}
          onOpenChange={(nextOpen) => {
            setOpen(nextOpen)
            if (!nextOpen) {
              abandonEditing('dismiss')
              saveAttemptRef.current += 1
              saveCheck.reset()
              if (!dirty) discardDraft()
              return
            }
            trackNetworkAccessEvent('access_control_entry_click', {
              ...analyticsContext,
              entry_status: showPaywall
                ? 'sandbox'
                : showDowngrade
                  ? 'lapsed'
                  : chip.kind === 'pro'
                    ? 'sandbox'
                    : chip.kind,
              has_draft: dirty,
            })
            if (dirty) {
              startEditing('draft_restored')
              setView('config')
              setShowBack(Boolean(assignment) && canMutate)
              return
            }
            if (!assignment) startEditing('first_config')
            setView(assignment || !canMutate ? 'status' : 'config')
            setShowBack(false)
          }}
        >
          <TooltipTrigger
            render={
              <PopoverTrigger className="flex h-8 shrink-0 items-center gap-1.5 rounded-md border-[0.5px] border-divider-deep px-2.5 shadow-xs outline-hidden hover:bg-state-base-hover focus-visible:ring-2 focus-visible:ring-state-accent-solid" />
            }
          >
            <span aria-hidden className="i-ri-shield-keyhole-line size-4 text-text-secondary" />
            <span className="system-sm-medium text-text-secondary">{label}</span>
            <AccessControlChipAffix
              kind={chip.kind}
              coveredCount={chip.coveredCount}
              inServiceCount={chip.inServiceCount}
            />
          </TooltipTrigger>
          <PopoverContent
            ref={panelRef}
            initialFocus={(interactionType) =>
              interactionType === 'keyboard' || interactionType === '' ? true : panelRef.current
            }
            align="end"
            className="w-100 rounded-2xl border-divider-regular p-0 backdrop-blur-[5px] transition-none data-starting-style:scale-100 data-starting-style:opacity-100"
          >
            {showPaywall ? (
              <AccessControlFreePaywall onTurnOn={handleTurnOn} />
            ) : showDowngrade && assignment ? (
              <AccessControlDowngradePanel
                assignment={assignment}
                appIcon={appIcon}
                availableAccessPoints={availableAccessPoints}
                onTurnOn={handleTurnOn}
              />
            ) : showStatus && assignment ? (
              <AccessControlStatusPanel
                analyticsContext={analyticsContext}
                draft={resolvedDraft}
                appIcon={appIcon}
                availableAccessPoints={availableAccessPoints}
                policies={policies}
                enabled={bindingQuery.data.effective_enabled}
                updating={updateBinding.isPending}
                readOnly={!canMutate}
                onEnabledChange={handleEnabledChange}
                onEdit={() => {
                  if (!canMutate) return
                  startEditing('preview_edit')
                  setDraft(resolvedDraft)
                  setShowBack(true)
                  setView('config')
                }}
              />
            ) : (
              <AccessControlConfigPanel
                analyticsContext={analyticsContext}
                draft={resolvedDraft}
                appIcon={appIcon}
                availableAccessPoints={availableAccessPoints}
                policies={policies}
                readOnly={!canMutate}
                ipCheck={ipCheck.isSuccess && !ipCheck.isFetching ? ipCheck.data : undefined}
                ipCheckStatus={
                  saveCheck.isPending || ipCheck.isFetching
                    ? 'loading'
                    : saveCheck.isError || ipCheck.isError
                      ? 'error'
                      : undefined
                }
                onRetryIpCheck={() => {
                  saveCheck.reset()
                  void ipCheck.refetch()
                }}
                policySelectOpen={policySelectOpen}
                onPolicySelectOpenChange={setPolicySelectOpen}
                canManagePolicies={canManagePolicies}
                baseline={baseline}
                showBack={showBack}
                saving={updateBinding.isPending || saveCheck.isPending}
                onBack={handleBack}
                onCancel={handleCancel}
                onCreatePolicy={handleCreatePolicy}
                onManagePolicies={handleManagePolicies}
                onDraftChange={(nextDraft) => {
                  if (canMutate) {
                    saveAttemptRef.current += 1
                    saveCheck.reset()
                    setDraft(nextDraft)
                  }
                }}
                onSave={() => handleSave()}
              />
            )}
          </PopoverContent>
        </Popover>
        <TooltipContent>{tooltip}</TooltipContent>
      </Tooltip>
      {policyFormSession && canMutate && canManagePolicies && (
        <IpPolicyDialog
          analyticsSession={policyFormSession}
          mode="create"
          open
          isPending={createGroup.isPending}
          onOpenChange={handlePolicyDialogOpenChange}
          onSubmit={(payload) => {
            if (!canMutate || !canManagePolicies) return
            const session = policyDialogSessionRef.current
            const analytics = {
              ...policyFormSession.context,
              mode: 'create' as const,
              entry_count: payload.allowed_cidrs.length,
              validation_error_types: [...policyFormSession.validationErrors],
            }
            void createGroup
              .mutateAsync(
                {
                  body: {
                    name: payload.name,
                    description: '',
                    allowed_cidrs: payload.allowed_cidrs,
                  },
                },
                {
                  onSuccess: (data) => {
                    queryClient.setQueryData(
                      consoleQuery.workspaces.current.networkAccessGroups.get.queryOptions()
                        .queryKey,
                      (current) => {
                        if (!current) return current
                        if (current.groups.some((group) => group.id === data.group.id))
                          return current
                        return {
                          ...current,
                          groups: [...current.groups, data.group],
                        }
                      },
                    )
                    if (policyDialogSessionRef.current !== session) return
                    setPolicyFormSession(null)
                    setView('config')
                    setPolicySelectOpen(true)
                    setOpen(true)
                  },
                },
              )
              .then(
                (data) =>
                  trackNetworkAccessEvent('ip_policy_save', {
                    ...analytics,
                    result: 'success',
                    policy_id: data.group.id,
                  }),
                (error: unknown) =>
                  trackNetworkAccessEvent('ip_policy_save', {
                    ...analytics,
                    result: 'failed',
                    fail_reason: getIpPolicyFailReason(error),
                  }),
              )
          }}
        />
      )}
      <AlertDialog
        open={confirmation !== null}
        onOpenChange={(nextOpen) => {
          if (nextOpen) return
          saveAttemptRef.current += 1
          saveCheck.reset()
          setConfirmation(null)
          setOpen(true)
        }}
      >
        <AlertDialogContent className="w-100">
          <div className="flex flex-col gap-2 p-6 pb-4">
            <AlertDialogTitle>
              {t(($) => $['studio.accessControl.saveWithoutOwnIp'], { ns: 'deployments' })}
            </AlertDialogTitle>
            <AlertDialogDescription>
              {t(($) => $['studio.accessControl.lockoutWarning'], {
                ns: 'deployments',
                ip: confirmation?.clientIp ?? '',
              })}
            </AlertDialogDescription>
            {confirmation?.changed && (
              <p role="status" className="system-sm-regular text-text-warning">
                {t(($) => $['studio.accessControl.policyChanged'], { ns: 'deployments' })}
              </p>
            )}
            {saveCheck.isError && (
              <p role="alert" className="system-sm-regular text-text-warning">
                {t(($) => $['settings.ipPolicyCurrentIpError'], { ns: 'common' })}
              </p>
            )}
          </div>
          <AlertDialogFooter>
            <AlertDialogCancelButton>
              {t(($) => $['operation.cancel'], { ns: 'common' })}
            </AlertDialogCancelButton>
            <AlertDialogConfirmButton
              loading={saveCheck.isPending || updateBinding.isPending}
              disabled={!canMutate}
              onClick={() => handleSave(confirmation?.policyVersion)}
            >
              {t(($) => $['studio.accessControl.saveAnyway'], { ns: 'deployments' })}
            </AlertDialogConfirmButton>
          </AlertDialogFooter>
        </AlertDialogContent>
      </AlertDialog>
    </>
  )
}