mirror of
https://github.com/appwrite/console.git
synced 2026-11-18 20:47:21 +00:00
fix(tables): clear row selection when the visible rows change
Selection state in MultiSelectionTable stuck around across pagination and search, keyed only on row id. Selecting rows, then paginating to a different page and hitting "select all" would carry the old ids into the new batch delete, silently deleting rows the user never saw selected. Reported from Storage and Databases in production. Reset selection whenever the URL changes, and key the previously unkeyed row each-blocks (files, users, memberships, platforms, backups) so Svelte doesn't reuse row elements across renders.
This commit is contained in:
1 parent
5ed1b66110
commit
8fa07a8394
10 files changed
+161
-6
No files matched your search
@@ -0,0 +1,7 @@
|
||||
const BUCKET_URL = 'http://localhost/console/storage/bucket-a';
|
||||
|
||||
export const page = $state({ url: new URL(BUCKET_URL) });
|
||||
|
||||
export function navigateTo(href: string) {
|
||||
page.url = new URL(href, BUCKET_URL);
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
import '@testing-library/jest-dom/vitest';
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { render, screen } from '@testing-library/svelte';
|
||||
import userEvent from '@testing-library/user-event';
|
||||
import { tick } from 'svelte';
|
||||
import Harness from './multiSelectTableHarness.svelte';
|
||||
import { navigateTo } from './appState.svelte';
|
||||
|
||||
vi.mock('$app/state', () => import('./appState.svelte'));
|
||||
|
||||
vi.mock('$lib/stores/sdk', () => ({
|
||||
sdk: {
|
||||
forConsole: { account: { getPrefs: () => Promise.resolve({}) } },
|
||||
forProject: () => ({})
|
||||
}
|
||||
}));
|
||||
|
||||
vi.mock('$lib/actions/analytics', () => ({
|
||||
trackEvent: vi.fn(),
|
||||
trackError: vi.fn(),
|
||||
Click: {},
|
||||
Submit: {}
|
||||
}));
|
||||
|
||||
const pages = { '1': ['a', 'b', 'c'], '2': ['d', 'e', 'f'] };
|
||||
|
||||
async function goToPageTwo() {
|
||||
navigateTo('?page=2');
|
||||
await tick();
|
||||
}
|
||||
|
||||
describe('MultiSelectionTable', () => {
|
||||
beforeEach(() => navigateTo('?page=1'));
|
||||
|
||||
it('drops the selection when another page of rows is loaded', async () => {
|
||||
const user = userEvent.setup();
|
||||
render(Harness, { props: { pages, onDeleteIds: vi.fn() } });
|
||||
|
||||
const [, firstRow] = screen.getAllByRole('checkbox');
|
||||
await user.click(firstRow);
|
||||
expect(screen.getByText('file selected')).toBeInTheDocument();
|
||||
|
||||
await goToPageTwo();
|
||||
|
||||
expect(screen.queryByText('file selected')).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('selects only the rows on screen after paginating', async () => {
|
||||
const user = userEvent.setup();
|
||||
const onDeleteIds = vi.fn();
|
||||
render(Harness, { props: { pages, onDeleteIds } });
|
||||
|
||||
await goToPageTwo();
|
||||
|
||||
const [selectAll] = screen.getAllByRole('checkbox');
|
||||
await user.click(selectAll);
|
||||
await user.click(screen.getByRole('button', { name: 'Delete' }));
|
||||
|
||||
expect(onDeleteIds).toHaveBeenCalledWith(['d', 'e', 'f']);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,35 @@
|
||||
<script lang="ts">
|
||||
import { page } from '$app/state';
|
||||
import { Table } from '@appwrite.io/pink-svelte';
|
||||
import MultiSelectionTable from '../multiSelectTable.svelte';
|
||||
|
||||
let {
|
||||
pages,
|
||||
onDeleteIds
|
||||
}: { pages: Record<string, string[]>; onDeleteIds: (ids: string[]) => void } = $props();
|
||||
|
||||
// rows follow the url the way a `+page.ts` load function does
|
||||
const rows = $derived(pages[page.url.searchParams.get('page') ?? '1']);
|
||||
</script>
|
||||
|
||||
<MultiSelectionTable
|
||||
resource="file"
|
||||
confirmDeletion={false}
|
||||
columns={[{ id: 'id' }]}
|
||||
onDelete={(_batchDelete, selectedRows) => {
|
||||
onDeleteIds([...selectedRows]);
|
||||
return { deleted: [] };
|
||||
}}>
|
||||
{#snippet header(root)}
|
||||
<Table.Header.Cell column="id" {root}>Id</Table.Header.Cell>
|
||||
{/snippet}
|
||||
|
||||
{#snippet children(root)}
|
||||
<!-- deliberately unkeyed, the way the console rendered file rows when this bug landed -->
|
||||
{#each rows as id}
|
||||
<Table.Row.Base {root} {id}>
|
||||
<Table.Cell column="id" {root}>{id}</Table.Cell>
|
||||
</Table.Row.Base>
|
||||
{/each}
|
||||
{/snippet}
|
||||
</MultiSelectionTable>
|
||||
@@ -12,6 +12,7 @@
|
||||
|
||||
<script lang="ts">
|
||||
import type { Snippet } from 'svelte';
|
||||
import { page } from '$app/state';
|
||||
import {
|
||||
Table,
|
||||
Badge,
|
||||
@@ -64,6 +65,19 @@
|
||||
let onDeleteError: string | null = $state(null);
|
||||
let showConfirmDeletion: boolean = $state(false);
|
||||
|
||||
// paginating, searching or switching resource swaps the rows out from under the
|
||||
// selection, and deleting what is no longer on screen is silent data loss
|
||||
const selectionKey = $derived(`${page.url.href}|${computeKey}`);
|
||||
|
||||
let renderedUrl: string | undefined;
|
||||
|
||||
$effect.pre(() => {
|
||||
if (renderedUrl === page.url.href) return;
|
||||
|
||||
renderedUrl = page.url.href;
|
||||
selectedRows = [];
|
||||
});
|
||||
|
||||
function notifySuccess(count: number) {
|
||||
if (!showSuccessNotification) return;
|
||||
if (count === 0) return;
|
||||
@@ -155,7 +169,7 @@
|
||||
}
|
||||
</script>
|
||||
|
||||
{#key computeKey}
|
||||
{#key selectionKey}
|
||||
<Table.Root let:root {columns} {allowSelection} bind:selectedRows>
|
||||
<svelte:fragment slot="header" let:root>
|
||||
{@render header?.(root)}
|
||||
|
||||
@@ -106,7 +106,7 @@
|
||||
{/snippet}
|
||||
|
||||
{#snippet children(root)}
|
||||
{#each data.users.users as user}
|
||||
{#each data.users.users as user (user.$id)}
|
||||
<Table.Row.Link
|
||||
href={`${base}/project-${page.params.region}-${page.params.project}/auth/user-${user.$id}`}
|
||||
{root}
|
||||
|
||||
+1
-1
@@ -71,7 +71,7 @@
|
||||
{/snippet}
|
||||
|
||||
{#snippet children(root)}
|
||||
{#each data.memberships.memberships as membership}
|
||||
{#each data.memberships.memberships as membership (membership.$id)}
|
||||
<Table.Row.Link
|
||||
{root}
|
||||
href={`${base}/project-${page.params.region}-${page.params.project}/auth/teams/team-${membership.teamId}`}
|
||||
|
||||
+1
-1
@@ -221,7 +221,7 @@
|
||||
{/snippet}
|
||||
|
||||
{#snippet children(root)}
|
||||
{#each data.backups.archives as backup, index}
|
||||
{#each data.backups.archives as backup, index (backup.$id)}
|
||||
{@const policy = getPolicyDetails(backup.policyId)}
|
||||
{@const retainedUntil = new Date(
|
||||
new Date(policy?.$createdAt).getTime() + policy?.retention * 24 * 60 * 60 * 1000
|
||||
|
||||
@@ -176,7 +176,7 @@
|
||||
{/snippet}
|
||||
|
||||
{#snippet children(root)}
|
||||
{#each data.platforms.platforms as platform}
|
||||
{#each data.platforms.platforms as platform (platform.$id)}
|
||||
<Table.Row.Link href={getPlatformPath(platform)} {root} id={platform.$id}>
|
||||
<Table.Cell {root}>
|
||||
{platform.name}
|
||||
|
||||
+1
-1
@@ -238,7 +238,7 @@
|
||||
{/snippet}
|
||||
|
||||
{#snippet children(root)}
|
||||
{#each data.files.files as file}
|
||||
{#each data.files.files as file (file.$id)}
|
||||
{#if file.chunksTotal / file.chunksUploaded !== 1}
|
||||
<Table.Row.Base {root} id={file.$id}>
|
||||
<Table.Cell column="filename" {root}>
|
||||
|
||||
@@ -1,6 +1,33 @@
|
||||
import '@testing-library/jest-dom/vitest';
|
||||
import { beforeAll, vi } from 'vitest';
|
||||
|
||||
// jsdom hands back a bare object for web storage under this runtime, so the
|
||||
// console's `localStorage` reads blow up before any component renders
|
||||
function createStorage(): Storage {
|
||||
const entries = new Map<string, string>();
|
||||
|
||||
return {
|
||||
get length() {
|
||||
return entries.size;
|
||||
},
|
||||
key: (index: number) => [...entries.keys()][index] ?? null,
|
||||
getItem: (key: string) => entries.get(key) ?? null,
|
||||
setItem: (key: string, value: string) => void entries.set(key, String(value)),
|
||||
removeItem: (key: string) => void entries.delete(key),
|
||||
clear: () => entries.clear()
|
||||
};
|
||||
}
|
||||
|
||||
for (const name of ['localStorage', 'sessionStorage'] as const) {
|
||||
if (typeof window[name]?.getItem === 'function') continue;
|
||||
|
||||
Object.defineProperty(window, name, {
|
||||
writable: true,
|
||||
configurable: true,
|
||||
value: createStorage()
|
||||
});
|
||||
}
|
||||
|
||||
// required for svelte5 + jsdom as jsdom does not support matchMedia
|
||||
Object.defineProperty(window, 'matchMedia', {
|
||||
writable: true,
|
||||
@@ -15,6 +42,17 @@ Object.defineProperty(window, 'matchMedia', {
|
||||
}))
|
||||
});
|
||||
|
||||
// jsdom ships no ResizeObserver, which pink-svelte's FloatingActionBar constructs on mount
|
||||
Object.defineProperty(window, 'ResizeObserver', {
|
||||
writable: true,
|
||||
configurable: true,
|
||||
value: class ResizeObserver {
|
||||
observe() {}
|
||||
unobserve() {}
|
||||
disconnect() {}
|
||||
}
|
||||
});
|
||||
|
||||
beforeAll(() => {
|
||||
vi.mock('$app/environment', () => ({
|
||||
dev: true,
|
||||
|
||||
Reference in new issue
Block a user