From dfcd05b7fc68408c051ef9436a69c9ec51eb4753 Mon Sep 17 00:00:00 2001 From: Johannes Fleck Date: Thu, 19 Nov 2026 14:34:14 +0100 Subject: [PATCH 1/4] refactor(ui): Introduce the ui/ component layer Move Modal, Tooltip, TooltipTrigger and TabBar into src/lib/components/ui/, enforce with ESLint that ui/ components do not import app code, and document the component layers in AGENTS.md. Part of #366 and #370 --- AGENTS.md | 14 +++++++-- eslint.config.js | 29 ++++++++++++++++++- .../dashboard/AddBookmarkModal.svelte | 2 +- .../layout/SessionExpiredModal.svelte | 2 +- .../components/layout/sidebar/Sidebar.svelte | 2 +- .../components/storage/StorageSearch.svelte | 2 +- .../storage/StorageSearchHistory.svelte | 2 +- .../storage/StorageSearchHistoryEntry.svelte | 2 +- .../storage/explorer/StorageBreadcrumb.svelte | 2 +- .../components/storage/explorer/TabBar.svelte | 2 +- .../storage/landing/BucketGrid.svelte | 2 +- .../storage/modals/AddBucketModal.svelte | 2 +- .../storage/modals/CreateModal.svelte | 2 +- .../storage/modals/DeleteConfirmModal.svelte | 2 +- .../modals/DeleteConnectionModal.svelte | 4 +-- .../storage/modals/DetailsModal.svelte | 2 +- .../storage/modals/MoveConfirmModal.svelte | 2 +- .../storage/modals/PreviewModal.svelte | 4 +-- .../storage/modals/RenameModal.svelte | 2 +- .../modals/UnsavedConfirmDialog.svelte | 2 +- .../shared/ConflictResolutionDialog.svelte | 2 +- .../storage/modals/upload/UploadModal.svelte | 2 +- .../storage/sidebar/BucketList.svelte | 4 +-- .../sidebar/StorageConnectionSidebar.svelte | 2 +- src/lib/components/{ => ui}/Modal.svelte | 0 .../{modal => ui}/Modal.svelte.spec.ts | 2 +- src/lib/components/{ => ui}/TabBar.svelte | 2 +- .../components/{ => ui}/TabBar.svelte.spec.ts | 0 src/lib/components/{ => ui}/Tooltip.svelte | 0 .../{ => ui}/Tooltip.svelte.spec.ts | 0 .../components/{ => ui}/TooltipTrigger.svelte | 0 .../{ => ui}/TooltipTrigger.svelte.spec.ts | 0 .../TooltipTriggerDialogWrapper.svelte | 4 +-- .../__tests__/TooltipTriggerWrapper.svelte | 2 +- .../connections/[id]/edit/+page.svelte | 2 +- src/routes/(app)/trino/+page.svelte | 4 +-- 36 files changed, 73 insertions(+), 36 deletions(-) rename src/lib/components/{ => ui}/Modal.svelte (100%) rename src/lib/components/{modal => ui}/Modal.svelte.spec.ts (99%) rename src/lib/components/{ => ui}/TabBar.svelte (99%) rename src/lib/components/{ => ui}/TabBar.svelte.spec.ts (100%) rename src/lib/components/{ => ui}/Tooltip.svelte (100%) rename src/lib/components/{ => ui}/Tooltip.svelte.spec.ts (100%) rename src/lib/components/{ => ui}/TooltipTrigger.svelte (100%) rename src/lib/components/{ => ui}/TooltipTrigger.svelte.spec.ts (100%) rename src/lib/components/{ => ui}/__tests__/TooltipTriggerDialogWrapper.svelte (72%) rename src/lib/components/{ => ui}/__tests__/TooltipTriggerWrapper.svelte (79%) diff --git a/AGENTS.md b/AGENTS.md index 0b6ef049..f48869cb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,7 +35,7 @@ Single SvelteKit application (not a monorepo). ├── src/ │ ├── lib/ │ │ ├── server/ # Server-only code: auth, db, logging, metrics, feature flags, trino/, storage/ -│ │ ├── components/ # Svelte components (shared ones at top level, per-module subfolders) +│ │ ├── components/ # Svelte components: ui/ (generic), app-wide at top level and layout/, per-module subfolders │ │ ├── client/ # Client-only utilities │ │ ├── stores/ # Svelte stores (*.svelte.ts) │ │ ├── storage/ # Client-side storage module logic @@ -140,6 +140,16 @@ Environment variables are parsed with zod at startup using the helpers in `src/l Document new variables in `README.md` and `.env.example`; don't read `env` ad hoc. +### Component Layers + +`src/lib/components/` is split by what a component depends on. Each layer may only use the layers above it: + +1. **`ui/`** — generic building blocks (`Modal`, `TooltipTrigger`, `TabBar`, ...). Data comes in through props, results go out through callbacks or `bind:`. They may import Svelte, icons, Paraglide messages, `$lib/types` and other `ui/` components, nothing else (enforced by ESLint). +2. **Top level and `layout/`** — app-wide components that know the app (stores, routes, session), e.g. `ErrorPanel`, `ToastHost`, the header and sidebar. +3. **`/`** — feature components. Pieces shared only within one module go into `/shared/`; move them to `ui/` once a second module needs them and they have no module dependencies. + +Before writing a new component, check DaisyUI and the existing `ui/` components. + ### Code Style & Best Practices - Run `npm run format`. @@ -213,7 +223,7 @@ pre-commit run --all-files # All of the above plus markdownlint, yamllint, she Most conventions in this file are checked automatically; fix violations instead of disabling rules. -- **ESLint** (`eslint.config.js`): no server imports from client code (`src/lib/client`, `stores`, `storage`, `editor`, `types`) and vice versa, file naming (PascalCase components, stores as `*.svelte.ts`), file size limits (`max-lines`), no `` outside `Modal.svelte`, a subset of hard-coded colour classes (`bg-white`, `text-gray-*`, ...), no `console` in server code. +- **ESLint** (`eslint.config.js`): no server imports from client code (`src/lib/client`, `stores`, `storage`, `editor`, `types`) and vice versa, file naming (PascalCase components, stores as `*.svelte.ts`), file size limits (`max-lines`), no `` outside `ui/Modal.svelte`, `ui/` components importing app code, a subset of hard-coded colour classes (`bg-white`, `text-gray-*`, ...), no `console` in server code. - **Architecture tests** (`npm run test:arch`, `src/architecture-tests/`): no circular dependencies in `src/lib` and `src/routes`, i18n key parity and no unused message keys, no static English `aria-label`, no native date inputs, `` with `alt`, no clickable `
`/``, no low-opacity `text-base-content` for text (use `text-muted`). `npm run test:arch:report` additionally writes dependency/metrics reports to `reports/`. When you add a new architectural rule, prefer an ESLint rule; otherwise add a `.spec.ts` in `src/architecture-tests/` following the existing patterns. diff --git a/eslint.config.js b/eslint.config.js index 880f4a38..b18696b4 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -138,9 +138,36 @@ export default defineConfig( } }, { - files: ['src/lib/components/Modal.svelte'], + files: ['src/lib/components/ui/Modal.svelte'], rules: { 'svelte/no-restricted-html-elements': 'off' } }, + { + // Generic building blocks: everything comes in through props, so they must not depend on app + // state, routing or feature modules (see "Component Layers" in AGENTS.md). + files: ['src/lib/components/ui/**/*.{svelte,ts}'], + rules: { + 'no-restricted-imports': [ + 'error', + { + patterns: [ + { + group: ['$lib/*', '!$lib/paraglide', '!$lib/types', '!$lib/components'], + message: 'ui/ components may only import Paraglide messages, shared types and ui/.' + }, + { + group: ['$lib/components/*', '!$lib/components/ui'], + message: 'ui/ components must not import app or feature components.' + }, + { + group: ['$app/*'], + message: 'ui/ components must not depend on SvelteKit app state.' + }, + { group: ['../*'], message: 'ui/ components must not import from outside ui/.' } + ] + } + ] + } + }, { files: [ 'src/lib/client/**/*.ts', diff --git a/src/lib/components/dashboard/AddBookmarkModal.svelte b/src/lib/components/dashboard/AddBookmarkModal.svelte index b302a5b9..cbb9dbf6 100644 --- a/src/lib/components/dashboard/AddBookmarkModal.svelte +++ b/src/lib/components/dashboard/AddBookmarkModal.svelte @@ -1,6 +1,6 @@ - - - -{#if isOpen} - - - -{/if} diff --git a/src/lib/components/storage/explorer/FileExplorer.svelte b/src/lib/components/storage/explorer/FileExplorer.svelte index fdd17a84..2b5e8742 100644 --- a/src/lib/components/storage/explorer/FileExplorer.svelte +++ b/src/lib/components/storage/explorer/FileExplorer.svelte @@ -7,7 +7,6 @@ import { getTabsState } from '$lib/storage/context.js'; import { collectDroppedFiles } from '$lib/storage/file-collection.js'; import { storageTransferEnabled } from '$lib/client/feature-flags.js'; - import type { ContextMenuAction } from '$lib/storage/types.js'; import type { ActionName } from '$lib/storage/types.js'; import IconVisibility from 'virtual:icons/material-symbols/visibility'; import IconDownload from 'virtual:icons/material-symbols/download'; @@ -27,7 +26,7 @@ import StorageBreadcrumb from './StorageBreadcrumb.svelte'; import TabBar from './TabBar.svelte'; import ObjectTable from './ObjectTable.svelte'; - import ContextMenu from './ContextMenu.svelte'; + import ContextMenu, { type ContextMenuAction } from '$lib/components/ui/ContextMenu.svelte'; import Pagination from '$lib/components/Pagination.svelte'; const storage = getStorageState(); diff --git a/src/lib/components/storage/explorer/StorageBreadcrumb.svelte b/src/lib/components/storage/explorer/StorageBreadcrumb.svelte index 1d0f9189..efe18c20 100644 --- a/src/lib/components/storage/explorer/StorageBreadcrumb.svelte +++ b/src/lib/components/storage/explorer/StorageBreadcrumb.svelte @@ -22,9 +22,8 @@ import { storageTransferEnabled } from '$lib/client/feature-flags.js'; import { parseStorageDrop, canStorageDrop } from '$lib/storage/drag-handlers.js'; import OperationsButton from './OperationsButton.svelte'; - import ContextMenu from './ContextMenu.svelte'; + import ContextMenu, { type ContextMenuAction } from '$lib/components/ui/ContextMenu.svelte'; import TooltipTrigger from '$lib/components/ui/TooltipTrigger.svelte'; - import type { ContextMenuAction } from '$lib/storage/types.js'; const storage = getStorageState(); const uid = $props.id(); diff --git a/src/lib/components/storage/explorer/TabBar.svelte b/src/lib/components/storage/explorer/TabBar.svelte index 24ce2395..8f5f6a10 100644 --- a/src/lib/components/storage/explorer/TabBar.svelte +++ b/src/lib/components/storage/explorer/TabBar.svelte @@ -5,11 +5,10 @@ import IconDriveFileRenameOutline from 'virtual:icons/material-symbols/drive-file-rename-outline'; import * as m from '$lib/paraglide/messages.js'; import type { TabsState } from '$lib/storage/tabs.svelte.js'; - import type { ContextMenuAction } from '$lib/storage/types.js'; import { getStorageState } from '$lib/storage/context.js'; import { storageTransferEnabled } from '$lib/client/feature-flags.js'; import { parseStorageDrop } from '$lib/storage/drag-handlers.js'; - import ContextMenu from './ContextMenu.svelte'; + import ContextMenu, { type ContextMenuAction } from '$lib/components/ui/ContextMenu.svelte'; import GenericTabBar, { type ExternalTabDrag } from '$lib/components/ui/TabBar.svelte'; interface Props { diff --git a/src/lib/components/storage/explorer/__tests__/ContextMenu.svelte.spec.ts b/src/lib/components/storage/explorer/__tests__/ContextMenu.svelte.spec.ts deleted file mode 100644 index 994ca594..00000000 --- a/src/lib/components/storage/explorer/__tests__/ContextMenu.svelte.spec.ts +++ /dev/null @@ -1,239 +0,0 @@ -import { page } from 'vitest/browser'; -import { describe, expect, it, vi } from 'vitest'; -import { render } from 'vitest-browser-svelte'; -import { faker } from '@faker-js/faker'; -import { SvelteSet } from 'svelte/reactivity'; -import ContextMenuWrapper from './ContextMenuWrapper.svelte'; -import type { StorageObject } from '$lib/storage/types.js'; -import { StorageState } from '$lib/storage/state.svelte.js'; - -function makeFile(key: string): StorageObject { - return { - key, - size: faker.number.int({ min: 100, max: 10_000_000 }), - lastModified: faker.date.recent(), - isDirectory: false, - contentType: 'application/octet-stream' - }; -} - -function makeFolder(key: string): StorageObject { - return { - key, - size: 0, - lastModified: faker.date.recent(), - isDirectory: true, - contentType: undefined - }; -} - -function createState( - objects: StorageObject[] = [], - opts: { contextMenu?: { x: number; y: number; key: string }; selectedKeys?: string[] } = {} -): StorageState { - const state = new StorageState({ connected: true, buckets: ['test-bucket'] }); - state.bucket = 'test-bucket'; - state.prefix = ''; - state.objects = { - objects, - hasNextPage: false, - currentPage: 1, - pageSize: 25 - }; - if (opts.contextMenu) state.contextMenu = opts.contextMenu; - if (opts.selectedKeys) state.selectedKeys = new SvelteSet(opts.selectedKeys); - return state; -} - -describe('ContextMenu', () => { - it('should render menu with role="menu"', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - render(ContextMenuWrapper, { state }); - - await expect.element(page.getByRole('menu')).toBeInTheDocument(); - }); - - it('should show action buttons', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - render(ContextMenuWrapper, { state }); - - await expect.element(page.getByRole('menuitem', { name: 'Preview' })).toBeInTheDocument(); - await expect.element(page.getByRole('menuitem', { name: 'Download' })).toBeInTheDocument(); - await expect.element(page.getByRole('menuitem', { name: 'Delete' })).toBeInTheDocument(); - }); - - it('should disable preview when context is a folder', async () => { - const folder = makeFolder('docs/'); - const state = createState([folder], { - contextMenu: { x: 100, y: 100, key: 'docs/' }, - selectedKeys: ['docs/'] - }); - render(ContextMenuWrapper, { state }); - - const previewBtn = page.getByRole('menuitem', { name: 'Preview' }); - await expect.element(previewBtn).toHaveAttribute('disabled'); - }); - - it('should enable download when context is a folder', async () => { - const folder = makeFolder('docs/'); - const state = createState([folder], { - contextMenu: { x: 100, y: 100, key: 'docs/' }, - selectedKeys: ['docs/'] - }); - render(ContextMenuWrapper, { state }); - - const downloadBtn = page.getByRole('menuitem', { name: 'Download' }); - await expect.element(downloadBtn).not.toHaveAttribute('disabled'); - }); - - it('should enable download when context is a file', async () => { - const file = makeFile('report.pdf'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'report.pdf' }, - selectedKeys: ['report.pdf'] - }); - render(ContextMenuWrapper, { state }); - - const downloadBtn = page.getByRole('menuitem', { name: 'Download' }); - await expect.element(downloadBtn).not.toHaveAttribute('disabled'); - }); - - it('should close menu when close button is clicked', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - const spy = vi.spyOn(state, 'closeContextMenu'); - render(ContextMenuWrapper, { state, title: 'Menu' }); - - await page.getByRole('menuitem', { name: 'Close' }).click(); - expect(spy).toHaveBeenCalled(); - }); - - it('should close menu on Escape key', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - const spy = vi.spyOn(state, 'closeContextMenu'); - render(ContextMenuWrapper, { state }); - - document.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true })); - expect(spy).toHaveBeenCalled(); - }); - - it('should execute action when action button is clicked', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - const spy = vi.spyOn(state, 'executeAction'); - render(ContextMenuWrapper, { state }); - - await page.getByRole('menuitem', { name: 'Delete' }).click(); - expect(spy).toHaveBeenCalledWith('delete'); - }); - - it('should position menu at context menu coordinates', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 200, y: 150, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - render(ContextMenuWrapper, { state }); - - const menu = page.getByRole('menu'); - await expect.element(menu).toBeInTheDocument(); - }); - - it('should adjust position when menu overflows viewport bottom', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: window.innerHeight - 10, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - render(ContextMenuWrapper, { state }); - - const menu = page.getByRole('menu'); - await expect.element(menu).toBeInTheDocument(); - const el = menu.element() as HTMLElement; - const top = parseInt(el.style.top); - expect(top).toBeLessThan(window.innerHeight - 10); - }); - - it('should not close menu when clicking inside it', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - const spy = vi.spyOn(state, 'closeContextMenu'); - render(ContextMenuWrapper, { state }); - - const menu = page.getByRole('menu'); - await menu.click(); - expect(spy).not.toHaveBeenCalled(); - }); - - it('should execute action when clicking an enabled action button (preview)', async () => { - const file = makeFile('photo.png'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'photo.png' }, - selectedKeys: ['photo.png'] - }); - const spy = vi.spyOn(state, 'executeAction'); - render(ContextMenuWrapper, { state }); - - await page.getByRole('menuitem', { name: 'Preview' }).click(); - expect(spy).toHaveBeenCalledWith('preview'); - }); - - it('should execute download action', async () => { - const file = makeFile('data.csv'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'data.csv' }, - selectedKeys: ['data.csv'] - }); - const spy = vi.spyOn(state, 'executeAction'); - render(ContextMenuWrapper, { state }); - - await page.getByRole('menuitem', { name: 'Download' }).click(); - expect(spy).toHaveBeenCalledWith('download'); - }); - - it('should not close menu on non-Escape key', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: ['test.txt'] - }); - const spy = vi.spyOn(state, 'closeContextMenu'); - render(ContextMenuWrapper, { state }); - - document.dispatchEvent(new KeyboardEvent('keydown', { key: 'Enter', bubbles: true })); - expect(spy).not.toHaveBeenCalled(); - }); - - it('should disable delete when no items are selected', async () => { - const file = makeFile('test.txt'); - const state = createState([file], { - contextMenu: { x: 100, y: 100, key: 'test.txt' }, - selectedKeys: [] - }); - render(ContextMenuWrapper, { state }); - - const deleteBtn = page.getByRole('menuitem', { name: 'Delete' }); - await expect.element(deleteBtn).toHaveAttribute('disabled'); - }); -}); diff --git a/src/lib/components/storage/explorer/__tests__/ContextMenuWrapper.svelte b/src/lib/components/storage/explorer/__tests__/ContextMenuWrapper.svelte deleted file mode 100644 index db8496e3..00000000 --- a/src/lib/components/storage/explorer/__tests__/ContextMenuWrapper.svelte +++ /dev/null @@ -1,51 +0,0 @@ - - - state.closeContextMenu()} - onaction={(key) => state.executeAction(key as 'preview' | 'download' | 'delete')} - {actions} - {title} -/> diff --git a/src/lib/components/storage/explorer/__tests__/FileExplorer.svelte.spec.ts b/src/lib/components/storage/explorer/__tests__/FileExplorer.svelte.spec.ts index e5fea596..57bcfc1a 100644 --- a/src/lib/components/storage/explorer/__tests__/FileExplorer.svelte.spec.ts +++ b/src/lib/components/storage/explorer/__tests__/FileExplorer.svelte.spec.ts @@ -154,8 +154,8 @@ describe('FileExplorer', () => { const state = createState([makeFile('test.txt')]); render(FileExplorerWrapper, { state }); - // Context menu title "Actions" should not be present - expect(page.getByText('Actions').elements().length).toBe(0); + await expect.element(page.getByText('Page 1')).toBeInTheDocument(); + expect(document.querySelector('[popover]:popover-open')).toBeNull(); }); it('should render pagination', async () => { diff --git a/src/lib/components/storage/explorer/__tests__/StorageBreadcrumb.svelte.spec.ts b/src/lib/components/storage/explorer/__tests__/StorageBreadcrumb.svelte.spec.ts index 50111caa..3d5213a8 100644 --- a/src/lib/components/storage/explorer/__tests__/StorageBreadcrumb.svelte.spec.ts +++ b/src/lib/components/storage/explorer/__tests__/StorageBreadcrumb.svelte.spec.ts @@ -384,29 +384,6 @@ describe('StorageBreadcrumb', () => { expect(spy).toHaveBeenCalledWith('test-bucket', ''); }); - it('should close context menu when clicking outside', async () => { - const state = createState({ bucket: 'test-bucket' }); - render(StorageBreadcrumbWrapper, { state }); - - const nav = page.getByRole('navigation', { name: 'breadcrumb' }); - const bucketEl = nav.getByText('test-bucket'); - await bucketEl.click({ button: 'right' }); - - // Context menu should be open - it's the fixed-position menu - const ctxMenuItems = page.getByRole('menuitem'); - await expect.element(ctxMenuItems.first()).toBeInTheDocument(); - - // The backdrop is a fixed inset-0 div that's a sibling before the context menu - // Dispatch mousedown on it to trigger closeBreadcrumbCtx - const menuEl = (await ctxMenuItems.first().element()) as HTMLElement; - const menuUl = menuEl.closest('ul[role="menu"]')!; - const backdrop = menuUl.previousElementSibling as HTMLElement; - backdrop.dispatchEvent(new MouseEvent('mousedown', { bubbles: true })); - - // Context menu should be closed. - await expect.element(page.getByRole('menuitem').first()).not.toBeInTheDocument(); - }); - it('should open context menu on right-click of bucket with prefix', async () => { const state = createState({ bucket: 'data', prefix: 'reports/' }); render(StorageBreadcrumbWrapper, { state }); diff --git a/src/lib/components/ui/ContextMenu.svelte b/src/lib/components/ui/ContextMenu.svelte new file mode 100644 index 00000000..3a92781a --- /dev/null +++ b/src/lib/components/ui/ContextMenu.svelte @@ -0,0 +1,204 @@ + + + + + + diff --git a/src/lib/components/ui/ContextMenu.svelte.spec.ts b/src/lib/components/ui/ContextMenu.svelte.spec.ts new file mode 100644 index 00000000..89dee0d0 --- /dev/null +++ b/src/lib/components/ui/ContextMenu.svelte.spec.ts @@ -0,0 +1,148 @@ +import { page, userEvent } from 'vitest/browser'; +import { afterEach, describe, expect, it, vi } from 'vitest'; +import { render } from 'vitest-browser-svelte'; +import IconEdit from 'virtual:icons/material-symbols/edit'; +import IconDelete from 'virtual:icons/material-symbols/delete'; +// The real stylesheet, so a display class that would show the closed popover is caught. +import '../../../app.css'; +import ContextMenu, { type ContextMenuAction } from './ContextMenu.svelte'; + +const actions: ContextMenuAction[] = [ + { key: 'edit', icon: IconEdit, label: 'Edit', href: '/edit' }, + { key: 'delete', icon: IconDelete, label: 'Delete', class: 'text-error' }, + { key: 'secret', icon: IconDelete, label: 'Secret', hidden: true }, + { key: 'locked', icon: IconDelete, label: 'Locked', disabled: true } +]; + +function renderMenu(props: Partial<{ open: boolean; x: number; y: number; title: string }> = {}) { + const onaction = vi.fn(); + const onclose = vi.fn(); + const result = render(ContextMenu, { + open: true, + x: 100, + y: 80, + actions, + onaction, + onclose, + ...props + }); + const menu = () => document.querySelector('[popover]')!; + return { ...result, onaction, onclose, menu }; +} + +describe('ContextMenu', () => { + afterEach(() => document.querySelectorAll('[data-outside]').forEach((el) => el.remove())); + + it('stays hidden while closed', async () => { + renderMenu({ open: false }); + await expect.element(page.getByRole('menu', { includeHidden: true })).not.toBeVisible(); + }); + + it('opens as a popover at the given point and takes focus', async () => { + const { menu } = renderMenu(); + await expect.element(page.getByRole('menu')).toBeVisible(); + expect(menu().matches(':popover-open')).toBe(true); + expect(menu().style.left).toBe('100px'); + expect(menu().style.top).toBe('80px'); + expect(document.activeElement?.getAttribute('role')).toBe('menu'); + }); + + it('stays open when a right-click opens it', async () => { + const target = document.createElement('div'); + target.textContent = 'Target'; + target.dataset.outside = ''; + document.body.append(target); + const { onclose, rerender } = renderMenu({ open: false }); + target.addEventListener('contextmenu', (e) => { + e.preventDefault(); + void rerender({ open: true }); + }); + + await page.getByText('Target').click({ button: 'right' }); + + await expect.element(page.getByRole('menu')).toBeVisible(); + await new Promise((resolve) => setTimeout(resolve, 100)); + await expect.element(page.getByRole('menu')).toBeVisible(); + expect(onclose).not.toHaveBeenCalled(); + }); + + it('moves to a second right-click instead of closing', async () => { + const target = document.createElement('div'); + target.textContent = 'Target'; + target.dataset.outside = ''; + target.style.cssText = 'position: fixed; left: 200px; top: 200px; padding: 8px;'; + document.body.append(target); + const { onclose, rerender, menu } = renderMenu(); + await expect.element(page.getByRole('menu')).toBeVisible(); + target.addEventListener('contextmenu', (e) => { + e.preventDefault(); + void rerender({ x: e.clientX, y: e.clientY }); + }); + + await page.getByText('Target').click({ button: 'right' }); + + await expect.poll(() => parseInt(menu().style.top)).toBeGreaterThanOrEqual(200); + await expect.element(page.getByRole('menu')).toBeVisible(); + expect(onclose).not.toHaveBeenCalled(); + }); + + it('hides without reporting a close when the parent closes it', async () => { + const { onclose, rerender, menu } = renderMenu(); + await expect.element(page.getByRole('menu')).toBeVisible(); + await rerender({ open: false }); + expect(menu().matches(':popover-open')).toBe(false); + expect(onclose).not.toHaveBeenCalled(); + }); + + it('flips to the other side of the point near the viewport edges', async () => { + const x = window.innerWidth - 5; + const y = window.innerHeight - 5; + const { menu } = renderMenu({ x, y }); + await expect.element(page.getByRole('menu')).toBeVisible(); + const rect = menu().getBoundingClientRect(); + expect(rect.right).toBeLessThanOrEqual(x + 1); + expect(rect.bottom).toBeLessThanOrEqual(y + 1); + }); + + it('renders visible actions as buttons or links', async () => { + renderMenu(); + await expect + .element(page.getByRole('menuitem', { name: 'Edit' })) + .toHaveAttribute('href', '/edit'); + await expect.element(page.getByRole('menuitem', { name: 'Locked' })).toBeDisabled(); + await expect.element(page.getByRole('menuitem', { name: 'Secret' })).not.toBeInTheDocument(); + }); + + it('runs an action and closes', async () => { + const { onaction, onclose } = renderMenu(); + await page.getByRole('menuitem', { name: 'Delete' }).click(); + expect(onaction).toHaveBeenCalledExactlyOnceWith('delete'); + expect(onclose).toHaveBeenCalled(); + }); + + it('closes on Escape', async () => { + const { onclose, menu } = renderMenu(); + await expect.element(page.getByRole('menu')).toBeVisible(); + await userEvent.keyboard('{Escape}'); + expect(onclose).toHaveBeenCalled(); + expect(menu().matches(':popover-open')).toBe(false); + }); + + it('closes on a click outside', async () => { + const outside = document.createElement('button'); + outside.textContent = 'Outside'; + outside.dataset.outside = ''; + document.body.append(outside); + const { onclose } = renderMenu({ x: 300, y: 300 }); + await expect.element(page.getByRole('menu')).toBeVisible(); + await page.getByRole('button', { name: 'Outside' }).click(); + expect(onclose).toHaveBeenCalled(); + }); + + it('closes from the title close button', async () => { + const { onclose, onaction } = renderMenu({ title: 'Actions' }); + await page.getByRole('menuitem', { name: 'Close' }).click(); + expect(onclose).toHaveBeenCalled(); + expect(onaction).not.toHaveBeenCalled(); + }); +}); diff --git a/src/lib/storage/types.ts b/src/lib/storage/types.ts index 7e3124e7..e083f301 100644 --- a/src/lib/storage/types.ts +++ b/src/lib/storage/types.ts @@ -1,4 +1,3 @@ -import type { Component } from 'svelte'; import type { FilePair } from './file-collection.js'; import type { ConflictEntry, @@ -59,15 +58,6 @@ export type ActiveModal = { // ── Context menu ───────────────────────────────────────────────────────────── -export interface ContextMenuAction { - key: string; - icon: Component; - label: string; - disabled?: boolean; - hidden?: boolean; - class?: string; -} - export interface ContextMenuState { x: number; y: number; From 6e3bb9a8e83a32a00efe666fdb52c80625640779 Mon Sep 17 00:00:00 2001 From: Johannes Fleck Date: Thu, 19 Nov 2026 14:34:31 +0100 Subject: [PATCH 3/4] refactor(storage): Replace FloatingMenu and hand-rolled menus with ContextMenu The bucket grid, treemap, bucket sidebar, saved-connections sidebar and settings connections page use ui/ContextMenu, which removes FloatingMenu and the remaining click-catchers. The delete-connection modal keeps its own target, so it opens again after being dismissed with Escape. Part of #366 and #370 --- .../ui-pattern-enforcement.spec.ts | 1 - .../storage/landing/BucketGrid.svelte | 17 +-- .../storage/modals/details/Treemap.svelte | 66 +++++---- .../storage/shared/FloatingMenu.svelte | 52 ------- .../storage/sidebar/BucketList.svelte | 101 +++----------- .../sidebar/StorageConnectionSidebar.svelte | 126 +++++++---------- .../(app)/settings/connections/+page.svelte | 128 ++++++++---------- 7 files changed, 158 insertions(+), 333 deletions(-) delete mode 100644 src/lib/components/storage/shared/FloatingMenu.svelte diff --git a/src/architecture-tests/ui-pattern-enforcement.spec.ts b/src/architecture-tests/ui-pattern-enforcement.spec.ts index c2581519..8471b301 100644 --- a/src/architecture-tests/ui-pattern-enforcement.spec.ts +++ b/src/architecture-tests/ui-pattern-enforcement.spec.ts @@ -44,7 +44,6 @@ describe('UI Pattern Enforcement', () => { const KNOWN_VIOLATION_PATHS = [ 'src/lib/components/catalog/CatalogTree.svelte', 'src/lib/components/storage/explorer/OperationsButton.svelte', - 'src/lib/components/storage/shared/FloatingMenu.svelte', 'src/lib/components/trino/StatementResult.svelte' ]; diff --git a/src/lib/components/storage/landing/BucketGrid.svelte b/src/lib/components/storage/landing/BucketGrid.svelte index 8b719c31..df2d6f95 100644 --- a/src/lib/components/storage/landing/BucketGrid.svelte +++ b/src/lib/components/storage/landing/BucketGrid.svelte @@ -5,7 +5,7 @@ import * as m from '$lib/paraglide/messages.js'; import { resolve } from '$app/paths'; import { getStorageState } from '$lib/storage/context.js'; - import FloatingMenu from '../shared/FloatingMenu.svelte'; + import ContextMenu from '$lib/components/ui/ContextMenu.svelte'; interface Props { buckets?: string[]; @@ -33,21 +33,14 @@ } - - - + onaction={() => ctxMenu && openDetails(ctxMenu.bucket)} + actions={[{ key: 'details', icon: IconInfo, label: m.storage_action_details() }]} +/> {#if loading || !storage.connectionHostname}
(() => { + const target = ctxMenu?.target; + if (!target) return []; + return [ + { + key: 'name', + icon: IconContentCopy, + label: target.isContainer + ? m.storage_details_copy_dir_name() + : m.storage_details_copy_file_name() + }, + { + key: 'path', + icon: IconFolderOpen, + label: m.storage_details_copy_full_path(), + hidden: !target.fullKey + } + ]; + }); + + function handleCtxAction(key: string) { + const target = ctxMenu?.target; + if (!target) return; + if (key === 'name') void copy(target.name); + else if (target.fullKey) void copy(target.fullKey); + } + async function copy(text: string) { try { await navigator.clipboard.writeText(text); @@ -290,40 +317,11 @@
- - {#if ctxMenu} - - {#if ctxMenu.target.fullKey} - - {/if} - {/if} - + onaction={handleCtxAction} + actions={ctxActions} +/> diff --git a/src/lib/components/storage/shared/FloatingMenu.svelte b/src/lib/components/storage/shared/FloatingMenu.svelte deleted file mode 100644 index 261a6d06..00000000 --- a/src/lib/components/storage/shared/FloatingMenu.svelte +++ /dev/null @@ -1,52 +0,0 @@ - - -{#if open} - - -{/if} diff --git a/src/lib/components/storage/sidebar/BucketList.svelte b/src/lib/components/storage/sidebar/BucketList.svelte index 5085cfc3..9bd90d9e 100644 --- a/src/lib/components/storage/sidebar/BucketList.svelte +++ b/src/lib/components/storage/sidebar/BucketList.svelte @@ -1,7 +1,6 @@ - - - -{#if unpinCtx} -
    node.focus()} - class=" - menu menu-sm border-base-300 bg-base-100 fixed z-150 w-48 rounded-lg - border p-1 shadow-lg - " - role="menu" - tabindex="-1" - style="left: {adjustedPos.left}px; top: {adjustedPos.top}px;" - > - -
  • - -
  • -
-{/if} +