dify/web/app/components/tools/__tests__/integrations-page.spec.tsx
Jingyi-Dify a917a49f66 feat: refine integrations layout and controls
- add integrations headers, install action, permission quick settings, and update setting entry points

- centralize default vs compact content insets for integrations child pages

- cover provider, plugin, marketplace, MCP, and model provider behaviors with focused tests
2026-05-12 14:52:40 -07:00

292 lines
11 KiB
TypeScript

import { fireEvent, screen } from '@testing-library/react'
import { renderWithNuqs } from '@/test/nuqs-testing'
import IntegrationsPage from '../integrations-page'
const { mockRouterPush } = vi.hoisted(() => ({
mockRouterPush: vi.fn(),
}))
const {
mockCanSetPermissions,
mockReferenceSetting,
mockSetReferenceSettings,
} = vi.hoisted(() => ({
mockCanSetPermissions: vi.fn(() => true),
mockReferenceSetting: vi.fn(() => ({
permission: {
install_permission: 'everyone',
debug_permission: 'admins',
},
auto_upgrade: {},
})),
mockSetReferenceSettings: vi.fn(),
}))
vi.mock('@/next/navigation', () => ({
useRouter: () => ({
push: mockRouterPush,
}),
}))
vi.mock('@/app/components/plugins/plugin-page/use-reference-setting', () => ({
default: () => ({
referenceSetting: mockReferenceSetting(),
canSetPermissions: mockCanSetPermissions(),
setReferenceSettings: mockSetReferenceSettings,
}),
}))
vi.mock('@/app/components/plugins/reference-setting-modal', () => ({
__esModule: true,
default: ({ onHide }: { onHide: () => void }) => (
<div data-testid="reference-setting-modal">
<button type="button" onClick={onHide}>close</button>
</div>
),
}))
vi.mock('@/app/components/plugins/plugin-page/install-plugin-dropdown', () => ({
__esModule: true,
default: ({ onSwitchToMarketplaceTab }: { onSwitchToMarketplaceTab: () => void }) => (
<button type="button" aria-label="plugin install" onClick={onSwitchToMarketplaceTab}>
install dropdown
</button>
),
}))
vi.mock('@/app/components/header/account-setting/model-provider-page', () => ({
__esModule: true,
default: ({
onSearchTextChange,
searchText,
}: {
onSearchTextChange?: (value: string) => void
searchText: string
}) => (
<div data-testid="model-provider-page">
<input
aria-label="search"
value={searchText}
onChange={event => onSearchTextChange?.(event.target.value)}
/>
</div>
),
}))
vi.mock('@/app/components/header/account-setting/data-source-page-new', () => ({
__esModule: true,
default: () => <div data-testid="data-source-page" />,
}))
vi.mock('@/app/components/header/account-setting/api-based-extension-page', () => ({
__esModule: true,
default: () => <div data-testid="api-extension-page" />,
}))
vi.mock('../provider-list', () => ({
__esModule: true,
default: ({ category }: { category?: string }) => <div data-testid="tool-provider-list">{category}</div>,
}))
vi.mock('../plugin-category-page', () => ({
__esModule: true,
default: ({ category }: { category: string }) => <div data-testid={`plugin-category-${category}`} />,
}))
const renderIntegrationsPage = (searchParams?: Record<string, string>, section?: React.ComponentProps<typeof IntegrationsPage>['section']) => {
return renderWithNuqs(<IntegrationsPage section={section} />, { searchParams })
}
describe('IntegrationsPage', () => {
beforeEach(() => {
vi.clearAllMocks()
mockCanSetPermissions.mockReturnValue(true)
mockReferenceSetting.mockReturnValue({
permission: {
install_permission: 'everyone',
debug_permission: 'admins',
},
auto_upgrade: {},
})
})
it('defaults to the model provider section when no query is provided', () => {
renderIntegrationsPage()
expect(screen.getByTestId('model-provider-page')).toBeInTheDocument()
expect(screen.getAllByText('common.settings.provider')).toHaveLength(2)
})
it('renders the model provider section from the section query', () => {
renderIntegrationsPage({ section: 'provider' })
expect(screen.getByTestId('model-provider-page')).toBeInTheDocument()
expect(screen.getAllByText('common.settings.provider')).toHaveLength(2)
expect(screen.getByRole('textbox', { name: 'search' })).toBeInTheDocument()
})
it('renders plugin category sections from the section query', () => {
const triggerView = renderIntegrationsPage({ section: 'trigger' })
expect(screen.getByTestId('plugin-category-trigger')).toBeInTheDocument()
expect(screen.getByTestId('plugin-category-trigger').parentElement).toHaveClass('flex', 'flex-col', 'overflow-hidden')
expect(screen.getByRole('link', { name: 'common.settings.trigger' })).toHaveAttribute('href', '/integrations/trigger')
triggerView.unmount()
const agentStrategyView = renderIntegrationsPage({ section: 'agent-strategy' })
expect(screen.getByTestId('plugin-category-agent-strategy')).toBeInTheDocument()
expect(screen.getByRole('link', { name: 'common.settings.agentStrategy' })).toHaveAttribute('href', '/integrations/agent-strategy')
agentStrategyView.unmount()
renderIntegrationsPage({ section: 'extension' })
expect(screen.getByTestId('plugin-category-extension')).toBeInTheDocument()
expect(screen.getByRole('link', { name: 'common.settings.extension' })).toHaveAttribute('href', '/integrations/extension')
})
it('renders migrated legacy setting sections', () => {
const { unmount } = renderIntegrationsPage({ section: 'data-source' })
expect(screen.getByTestId('data-source-page')).toBeInTheDocument()
unmount()
renderIntegrationsPage({ section: 'api-based-extension' })
expect(screen.getByTestId('api-extension-page')).toBeInTheDocument()
})
it('renders existing pages from route sections', () => {
const modelProviderView = renderIntegrationsPage(undefined, 'provider')
expect(screen.getByTestId('model-provider-page')).toBeInTheDocument()
modelProviderView.unmount()
const mcpView = renderIntegrationsPage(undefined, 'mcp')
expect(screen.getByTestId('tool-provider-list')).toHaveTextContent('mcp')
expect(screen.getByTestId('tool-provider-list').parentElement).toHaveClass('flex', 'flex-col', 'overflow-hidden')
mcpView.unmount()
renderIntegrationsPage(undefined, 'data-source')
expect(screen.getByTestId('data-source-page')).toBeInTheDocument()
})
it('keeps existing category-only tools URLs functional', () => {
renderIntegrationsPage({ category: 'mcp' })
expect(screen.getByTestId('tool-provider-list')).toBeInTheDocument()
expect(screen.getByRole('link', { name: 'MCP' })).toHaveClass('bg-state-base-active')
expect(screen.getByRole('link', { name: 'MCP' })).toHaveAttribute('href', '/integrations/tools/mcp')
})
it('renders the tools header for tool sections', () => {
renderIntegrationsPage({ section: 'builtin' })
expect(screen.getAllByText('common.menus.tools')).toHaveLength(2)
expect(screen.getByText('common.toolsPage.description')).toBeInTheDocument()
})
it('renders the mcp header for the mcp section', () => {
renderIntegrationsPage({ section: 'mcp' })
expect(screen.getAllByText('MCP')).toHaveLength(2)
expect(screen.getByText('common.mcpPage.description')).toBeInTheDocument()
expect(screen.queryByText('common.toolsPage.description')).not.toBeInTheDocument()
})
it('renders the swagger API header for the custom tool section', () => {
renderIntegrationsPage({ section: 'custom-tool' })
expect(screen.getAllByText('common.settings.swaggerAPIAsTool')).toHaveLength(2)
expect(screen.getByText('common.swaggerAPIAsToolPage.description')).toBeInTheDocument()
expect(screen.queryByText('common.toolsPage.description')).not.toBeInTheDocument()
})
it.each([
['workflow-tool', 'workflow.common.workflowAsTool', 'common.workflowAsToolPage.description'],
['api-based-extension', 'common.settings.apiBasedExtension', 'common.apiBasedExtensionPage.description'],
['data-source', 'common.settings.dataSource', 'common.dataSourcePage.description'],
['trigger', 'common.settings.trigger', 'common.triggerPage.description'],
['extension', 'common.settings.extension', 'common.extensionPage.description'],
['agent-strategy', 'common.settings.agentStrategy', 'common.agentStrategyPage.description'],
] as const)('renders the %s header', (section, title, description) => {
renderIntegrationsPage({ section })
expect(screen.getAllByText(title)).toHaveLength(2)
expect(screen.getByText(description)).toBeInTheDocument()
expect(screen.queryByText('common.toolsPage.description')).not.toBeInTheDocument()
})
it.each(['extension', 'agent-strategy'] as const)('renders plugin update settings action for %s', (section) => {
renderIntegrationsPage({ section })
expect(screen.getByText('common.modelProvider.updateSetting')).toBeInTheDocument()
expect(screen.getByText('plugin.autoUpdate.strategy.fixOnly.name')).toBeInTheDocument()
fireEvent.click(screen.getByText('common.modelProvider.updateSetting'))
expect(screen.getByTestId('reference-setting-modal')).toBeInTheDocument()
})
it('opens the original plugins marketplace path from the install dropdown marketplace action', () => {
renderIntegrationsPage({ section: 'builtin' })
fireEvent.click(screen.getByRole('button', { name: 'plugin install' }))
expect(mockRouterPush).toHaveBeenCalledWith('/plugins?tab=discover')
})
it('opens the sidebar plugin permissions quick settings and updates permissions', () => {
renderIntegrationsPage({ section: 'provider' })
fireEvent.click(screen.getByRole('button', { name: 'plugin.privilege.permissions' }))
expect(screen.getByText('plugin.privilege.permissions')).toBeInTheDocument()
expect(screen.getByText('plugin.privilege.quickWhoCanInstall')).toBeInTheDocument()
expect(screen.getByText('plugin.privilege.quickWhoCanDebug')).toBeInTheDocument()
fireEvent.click(screen.getByRole('button', { name: 'plugin.privilege.quickWhoCanInstall: plugin.privilege.noone' }))
expect(mockSetReferenceSettings).toHaveBeenCalledWith({
permission: {
install_permission: 'noone',
debug_permission: 'admins',
},
auto_upgrade: {},
})
})
it('disables the sidebar plugin permissions quick settings when permission management is unavailable', () => {
mockCanSetPermissions.mockReturnValue(false)
renderIntegrationsPage({ section: 'provider' })
const trigger = screen.getByRole('button', { name: 'plugin.privilege.permissions' })
expect(trigger).toBeDisabled()
fireEvent.click(trigger)
expect(screen.queryByText('plugin.privilege.quickWhoCanInstall')).not.toBeInTheDocument()
expect(screen.queryByText('plugin.privilege.quickWhoCanDebug')).not.toBeInTheDocument()
})
it('collapses and expands the integrations sidebar', () => {
renderIntegrationsPage({ section: 'provider' })
fireEvent.click(screen.getByRole('button', { name: 'common.settings.collapse' }))
expect(screen.queryByText('common.settings.integrations')).not.toBeInTheDocument()
expect(screen.queryByText('common.settings.swaggerAPIAsTool')).not.toBeInTheDocument()
expect(screen.getByRole('link', { name: 'MCP' })).toBeInTheDocument()
expect(screen.getByRole('link', { name: 'common.settings.trigger' })).toHaveAttribute('href', '/integrations/trigger')
expect(screen.getByRole('button', { name: 'common.settings.expand' })).toBeInTheDocument()
fireEvent.click(screen.getByRole('button', { name: 'common.settings.expand' }))
expect(screen.getByText('common.settings.integrations')).toBeInTheDocument()
expect(screen.getByText('common.settings.swaggerAPIAsTool')).toBeInTheDocument()
})
})