diff --git a/apps/desktop/src/components/mqtt/MqttAdminConsole.vue b/apps/desktop/src/components/mqtt/MqttAdminConsole.vue index 547cd4bd7b..98e4605358 100644 --- a/apps/desktop/src/components/mqtt/MqttAdminConsole.vue +++ b/apps/desktop/src/components/mqtt/MqttAdminConsole.vue @@ -34,12 +34,18 @@ interface MqttTabUiState { publishPanelCollapsed?: boolean; } +interface MqttMessagePreview extends MqttMessage { + previewKey: string; + payloadElementId: string; +} + const { initialState: restoredUiState, track: trackUiState } = useTabUiState({}, "MqttAdminConsole"); const brokerInfo = ref(null); const savedTopics = ref([]); const subscribedTopics = ref<[string, string][]>([]); const messages = ref([]); +const collapsedMessageKeys = ref>(new Set()); const noLocalSubscribe = ref(false); const selectedTopic = ref(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(() => { + const identityOccurrences = new Map(); + 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);
{{ t("connection.mqttNoMessages") }}
{{ t("connection.mqttNoMatchingMessages") }}
{{ msg.topic }} QoS{{ msg.qos }} {{ t("connection.mqttRetained") }} + +
+
+
-
{{ formatMessagePayload(msg) }}
{{ new Date(msg.receivedAtMs).toLocaleTimeString() }}
diff --git a/apps/desktop/src/components/mqtt/__tests__/MqttAdminConsolePayloadCollapse.spec.ts b/apps/desktop/src/components/mqtt/__tests__/MqttAdminConsolePayloadCollapse.spec.ts new file mode 100644 index 0000000000..e7eb425672 --- /dev/null +++ b/apps/desktop/src/components/mqtt/__tests__/MqttAdminConsolePayloadCollapse.spec.ts @@ -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 => ({ + 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('[data-testid="mqtt-message-payload-toggle"]')); +} + +function payloads(container: HTMLElement): HTMLElement[] { + return Array.from(container.querySelectorAll('[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('[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); + }); +}); diff --git a/apps/desktop/src/i18n/locales/az.ts b/apps/desktop/src/i18n/locales/az.ts index 534b9618ff..dd78966049 100644 --- a/apps/desktop/src/i18n/locales/az.ts +++ b/apps/desktop/src/i18n/locales/az.ts @@ -1015,6 +1015,8 @@ export default withEnglishFallback({ mqttRefresh: "Yenilə", mqttPublishDialogTitle: "MQTT mesajını yayımla", mqttClearMessages: "Mesajları təmizlə", + mqttCollapsePayload: "Mesaj məzmununu yığ", + mqttExpandPayload: "Mesaj məzmununu genişləndir", mqttPauseMessages: "Fasilə ver", mqttResumeMessages: "Davam et", mqttHidePublishPanel: "Yayımlama panelini gizlət", diff --git a/apps/desktop/src/i18n/locales/en.ts b/apps/desktop/src/i18n/locales/en.ts index 3853ef67a7..f69ae39abf 100644 --- a/apps/desktop/src/i18n/locales/en.ts +++ b/apps/desktop/src/i18n/locales/en.ts @@ -1311,6 +1311,8 @@ export default { mqttRefresh: "Refresh", mqttPublishDialogTitle: "Publish MQTT Message", mqttClearMessages: "Clear messages", + mqttCollapsePayload: "Collapse payload", + mqttExpandPayload: "Expand payload", mqttPauseMessages: "Pause", mqttResumeMessages: "Resume", mqttHidePublishPanel: "Hide publish panel", diff --git a/apps/desktop/src/i18n/locales/es.ts b/apps/desktop/src/i18n/locales/es.ts index b6c5b4af97..48479533f4 100644 --- a/apps/desktop/src/i18n/locales/es.ts +++ b/apps/desktop/src/i18n/locales/es.ts @@ -1577,6 +1577,8 @@ export default withEnglishFallback({ mqttRefresh: "Actualizar", mqttPublishDialogTitle: "Publicar mensaje MQTT", mqttClearMessages: "Borrar mensajes", + mqttCollapsePayload: "Contraer Payload", + mqttExpandPayload: "Expandir Payload", mqttPauseMessages: "Pausar", mqttResumeMessages: "Reanudar", mqttHidePublishPanel: "Ocultar panel de publicación", diff --git a/apps/desktop/src/i18n/locales/it.ts b/apps/desktop/src/i18n/locales/it.ts index 76a827963f..e4fb715b0a 100644 --- a/apps/desktop/src/i18n/locales/it.ts +++ b/apps/desktop/src/i18n/locales/it.ts @@ -1512,6 +1512,8 @@ export default withEnglishFallback({ mqttRefresh: "Aggiorna", mqttPublishDialogTitle: "Pubblica messaggio MQTT", mqttClearMessages: "Cancella messaggi", + mqttCollapsePayload: "Comprimi Payload", + mqttExpandPayload: "Espandi Payload", mqttPauseMessages: "Pausa", mqttResumeMessages: "Riprendi", mqttHidePublishPanel: "Nascondi pannello di pubblicazione", diff --git a/apps/desktop/src/i18n/locales/ja.ts b/apps/desktop/src/i18n/locales/ja.ts index 93f50323e2..f7143b354c 100644 --- a/apps/desktop/src/i18n/locales/ja.ts +++ b/apps/desktop/src/i18n/locales/ja.ts @@ -1511,6 +1511,8 @@ export default withEnglishFallback({ mqttRefresh: "更新", mqttPublishDialogTitle: "MQTT メッセージを公開", mqttClearMessages: "メッセージを消去", + mqttCollapsePayload: "ペイロードを折りたたむ", + mqttExpandPayload: "ペイロードを展開", mqttPauseMessages: "一時停止", mqttResumeMessages: "再開", mqttHidePublishPanel: "公開パネルを隠す", diff --git a/apps/desktop/src/i18n/locales/ko.ts b/apps/desktop/src/i18n/locales/ko.ts index 5db094bed1..9270104d80 100644 --- a/apps/desktop/src/i18n/locales/ko.ts +++ b/apps/desktop/src/i18n/locales/ko.ts @@ -1503,6 +1503,8 @@ export default withEnglishFallback({ sshTotpCancelled: "일회용 코드 입력이 취소되었습니다", mqttSearchPayloadPlaceholder: "메시지 Payload 검색...", mqttNoMatchingMessages: "현재 Payload 필터 조건과 일치하는 로드된 메시지가 없습니다.", + mqttCollapsePayload: "Payload 접기", + mqttExpandPayload: "Payload 펼치기", databaseCategoryPlugins: "플러그인", pluginProviderUnavailable: "이 플러그인 연결 제공자를 사용할 수 없습니다. 플러그인을 다시 설치하거나 활성화한 후 다시 시도하세요.", pluginRequiredField: "{field}을(를) 입력하세요.", diff --git a/apps/desktop/src/i18n/locales/pt-BR.ts b/apps/desktop/src/i18n/locales/pt-BR.ts index f15bf36e97..ec40ff6ae5 100644 --- a/apps/desktop/src/i18n/locales/pt-BR.ts +++ b/apps/desktop/src/i18n/locales/pt-BR.ts @@ -1512,6 +1512,8 @@ export default withEnglishFallback({ mqttRefresh: "Atualizar", mqttPublishDialogTitle: "Publicar mensagem MQTT", mqttClearMessages: "Limpar mensagens", + mqttCollapsePayload: "Recolher Payload", + mqttExpandPayload: "Expandir Payload", mqttPauseMessages: "Pausar", mqttResumeMessages: "Retomar", mqttHidePublishPanel: "Ocultar painel de publicação", diff --git a/apps/desktop/src/i18n/locales/ru.ts b/apps/desktop/src/i18n/locales/ru.ts index cd992fab39..2fb3b89d85 100644 --- a/apps/desktop/src/i18n/locales/ru.ts +++ b/apps/desktop/src/i18n/locales/ru.ts @@ -1197,6 +1197,8 @@ export default withEnglishFallback({ mqttRefresh: "Обновить", mqttPublishDialogTitle: "Опубликовать сообщение MQTT", mqttClearMessages: "Очистить сообщения", + mqttCollapsePayload: "Свернуть полезную нагрузку", + mqttExpandPayload: "Развернуть полезную нагрузку", mqttPauseMessages: "Пауза", mqttResumeMessages: "Продолжить", mqttHidePublishPanel: "Скрыть панель публикации", diff --git a/apps/desktop/src/i18n/locales/tr.ts b/apps/desktop/src/i18n/locales/tr.ts index 1877a033c8..b976ac4176 100644 --- a/apps/desktop/src/i18n/locales/tr.ts +++ b/apps/desktop/src/i18n/locales/tr.ts @@ -1017,6 +1017,8 @@ export default withEnglishFallback({ mqttRefresh: "Yenile", mqttPublishDialogTitle: "MQTT Mesajı Yayınla", mqttClearMessages: "Mesajları temizle", + mqttCollapsePayload: "Yükü daralt", + mqttExpandPayload: "Yükü genişlet", mqttPauseMessages: "Duraklat", mqttResumeMessages: "Sürdür", mqttHidePublishPanel: "Yayınlama panelini gizle", diff --git a/apps/desktop/src/i18n/locales/zh-CN.ts b/apps/desktop/src/i18n/locales/zh-CN.ts index 36f714bce5..789dd316ea 100644 --- a/apps/desktop/src/i18n/locales/zh-CN.ts +++ b/apps/desktop/src/i18n/locales/zh-CN.ts @@ -1225,6 +1225,8 @@ export default withEnglishFallback({ mqttRefresh: "刷新", mqttPublishDialogTitle: "发布 MQTT 消息", mqttClearMessages: "清空消息", + mqttCollapsePayload: "收起消息内容", + mqttExpandPayload: "展开消息内容", mqttPauseMessages: "暂停", mqttResumeMessages: "继续", mqttHidePublishPanel: "隐藏发布区", diff --git a/apps/desktop/src/i18n/locales/zh-TW.ts b/apps/desktop/src/i18n/locales/zh-TW.ts index 34107e589c..9c69c9462b 100644 --- a/apps/desktop/src/i18n/locales/zh-TW.ts +++ b/apps/desktop/src/i18n/locales/zh-TW.ts @@ -1522,6 +1522,8 @@ export default withEnglishFallback({ mqttRefresh: "重新整理", mqttPublishDialogTitle: "發布 MQTT 訊息", mqttClearMessages: "清除訊息", + mqttCollapsePayload: "收合訊息內容", + mqttExpandPayload: "展開訊息內容", mqttPauseMessages: "暫停", mqttResumeMessages: "繼續", mqttHidePublishPanel: "隱藏發布區",