refactor: accept expanded deviceInfo fields in v1 devices #1021
+331
−23
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| package dto | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "time" | ||
| ) | ||
|
|
||
|
|
@@ -37,13 +38,104 @@ type Device struct { | |
| } | ||
|
|
||
| type DeviceInfo struct { | ||
| FWVersion string `json:"fwVersion"` | ||
| FWBuild string `json:"fwBuild"` | ||
| FWSku string `json:"fwSku"` | ||
| CurrentMode string `json:"currentMode"` | ||
| Features string `json:"features"` | ||
| IPAddress string `json:"ipAddress"` | ||
| LastUpdated time.Time `json:"lastUpdated"` | ||
| TLSMode string `json:"tlsMode"` | ||
| UPID map[string]any `json:"upid,omitempty"` | ||
| AMTEnabledInBIOS *bool `json:"amtEnabledInBIOS,omitempty"` | ||
| MEInterfaceVersion string `json:"meInterfaceVersion"` | ||
| DHCPEnabled *bool `json:"dhcpEnabled,omitempty"` | ||
| CertHashes []string `json:"certHashes,omitempty"` | ||
| LMSInstalled *bool `json:"lmsInstalled,omitempty"` | ||
| LMSVersion string `json:"lmsVersion"` | ||
| OSName string `json:"osName"` | ||
|
Comment on lines
+47
to
+56
|
||
| OSVersion string `json:"osVersion"` | ||
| OSDistro string `json:"osDistro"` | ||
| CPUModel string `json:"cpuModel"` | ||
| OSIPAddress string `json:"osIpAddress"` | ||
| EthernetAdapterCount *int `json:"ethernetAdapterCount,omitempty"` | ||
| MonitorConnected *bool `json:"monitorConnected,omitempty"` | ||
| IEEE8021XEnabled *bool `json:"ieee8021xEnabled,omitempty"` | ||
| LastDiscovered *time.Time `json:"lastDiscovered,omitempty"` | ||
| ExtraFields map[string]json.RawMessage `json:"-"` | ||
| } | ||
|
|
||
| func (d *DeviceInfo) UnmarshalJSON(data []byte) error { | ||
| type alias DeviceInfo | ||
|
|
||
| var base alias | ||
| if err := json.Unmarshal(data, &base); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var raw map[string]json.RawMessage | ||
| if err := json.Unmarshal(data, &raw); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| delete(raw, "fwVersion") | ||
|
Member
There was a problem hiding this comment. Drop the catch-all entirely. Unknown fields aren't part of the contract — if a field isn't known, it doesn't belong on the wire. That means this whole Follow-ups in this PR:
Net result is roughly -50 lines and removes a class of silent-drift bugs. |
||
| delete(raw, "fwBuild") | ||
| delete(raw, "fwSku") | ||
| delete(raw, "currentMode") | ||
| delete(raw, "features") | ||
| delete(raw, "ipAddress") | ||
| delete(raw, "lastUpdated") | ||
| delete(raw, "tlsMode") | ||
| delete(raw, "upid") | ||
| delete(raw, "amtEnabledInBIOS") | ||
| delete(raw, "meInterfaceVersion") | ||
| delete(raw, "dhcpEnabled") | ||
| delete(raw, "certHashes") | ||
| delete(raw, "lmsInstalled") | ||
| delete(raw, "lmsVersion") | ||
| delete(raw, "osName") | ||
| delete(raw, "osVersion") | ||
| delete(raw, "osDistro") | ||
| delete(raw, "cpuModel") | ||
| delete(raw, "osIpAddress") | ||
| delete(raw, "ethernetAdapterCount") | ||
| delete(raw, "monitorConnected") | ||
| delete(raw, "ieee8021xEnabled") | ||
| delete(raw, "lastDiscovered") | ||
|
|
||
| *d = DeviceInfo(base) | ||
| if len(raw) > 0 { | ||
| d.ExtraFields = raw | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (d DeviceInfo) MarshalJSON() ([]byte, error) { | ||
| type alias DeviceInfo | ||
|
|
||
| base := alias(d) | ||
| base.ExtraFields = nil | ||
|
Member
There was a problem hiding this comment. Moot — the entire |
||
|
|
||
| b, err := json.Marshal(base) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if len(d.ExtraFields) == 0 { | ||
| return b, nil | ||
| } | ||
|
|
||
| var raw map[string]json.RawMessage | ||
| if err := json.Unmarshal(b, &raw); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for key, value := range d.ExtraFields { | ||
| raw[key] = value | ||
|
Member
There was a problem hiding this comment. This concern goes away entirely if |
||
| } | ||
|
|
||
| return json.Marshal(raw) | ||
| } | ||
|
|
||
| type Explorer struct { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package dto | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestDeviceInfoJSONRoundTrip(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| amtEnabled := true | ||
| dhcpEnabled := true | ||
| lmsInstalled := true | ||
| ethernetAdapterCount := 2 | ||
| monitorConnected := true | ||
| ieee8021xEnabled := false | ||
| lastDiscovered := time.Date(2026, 5, 14, 10, 23, 0, 0, time.UTC) | ||
|
|
||
| info := DeviceInfo{ | ||
| FWVersion: "16.1.30", | ||
| FWBuild: "3400", | ||
| FWSku: "11", | ||
| CurrentMode: "Admin", | ||
| Features: "SOL,IDER,KVM", | ||
| IPAddress: "10.0.0.12", | ||
| LastUpdated: time.Date(2026, 5, 21, 0, 0, 0, 0, time.UTC), | ||
| TLSMode: "TLS 1.2", | ||
| UPID: map[string]any{"oemPlatformIdType": "Not Set (0)", "oemId": "", "csmeId": "4A45A39C5ED94620"}, | ||
| AMTEnabledInBIOS: &amtEnabled, | ||
| MEInterfaceVersion: "16.1.25.2124", | ||
| DHCPEnabled: &dhcpEnabled, | ||
| CertHashes: []string{"a1b2c3", "d4e5f6"}, | ||
| LMSInstalled: &lmsInstalled, | ||
| LMSVersion: "2410.5.0.0", | ||
| OSName: "linux", | ||
| OSVersion: "6.8.0-51-generic", | ||
| OSDistro: "Ubuntu 24.04 LTS", | ||
| CPUModel: "Intel(R) Core(TM) Ultra 7 165H", | ||
| OSIPAddress: "10.49.76.163", | ||
| EthernetAdapterCount: ðernetAdapterCount, | ||
| MonitorConnected: &monitorConnected, | ||
| IEEE8021XEnabled: &ieee8021xEnabled, | ||
| LastDiscovered: &lastDiscovered, | ||
| ExtraFields: map[string]json.RawMessage{ | ||
| "customFlag": json.RawMessage("true"), | ||
| }, | ||
| } | ||
|
|
||
| encoded, err := json.Marshal(info) | ||
| require.NoError(t, err) | ||
|
|
||
| var decoded DeviceInfo | ||
| require.NoError(t, json.Unmarshal(encoded, &decoded)) | ||
|
|
||
| require.Equal(t, info.TLSMode, decoded.TLSMode) | ||
| require.Equal(t, info.MEInterfaceVersion, decoded.MEInterfaceVersion) | ||
| require.Equal(t, info.CertHashes, decoded.CertHashes) | ||
| require.Equal(t, info.LMSVersion, decoded.LMSVersion) | ||
| require.NotNil(t, decoded.LMSInstalled) | ||
| require.Equal(t, *info.LMSInstalled, *decoded.LMSInstalled) | ||
| require.NotNil(t, decoded.LastDiscovered) | ||
| require.True(t, decoded.LastDiscovered.Equal(lastDiscovered)) | ||
| require.Contains(t, decoded.ExtraFields, "customFlag") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
map[string]anycoerces numeric JSON values tofloat64on Unmarshal. If any UPID subfield is ever sent as an integer (e.g."oemPlatformIdType": 0), the re-marshaled value loses type fidelity, and any 64-bit identifier larger than 2^53 loses precision outright.The Postman sample shows UPID has a knowable shape (
oemPlatformIdType,oemId,csmeId) — a typed struct would be safer thanmap[string]any. If a typed struct isn't practical yet,map[string]json.RawMessagepreserves the original bytes for round-trip without coercion.