feat(redis): add configurable key search templates

This commit is contained in:
whoops authored and GitHub committed 2026-08-25 22:34:04 +08:00
1 parent bfd7c7def2
commit 5e307f56cc
47 files changed
+407 -11

No files matched your search

@@ -1273,7 +1273,7 @@ describe("RedisKeyBrowser fuzzy key hierarchy", () => {
expect(document.body.textContent).toContain("first");
});
it("cancels a sparse scan immediately when the search text changes", async () => {
it("cancels a sparse scan immediately without searching until Enter", async () => {
mocks.redisScanPageSize = 1_000;
mountBrowser();
await settle();
@@ -1281,6 +1281,7 @@ describe("RedisKeyBrowser fuzzy key hierarchy", () => {
await settle();
const oldPage = deferred<{ cursor: number; keys: RedisKeyInfo[]; total_keys: number }>();
const stale = { key_display: "old:result", key_raw: "b2xkOnJlc3VsdA==", key_type: "string", ttl: -1 };
const fresh = { key_display: "new:result", key_raw: "bmV3OnJlc3VsdA==", key_type: "string", ttl: -1 };
mocks.redisScanKeysBatch.mockReset();
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, _cursor: number, pattern: string) => {
@@ -1291,14 +1292,22 @@ describe("RedisKeyBrowser fuzzy key hierarchy", () => {
await submitKeySearch("old");
await vi.waitFor(() => expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1));
const input = requiredElement<HTMLInputElement>("[data-redis-search-input]");
input.value = "new";
input.dispatchEvent(new Event("input", { bubbles: true }));
await settle();
oldPage.resolve({ cursor: 1, keys: [], total_keys: 1_000_000 });
await setInput("[data-redis-search-input]", "new");
expect(mocks.redisScanKeysBatch).toHaveBeenCalledTimes(1);
mocks.updateRedisDbKeyStats.mockClear();
oldPage.resolve({ cursor: 0, keys: [stale], total_keys: 1 });
await settle();
expect(mocks.updateRedisDbKeyStats).not.toHaveBeenCalled();
expect(document.body.textContent).not.toContain("old:result");
expect(document.body.textContent).not.toContain("new:result");
expect(mocks.redisScanKeysBatch.mock.calls.filter((call) => call[3] === "*old*")).toHaveLength(1);
expect(mocks.redisScanKeysBatch.mock.calls.map((call) => call[3])).toEqual(["*old*"]);
requiredElement<HTMLInputElement>("[data-redis-search-input]").dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
await settle();
await vi.waitFor(() => expect(document.body.textContent).toContain("result"));
expect(mocks.redisScanKeysBatch.mock.calls.map((call) => call[3])).toEqual(["*old*", "*new*"]);
});
@@ -1731,6 +1740,7 @@ describe("RedisKeyBrowser interrupted Fetch All", () => {
it("does not select stale keys when a search changes during select-all scanning", async () => {
const oldPage = deferred<{ cursor: number; keys: RedisKeyInfo[]; total_keys: number }>();
const oldKey = { key_display: "old", key_raw: "b2xk", key_type: "string", ttl: -1 };
const lateOldKey = { key_display: "late-old", key_raw: "bGF0ZS1vbGQ=", key_type: "string", ttl: -1 };
const freshKey = { key_display: "fresh", key_raw: "ZnJlc2g=", key_type: "string", ttl: -1 };
mocks.redisScanKeysBatch.mockImplementation((_connectionId: string, _db: number, cursor: number, pattern: string) => {
if (pattern === "*" && cursor === 0) return Promise.resolve({ cursor: 1, keys: [oldKey], total_keys: 2 });
@@ -1742,11 +1752,16 @@ describe("RedisKeyBrowser interrupted Fetch All", () => {
requiredElement<HTMLButtonElement>("[data-redis-select-all]").click();
await vi.waitFor(() => expect(mocks.redisScanKeysBatch.mock.calls.length).toBeGreaterThan(1));
const input = requiredElement<HTMLInputElement>("[data-redis-search-input]");
input.value = "fresh";
input.dispatchEvent(new Event("input", { bubbles: true }));
await setInput("[data-redis-search-input]", "fresh");
oldPage.resolve({ cursor: 0, keys: [lateOldKey], total_keys: 0 });
await settle();
oldPage.resolve({ cursor: 0, keys: [oldKey], total_keys: 0 });
expect(document.body.textContent).not.toContain("late-old");
expect(document.body.textContent).not.toContain("redis.stopFetchAll");
expect(mocks.redisScanKeysBatch.mock.calls.every((call) => call[3] === "*")).toBe(true);
expect(document.querySelector("[data-redis-batch-delete]")).toBeNull();
requiredElement<HTMLInputElement>("[data-redis-search-input]").dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
await settle();
await vi.waitFor(() => expect(document.body.textContent).toContain("fresh"));
@@ -52,6 +52,7 @@ import { copyToClipboard } from "@/lib/common/clipboard";
import { useEditorFontFamilyStyle } from "@/composables/useEditorFontFamilyStyle";
import { useToast } from "@/composables/useToast";
import { redisKeySearchPattern } from "@/lib/redis/redisKeyPattern";
import { filterRedisKeyTemplates, resolveRedisKeyTemplates } from "@/lib/redis/redisKeyTemplates";
import { REDIS_SCAN_PAGE_SIZE_DEFAULT } from "@/lib/redis/redisKeyPattern";
import { chunkRedisKeyRaws, collectUniqueRedisKeys } from "@/lib/redis/redisKeyBatch";
import { getRedisCreateKeyTypeHelp, redisCreateKeyTypeHelpOptionOnOpen, shouldActivateRedisCreateKeyTypeHelpOnFocus } from "@/lib/redis/redisCreateKeyTypeHelp";
@@ -112,6 +113,10 @@ const commandTerminalRef = ref<HTMLElement>();
const searchPattern = ref("");
const searchMode = ref<RedisSearchMode>("key");
const fuzzyKeySearch = ref(false);
const keyTemplateMenuOpen = ref(false);
const keyTemplateSelectedIndex = ref(0);
const keyTemplateListboxId = `redis-key-template-suggestions-${uuid()}`;
let keyTemplateBlurTimer: ReturnType<typeof setTimeout> | null = null;
const selectedKeyRaw = ref<string | null>(null);
const hasMore = ref(false);
const scanCursor = ref(0);
@@ -216,6 +221,10 @@ const searchPlaceholder = computed(() => {
if (searchMode.value === "key") return fuzzyKeySearch.value ? t("redis.fuzzyPattern") : t("redis.pattern");
return searchMode.value === "all" ? t("redis.allSearchPlaceholder") : t("redis.valueSearchPlaceholder");
});
const redisKeyTemplates = computed(() => resolveRedisKeyTemplates(connectionStore.getConfig(props.connectionId)?.redis_key_templates, settingsStore.editorSettings.redisKeyTemplates ?? []));
const keyTemplateSuggestions = computed(() => (searchMode.value === "key" ? filterRedisKeyTemplates(redisKeyTemplates.value, searchPattern.value) : []));
const keyTemplateMenuVisible = computed(() => keyTemplateMenuOpen.value && searchMode.value === "key" && keyTemplateSuggestions.value.length > 0);
const keyTemplateActiveDescendant = computed(() => (keyTemplateMenuVisible.value ? `${keyTemplateListboxId}-option-${keyTemplateSelectedIndex.value}` : undefined));
const loadingEmptyText = computed(() => (isValueSearchMode.value && valueQuery.value ? t(searchMode.value === "all" ? "redis.searchingAll" : "redis.searchingValues") : t("redis.loadingKeys")));
const redisKeySeparator = computed(() => connectionStore.getConfig(props.connectionId)?.redis_key_separator ?? ":");
const redisScanPageSize = computed(() => connectionStore.getConfig(props.connectionId)?.redis_scan_page_size ?? REDIS_SCAN_PAGE_SIZE_DEFAULT);
@@ -1636,7 +1645,90 @@ function typeColor(type: string): string {
let searchTimer: ReturnType<typeof setTimeout> | null = null;
let hasAutoFocusedSearch = false;
function dismissKeyTemplateMenu() {
keyTemplateMenuOpen.value = false;
keyTemplateSelectedIndex.value = 0;
if (keyTemplateBlurTimer) {
clearTimeout(keyTemplateBlurTimer);
keyTemplateBlurTimer = null;
}
}
function openKeyTemplateMenu() {
if (searchMode.value !== "key" || redisKeyTemplates.value.length === 0) {
dismissKeyTemplateMenu();
return;
}
keyTemplateMenuOpen.value = true;
keyTemplateSelectedIndex.value = 0;
}
function clampKeyTemplateSelection() {
const max = Math.max(keyTemplateSuggestions.value.length - 1, 0);
if (keyTemplateSelectedIndex.value > max) keyTemplateSelectedIndex.value = max;
}
function selectKeyTemplate(index: number) {
const template = keyTemplateSuggestions.value[index];
if (!template) return;
if (searchTimer) {
clearTimeout(searchTimer);
searchTimer = null;
}
searchPending.value = false;
searchPattern.value = template;
dismissKeyTemplateMenu();
void nextTick(() => getSearchInput()?.focus());
}
function moveKeyTemplateSelection(direction: number): boolean {
if (!keyTemplateMenuVisible.value) return false;
const count = keyTemplateSuggestions.value.length;
if (count === 0) return false;
keyTemplateSelectedIndex.value = Math.min(Math.max(keyTemplateSelectedIndex.value + direction, 0), count - 1);
void nextTick(() => {
document.getElementById(`${keyTemplateListboxId}-option-${keyTemplateSelectedIndex.value}`)?.scrollIntoView({ block: "nearest" });
});
return true;
}
function onSearchFocus() {
openKeyTemplateMenu();
}
function onSearchBlur() {
if (keyTemplateBlurTimer) clearTimeout(keyTemplateBlurTimer);
keyTemplateBlurTimer = setTimeout(() => {
dismissKeyTemplateMenu();
keyTemplateBlurTimer = null;
}, 150);
}
function onSearchInput() {
if (searchMode.value === "key" && redisKeyTemplates.value.length > 0) {
keyTemplateMenuOpen.value = true;
keyTemplateSelectedIndex.value = 0;
clampKeyTemplateSelection();
} else {
dismissKeyTemplateMenu();
}
// Key search is Enter-only so users can finish editing templates / patterns
// (including {$placeholders}) without triggering SCAN on every keystroke.
if (searchMode.value === "key") {
if (searchTimer) {
clearTimeout(searchTimer);
searchTimer = null;
}
searchPending.value = false;
invalidateScanRequests();
loading.value = false;
isFetchingAll.value = false;
fetchAllStopRequested.value = true;
fetchAllLoadedCount.value = 0;
selectedKeyRaw.value = null;
resetCheckedKeys();
return;
}
if (searchTimer) clearTimeout(searchTimer);
// Invalidate in-flight SCAN work as soon as the query changes instead of
// waiting for the debounce timer to start the replacement search.
@@ -1654,6 +1746,7 @@ function onSearchInput() {
function setSearchMode(mode: RedisSearchMode) {
if (searchMode.value === mode) return;
searchMode.value = mode;
if (mode !== "key") dismissKeyTemplateMenu();
void loadKeys();
}
@@ -1834,6 +1927,28 @@ function focusSearch(): boolean {
}
function onSearchKeydown(event: KeyboardEvent) {
if (keyTemplateMenuVisible.value) {
if (event.key === "ArrowDown") {
event.preventDefault();
moveKeyTemplateSelection(1);
return;
}
if (event.key === "ArrowUp") {
event.preventDefault();
moveKeyTemplateSelection(-1);
return;
}
if (event.key === "Enter") {
event.preventDefault();
selectKeyTemplate(keyTemplateSelectedIndex.value);
return;
}
if (event.key === "Escape") {
event.preventDefault();
dismissKeyTemplateMenu();
return;
}
}
if (event.key === "Enter") {
void loadKeys();
return;
@@ -1841,6 +1956,7 @@ function onSearchKeydown(event: KeyboardEvent) {
if (!isCancelSearchShortcut(event)) return;
event.preventDefault();
searchPattern.value = "";
dismissKeyTemplateMenu();
void loadKeys();
}
@@ -2083,15 +2199,37 @@ defineExpose({ focusSearch, insertCommand, executeCommand: executeAiCommand });
</div>
<div class="redis-key-search-row mt-2">
<div class="relative min-w-0">
<Search class="pointer-events-none absolute left-2.5 top-1/2 h-3.5 w-3.5 -translate-y-1/2 text-muted-foreground/80" />
<Search class="pointer-events-none absolute left-2.5 top-1/2 z-[1] h-3.5 w-3.5 -translate-y-1/2 text-muted-foreground/80" />
<Input
v-model="searchPattern"
data-redis-search-input
role="combobox"
class="h-8 border-border/70 bg-background pl-8 pr-3 text-xs shadow-sm caret-primary placeholder:text-muted-foreground/80 focus-visible:border-primary/60 focus-visible:ring-2 focus-visible:ring-primary/20"
:placeholder="searchPlaceholder"
:aria-expanded="keyTemplateMenuVisible"
:aria-controls="keyTemplateMenuVisible ? keyTemplateListboxId : undefined"
:aria-activedescendant="keyTemplateActiveDescendant"
autocomplete="off"
@input="onSearchInput"
@keydown="onSearchKeydown"
@focus="onSearchFocus"
@blur="onSearchBlur"
/>
<div v-if="keyTemplateMenuVisible" :id="keyTemplateListboxId" role="listbox" :aria-label="t('redis.keyTemplateSuggestions')" class="absolute left-0 right-0 top-[calc(100%+0.25rem)] z-30 max-h-60 overflow-y-auto rounded-md border bg-popover py-1 text-popover-foreground shadow-md">
<button
v-for="(template, index) in keyTemplateSuggestions"
:id="`${keyTemplateListboxId}-option-${index}`"
:key="template"
type="button"
role="option"
class="dbx-editor-font-family flex w-full items-center px-3 py-1.5 text-left text-xs hover:bg-accent hover:text-accent-foreground"
:class="keyTemplateSelectedIndex === index ? 'bg-accent text-accent-foreground' : ''"
:aria-selected="keyTemplateSelectedIndex === index"
@mousedown.prevent="selectKeyTemplate(index)"
>
<span class="truncate">{{ template }}</span>
</button>
</div>
</div>
<div class="flex shrink-0 items-center gap-1">
<Button