From ae0dbb9faf8bf2862aa5b2ac2a1ba33bb6466ef8 Mon Sep 17 00:00:00 2001 From: yoyoyohamapi <8338436+yoyoyohamapi@users.noreply.github.com> Date: Wed, 21 May 2025 02:28:43 +0000 Subject: [PATCH] refactor(core): indexer & embedding -> embedding (#12387) ### TL;DR refactor: rename settings, indexer embedding -> embedding ## Summary by CodeRabbit - **Refactor** - Unified naming in workspace settings from "Indexer & Embedding" to "Embedding" for improved clarity. - Updated sidebar labels, tab keys, and test IDs to reflect the new naming convention. - Streamlined the layout and organization of the embedding settings interface for a more consistent user experience. - Simplified the export and component structure for embedding settings. --- .../setting/workspace-setting/index.tsx | 15 +- .../core/src/modules/dialogs/constant.ts | 2 +- .../workspace-indexer-embedding/index.ts | 2 +- .../view/embedding-settings.tsx | 154 +++++++++--------- .../view/index.tsx | 23 +-- .../e2e/utils/settings-panel-utils.ts | 6 +- 6 files changed, 91 insertions(+), 111 deletions(-) diff --git a/packages/frontend/core/src/desktop/dialogs/setting/workspace-setting/index.tsx b/packages/frontend/core/src/desktop/dialogs/setting/workspace-setting/index.tsx index 141836365..19e4ef2da 100644 --- a/packages/frontend/core/src/desktop/dialogs/setting/workspace-setting/index.tsx +++ b/packages/frontend/core/src/desktop/dialogs/setting/workspace-setting/index.tsx @@ -2,7 +2,7 @@ import { useWorkspaceInfo } from '@affine/core/components/hooks/use-workspace-in import { ServerService } from '@affine/core/modules/cloud'; import type { SettingTab } from '@affine/core/modules/dialogs/constant'; import { WorkspaceService } from '@affine/core/modules/workspace'; -import { IndexerEmbeddingSettings } from '@affine/core/modules/workspace-indexer-embedding'; +import { EmbeddingSettings } from '@affine/core/modules/workspace-indexer-embedding'; import { ServerDeploymentType } from '@affine/graphql'; import { useI18n } from '@affine/i18n'; import { @@ -54,8 +54,8 @@ export const WorkspaceSetting = ({ return ; case 'workspace:integrations': return ; - case 'workspace:indexer-embedding': - return ; + case 'workspace:embedding': + return ; default: return null; } @@ -110,10 +110,13 @@ export const useWorkspaceSettingList = (): SettingSidebarItem[] => { testId: 'workspace-setting:storage', }, { - key: 'workspace:indexer-embedding', - title: t['Indexer & Embedding'](), + key: 'workspace:embedding', + title: + t[ + 'com.affine.settings.workspace.indexer-embedding.embedding.title' + ](), icon: , - testId: 'workspace-setting:indexer-embedding', + testId: 'workspace-setting:embedding', }, showBilling && { key: 'workspace:billing' as SettingTab, diff --git a/packages/frontend/core/src/modules/dialogs/constant.ts b/packages/frontend/core/src/modules/dialogs/constant.ts index 7151bbdea..ca9258e87 100644 --- a/packages/frontend/core/src/modules/dialogs/constant.ts +++ b/packages/frontend/core/src/modules/dialogs/constant.ts @@ -14,7 +14,7 @@ export type SettingTab = | 'editor' | 'account' | 'meetings' - | `workspace:${'preference' | 'properties' | 'members' | 'storage' | 'billing' | 'license' | 'integrations' | 'indexer-embedding' | 'search'}`; + | `workspace:${'preference' | 'properties' | 'members' | 'storage' | 'billing' | 'license' | 'integrations' | 'embedding' | 'search'}`; export type GLOBAL_DIALOG_SCHEMA = { 'create-workspace': (props: { serverId?: string }) => { diff --git a/packages/frontend/core/src/modules/workspace-indexer-embedding/index.ts b/packages/frontend/core/src/modules/workspace-indexer-embedding/index.ts index d6801ddc0..d8939077a 100644 --- a/packages/frontend/core/src/modules/workspace-indexer-embedding/index.ts +++ b/packages/frontend/core/src/modules/workspace-indexer-embedding/index.ts @@ -17,4 +17,4 @@ export function configureIndexerEmbeddingModule(framework: Framework) { .entity(Embedding, [WorkspaceService, EmbeddingStore]); } -export { IndexerEmbeddingSettings } from './view'; +export { EmbeddingSettings } from './view'; diff --git a/packages/frontend/core/src/modules/workspace-indexer-embedding/view/embedding-settings.tsx b/packages/frontend/core/src/modules/workspace-indexer-embedding/view/embedding-settings.tsx index 4317d8ab3..1617f2fa4 100644 --- a/packages/frontend/core/src/modules/workspace-indexer-embedding/view/embedding-settings.tsx +++ b/packages/frontend/core/src/modules/workspace-indexer-embedding/view/embedding-settings.tsx @@ -1,5 +1,6 @@ import { Button, Switch } from '@affine/component'; import { + SettingHeader, SettingRow, SettingWrapper, } from '@affine/component/setting-components'; @@ -94,86 +95,85 @@ export const EmbeddingSettings: React.FC = () => { ]); return ( - - + - - - - - - - - - - - {attachmentNodes.length > 0 && ( - - )} - - - + + + + {attachmentNodes.length > 0 && ( + + )} + + + + + + {ignoredDocNodes.length > 0 && ( + + )} + + ); }; diff --git a/packages/frontend/core/src/modules/workspace-indexer-embedding/view/index.tsx b/packages/frontend/core/src/modules/workspace-indexer-embedding/view/index.tsx index ed43d6614..4a1d7ac8e 100644 --- a/packages/frontend/core/src/modules/workspace-indexer-embedding/view/index.tsx +++ b/packages/frontend/core/src/modules/workspace-indexer-embedding/view/index.tsx @@ -1,22 +1 @@ -import { SettingHeader } from '@affine/component/setting-components'; -import { useI18n } from '@affine/i18n'; -import type React from 'react'; - -import { EmbeddingSettings } from './embedding-settings'; - -export const IndexerEmbeddingSettings: React.FC = () => { - const t = useI18n(); - - return ( - <> - - - - - ); -}; +export { EmbeddingSettings } from './embedding-settings'; diff --git a/tests/affine-cloud-copilot/e2e/utils/settings-panel-utils.ts b/tests/affine-cloud-copilot/e2e/utils/settings-panel-utils.ts index 5d7b58935..1a178423f 100644 --- a/tests/affine-cloud-copilot/e2e/utils/settings-panel-utils.ts +++ b/tests/affine-cloud-copilot/e2e/utils/settings-panel-utils.ts @@ -4,11 +4,9 @@ const WORKSPACE_EMBEDDING_SWITCH_TEST_ID = 'workspace-embedding-setting-switch'; export class SettingsPanelUtils { public static async openSettingsPanel(page: Page) { - if ( - await page.getByTestId('workspace-setting:indexer-embedding').isHidden() - ) { + if (await page.getByTestId('workspace-setting:embedding').isHidden()) { await page.getByTestId('slider-bar-workspace-setting-button').click(); - await page.getByTestId('workspace-setting:indexer-embedding').click(); + await page.getByTestId('workspace-setting:embedding').click(); await page.getByTestId('workspace-embedding-setting-wrapper').waitFor({ state: 'visible', });