Files
dbx/apps/desktop/src/components/redis/RedisKeyBrowser.infiniteScroll.spec.ts
T

1254 lines
53 KiB
TypeScript
Vendored

// @vitest-environment happy-dom
import { createApp, defineComponent, h, KeepAlive, nextTick, ref } from "vue";
import { createI18n } from "vue-i18n";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { RedisKeyInfo } from "@/lib/backend/api";
import { defaultRedisKeyGrouping, type RedisKeyGrouping } from "@/lib/redis/redisKeyGrouping";
import { REDIS_SCAN_PAGE_SIZE_OPTIONS } from "@/lib/redis/redisKeyPattern";
const grouping = ref<RedisKeyGrouping>();
vi.mock("@/lib/redis/redisKeyViewScheduler", () => ({ createRedisKeyViewYield: () => () => new Promise<void>((resolve) => requestAnimationFrame(() => resolve())) }));
const mocks = vi.hoisted(() => ({
scrollerInitialSnapshot: vi.fn(),
scrollerRefresh: vi.fn(),
ensureConnected: vi.fn(),
redisScanKeysBatch: vi.fn(),
redisScanValues: vi.fn(),
redisGetValue: vi.fn(),
redisSetString: vi.fn(),
redisJsonSet: vi.fn(),
redisHashSet: vi.fn(),
redisListPush: vi.fn(),
redisSetAdd: vi.fn(),
redisZadd: vi.fn(),
redisStreamAdd: vi.fn(),
redisSetTtl: vi.fn(),
redisSetExpireAt: vi.fn(),
redisSetKeysTtl: vi.fn(),
redisSetKeysExpireAt: vi.fn(),
redisCheckJsonModule: vi.fn(),
redisDeleteKey: vi.fn(),
redisDeleteKeys: vi.fn(),
redisExecuteCommand: vi.fn(),
saveHistory: vi.fn(),
toast: vi.fn(),
updateRedisDbKeyStats: vi.fn(),
listRedisCompletionCommandDocs: vi.fn(),
listRedisCompletionKeys: vi.fn(),
redisScanPageSize: 100,
infiniteScroll: true,
queryResultMaxRowsEnabled: true,
queryResultMaxRows: 5000,
}));
vi.mock("@/lib/backend/api", () => ({
redisScanKeysBatch: mocks.redisScanKeysBatch,
redisScanValues: mocks.redisScanValues,
redisGetValue: mocks.redisGetValue,
redisSetString: mocks.redisSetString,
redisJsonSet: mocks.redisJsonSet,
redisHashSet: mocks.redisHashSet,
redisListPush: mocks.redisListPush,
redisSetAdd: mocks.redisSetAdd,
redisZadd: mocks.redisZadd,
redisStreamAdd: mocks.redisStreamAdd,
redisSetTtl: mocks.redisSetTtl,
redisSetExpireAt: mocks.redisSetExpireAt,
redisSetKeysTtl: mocks.redisSetKeysTtl,
redisSetKeysExpireAt: mocks.redisSetKeysExpireAt,
redisCheckJsonModule: mocks.redisCheckJsonModule,
redisDeleteKey: mocks.redisDeleteKey,
redisDeleteKeys: mocks.redisDeleteKeys,
redisExecuteCommand: mocks.redisExecuteCommand,
saveHistory: mocks.saveHistory,
}));
vi.mock("@/stores/connectionStore", () => ({
useConnectionStore: () => ({
ensureConnected: mocks.ensureConnected,
getConfig: () => ({ name: "Redis", redis_key_separator: ":", redis_scan_page_size: mocks.redisScanPageSize, redis_key_grouping: grouping.value }),
updateRedisKeyGrouping: async (_id: string, config: RedisKeyGrouping) => {
grouping.value = config;
},
updateRedisDbKeyStats: mocks.updateRedisDbKeyStats,
listRedisCompletionCommandDocs: mocks.listRedisCompletionCommandDocs,
listRedisCompletionKeys: mocks.listRedisCompletionKeys,
invalidateCompletionCache: vi.fn(),
refreshRedisDbKeyCounts: vi.fn(),
}),
}));
vi.mock("@/stores/settingsStore", () => ({
useSettingsStore: () => ({
editorSettings: {
infiniteScroll: mocks.infiniteScroll,
queryResultMaxRowsEnabled: mocks.queryResultMaxRowsEnabled,
queryResultMaxRows: mocks.queryResultMaxRows,
},
}),
}));
vi.mock("@/composables/useEditorFontFamilyStyle", () => ({
useEditorFontFamilyStyle: () => ({}),
}));
vi.mock("@/composables/useToast", () => ({
useToast: () => ({ toast: mocks.toast }),
}));
vi.mock("@/components/ui/button", async () => {
const { defineComponent, h } = await import("vue");
return {
Button: defineComponent({
inheritAttrs: false,
props: { disabled: Boolean },
setup(props, { attrs, slots }) {
return () => h("button", { ...attrs, disabled: props.disabled }, slots.default?.());
},
}),
};
});
vi.mock("@/components/ui/input", async () => {
const { defineComponent, h, mergeProps } = await import("vue");
return {
Input: defineComponent({
inheritAttrs: false,
props: { modelValue: String, disabled: Boolean },
emits: ["update:modelValue"],
setup(props, { attrs, emit }) {
return () =>
h(
"input",
mergeProps(attrs, {
value: props.modelValue ?? "",
disabled: props.disabled,
onInput: (event: Event) => emit("update:modelValue", (event.target as HTMLInputElement).value),
}),
);
},
}),
};
});
vi.mock("@/components/ui/badge", async () => {
const { defineComponent, h } = await import("vue");
return {
Badge: defineComponent({
setup:
(_, { attrs, slots }) =>
() =>
h("span", attrs, slots.default?.()),
}),
};
});
vi.mock("@/components/ui/dialog", async () => {
const { defineComponent, h } = await import("vue");
const slotContainer = defineComponent({
setup:
(_, { attrs, slots }) =>
() =>
h("div", attrs, slots.default?.()),
});
return {
Dialog: defineComponent({
props: { open: Boolean },
setup(props, { slots }) {
return () => (props.open ? h("div", { "data-test-dialog": "" }, slots.default?.()) : null);
},
}),
DialogContent: slotContainer,
DialogFooter: slotContainer,
DialogHeader: slotContainer,
DialogTitle: slotContainer,
};
});
vi.mock("@/components/ui/select", async () => {
const { defineComponent, h } = await import("vue");
const slotContainer = defineComponent({
setup:
(_, { attrs, slots }) =>
() =>
h("div", attrs, slots.default?.()),
});
return {
Select: slotContainer,
SelectContent: slotContainer,
SelectItem: defineComponent({
props: { value: String },
setup(props, { slots }) {
return () => h("button", { type: "button", "data-test-select-value": props.value }, slots.default?.());
},
}),
SelectTrigger: slotContainer,
SelectValue: slotContainer,
};
});
vi.mock("@/components/ui/option-help-panel", async () => {
const { defineComponent, h } = await import("vue");
return { OptionHelpPanel: defineComponent({ setup: () => () => h("div") }) };
});
vi.mock("@/components/ui/tabs", async () => {
const { defineComponent, h } = await import("vue");
const slotContainer = defineComponent({
setup:
(_, { attrs, slots }) =>
() =>
h("div", attrs, slots.default?.()),
});
return { Tabs: slotContainer, TabsContent: slotContainer, TabsList: slotContainer, TabsTrigger: slotContainer };
});
vi.mock("@/components/ui/switch", async () => {
const { defineComponent, h } = await import("vue");
return { Switch: defineComponent({ setup: () => () => h("button", { type: "button" }) }) };
});
vi.mock("@/components/ui/date-time-picker/DateTimePicker.vue", async () => {
const { defineComponent, h } = await import("vue");
return { default: defineComponent({ setup: () => () => h("div") }) };
});
vi.mock("@/components/ui/CustomContextMenu.vue", async () => {
const { defineComponent, h } = await import("vue");
return {
default: defineComponent({
setup(_, { slots }) {
return () => h("div", slots.default?.({ onContextMenu: () => undefined }));
},
}),
};
});
vi.mock("@/components/editor/DangerConfirmDialog.vue", async () => {
const { defineComponent, h } = await import("vue");
return { default: defineComponent({ props: { open: Boolean }, setup: () => () => h("div") }) };
});
vi.mock("./RedisValueViewer.vue", async () => {
const { defineComponent, h } = await import("vue");
return { default: defineComponent({ setup: () => () => h("div") }) };
});
vi.mock("./RedisPubSubPanel.vue", async () => {
const { defineComponent, h } = await import("vue");
return { default: defineComponent({ setup: () => () => h("div") }) };
});
vi.mock("./RedisSlowlogPanel.vue", async () => {
const { defineComponent, h } = await import("vue");
return { default: defineComponent({ setup: () => () => h("div") }) };
});
vi.mock("vue-virtual-scroller", async () => {
const { defineComponent, h } = await import("vue");
return {
RecycleScroller: defineComponent({
inheritAttrs: false,
props: { items: { type: Array, default: () => [] } },
setup(props, { attrs, slots, expose }) {
// The installed library copies/keys all initial items in setup, even
// though its rendered pool only contains the visible viewport.
mocks.scrollerInitialSnapshot(props.items.slice().length);
const epoch = ref(0);
expose({
findItemIndex: () => 0,
getScroll: () => ({ start: 0 }),
scrollToItem: () => {},
updateVisibleItems: () => {
mocks.scrollerRefresh(props.items.length);
epoch.value++;
},
});
// Real RecycleScroller only mounts as many rows as fit the viewport;
// rendering everything here would defeat the point of this test, so
// cap it the same way the expiry spec's mock does.
const visibleItemCount = 50;
return () => {
void epoch.value;
return h(
"div",
attrs,
props.items.slice(0, visibleItemCount).map((item) => slots.default?.({ item })),
);
};
},
}),
};
});
vi.mock("splitpanes", async () => {
const { defineComponent, h } = await import("vue");
const slotContainer = defineComponent({
setup:
(_, { attrs, slots }) =>
() =>
h("div", attrs, slots.default?.()),
});
return { Splitpanes: slotContainer, Pane: slotContainer };
});
import RedisKeyBrowser from "./RedisKeyBrowser.vue";
const mountedApps: Array<{ unmount: () => void; host: HTMLElement }> = [];
function mountBrowser() {
const host = document.createElement("div");
document.body.append(host);
const app = createApp(RedisKeyBrowser, { connectionId: "connection", db: 0, blockDangerousRedisCommands: false });
app.use(createI18n({ legacy: false, locale: "en", messages: { en: {} }, missingWarn: false, fallbackWarn: false }));
app.mount(host);
mountedApps.push({ unmount: () => app.unmount(), host });
return host;
}
function mountKeptAliveBrowser(onError?: (error: unknown) => void) {
const active = ref(true);
const host = document.createElement("div");
document.body.append(host);
const app = createApp(
defineComponent({
setup() {
return () =>
h(KeepAlive, null, {
default: () => (active.value ? h(RedisKeyBrowser, { connectionId: "connection", db: 0, blockDangerousRedisCommands: false }) : null),
});
},
}),
);
if (onError) app.config.errorHandler = onError;
app.use(createI18n({ legacy: false, locale: "en", messages: { en: {} }, missingWarn: false, fallbackWarn: false }));
app.mount(host);
mountedApps.push({ unmount: () => app.unmount(), host });
return {
host,
async deactivate() {
active.value = false;
await settleThoroughly();
},
async activate() {
active.value = true;
await settleThoroughly();
},
};
}
function unmountBrowser(host: HTMLElement) {
const index = mountedApps.findIndex((mounted) => mounted.host === host);
expect(index, "mounted browser").toBeGreaterThanOrEqual(0);
const [mounted] = mountedApps.splice(index, 1);
mounted!.unmount();
host.remove();
}
async function settle() {
await nextTick();
await Promise.resolve();
await nextTick();
await Promise.resolve();
await nextTick();
}
function deferred<T>() {
let resolve!: (value: T) => void;
let reject!: (reason?: unknown) => void;
const promise = new Promise<T>((next, fail) => {
resolve = next;
reject = fail;
});
return { promise, resolve, reject };
}
function resetApiMocks() {
vi.clearAllMocks();
mocks.ensureConnected.mockResolvedValue(undefined);
mocks.redisScanPageSize = 100;
mocks.infiniteScroll = true;
mocks.queryResultMaxRowsEnabled = true;
mocks.queryResultMaxRows = 5000;
mocks.redisScanKeysBatch.mockResolvedValue({ cursor: 0, keys: [], total_keys: 0 });
mocks.redisScanValues.mockReset().mockResolvedValue({ cursor: 0, keys: [], total_keys: 0 });
}
// A short, un-collapsed tree (a real DB has millions of keys folded into a
// handful of visible top-level groups) never overflows the scroller's
// viewport, so it never emits a native `scroll` event. Simulate that real
// layout fact — happy-dom always reports 0 for clientHeight/scrollHeight —
// by stubbing both getters for the specific scroller element under test.
let originalClientHeight: PropertyDescriptor | undefined;
let originalScrollHeight: PropertyDescriptor | undefined;
function stubNonOverflowingViewport() {
originalClientHeight = Object.getOwnPropertyDescriptor(HTMLElement.prototype, "clientHeight");
originalScrollHeight = Object.getOwnPropertyDescriptor(HTMLElement.prototype, "scrollHeight");
Object.defineProperty(HTMLElement.prototype, "clientHeight", {
configurable: true,
get(this: HTMLElement) {
return this.classList.contains("redis-key-scroller") ? 1000 : 0;
},
});
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {
configurable: true,
get(this: HTMLElement) {
return this.classList.contains("redis-key-scroller") ? 90 : 0;
},
});
}
function restoreViewportStub() {
if (originalClientHeight) Object.defineProperty(HTMLElement.prototype, "clientHeight", originalClientHeight);
if (originalScrollHeight) Object.defineProperty(HTMLElement.prototype, "scrollHeight", originalScrollHeight);
}
beforeEach(() => {
grouping.value = undefined;
resetApiMocks();
});
afterEach(() => {
for (const { unmount, host } of mountedApps.splice(0)) {
unmount();
host.remove();
}
restoreViewportStub();
});
describe("RedisKeyBrowser infinite scroll auto-continue (issue #6022)", () => {
it.each(["mount", "refresh"])("cancels legacy publication when grouping is re-enabled during %s", async (phase) => {
grouping.value = { ...defaultRedisKeyGrouping(), enabled: true };
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 0, keys: [{ key_display: "a", key_raw: btoa("a"), key_type: "string", ttl: -1 }], total_keys: 1 });
const host = mountBrowser();
await settleThoroughly();
const reenable = () => {
grouping.value = { ...grouping.value!, enabled: true };
};
if (phase === "mount") mocks.scrollerInitialSnapshot.mockImplementationOnce(reenable);
else mocks.scrollerRefresh.mockImplementationOnce(reenable);
grouping.value = { ...grouping.value!, enabled: false };
await settleThoroughly();
expect(grouping.value.enabled).toBe(true);
expect(host.querySelector('[role="button"]')).not.toBeNull();
expect(host.textContent).not.toContain("redisGrouping.preparingLegacy");
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
});
it("does not publish a prepared old scope after the database changes or keys are cleared", async () => {
grouping.value = { ...defaultRedisKeyGrouping(), enabled: true };
const keys = Array.from({ length: 1100 }, (_, i) => ({ key_display: `old:${i}`, key_raw: btoa(`old:${i}`), key_type: "string", ttl: -1 }));
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 0, keys, total_keys: keys.length });
const db = ref(0);
const host = document.createElement("div");
document.body.append(host);
const app = createApp(defineComponent({ setup: () => () => h(RedisKeyBrowser, { connectionId: "connection", db: db.value, blockDangerousRedisCommands: false }) }));
app.use(createI18n({ legacy: false, locale: "en", messages: { en: {} }, missingWarn: false, fallbackWarn: false }));
app.mount(host);
mountedApps.push({ unmount: () => app.unmount(), host });
await new Promise((resolve) => setTimeout(resolve, 20));
await settleThoroughly();
const frames: FrameRequestCallback[] = [];
vi.stubGlobal("requestAnimationFrame", (callback: FrameRequestCallback) => {
frames.push(callback);
return frames.length;
});
try {
grouping.value = { ...grouping.value!, enabled: false };
await settle();
expect(frames.length).toBeGreaterThan(0);
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 0, keys: [{ key_display: "new", key_raw: btoa("new"), key_type: "string", ttl: -1 }], total_keys: 1 });
db.value = 1;
await settleThoroughly();
for (let i = 0; i < 30; i++) {
for (const callback of frames.splice(0)) callback(i);
await settle();
}
expect(host.querySelector(`[data-redis-leaf='${btoa("new")}']`)).not.toBeNull();
expect(host.textContent).not.toContain("old");
window.dispatchEvent(new CustomEvent("dbx-redis-db-flushed", { detail: { connectionId: "connection", db: 1 } }));
await settleThoroughly();
expect(host.querySelector(`[data-redis-leaf='${btoa("new")}']`)).toBeNull();
} finally {
vi.unstubAllGlobals();
}
});
it("keeps custom rows during cooperative legacy preparation, cancels and retries", async () => {
grouping.value = { ...defaultRedisKeyGrouping(), enabled: true };
const keys = Array.from({ length: 1100 }, (_, i) => ({ key_display: `namespace:${i}`, key_raw: btoa(`namespace:${i}`), key_type: "string", ttl: -1 }));
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 0, keys, total_keys: keys.length });
const host = mountBrowser();
await settleThoroughly();
await new Promise((resolve) => setTimeout(resolve, 20));
await settleThoroughly();
expect(host.querySelector('[role="button"]')).not.toBeNull();
const frames: FrameRequestCallback[] = [];
vi.stubGlobal("requestAnimationFrame", (callback: FrameRequestCallback) => {
frames.push(callback);
return frames.length;
});
try {
grouping.value = { ...grouping.value!, enabled: false };
await settle();
expect(frames.length).toBeGreaterThan(0);
expect(host.textContent).toContain("redisGrouping.preparingLegacy");
expect(host.querySelector('[role="button"]')).not.toBeNull();
grouping.value = { ...grouping.value!, enabled: true };
for (const callback of frames.splice(0)) callback(0);
await settle();
expect(host.textContent).not.toContain("redisGrouping.preparingLegacy");
expect(host.querySelector('[role="button"]')).not.toBeNull();
mocks.scrollerInitialSnapshot.mockClear();
grouping.value = { ...grouping.value!, enabled: false };
for (let i = 0; i < 30; i++) {
for (const callback of frames.splice(0)) callback(i);
await settle();
}
expect(host.textContent).not.toContain("redisGrouping.preparingLegacy");
expect(host.querySelector("[data-redis-group]")).not.toBeNull();
expect(mocks.scrollerInitialSnapshot).toHaveBeenCalledWith(0);
expect(mocks.scrollerInitialSnapshot.mock.calls.every(([length]) => length === 0)).toBe(true);
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
} finally {
vi.unstubAllGlobals();
}
});
it("continues sparse custom groups and preserves explicit checks across layout toggles", async () => {
grouping.value = { ...defaultRedisKeyGrouping(), enabled: true };
stubNonOverflowingViewport();
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 7, keys: [{ key_display: "a", key_raw: btoa("a"), key_type: "string", ttl: -1 }], total_keys: 2 });
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 0, keys: [{ key_display: "b", key_raw: btoa("b"), key_type: "string", ttl: -1 }], total_keys: 2 });
const host = mountBrowser();
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2);
host.querySelector<HTMLButtonElement>("[data-redis-select-all]")!.click();
await settleThoroughly();
expect(host.querySelector("[data-redis-batch-delete]")?.textContent).toContain("2");
grouping.value = { ...grouping.value!, enabled: false };
await settleThoroughly();
expect(host.querySelector("[data-redis-batch-delete]")?.textContent).toContain("2");
grouping.value = { ...grouping.value!, enabled: true, inner_view: "tree" };
await settleThoroughly();
expect(host.querySelector("[data-redis-batch-delete]")?.textContent).toContain("2");
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2);
});
it("keeps fetching pages on its own when the loaded rows don't overflow the viewport, without any scroll event", async () => {
stubNonOverflowingViewport();
const firstPage: RedisKeyInfo[] = [{ key_display: "id:acct:1:mt5:live01:59995072:x", key_raw: "a", key_type: "string", ttl: -1, size: 0, value_preview: "" }];
const secondPage: RedisKeyInfo[] = [{ key_display: "id:acct:1:mt5:live01:59995129:x", key_raw: "b", key_type: "string", ttl: -1, size: 0, value_preview: "" }];
const thirdPage: RedisKeyInfo[] = [
{ key_display: "id:acct:1:mt5:live01:59995904:x", key_raw: "c", key_type: "string", ttl: -1, size: 0, value_preview: "" },
{ key_display: "id:acct:1:mt4:live04:40001:y", key_raw: "d", key_type: "string", ttl: -1, size: 0, value_preview: "" },
];
// A large real keyspace: cursor keeps moving and only closes on the
// third round-trip, same shape as scanning a few hundred-thousand keys.
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 7, keys: firstPage, total_keys: 200_004 });
if (cursor === 7) return Promise.resolve({ cursor: 91, keys: secondPage, total_keys: 0 });
return Promise.resolve({ cursor: 0, keys: thirdPage, total_keys: 0 });
});
const host = mountBrowser();
await settle();
await settle();
await settle();
// Nobody dispatched a `scroll` event — a container shorter than its
// viewport never fires one in a real browser — yet all three pages must
// have been pulled automatically. All 4 keys share the "id" top-level
// segment, so the (collapsed-by-default) root group's own badge is
// enough to prove every page made it into the tree, without needing to
// expand each nested folder just to read the leaf labels.
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(3);
expect(host.textContent).toContain("id");
expect(host.textContent).toContain("(4)");
});
it("stops auto-fetching once the loaded rows actually overflow the viewport", async () => {
stubNonOverflowingViewport();
// This time the scroller reports real overflow after the first page, so
// the existing scroll-driven `loadMore` is expected to take over instead.
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {
configurable: true,
get(this: HTMLElement) {
return this.classList.contains("redis-key-scroller") ? 5000 : 0;
},
});
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 7, keys: [{ key_display: "k1", key_raw: "a", key_type: "string", ttl: -1, size: 0, value_preview: "" }], total_keys: 200_004 });
return Promise.resolve({ cursor: 0, keys: [{ key_display: "k2", key_raw: "b", key_type: "string", ttl: -1, size: 0, value_preview: "" }], total_keys: 0 });
});
mountBrowser();
await settle();
await settle();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
});
it("rechecks bounded auto-loading when the viewport grows", async () => {
stubNonOverflowingViewport();
let overflow = true;
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {
configurable: true,
get(this: HTMLElement) {
return this.classList.contains("redis-key-scroller") ? (overflow ? 5000 : 90) : 0;
},
});
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 7, keys: [keyInfo("a")], total_keys: 200_004 });
return Promise.resolve({ cursor: 0, keys: [keyInfo("b")], total_keys: 0 });
});
const host = mountBrowser();
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
overflow = false;
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("resize"));
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2);
});
});
// Use the real production default page size (not an artificial single-call
// size) so these tests actually exercise the amplification the review
// flagged: with the default 1,000-row page, a single logical "page" can
// still internally retry across many backend calls while it comes back
// empty (COUNT is only a hint), so a page-count cap alone doesn't bound the
// real work. See `AUTO_LOAD_TOTAL_SCAN_ITERATIONS` in RedisKeyBrowser.vue —
// the whole automatic-fill operation shares ONE SCAN-iteration budget across
// every backend call it makes, however many logical pages that spans.
const PRODUCTION_PAGE_SIZE = 1000;
// Mirrors the constants in RedisKeyBrowser.vue: `iterations` per backend
// call is capped at 8, and the automatic-fill operation gets a total budget
// of 50 SCAN iterations. Supported page sizes split that budget differently:
// 200/1,000-row pages need at most 7 backend calls, while 5,000/10,000-row
// pages can need at most 10. The shared iteration limit remains the invariant.
const ITERATIONS_PER_CALL = 8;
const AUTO_LOAD_TOTAL_SCAN_ITERATIONS = 50;
const AUTO_LOAD_MAX_CALLS = Math.ceil(AUTO_LOAD_TOTAL_SCAN_ITERATIONS / ITERATIONS_PER_CALL);
const AUTO_LOAD_PAGE_SIZE_CASES = [
{ pageSize: 200, maxCalls: 7 },
{ pageSize: 1000, maxCalls: 7 },
{ pageSize: 5000, maxCalls: 10 },
{ pageSize: 10000, maxCalls: 10 },
] as const;
async function settleThoroughly(rounds = 40) {
for (let i = 0; i < rounds; i++) await settle();
}
function keyInfo(rawKey: string): RedisKeyInfo {
return { key_display: rawKey, key_raw: rawKey, key_type: "string", ttl: -1, size: 0, value_preview: "" };
}
async function searchByValue(host: HTMLElement, mode: "value" | "all" = "value") {
const modeIndex = mode === "value" ? 1 : 2;
host.querySelectorAll<HTMLButtonElement>(".redis-search-mode-button")[modeIndex]?.click();
await settle();
const input = host.querySelector<HTMLInputElement>("[data-redis-search-input]");
expect(input, "redis search input").toBeDefined();
input!.value = "needle";
input!.dispatchEvent(new Event("input", { bubbles: true }));
await nextTick();
input!.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
await settleThoroughly();
}
function clickLoadMore(host: HTMLElement) {
const button = Array.from(host.querySelectorAll<HTMLButtonElement>("button")).find((candidate) => candidate.textContent?.includes("redis.loadMoreKeys") && !candidate.disabled);
expect(button, "load more button").toBeDefined();
button!.click();
}
function clickFetchAll(host: HTMLElement) {
const button = Array.from(host.querySelectorAll<HTMLButtonElement>("button")).find((candidate) => candidate.textContent?.includes("redis.fetchAllKeys") && !candidate.disabled);
expect(button, "fetch all button").toBeDefined();
button!.click();
}
describe("RedisKeyBrowser bounded value search (issue #7779)", () => {
describe.each([
["value", false],
["all", true],
] as const)("%s search", (mode, searchBoth) => {
it.each(REDIS_SCAN_PAGE_SIZE_OPTIONS)("uses configured COUNT %i and stops after each explicit action on empty pages", async (pageSize) => {
stubNonOverflowingViewport();
mocks.redisScanPageSize = pageSize;
mocks.redisScanValues
.mockResolvedValueOnce({ cursor: 41, keys: [], total_keys: 5_000_000 })
.mockResolvedValueOnce({ cursor: 73, keys: [], total_keys: 0 })
.mockResolvedValue({ cursor: 0, keys: [keyInfo("unexpected")], total_keys: 0 });
const host = mountBrowser();
await settleThoroughly();
await searchByValue(host, mode);
await settleThoroughly(10);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
expect(mocks.redisScanValues).toHaveBeenLastCalledWith("connection", 0, 0, "*", "needle", pageSize, searchBoth);
expect(host.textContent).toContain("redis.loadMoreKeys");
clickLoadMore(host);
await settleThoroughly(10);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(2);
expect(mocks.redisScanValues).toHaveBeenLastCalledWith("connection", 0, 41, "*", "needle", pageSize, searchBoth);
expect(host.textContent).toContain("redis.loadMoreKeys");
});
it.each(REDIS_SCAN_PAGE_SIZE_OPTIONS)("uses configured COUNT %i throughout explicit Fetch all", async (pageSize) => {
mocks.redisScanPageSize = pageSize;
mocks.redisScanValues.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 11, keys: [], total_keys: 5_000_000 });
if (cursor === 11) return Promise.resolve({ cursor: 12, keys: [], total_keys: 0 });
return Promise.resolve({ cursor: 0, keys: [keyInfo("last")], total_keys: 0 });
});
const host = mountBrowser();
await settleThoroughly();
await searchByValue(host, mode);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
clickFetchAll(host);
await settleThoroughly();
expect(mocks.redisScanValues.mock.calls).toEqual([0, 11, 12].map((cursor) => ["connection", 0, cursor, "*", "needle", pageSize, searchBoth]));
expect(host.textContent).toContain("last");
});
it("stops Fetch all after the in-flight configured page and retains its prior cursor", async () => {
mocks.redisScanPageSize = 5000;
const pending = deferred<{ cursor: number; keys: RedisKeyInfo[]; total_keys: number }>();
mocks.redisScanValues
.mockResolvedValueOnce({ cursor: 41, keys: [], total_keys: 5_000_000 })
.mockReturnValueOnce(pending.promise)
.mockResolvedValue({ cursor: 0, keys: [keyInfo("resumed")], total_keys: 0 });
const host = mountBrowser();
await settleThoroughly();
await searchByValue(host, mode);
clickFetchAll(host);
await settleThoroughly();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(2);
const stop = Array.from(host.querySelectorAll<HTMLButtonElement>("button")).find((button) => button.textContent?.includes("redis.stopFetchAll") && !button.disabled);
expect(stop, "stop fetch all button").toBeDefined();
stop!.click();
pending.resolve({ cursor: 73, keys: [], total_keys: 0 });
await settleThoroughly(10);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(2);
clickLoadMore(host);
await settleThoroughly();
expect(mocks.redisScanValues.mock.calls).toEqual([0, 41, 41].map((cursor) => ["connection", 0, cursor, "*", "needle", 5000, searchBoth]));
expect(host.textContent).toContain("resumed");
});
});
it.each(["value", "all"] as const)("advances exactly one %s page per Load more or real scroll and preserves the opaque cursor", async (mode) => {
stubNonOverflowingViewport();
mocks.redisScanPageSize = 5000;
mocks.redisScanValues.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 41, keys: [keyInfo("match")], total_keys: 5_000_000 });
if (cursor === 41) return Promise.resolve({ cursor: 73, keys: [keyInfo("match")], total_keys: 0 });
return Promise.resolve({ cursor: 99, keys: [keyInfo("sparse")], total_keys: 0 });
});
const host = mountBrowser();
await settleThoroughly();
await searchByValue(host, mode);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("resize"));
await settleThoroughly();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
clickLoadMore(host);
await settleThoroughly();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(2);
expect(mocks.redisScanValues.mock.calls[1]?.[2]).toBe(41);
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("scroll"));
await vi.waitFor(() => expect(mocks.redisScanValues).toHaveBeenCalledTimes(3));
await settleThoroughly(10);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(3);
expect(mocks.redisScanValues.mock.calls[2]?.[2]).toBe(73);
expect(mocks.redisScanValues.mock.calls).toEqual([0, 41, 73].map((cursor) => ["connection", 0, cursor, "*", "needle", 5000, mode === "all"]));
expect(host.textContent).toContain("sparse");
});
it("does not retry a rejected value continuation", async () => {
stubNonOverflowingViewport();
mocks.redisScanValues.mockResolvedValueOnce({ cursor: 31, keys: [keyInfo("match")], total_keys: 5_000_000 }).mockRejectedValue(new Error("value scan failed"));
const host = mountBrowser();
await settleThoroughly();
await searchByValue(host);
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("scroll"));
await vi.waitFor(() => expect(mocks.redisScanValues).toHaveBeenCalledTimes(2));
await settleThoroughly();
expect(mocks.toast).toHaveBeenCalledTimes(1);
await settleThoroughly(10);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(2);
});
});
describe("RedisKeyBrowser KeepAlive empty scan pages (issue #7779)", () => {
it.each(["value", "all"] as const)("retains an empty %s scan cursor across tab switches", async (mode) => {
mocks.redisScanPageSize = 5000;
mocks.redisScanValues.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 41, keys: [], total_keys: 5_000_000 });
if (cursor === 41) return Promise.resolve({ cursor: 73, keys: [], total_keys: 0 });
return Promise.resolve({ cursor: 0, keys: [keyInfo("match")], total_keys: 0 });
});
const browser = mountKeptAliveBrowser();
await settleThoroughly();
await searchByValue(browser.host, mode);
clickLoadMore(browser.host);
await settleThoroughly();
expect(mocks.redisScanValues.mock.calls.map((call) => call[2])).toEqual([0, 41]);
await browser.deactivate();
await browser.activate();
expect(mocks.redisScanValues.mock.calls.map((call) => call[2])).toEqual([0, 41]);
clickLoadMore(browser.host);
await settleThoroughly();
expect(mocks.redisScanValues.mock.calls.map((call) => call[2])).toEqual([0, 41, 73]);
expect(mocks.redisScanValues.mock.calls.every((call) => call[5] === 5000)).toBe(true);
expect(browser.host.textContent).toContain("match");
});
it.each(["value", "all"] as const)("starts the edited %s query from zero after pausing its debounce", async (mode) => {
mocks.infiniteScroll = false;
mocks.redisScanValues.mockImplementation((_connectionId: string, _db: number, _cursor: number, _pattern: string, query: string) => Promise.resolve(query === "needle" ? { cursor: 41, keys: [], total_keys: 5_000_000 } : { cursor: 0, keys: [keyInfo("updated-match")], total_keys: 1 }));
const browser = mountKeptAliveBrowser();
await settleThoroughly();
await searchByValue(browser.host, mode);
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
const input = browser.host.querySelector<HTMLInputElement>("[data-redis-search-input]")!;
input.value = "updated";
input.dispatchEvent(new Event("input", { bubbles: true }));
await settle();
await browser.deactivate();
await browser.activate();
expect(mocks.redisScanValues.mock.calls.map((call) => [call[2], call[4]])).toEqual([
[0, "needle"],
[0, "updated"],
]);
expect(browser.host.textContent).toContain("updated-match");
});
it("keeps the edited query pending when connection recovery finishes while inactive", async () => {
mocks.infiniteScroll = false;
mocks.redisScanValues.mockImplementation((_connectionId: string, _db: number, _cursor: number, _pattern: string, query: string) => Promise.resolve(query === "needle" ? { cursor: 41, keys: [], total_keys: 5_000_000 } : { cursor: 0, keys: [keyInfo("updated-match")], total_keys: 1 }));
const browser = mountKeptAliveBrowser();
await settleThoroughly();
await searchByValue(browser.host);
const input = browser.host.querySelector<HTMLInputElement>("[data-redis-search-input]")!;
input.value = "updated";
input.dispatchEvent(new Event("input", { bubbles: true }));
await settle();
await browser.deactivate();
const connectionRecovery = deferred<void>();
mocks.ensureConnected.mockReturnValueOnce(connectionRecovery.promise);
await browser.activate();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
await browser.deactivate();
connectionRecovery.resolve();
await settleThoroughly();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
await browser.activate();
expect(mocks.redisScanValues.mock.calls.map((call) => [call[2], call[4]])).toEqual([
[0, "needle"],
[0, "updated"],
]);
expect(browser.host.textContent).toContain("updated-match");
});
it("retries a failed refresh on activation even when the previous empty page had more keys", async () => {
const onError = vi.fn();
const failure = new Error("refresh failed");
mocks.infiniteScroll = false;
mocks.redisScanValues
.mockResolvedValueOnce({ cursor: 41, keys: [], total_keys: 5_000_000 })
.mockRejectedValueOnce(failure)
.mockResolvedValue({ cursor: 0, keys: [keyInfo("recovered")], total_keys: 1 });
const browser = mountKeptAliveBrowser(onError);
await settleThoroughly();
await searchByValue(browser.host);
const refresh = Array.from(browser.host.querySelectorAll<HTMLButtonElement>("button")).find((button) => button.className.includes("h-6 w-6") && !button.hasAttribute("title"));
expect(refresh, "refresh button").toBeDefined();
refresh!.click();
await settleThoroughly();
expect(onError).toHaveBeenCalledWith(failure, expect.anything(), expect.anything());
await browser.deactivate();
await browser.activate();
expect(mocks.redisScanValues.mock.calls.map((call) => call[2])).toEqual([0, 0, 0]);
expect(browser.host.textContent).toContain("recovered");
});
it("retries an interrupted refresh without accepting its late empty page", async () => {
const pending = deferred<{ cursor: number; keys: RedisKeyInfo[]; total_keys: number }>();
mocks.infiniteScroll = false;
mocks.redisScanValues
.mockResolvedValueOnce({ cursor: 41, keys: [], total_keys: 5_000_000 })
.mockReturnValueOnce(pending.promise)
.mockResolvedValue({ cursor: 0, keys: [keyInfo("recovered")], total_keys: 1 });
const browser = mountKeptAliveBrowser();
await settleThoroughly();
await searchByValue(browser.host);
const refresh = Array.from(browser.host.querySelectorAll<HTMLButtonElement>("button")).find((button) => button.className.includes("h-6 w-6") && !button.hasAttribute("title"));
expect(refresh, "refresh button").toBeDefined();
refresh!.click();
await settleThoroughly();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(2);
await browser.deactivate();
pending.resolve({ cursor: 91, keys: [], total_keys: 0 });
await settleThoroughly();
await browser.activate();
expect(mocks.redisScanValues.mock.calls.map((call) => call[2])).toEqual([0, 0, 0]);
expect(browser.host.textContent).toContain("recovered");
});
});
describe("RedisKeyBrowser continuation ownership (issue #7779)", () => {
it("disables refresh while the current page is loading", async () => {
const pending = deferred<{ cursor: number; keys: RedisKeyInfo[]; total_keys: number }>();
mocks.redisScanKeysBatch.mockReturnValue(pending.promise);
const host = mountBrowser();
await vi.waitFor(() => expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1));
const refresh = Array.from(host.querySelectorAll<HTMLButtonElement>("button")).find((button) => button.className.includes("h-6 w-6") && !button.hasAttribute("title"));
expect(refresh, "refresh button").toBeDefined();
expect(refresh!.disabled).toBe(true);
refresh!.click();
await settle();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
pending.resolve({ cursor: 0, keys: [], total_keys: 0 });
await settleThoroughly();
});
it("blocks an old cursor while an Enter-only key pattern is unsubmitted", async () => {
stubNonOverflowingViewport();
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {
configurable: true,
get(this: HTMLElement) {
return this.classList.contains("redis-key-scroller") ? 5000 : 0;
},
});
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, _cursor: number, pattern: string) => {
if (pattern === "*") return Promise.resolve({ cursor: 41, keys: [keyInfo("seed")], total_keys: 5_000_000 });
return Promise.resolve({ cursor: 0, keys: [keyInfo("new")], total_keys: 1 });
});
const host = mountBrowser();
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
const input = host.querySelector<HTMLInputElement>("[data-redis-search-input]")!;
input.value = "new";
input.dispatchEvent(new Event("input", { bubbles: true }));
await settle();
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("resize"));
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("scroll"));
await new Promise((resolve) => setTimeout(resolve, 20));
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
input.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
await vi.waitFor(() => expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2));
expect(mocks.redisScanKeysBatch.mock.calls[1]?.slice(2, 4)).toEqual([0, "new"]);
});
it("discards a late value page after unmount without scheduling a successor", async () => {
const pending = deferred<{ cursor: number; keys: RedisKeyInfo[]; total_keys: number }>();
mocks.redisScanValues.mockReturnValue(pending.promise);
const host = mountBrowser();
await settleThoroughly();
await searchByValue(host);
await vi.waitFor(() => expect(mocks.redisScanValues).toHaveBeenCalledTimes(1));
mocks.updateRedisDbKeyStats.mockClear();
unmountBrowser(host);
pending.resolve({ cursor: 91, keys: [keyInfo("stale")], total_keys: 5_000_000 });
await settleThoroughly();
expect(mocks.redisScanValues).toHaveBeenCalledTimes(1);
expect(mocks.updateRedisDbKeyStats).not.toHaveBeenCalled();
});
});
// `iterations` (aka `max_iterations`) is the 6th positional arg the frontend
// sends to `redisScanKeysBatch` — the same unit the backend spends as real
// Redis SCAN calls (see `crates/dbx-core/src/db/redis_driver.rs`).
function totalIterationsRequested(): number {
return mocks.redisScanKeysBatch.mock.calls.reduce((sum: number, call: unknown[]) => sum + (call[5] as number), 0);
}
describe("RedisKeyBrowser automatic continuation request budget (PR #6313 review)", () => {
beforeEach(() => {
mocks.redisScanPageSize = PRODUCTION_PAGE_SIZE;
});
it.each(AUTO_LOAD_PAGE_SIZE_CASES)("stops after at most $maxCalls automatic backend calls for page size $pageSize", async ({ pageSize, maxCalls }) => {
stubNonOverflowingViewport();
mocks.redisScanPageSize = pageSize;
let call = 0;
// The tree-vs-empty-state view only mounts the scroller once at least one
// key has loaded, so seed exactly one key on the first page — every page
// after that comes back empty with a cursor that always advances and
// never hits 0. An unbounded loop would spin until the (huge) keyspace is
// exhausted or the process runs out of time.
mocks.redisScanKeysBatch.mockImplementation((_c: string, _d: number, cursor: number) => {
call++;
return Promise.resolve({ cursor: cursor + 1, keys: call === 1 ? [keyInfo("seed")] : [], total_keys: 5_000_000 });
});
mountBrowser();
await settleThoroughly();
// 1 initial page + the automatic-fill operation's total iteration budget,
// never the ~147-call amplification a page-count-only cap would allow at
// this page size.
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1 + maxCalls);
expect(totalIterationsRequested()).toBeLessThanOrEqual(ITERATIONS_PER_CALL + AUTO_LOAD_TOTAL_SCAN_ITERATIONS);
const callsAtBound = mocks.redisScanKeysBatch.mock.calls.length;
await settleThoroughly(10);
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(callsAtBound);
});
it("stops after a bounded total of backend calls when every page comes back with only already-loaded keys, at the production page size", async () => {
stubNonOverflowingViewport();
// Every page repeats the same key, so unique loaded/visible keys stay at 1
// forever — a stop condition based on unique-key growth alone never fires.
mocks.redisScanKeysBatch.mockImplementation((_c: string, _d: number, cursor: number) => Promise.resolve({ cursor: cursor + 1, keys: [keyInfo("dup")], total_keys: 5_000_000 }));
mountBrowser();
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1 + AUTO_LOAD_MAX_CALLS);
expect(totalIterationsRequested()).toBeLessThanOrEqual(ITERATIONS_PER_CALL + AUTO_LOAD_TOTAL_SCAN_ITERATIONS);
});
it("stops after a bounded total of backend calls against a sparse filter that only rarely yields a new key, at the production page size", async () => {
stubNonOverflowingViewport();
let call = 0;
mocks.redisScanKeysBatch.mockImplementation((_c: string, _d: number, cursor: number) => {
call++;
// A new unique key surfaces on the first page (so the scroller mounts)
// and then only every 3rd call after that — same shape as a narrow
// pattern against a huge, mostly-non-matching keyspace.
const keys = call === 1 || call % 3 === 0 ? [keyInfo(`sparse-${call}`)] : [];
return Promise.resolve({ cursor: cursor + 1, keys, total_keys: 5_000_000 });
});
mountBrowser();
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1 + AUTO_LOAD_MAX_CALLS);
expect(totalIterationsRequested()).toBeLessThanOrEqual(ITERATIONS_PER_CALL + AUTO_LOAD_TOTAL_SCAN_ITERATIONS);
});
it("still stops on reaching the configured max-key limit, well under the iteration budget", async () => {
stubNonOverflowingViewport();
mocks.queryResultMaxRows = 3;
let call = 0;
mocks.redisScanKeysBatch.mockImplementation((_c: string, _d: number, cursor: number) => {
call++;
return Promise.resolve({ cursor: cursor + 1, keys: [keyInfo(`k${call}`)], total_keys: 5_000_000 });
});
mountBrowser();
await settleThoroughly();
// 1 initial page + 2 automatic pages reaches the 3-key limit, well before
// the total iteration budget would otherwise cut it off.
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(3);
});
});
describe("RedisKeyBrowser loadMore failure handling (PR #6313 review)", () => {
it("does not automatically retry after a page request fails", async () => {
stubNonOverflowingViewport();
mocks.redisScanKeysBatch.mockResolvedValueOnce({ cursor: 7, keys: [keyInfo("a")], total_keys: 200_004 }).mockRejectedValue(new Error("backend unavailable"));
mountBrowser();
await settleThoroughly();
// One successful initial page, one failed automatic follow-up — and then
// nothing further, even after settling repeatedly.
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2);
expect(mocks.toast).toHaveBeenCalledTimes(1);
await settleThoroughly(10);
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2);
});
it("charges a failed automatic request to the shared iteration budget", async () => {
stubNonOverflowingViewport();
mocks.redisScanKeysBatch
.mockResolvedValueOnce({ cursor: 7, keys: [keyInfo("a")], total_keys: 200_004 })
.mockRejectedValueOnce(new Error("backend unavailable"))
.mockImplementation((_connectionId: string, _db: number, cursor: number) => Promise.resolve({ cursor: cursor + 1, keys: [], total_keys: 0 }));
const host = mountBrowser();
await settleThoroughly();
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(2);
host.querySelector(".redis-key-scroller")?.dispatchEvent(new Event("resize"));
await settleThoroughly();
expect(totalIterationsRequested()).toBeLessThanOrEqual(ITERATIONS_PER_CALL + AUTO_LOAD_TOTAL_SCAN_ITERATIONS);
expect(mocks.redisScanKeysBatch.mock.calls.length).toBeLessThanOrEqual(1 + AUTO_LOAD_MAX_CALLS);
});
});
// A group's `loadedLeafCount` only reflects keys the SCAN happened to return
// before auto-load stopped (see `redisKeyTree.ts`); when the cursor hasn't
// reached 0 yet, that count is not the folder's real total. Issue #6392: a
// user compared DBX's tree against `redis-cli --scan` and saw folder counts
// far below the real per-prefix cardinality, with nothing in the UI hinting
// the numbers were partial.
describe("RedisKeyBrowser group key counts reflect incomplete loading (issue #6392)", () => {
it("marks a group's count as partial while more keys remain unscanned", async () => {
stubNonOverflowingViewport();
// cursor never returns to 0, so hasMore stays true even after the
// shared auto-load budget is exhausted.
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number) => {
if (cursor === 0) return Promise.resolve({ cursor: 1, keys: [keyInfo("grp:a"), keyInfo("grp:b")], total_keys: 500 });
return Promise.resolve({ cursor: cursor + 1, keys: [], total_keys: 0 });
});
const host = mountBrowser();
await settleThoroughly();
const countBadge = host.querySelector(".text-muted-foreground.ml-1");
expect(countBadge?.textContent).toBe("(2+)");
expect(countBadge?.getAttribute("title")).toBeTruthy();
});
it("shows an exact count once every key has actually been scanned", async () => {
stubNonOverflowingViewport();
mocks.redisScanKeysBatch.mockResolvedValue({ cursor: 0, keys: [keyInfo("grp:a"), keyInfo("grp:b")], total_keys: 2 });
const host = mountBrowser();
await settleThoroughly();
const countBadge = host.querySelector(".text-muted-foreground.ml-1");
expect(countBadge?.textContent).toBe("(2)");
expect(countBadge?.getAttribute("title")).toBeFalsy();
});
});
describe("RedisKeyBrowser group subtree fill on expand (issue #7162)", () => {
beforeEach(() => {
mocks.redisScanPageSize = 100;
});
function scanCallsWithPattern(pattern: string): number {
return mocks.redisScanKeysBatch.mock.calls.filter((call: unknown[]) => call[3] === pattern).length;
}
// Clicks the group row itself. `[data-redis-group]` marks the group's
// selection checkbox: it carries `cursor-pointer` itself and consumes the
// click, so a `closest()` from it can never reach the expanding row — walk
// up to the checkbox's row container (the div with the row click handler)
// instead.
function expandFirstGroupRow(host: HTMLElement) {
const checkbox = host.querySelector<HTMLElement>("[data-redis-group]");
const row = checkbox?.parentElement?.parentElement;
expect(row?.className).toContain("cursor-pointer");
row!.click();
}
// Overflowing viewport: rows render (RecycleScroller buffer 600) while the
// bounded auto-fill stays off, reproducing the stranded state from the
// issue — the main scan is still open (hasMore), so the tree is silently
// partial and a key that search finds may not exist in the tree at all.
function stubOverflowingViewport() {
stubNonOverflowingViewport();
Object.defineProperty(HTMLElement.prototype, "scrollHeight", {
configurable: true,
get(this: HTMLElement) {
return this.classList.contains("redis-key-scroller") ? 5000 : 100;
},
});
}
it("fills the expanded group's subtree via a dedicated prefix scan without advancing the main scan", async () => {
stubOverflowingViewport();
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number, pattern: string) => {
if (pattern === "grp:*") {
return Promise.resolve({ cursor: 0, keys: [keyInfo("grp:hidden"), keyInfo("grp:sub:x")], total_keys: 0 });
}
if (cursor === 0) return Promise.resolve({ cursor: 9, keys: [keyInfo("grp:a")], total_keys: 10_000 });
return Promise.resolve({ cursor: 9, keys: [], total_keys: 0 });
});
const host = mountBrowser();
await settleThoroughly();
// Only the first browse page ran: the tree holds `grp:a` alone and the
// main scan is still open.
expect(scanCallsWithPattern("*")).toBe(1);
expect(scanCallsWithPattern("grp:*")).toBe(0);
expect(host.textContent).toContain("grp");
expandFirstGroupRow(host);
await settleThoroughly();
// Expanding the group scanned its subtree with a fresh cursor; the main
// browse cursor was not advanced (no extra `*` pages).
expect(scanCallsWithPattern("grp:*")).toBe(1);
expect(scanCallsWithPattern("*")).toBe(1);
expect(host.textContent).toContain("hidden");
expect(host.textContent).toContain("sub");
// Re-collapse + re-expand must not rescan the already-completed subtree.
expandFirstGroupRow(host);
await settleThoroughly();
expandFirstGroupRow(host);
await settleThoroughly();
expect(scanCallsWithPattern("grp:*")).toBe(1);
});
it("skips the subtree scan when the main scan already completed", async () => {
stubOverflowingViewport();
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number, pattern: string) => {
expect(pattern).toBe("*");
if (cursor === 0) return Promise.resolve({ cursor: 0, keys: [keyInfo("grp:a"), keyInfo("grp:b")], total_keys: 2 });
return Promise.resolve({ cursor: 0, keys: [], total_keys: 0 });
});
const host = mountBrowser();
await settleThoroughly();
expandFirstGroupRow(host);
await settleThoroughly();
expect(scanCallsWithPattern("grp:*")).toBe(0);
expect(host.textContent).toContain("b");
});
});