fix(adminui): the MQTT tag editor writes a meaningless payloadFormat into a Sparkplug tag blob #513

New Issue

2026-07-27T13:50:31-04:00

dohertj2 commented

2026-07-27 13:50:31 -04:00

MqttTagConfigEditor writes a payloadFormat key into the tag's TagConfig JSON even when the tag is in
SparkplugB mode, where the key has no meaning — payloadFormat (Json/Raw/Scalar) is a Plain-mode
concept.

Cosmetic only, and confirmed so. The tag factory routes Sparkplug tags on the Sparkplug keys
(groupId/edgeNodeId/deviceId/metricName) and ignores payloadFormat entirely, so nothing is
mis-bound — the value is noise in the stored blob, not a behaviour.

Why fix it anyway. The blob is operator-visible (it is what the raw-JSON textarea shows and what a config
export contains), and a key that looks like it selects a decode path but does not is a trap for the next
person reading a Sparkplug tag's config — including anyone diagnosing a decode problem.

Fix. Have the editor's ToJson omit payloadFormat when mode is SparkplugB. Keep the
preserve-unknown-keys behaviour intact (the editors deliberately round-trip keys they do not own — do not let
this change start dropping foreign keys).

Acceptance. A Sparkplug tag authored through the editor round-trips without a payloadFormat key; a Plain
tag still carries it; unknown keys are still preserved on both paths.

`MqttTagConfigEditor` writes a `payloadFormat` key into the tag's `TagConfig` JSON even when the tag is in **SparkplugB** mode, where the key has no meaning — `payloadFormat` (`Json`/`Raw`/`Scalar`) is a **Plain**-mode concept. **Cosmetic only, and confirmed so.** The tag factory routes Sparkplug tags on the Sparkplug keys (`groupId`/`edgeNodeId`/`deviceId`/`metricName`) and ignores `payloadFormat` entirely, so nothing is mis-bound — the value is noise in the stored blob, not a behaviour. **Why fix it anyway.** The blob is operator-visible (it is what the raw-JSON textarea shows and what a config export contains), and a key that looks like it selects a decode path but does not is a trap for the next person reading a Sparkplug tag's config — including anyone diagnosing a decode problem. **Fix.** Have the editor's `ToJson` omit `payloadFormat` when mode is SparkplugB. Keep the preserve-unknown-keys behaviour intact (the editors deliberately round-trip keys they do not own — do not let this change start dropping foreign keys). **Acceptance.** A Sparkplug tag authored through the editor round-trips without a `payloadFormat` key; a Plain tag still carries it; unknown keys are still preserved on both paths.

dohertj2 added the driver/mqtt label 2026-07-27 13:50:31 -04:00

dohertj2 referenced this issue from a commit

2026-07-27 13:52:13 -04:00

docs(drivers): un-stale the MQTT README rows + track every known gap as an issue

dohertj2 referenced this issue from a commit

2026-07-31 06:42:15 -04:00

fix(mqtt): close #509, #510, #512, #513, #514

dohertj2 referenced this issue from a commit

2026-07-31 06:42:15 -04:00

merge: MQTT tracker batch — #508, #509, #510, #512, #513, #514

dohertj2 commented

2026-07-31 06:42:57 -04:00

Fixed in master 2a7d1167.

MqttTagConfigModel.ToJson now writes payloadFormat in Plain mode only.

Sharper than the issue states, and worth recording. This was not preserving a retyped tag's
leftover — PayloadFormat is the one Plain field with a non-nullable typed backing, so
"write what the field says" invented "payloadFormat":"Json" in the blob of a Sparkplug tag that had
never carried one. Every other mode-inapplicable key (topic, jsonPath, groupId…) is blank-⇒-omit,
which is why none of them had the same problem.

Preserve-unknown-keys is unchanged and pinned: the retype test asserts the stale key is cleared while
isHistorized and an unrecognised key survive. Falsified by reverting the line — the two omission tests
go red, the Plain control stays green.

Fixed in master `2a7d1167`. `MqttTagConfigModel.ToJson` now writes `payloadFormat` in Plain mode only. **Sharper than the issue states, and worth recording.** This was not preserving a retyped tag's leftover — `PayloadFormat` is the one Plain field with a **non-nullable** typed backing, so "write what the field says" *invented* `"payloadFormat":"Json"` in the blob of a Sparkplug tag that had never carried one. Every other mode-inapplicable key (`topic`, `jsonPath`, `groupId`…) is blank-⇒-omit, which is why none of them had the same problem. Preserve-unknown-keys is unchanged and pinned: the retype test asserts the stale key is cleared *while* `isHistorized` and an unrecognised key survive. Falsified by reverting the line — the two omission tests go red, the Plain control stays green.

dohertj2 closed this issue

2026-07-31 06:42:57 -04:00

dohertj2 referenced this issue from a commit

2026-08-10 04:37:34 -04:00

fix(inspect): trim before the framing check; stop advisories swallowing the backstop (#556); pin the MQTT payloadFormat mode contract (#557 item 2)

Sign in to join this conversation.