feat(redis): add command-line query result mode

Closes #10099
This commit is contained in:
t8y2 committed 2026-09-27 12:36:33 +00:00
1 parent add378d643
commit 9c23e3198b
19 files changed
+488 -41

No files matched your search

@@ -96,6 +96,7 @@ function preloadDataGridComponent() {
const QueryEditor = defineAsyncComponent({ loader: () => import("@/components/editor/QueryEditor.vue"), loadingComponent: QueryLoadingState, delay: 0 });
const DataGrid = defineAsyncComponent(loadDataGridComponent);
const RedisKeyBrowser = defineAsyncComponent(() => import("@/components/redis/RedisKeyBrowser.vue"));
const RedisQueryConsoleOutput = defineAsyncComponent(() => import("@/components/redis/RedisQueryConsoleOutput.vue"));
const RedisDashboard = defineAsyncComponent(() => import("@/components/redis/RedisDashboard.vue"));
const EtcdKeyBrowser = defineAsyncComponent(() => import("@/components/etcd/EtcdKeyBrowser.vue"));
const EtcdDashboard = defineAsyncComponent(() => import("@/components/etcd/EtcdDashboard.vue"));
@@ -186,7 +187,7 @@ import { loadObjectDdl } from "@/lib/metadata/objectDdlCache";
import { formatDdlForDisplay } from "@/lib/sql/ddlDisplay";
import { sqlObjectNavigationTypeFromTableType } from "@/lib/sql/sqlNavigation";
import type { CustomSaveHandler } from "@/composables/useDataGridEditor";
import type { QueryMessage, QueryTab, TableInfoTab, TreeNode, VectorCollectionMeta } from "@/types/database";
import type { QueryMessage, QueryTab, RedisResultViewMode, TableInfoTab, TreeNode, VectorCollectionMeta } from "@/types/database";
import type { SqlObjectNavigationTarget } from "@/lib/sql/sqlNavigation";
import { sqlFormatDialectForDbType, type SqlFormatDialect } from "@/lib/sql/sqlFormatter";
import { productionContextForDatabase } from "@/lib/database/productionSafety";
@@ -613,6 +614,9 @@ const hasTabularResult = computed(() => {
if (props.activeTab.result?.columns.length && props.activeTab.result.server_message !== true) return true;
return visibleResultItems.value.length > 0;
});
const redisConsoleResults = computed(() => (props.activeTab.results?.length ? props.activeTab.results : props.activeTab.result ? [props.activeTab.result] : []));
const canShowRedisConsoleOutput = computed(() => activeEffectiveDatabaseType.value === "redis" && (props.activeTab.isExecuting || redisConsoleResults.value.some((result) => result.execution_error === true || typeof result.redis_console_output === "string")));
const redisResultViewMode = computed<RedisResultViewMode>(() => (activeEffectiveDatabaseType.value === "redis" ? (props.activeTab.uiState?.redisResultViewMode ?? "grid") : "grid"));
const canShowResultOutput = computed(() => hasTabularResult.value || props.activeTab.isExecuting);
const canShowExplainOutput = computed(() => !!props.activeTab.explainPlan || !!props.activeTab.explainError || !!props.activeTab.explainTableResult || !!props.activeTab.explainTableError || props.activeTab.isExplaining === true);
// A batch can attach server messages to more than one statement result (for
@@ -626,7 +630,7 @@ const resultMessages = computed<QueryMessage[]>(() => {
});
const resultMessageCount = computed(() => resultMessages.value.length);
const canShowMessagesOutput = computed(() => resultMessageCount.value > 0);
const showStandaloneResultToolbar = computed(() => activeElasticsearchJsonResponse.value || props.activeOutputView !== "result" || !props.activeTab.result || !hasTabularResult.value);
const showStandaloneResultToolbar = computed(() => activeElasticsearchJsonResponse.value || props.activeOutputView !== "result" || (redisResultViewMode.value === "console" && canShowRedisConsoleOutput.value) || !props.activeTab.result || !hasTabularResult.value);
const standaloneResultToolbarCompact = computed(() => isDataGridToolbarCompact(standaloneResultToolbarWidth.value, standaloneResultToolbarViewportWidth.value));
let standaloneResultToolbarResizeObserver: ResizeObserver | undefined;
@@ -635,6 +639,11 @@ function updateStandaloneResultToolbarDimensions() {
standaloneResultToolbarViewportWidth.value = typeof window === "undefined" ? 0 : window.innerWidth;
}
function setRedisResultViewMode(mode: RedisResultViewMode) {
if (activeEffectiveDatabaseType.value !== "redis") return;
queryStore.updateTabUiState(props.activeTab.id, { redisResultViewMode: mode });
}
function observeStandaloneResultToolbar() {
standaloneResultToolbarResizeObserver?.disconnect();
standaloneResultToolbarResizeObserver = undefined;
@@ -1817,7 +1826,7 @@ defineExpose({
<ResultSetNavigator v-if="visibleResultItems.length > 0" :key="`${activeTab.id}:${activeTab.activeResultRunId ?? 'current'}`" :items="visibleResultItems" :active-index="activeTab.activeResultIndex ?? 0" :active="activeOutputView === 'result'" @select="selectResultItem" />
</template>
<div class="ml-auto flex shrink-0 items-center gap-1">
<Popover v-if="activeOutputView === 'result' && activeTab.result && hasTabularResult && !activeElasticsearchJsonResponse" v-model:open="dataGridViewOptionsOpen">
<Popover v-if="activeOutputView === 'result' && redisResultViewMode === 'grid' && activeTab.result && hasTabularResult && !activeElasticsearchJsonResponse" v-model:open="dataGridViewOptionsOpen">
<PopoverTrigger as-child>
<Button variant="ghost" size="icon" class="h-6 w-7 shrink-0 text-foreground hover:bg-accent" :title="t('grid.viewOptions')" :aria-label="t('grid.viewOptions')">
<Wrench class="h-4 w-4" />
@@ -2096,9 +2105,12 @@ defineExpose({
:can-show-summary="hasExecutionSummary"
:can-show-chart="hasNumericData && !activeElasticsearchJsonResponse"
:can-show-messages="canShowMessagesOutput"
:can-show-redis-console="canShowRedisConsoleOutput"
:result-mode="redisResultViewMode"
:message-count="resultMessageCount"
:compact="standaloneResultToolbarCompact"
@select-view="emit('update:activeOutputView', activeTab.id, $event)"
@select-result-mode="setRedisResultViewMode"
/>
<QueryResultToolbarActions
class="ml-auto"
@@ -2250,6 +2262,8 @@ defineExpose({
</div>
</div>
<RedisQueryConsoleOutput v-else-if="activeOutputView === 'result' && redisResultViewMode === 'console' && canShowRedisConsoleOutput" :result="activeTab.result" :results="activeTab.results" :loading="activeTab.isExecuting" />
<QueryMessagesView v-else-if="activeOutputView === 'messages'" class="flex-1 min-h-0" :messages="resultMessages" />
<template v-else>
@@ -2337,9 +2351,12 @@ defineExpose({
:can-show-summary="hasExecutionSummary"
:can-show-chart="hasNumericData && !activeElasticsearchJsonResponse"
:can-show-messages="canShowMessagesOutput"
:can-show-redis-console="canShowRedisConsoleOutput"
:result-mode="redisResultViewMode"
:message-count="resultMessageCount"
:compact="compact"
@select-view="emit('update:activeOutputView', activeTab.id, $event)"
@select-result-mode="setRedisResultViewMode"
/>
<template v-if="activeElasticsearchRawBody">
<div class="mx-1 h-4 w-px bg-border" />
@@ -1,9 +1,10 @@
<script setup lang="ts">
import { computed } from "vue";
import { BarChart3, ListChecks, MessageSquareText } from "@lucide/vue";
import { BarChart3, ListChecks, MessageSquareText, SquareTerminal } from "@lucide/vue";
import { useI18n } from "vue-i18n";
import { Button } from "@/components/ui/button";
import LightTooltip from "@/components/ui/LightTooltip.vue";
import type { RedisResultViewMode } from "@/types/database";
type OutputView = "result" | "summary" | "explain" | "chart" | "messages" | "profile";
type PrimaryResultView = Exclude<OutputView, "explain" | "profile">;
@@ -15,32 +16,65 @@ const props = withDefaults(
canShowSummary: boolean;
canShowChart: boolean;
canShowMessages: boolean;
canShowRedisConsole?: boolean;
resultMode?: RedisResultViewMode;
messageCount?: number;
compact?: boolean;
}>(),
{ compact: false, messageCount: 0 },
{ compact: false, messageCount: 0, canShowRedisConsole: false, resultMode: "grid" },
);
const emit = defineEmits<{
selectView: [view: PrimaryResultView];
selectResultMode: [mode: RedisResultViewMode];
}>();
const { t } = useI18n();
const messagesTooltip = computed(() => (props.messageCount > 0 ? `${t("tabs.messages")} (${props.messageCount})` : t("tabs.messages")));
const effectiveResultMode = computed<RedisResultViewMode>(() => (props.canShowRedisConsole ? props.resultMode : "grid"));
function selectView(view: PrimaryResultView) {
if (props.activeView === view) return;
emit("selectView", view);
}
function selectResultMode(mode: RedisResultViewMode) {
if (props.activeView === "result" && effectiveResultMode.value === mode) return;
if (props.canShowRedisConsole && props.resultMode !== mode) emit("selectResultMode", mode);
if (props.activeView !== "result") emit("selectView", "result");
}
</script>
<template>
<div data-query-result-view-switcher class="flex shrink-0 items-center gap-1 px-1">
<Button size="sm" :variant="activeView === 'result' ? 'secondary' : 'ghost'" class="h-5 shrink-0 px-2 text-xs leading-none" :disabled="!canShowResult" :aria-pressed="activeView === 'result'" @click="selectView('result')">
<Button
size="sm"
:variant="activeView === 'result' && effectiveResultMode === 'grid' ? 'secondary' : 'ghost'"
class="h-5 shrink-0 px-2 text-xs leading-none"
:disabled="!canShowResult"
:aria-pressed="activeView === 'result' && effectiveResultMode === 'grid'"
@click="canShowRedisConsole ? selectResultMode('grid') : selectView('result')"
>
<span class="inline-flex h-4 items-center leading-none">{{ t("tabs.tableData") }}</span>
</Button>
<LightTooltip v-if="canShowRedisConsole" :text="t('redis.commandLine')" :disabled="!compact" side="bottom" :delay="0" :close-delay="0" nowrap>
<Button
size="sm"
:variant="activeView === 'result' && effectiveResultMode === 'console' ? 'secondary' : 'ghost'"
class="h-5 shrink-0 text-xs leading-none"
:class="compact ? 'w-6 gap-0 px-0' : 'gap-1 px-2'"
:title="t('redis.commandLine')"
:aria-label="t('redis.commandLine')"
:aria-pressed="activeView === 'result' && effectiveResultMode === 'console'"
@click="selectResultMode('console')"
>
<SquareTerminal class="block h-3.5 w-3.5 self-center" />
<span v-if="!compact" class="inline-flex h-4 items-center leading-none">{{ t("redis.commandLine") }}</span>
</Button>
</LightTooltip>
<LightTooltip :text="t('tabs.executionSummary')" :disabled="!compact" side="bottom" :delay="0" :close-delay="0" nowrap>
<Button
size="sm"
@@ -0,0 +1,81 @@
// @vitest-environment happy-dom
import { createApp, defineComponent, h, nextTick, reactive } from "vue";
import { createI18n } from "vue-i18n";
import { afterEach, describe, expect, it } from "vitest";
import QueryResultViewSwitcher from "@/components/layout/QueryResultViewSwitcher.vue";
import type { RedisResultViewMode, TabOutputView } from "@/types/database";
const mounted: Array<{ unmount: () => void; host: HTMLElement }> = [];
afterEach(() => {
for (const { unmount, host } of mounted.splice(0)) {
unmount();
host.remove();
}
});
async function mountSwitcher(canShowRedisConsole: boolean) {
const state = reactive<{ view: TabOutputView; mode?: RedisResultViewMode }>({ view: "result" });
const host = document.createElement("div");
document.body.appendChild(host);
const app = createApp(
defineComponent({
setup: () => () =>
h(QueryResultViewSwitcher, {
activeView: state.view,
canShowResult: true,
canShowSummary: false,
canShowChart: false,
canShowMessages: false,
canShowRedisConsole,
resultMode: state.mode,
onSelectView: (view: TabOutputView) => {
state.view = view;
},
onSelectResultMode: (mode: RedisResultViewMode) => {
state.mode = mode;
},
}),
}),
);
app.use(
createI18n({
legacy: false,
locale: "en",
messages: { en: { tabs: { tableData: "Table Data", executionSummary: "Summary", messages: "Messages" }, chart: { title: "Chart" }, redis: { commandLine: "Command line" } } },
}),
);
app.mount(host);
mounted.push({ unmount: () => app.unmount(), host });
await nextTick();
return { host, state };
}
describe("QueryResultViewSwitcher Redis mode", () => {
it("defaults Redis results to the grid and switches through the existing toolbar contract", async () => {
const { host, state } = await mountSwitcher(true);
const grid = [...host.querySelectorAll<HTMLButtonElement>("button")].find((button) => button.textContent?.includes("Table Data"));
const console = host.querySelector<HTMLButtonElement>('button[aria-label="Command line"]');
expect(state.mode).toBeUndefined();
expect(grid?.getAttribute("aria-pressed")).toBe("true");
expect(console?.getAttribute("aria-pressed")).toBe("false");
console?.click();
await nextTick();
expect(state.mode).toBe("console");
expect(state.view).toBe("result");
expect(console?.getAttribute("aria-pressed")).toBe("true");
grid?.click();
await nextTick();
expect(state.mode).toBe("grid");
expect(grid?.getAttribute("aria-pressed")).toBe("true");
});
it("does not expose the Redis-only mode on generic result toolbars", async () => {
const { host } = await mountSwitcher(false);
expect(host.querySelector('button[aria-label="Command line"]')).toBeNull();
});
});