fix(redis): show values for kvrocks bitmap and hyperloglog keys

This commit is contained in:
高桥凉介 authored and GitHub committed 2026-09-28 13:56:02 +08:00
1 parent c571c1ddc7
commit d452346082
17 files changed
+367 -30

No files matched your search

@@ -130,7 +130,7 @@ function missingValue() {
key_raw: "key",
ttl: -2,
redis_type: "none",
data: { kind: "unknown" as const },
data: { kind: "unknown" as const, redis_type: "none" },
};
}
@@ -0,0 +1,185 @@
// @vitest-environment happy-dom
//
// 覆盖 kvrocks 专有类型(bitmap / hyperloglog)与未知类型的详情渲染:
// 这些类型以前会落到 unknown 分支,界面上只显示空值(issue #10406)。
import { createApp, defineComponent, h, nextTick } from "vue";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { createI18n } from "vue-i18n";
const mocks = vi.hoisted(() => ({
redisGetValue: vi.fn(),
redisGetTtl: vi.fn(),
toast: vi.fn(),
}));
vi.mock("@/lib/backend/api", () => ({
redisGetValue: mocks.redisGetValue,
redisGetTtl: mocks.redisGetTtl,
redisSetTtl: vi.fn(),
redisSetExpireAt: vi.fn(),
}));
vi.mock("@/composables/useEditorFontFamilyStyle", () => ({
useEditorFontFamilyStyle: () => ({}),
}));
vi.mock("@/composables/useToast", () => ({
useToast: () => ({ toast: mocks.toast }),
}));
vi.mock("@/lib/common/shikiJsonHighlighter", () => ({
createShikiJsonHighlighter: vi.fn().mockResolvedValue(() => ""),
}));
import RedisValueViewer from "./RedisValueViewer.vue";
const mountedApps: Array<{ unmount: () => void; host: HTMLElement }> = [];
function createLocalStorage(): Storage {
const entries = new Map<string, string>();
return {
get length() {
return entries.size;
},
clear() {
entries.clear();
},
getItem(key) {
return entries.get(key) ?? null;
},
key(index) {
return [...entries.keys()][index] ?? null;
},
removeItem(key) {
entries.delete(key);
},
setItem(key, value) {
entries.set(key, String(value));
},
};
}
beforeEach(() => {
vi.clearAllMocks();
vi.stubGlobal("localStorage", createLocalStorage());
});
afterEach(() => {
for (const { unmount, host } of mountedApps.splice(0)) {
unmount();
host.remove();
}
vi.unstubAllGlobals();
});
const testI18nMessages = {
en: {
redis: {
bitmapInfo: "kvrocks bitmap · {bits} bits set · {bytes} bytes",
hyperLogLogHint: "kvrocks HyperLogLog: PFCOUNT cardinality estimate",
unsupportedValueType: "Viewing this Redis type is not supported yet: {type}",
unsupportedValueTypeHint: "Proprietary kvrocks type",
largeStringPreviewHintUnknown: "This value is large. Only the first {loaded} is loaded, and the preview is read-only.",
},
},
};
async function settle() {
await nextTick();
await Promise.resolve();
await nextTick();
}
async function mountViewer() {
const host = document.createElement("div");
document.body.append(host);
const app = createApp(
defineComponent({
setup() {
return () => h(RedisValueViewer, { connectionId: "connection", db: 0, keyDisplay: "key", keyRaw: "key" });
},
}),
);
app.use(createI18n({ legacy: false, locale: "en", messages: testI18nMessages, missingWarn: false, fallbackWarn: false }));
app.mount(host);
mountedApps.push({ unmount: () => app.unmount(), host });
await settle();
}
describe("RedisValueViewer kvrocks 专有类型", () => {
it("按字节渲染 kvrocks 位图并显示置位数量,且不提供保存动作", async () => {
mocks.redisGetValue.mockResolvedValue({
key_display: "bitmap-key",
key_raw: "bitmap-key",
ttl: -1,
redis_type: "bitmap",
data: {
kind: "bitmap",
content: { raw_base64: "gA==", encoding: "binary" },
total_bytes: 1,
set_bits: 1,
},
});
await mountViewer();
const info = document.querySelector("[data-redis-bitmap-info]");
expect(info?.textContent).toContain("1 bits set");
expect(info?.textContent).toContain("1 bytes");
// 位图写回会改变服务端类型,因此详情面板不出现保存按钮
expect(document.querySelector("[data-slot='button'][aria-label='grid.save']")).toBeNull();
});
it("截断的 kvrocks 位图显示未知总量的截断提示而不是空文案", async () => {
// 超过预览上限时后端拿不到位图准确长度(total_bytes 为空),截断横幅须走未知总量文案
mocks.redisGetValue.mockResolvedValue({
key_display: "bitmap-key",
key_raw: "bitmap-key",
ttl: -1,
redis_type: "bitmap",
data: {
kind: "bitmap",
content: { raw_base64: "gA==", encoding: "binary" },
truncated: true,
set_bits: 1,
},
});
await mountViewer();
const banner = document.querySelector("[data-redis-large-string-preview]");
expect(banner).not.toBeNull();
expect(banner?.textContent).toContain("Only the first 1 B is loaded");
});
it("HyperLogLog 类型展示 PFCOUNT 基数估计", async () => {
mocks.redisGetValue.mockResolvedValue({
key_display: "hll-key",
key_raw: "hll-key",
ttl: -1,
redis_type: "hyperloglog",
data: { kind: "hyperloglog", count: 42 },
});
await mountViewer();
expect(document.body.textContent).toContain("42");
expect(document.body.textContent).toContain("PFCOUNT cardinality estimate");
});
it("未知类型提示具体类型名而不是空白", async () => {
mocks.redisGetValue.mockResolvedValue({
key_display: "ts-key",
key_raw: "ts-key",
ttl: -1,
redis_type: "timeseries",
data: { kind: "unknown", redis_type: "timeseries" },
});
await mountViewer();
expect(document.body.textContent).toContain("timeseries");
expect(document.body.textContent).toContain("Viewing this Redis type is not supported yet");
});
});
@@ -441,13 +441,25 @@ async function toggleZsetSort() {
const redisKind = computed(() => data.value?.data.kind ?? "unknown");
const isStringLikeKind = computed(() => redisKind.value === "string");
/** kvrocks 的位图类型:取值链路与字符串一致,但不可编辑(SET 会把它变成字符串)。 */
const isBitmapKind = computed(() => redisKind.value === "bitmap");
const bitmapSetBits = computed(() => (data.value?.data.kind === "bitmap" ? data.value.data.set_bits : undefined));
const bitmapByteLength = computed(() => (data.value?.data.kind === "bitmap" ? data.value.data.total_bytes : undefined));
const hyperLogLogCount = computed(() => (data.value?.data.kind === "hyperloglog" ? data.value.data.count : undefined));
const unsupportedRedisType = computed(() => (data.value?.data.kind === "unknown" ? data.value.data.redis_type : ""));
const stringBlob = computed<RedisBlob | null>(() => {
const value = data.value;
if (!value) return null;
return value.data.kind === "string" ? value.data.content : null;
if (value.data.kind === "string") return value.data.content;
// kvrocks 位图用 GET 取到的字节与字符串完全一致,直接复用字符串预览链路
return value.data.kind === "bitmap" ? value.data.content : null;
});
const isStringValueTruncated = computed(() => data.value?.data.kind === "string" && Boolean(data.value.data.truncated));
const stringValueDetail = computed(() => (stringBlob.value ? formatRedisMemberDetail(stringBlob.value, { allowJsonText: true }) : null));
const isStringValueTruncated = computed(() => {
const value = data.value;
if (!value) return false;
return (value.data.kind === "string" || value.data.kind === "bitmap") && Boolean(value.data.truncated);
});
const stringValueDetail = computed(() => (stringBlob.value ? formatRedisMemberDetail(stringBlob.value, { allowJsonText: !isBitmapKind.value }) : null));
const selectedMemberDetail = computed(() => formatRedisMemberDetail(selectedMemberRaw.value, { allowJsonText: true }));
// Decompression depends on the value/codec refs above, so these watchers and
@@ -577,7 +589,8 @@ const memberCopyText = computed(() => memberDecodedText.value ?? detailTextForFo
const redisJsonAppearance = computed(() => (isDark.value ? "dark" : "light"));
const isBinaryStringValue = computed(() => Boolean(stringValueDetail.value?.binary));
const selectedMemberCanEdit = computed(() => selectedMemberContext.value?.canEdit ?? false);
const canEditCurrentStringFormat = computed(() => !isStringValueTruncated.value && Boolean(stringValueDetail.value?.editable) && (stringValueView.value === "utf8" || stringValueView.value === "json"));
// kvrocks 位图不是字符串,写回会成为字符串,因此位图详情只读
const canEditCurrentStringFormat = computed(() => !isBitmapKind.value && !isStringValueTruncated.value && Boolean(stringValueDetail.value?.editable) && (stringValueView.value === "utf8" || stringValueView.value === "json"));
const showStringEditActions = computed(() => canEditCurrentStringFormat.value);
const originalStringEditValue = computed(() => (stringBlob.value ? rawRedisValueText(stringBlob.value) : ""));
const stringJsonRawBaseline = ref("");
@@ -654,7 +667,8 @@ const metadataSizeLabel = computed(() => {
const largeStringPreviewHint = computed(() => {
const value = data.value;
const loaded = stringValueDetail.value?.byteCount ?? 0;
if (!value || value.data.kind !== "string" || !value.data.truncated) return "";
// kvrocks 位图复用字符串截断横幅;截断时后端拿不到准确长度(total_bytes 为空),走未知总量文案
if (!value || (value.data.kind !== "string" && value.data.kind !== "bitmap") || !value.data.truncated) return "";
if (value.data.total_bytes != null) {
return t("redis.largeStringPreviewHint", { loaded: formatBytes(loaded), total: formatBytes(value.data.total_bytes) });
}
@@ -1572,10 +1586,13 @@ async function load(options: { background?: boolean; notifyParent?: boolean; pre
memberDraftFormat.value = null;
}
if (loadedValue.data.kind === "string") {
if (loadedValue.data.kind === "string" || loadedValue.data.kind === "bitmap") {
// kvrocks 位图复用字符串的预览/编码渲染链路;位图不允许 JSON 视图与编辑,
// 因为它并不是字符串(写回会改变服务端类型)。
const allowJsonText = loadedValue.data.kind === "string";
if (loadedValue.data.truncated) stringValueCodec.value = "none";
const detail = formatRedisMemberDetail(loadedValue.data.content, { allowJsonText: true });
stringValueView.value = preferredRedisValueFormat(loadedValue.data.content, readPreferredRedisValueFormat(), { allowJsonText: true });
const detail = formatRedisMemberDetail(loadedValue.data.content, { allowJsonText });
stringValueView.value = preferredRedisValueFormat(loadedValue.data.content, readPreferredRedisValueFormat(), { allowJsonText });
stringJsonRawBaseline.value = detail.json?.formattedText ?? "";
stringJsonDraftBaseline.value = jsonDraftBaseline(stringJsonRawBaseline.value, redisJsonDecoded.value);
editValue.value = stringValueView.value === "json" && detail.json ? stringJsonDraftBaseline.value : detail.rawText;
@@ -2811,8 +2828,8 @@ useUpdateBlocker(() => (hasUnsavedRedisDraft.value || editingTtl.value || saving
</div>
</div>
<!-- String -->
<div v-if="isStringLikeKind && stringValueDetail" class="flex-1 flex flex-col overflow-hidden">
<!-- String / kvrocks Bitmap(位图同样按字节预览,但只读) -->
<div v-if="(isStringLikeKind || isBitmapKind) && stringValueDetail" class="flex-1 flex flex-col overflow-hidden">
<div class="flex h-9 items-center gap-2 border-b px-4 text-xs shrink-0">
<span class="shrink-0 text-muted-foreground">{{ t("redis.codecRowLabel") }}</span>
<RedisHorizontalScrollbar>
@@ -2941,12 +2958,22 @@ useUpdateBlocker(() => (hasUnsavedRedisDraft.value || editingTtl.value || saving
<div v-else-if="isBinaryStringValue" class="px-4 py-2 border-t text-xs text-muted-foreground shrink-0">
{{ t("redis.binaryStringReadonlyHint") }}
</div>
<!-- kvrocks 位图:补充置位数等 kvrocks 专有的位图信息 -->
<div v-if="isBitmapKind" data-redis-bitmap-info class="px-4 py-2 border-t text-xs text-muted-foreground shrink-0">
{{ t("redis.bitmapInfo", { bits: bitmapSetBits ?? "-", bytes: bitmapByteLength ?? "-" }) }}
</div>
<div v-if="showStringEditActions" class="px-4 py-2 border-t flex justify-end gap-2 shrink-0">
<Button variant="ghost" size="sm" :disabled="savingString || !stringValueChanged" @click="discardStringEdit">{{ t("grid.discard") }}</Button>
<Button size="sm" :disabled="savingString || !stringValueChanged" @click="saveString"><Loader2 v-if="savingString" class="w-3 h-3 mr-1 animate-spin" /><Save v-else class="w-3 h-3 mr-1" /> {{ t("grid.save") }}</Button>
</div>
</div>
<!-- kvrocks HyperLogLog:原始字节不可读,只展示 PFCOUNT 得到的基数估计 -->
<div v-else-if="redisKind === 'hyperloglog'" class="flex-1 flex flex-col items-center justify-center gap-2 p-6 text-center">
<div class="dbx-editor-font-family text-2xl font-semibold">{{ hyperLogLogCount ?? "-" }}</div>
<div class="text-xs text-muted-foreground">{{ t("redis.hyperLogLogHint") }}</div>
</div>
<!-- Redis JSON -->
<div v-else-if="redisKind === 'json'" class="flex-1 flex flex-col overflow-hidden">
<div class="flex h-9 items-center gap-2 border-b px-4 text-xs shrink-0">
@@ -3512,9 +3539,11 @@ useUpdateBlocker(() => (hasUnsavedRedisDraft.value || editingTtl.value || saving
</Tabs>
</div>
<!-- Unknown -->
<div v-else class="flex-1 overflow-auto p-4">
<pre class="dbx-editor-font-family text-sm whitespace-pre-wrap">{{ formatValue(data.data) }}</pre>
<!-- Unknown:服务端返回了 DBX 暂不支持的类型(如 kvrocks 的 timeseries / TDIS-TYPE),
明确提示类型名,避免只显示空值让人以为键里没有内容(issue #10406)。 -->
<div v-else class="flex-1 flex flex-col items-center justify-center gap-2 p-6 text-center">
<div class="text-sm">{{ t("redis.unsupportedValueType", { type: unsupportedRedisType || "?" }) }}</div>
<div class="text-xs text-muted-foreground">{{ t("redis.unsupportedValueTypeHint") }}</div>
</div>
</template>