feat(mqtt): collapse individual message payloads

Closes #9307
This commit is contained in:
t8y2 committed 2026-09-26 12:45:31 +00:00
1 parent 8b3843dfd8
commit ec38b8c371
13 files changed
+271 -5

No files matched your search

@@ -34,12 +34,18 @@ interface MqttTabUiState {
publishPanelCollapsed?: boolean;
}
interface MqttMessagePreview extends MqttMessage {
previewKey: string;
payloadElementId: string;
}
const { initialState: restoredUiState, track: trackUiState } = useTabUiState<MqttTabUiState>({}, "MqttAdminConsole");
const brokerInfo = ref<MqttBrokerInfo | null>(null);
const savedTopics = ref<MqttSavedTopic[]>([]);
const subscribedTopics = ref<[string, string][]>([]);
const messages = ref<MqttMessage[]>([]);
const collapsedMessageKeys = ref<Set<string>>(new Set());
const noLocalSubscribe = ref(false);
const selectedTopic = ref<string>(restoredUiState.selectedTopic ?? props.initialTopic ?? "");
const loading = ref(true);
@@ -108,10 +114,34 @@ function messagePayloadText(msg: MqttMessage): string {
return msg.payloadText ?? decodePayload(msg.payloadBase64, "plaintext");
}
function hashMessageValue(value: string): string {
let hash = 0x811c9dc5;
for (let index = 0; index < value.length; index += 1) {
hash ^= value.charCodeAt(index);
hash = Math.imul(hash, 0x01000193);
}
return (hash >>> 0).toString(36);
}
function messagePreviewIdentity(msg: MqttMessage): string {
return [msg.receivedAtMs, msg.direction ?? "received", msg.qos, msg.retain ? 1 : 0, hashMessageValue(msg.topic), msg.payloadBase64.length, hashMessageValue(msg.payloadBase64)].join("-");
}
const messagePreviews = computed<MqttMessagePreview[]>(() => {
const identityOccurrences = new Map<string, number>();
return messages.value.map((msg) => {
const identity = messagePreviewIdentity(msg);
const occurrence = identityOccurrences.get(identity) ?? 0;
identityOccurrences.set(identity, occurrence + 1);
const previewKey = `${identity}-${occurrence}`;
return { ...msg, previewKey, payloadElementId: `mqtt-message-payload-${previewKey}` };
});
});
const filteredMessages = computed(() => {
const query = payloadSearch.value.trim().toLowerCase();
if (!query) return messages.value;
return messages.value.filter((msg) => messagePayloadText(msg).toLowerCase().includes(query));
if (!query) return messagePreviews.value;
return messagePreviews.value.filter((msg) => messagePayloadText(msg).toLowerCase().includes(query));
});
async function refreshData() {
@@ -264,6 +294,7 @@ async function handleClearMessages() {
try {
await mqttClearMessages(props.connectionId);
messages.value = [];
collapsedMessageKeys.value = new Set();
} catch (e) {
error.value = String(e);
}
@@ -293,6 +324,17 @@ function toggleMessagesPaused() {
messagesPaused.value = !messagesPaused.value;
}
function isMessagePayloadCollapsed(messageKey: string): boolean {
return collapsedMessageKeys.value.has(messageKey);
}
function toggleMessagePayload(messageKey: string) {
const nextCollapsedMessageKeys = new Set(collapsedMessageKeys.value);
if (nextCollapsedMessageKeys.has(messageKey)) nextCollapsedMessageKeys.delete(messageKey);
else nextCollapsedMessageKeys.add(messageKey);
collapsedMessageKeys.value = nextCollapsedMessageKeys;
}
function formatMessagePayload(msg: MqttMessage): string {
if (displayEncoding.value === "plaintext") return messagePayloadText(msg);
return decodePayload(msg.payloadBase64, displayEncoding.value);
@@ -420,8 +462,9 @@ onUnmounted(stopPolling);
<div v-if="messages.length === 0" class="p-4 text-center text-xs text-muted-foreground">{{ t("connection.mqttNoMessages") }}</div>
<div v-else-if="filteredMessages.length === 0" data-testid="mqtt-no-matching-messages" class="p-4 text-center text-xs text-muted-foreground">{{ t("connection.mqttNoMatchingMessages") }}</div>
<div
v-for="(msg, i) in filteredMessages"
:key="i"
v-for="msg in filteredMessages"
:key="msg.previewKey"
data-testid="mqtt-message"
class="w-full cursor-pointer border-b px-3 py-2 text-xs"
:class="
msg.direction === 'sent'
@@ -436,8 +479,26 @@ onUnmounted(stopPolling);
<span class="truncate font-mono font-medium text-blue-700 dark:text-blue-300">{{ msg.topic }}</span>
<span class="shrink-0 text-muted-foreground">QoS{{ msg.qos }}</span>
<span v-if="msg.retain" class="shrink-0 text-[10px] font-medium text-amber-600 dark:text-amber-400">{{ t("connection.mqttRetained") }}</span>
<Button
type="button"
size="xs"
variant="ghost"
data-testid="mqtt-message-payload-toggle"
class="ml-auto h-5 gap-0.5 px-1.5 text-[10px] font-normal"
:title="isMessagePayloadCollapsed(msg.previewKey) ? t('connection.mqttExpandPayload') : t('connection.mqttCollapsePayload')"
:aria-expanded="!isMessagePayloadCollapsed(msg.previewKey)"
:aria-controls="msg.payloadElementId"
@click.stop="toggleMessagePayload(msg.previewKey)"
>
<ChevronDown v-if="isMessagePayloadCollapsed(msg.previewKey)" class="h-3 w-3" />
<ChevronUp v-else class="h-3 w-3" />
<span>{{ isMessagePayloadCollapsed(msg.previewKey) ? t("connection.mqttExpandPayload") : t("connection.mqttCollapsePayload") }}</span>
<span class="sr-only">: {{ msg.topic }}</span>
</Button>
</div>
<div :id="msg.payloadElementId" data-testid="mqtt-message-payload" class="break-all whitespace-pre-wrap font-mono text-muted-foreground" :hidden="isMessagePayloadCollapsed(msg.previewKey)">
<template v-if="!isMessagePayloadCollapsed(msg.previewKey)">{{ formatMessagePayload(msg) }}</template>
</div>
<div class="break-all whitespace-pre-wrap font-mono text-muted-foreground">{{ formatMessagePayload(msg) }}</div>
<div class="mt-0.5 text-[10px] text-muted-foreground/60">{{ new Date(msg.receivedAtMs).toLocaleTimeString() }}</div>
</div>
</div>
@@ -0,0 +1,183 @@
// @vitest-environment happy-dom
import { createApp, nextTick, type App } from "vue";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import i18n from "@/i18n";
import MqttAdminConsole from "@/components/mqtt/MqttAdminConsole.vue";
import type { MqttBrokerInfo, MqttMessage } from "@/types/mqtt";
const { mqttClearMessagesMock, mqttGetMessagesMock } = vi.hoisted(() => ({
mqttClearMessagesMock: vi.fn(),
mqttGetMessagesMock: vi.fn(),
}));
vi.mock("@/lib/backend/api", () => ({
mqttGetBrokerInfo: vi.fn(
async (): Promise<MqttBrokerInfo> => ({
brokerUrl: "mqtt://localhost:1883",
clientId: "dbx-test",
connected: true,
protocolVersion: "5.0",
subscriptionCount: 1,
}),
),
mqttListTopics: vi.fn(async () => [["device/status", "atmostonce"]]),
mqttListSavedTopicConfigs: vi.fn(async () => [{ topic: "device/status", qos: "atmostonce", enabled: true, noLocal: false }]),
mqttGetMessages: mqttGetMessagesMock,
mqttSubscribe: vi.fn(),
mqttUnsubscribe: vi.fn(),
mqttSaveTopicConfig: vi.fn(),
mqttDeleteTopicConfig: vi.fn(),
mqttClearMessages: mqttClearMessagesMock,
}));
const mountedApps: App[] = [];
function messageAt(payload: string, receivedAtMs: number): MqttMessage {
return {
topic: `device/${payload}`,
payloadBase64: btoa(payload),
payloadText: payload,
qos: 0,
retain: false,
receivedAtMs,
direction: "received",
};
}
async function mountConsole() {
const container = document.createElement("div");
document.body.append(container);
const app = createApp(MqttAdminConsole, {
connectionId: "mqtt-connection-1",
initialTopic: "device/status",
});
mountedApps.push(app);
app.use(i18n);
app.mount(container);
await settleConsole();
return container;
}
async function settleConsole() {
await Promise.resolve();
await Promise.resolve();
await Promise.resolve();
await nextTick();
}
function payloadToggles(container: HTMLElement): HTMLButtonElement[] {
return Array.from(container.querySelectorAll<HTMLButtonElement>('[data-testid="mqtt-message-payload-toggle"]'));
}
function payloads(container: HTMLElement): HTMLElement[] {
return Array.from(container.querySelectorAll<HTMLElement>('[data-testid="mqtt-message-payload"]'));
}
async function click(element: Element) {
element.dispatchEvent(new MouseEvent("click", { bubbles: true }));
await nextTick();
}
async function setPayloadSearch(container: HTMLElement, value: string) {
const input = container.querySelector<HTMLInputElement>('[data-testid="mqtt-payload-search"]');
expect(input).not.toBeNull();
input!.value = value;
input!.dispatchEvent(new Event("input", { bubbles: true }));
await nextTick();
}
beforeEach(() => {
mqttGetMessagesMock.mockReset().mockResolvedValue([]);
mqttClearMessagesMock.mockReset().mockResolvedValue(undefined);
i18n.global.locale.value = "en";
vi.useFakeTimers();
});
afterEach(() => {
vi.useRealTimers();
for (const app of mountedApps.splice(0)) app.unmount();
document.body.innerHTML = "";
});
describe("MQTT message payload collapse (issue #9307)", () => {
it("starts every message payload expanded", async () => {
mqttGetMessagesMock.mockResolvedValueOnce([messageAt("payload-alpha", 1_700_000_000_001), messageAt("payload-beta", 1_700_000_000_002)]);
const container = await mountConsole();
const toggles = payloadToggles(container);
const messagePayloads = payloads(container);
expect(toggles).toHaveLength(2);
expect(messagePayloads).toHaveLength(2);
expect(toggles.every((toggle) => toggle.getAttribute("aria-expanded") === "true")).toBe(true);
expect(toggles.every((toggle) => toggle.textContent?.includes("Collapse payload"))).toBe(true);
expect(messagePayloads.every((payload) => !payload.hidden)).toBe(true);
expect(toggles.every((toggle) => container.querySelector(`#${toggle.getAttribute("aria-controls")}`))).toBe(true);
});
it("toggles each message payload independently without selecting its topic", async () => {
mqttGetMessagesMock.mockResolvedValueOnce([messageAt("payload-alpha", 1_700_000_000_001), messageAt("payload-beta", 1_700_000_000_002)]);
const container = await mountConsole();
const callsAfterLoad = mqttGetMessagesMock.mock.calls.length;
let toggles = payloadToggles(container);
await click(toggles[0]);
toggles = payloadToggles(container);
expect(toggles[0].getAttribute("aria-expanded")).toBe("false");
expect(toggles[0].textContent).toContain("Expand payload");
expect(payloads(container).map((payload) => payload.hidden)).toEqual([true, false]);
expect(payloads(container)[0].textContent).toBe("");
await click(toggles[1]);
expect(payloads(container).map((payload) => payload.hidden)).toEqual([true, true]);
toggles = payloadToggles(container);
await click(toggles[0]);
expect(payloads(container).map((payload) => payload.hidden)).toEqual([false, true]);
expect(mqttGetMessagesMock).toHaveBeenCalledTimes(callsAfterLoad);
});
it("keeps collapse state with the same message while payload search changes indexes", async () => {
mqttGetMessagesMock.mockResolvedValueOnce([messageAt("payload-alpha", 1_700_000_000_001), messageAt("payload-beta", 1_700_000_000_002)]);
const container = await mountConsole();
await click(payloadToggles(container)[1]);
await setPayloadSearch(container, "beta");
expect(payloadToggles(container)).toHaveLength(1);
expect(payloadToggles(container)[0].getAttribute("aria-expanded")).toBe("false");
expect(payloads(container)[0].hidden).toBe(true);
await setPayloadSearch(container, "");
expect(payloadToggles(container).map((toggle) => toggle.getAttribute("aria-expanded"))).toEqual(["true", "false"]);
expect(payloads(container).map((payload) => payload.hidden)).toEqual([false, true]);
});
it("clears collapse state when messages are cleared", async () => {
const message = messageAt("payload-alpha", 1_700_000_000_001);
mqttGetMessagesMock.mockResolvedValueOnce([message]);
const container = await mountConsole();
await click(payloadToggles(container)[0]);
expect(payloads(container)[0].hidden).toBe(true);
const clearButton = Array.from(container.querySelectorAll("button")).find((button) => button.textContent?.trim() === "Clear messages");
expect(clearButton).toBeTruthy();
await click(clearButton!);
await settleConsole();
expect(mqttClearMessagesMock).toHaveBeenCalledWith("mqtt-connection-1");
expect(container.querySelectorAll('[data-testid="mqtt-message"]')).toHaveLength(0);
mqttGetMessagesMock.mockResolvedValueOnce([message]);
const refreshButton = Array.from(container.querySelectorAll("button")).find((button) => button.textContent?.trim() === "Refresh");
expect(refreshButton).toBeTruthy();
await click(refreshButton!);
await settleConsole();
expect(payloadToggles(container)[0].getAttribute("aria-expanded")).toBe("true");
expect(payloads(container)[0].hidden).toBe(false);
});
});