fix panic from assignment to entry in nil map (#453)

Author: kcajmagic

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v1.6.1]
+- Fixed panic from assignment to entry in nil map [#453](https://github.com/xmidt-org/webpa-common/pull/453)
+
 ## [v1.6.0]
 - Added session-id to device information [#451](https://github.com/xmidt-org/webpa-common/pull/451)
 - Added device metadata to outbound events [#451](https://github.com/xmidt-org/webpa-common/pull/451)

device/manager.go

@@ -505,6 +505,9 @@ func updateEventMetadata(event Event) Event {
 	}
 
 	// update metadata
+	if msg.Metadata == nil {
+		msg.Metadata = map[string]string{}
+	}
 	msg.Metadata["partner-ids"] = strings.Join(event.Device.PartnerIDs(), ",")
 	msg.Metadata["session-id"] = event.Device.SessionID()
 

device/manager_test.go

@@ -447,3 +447,53 @@ func TestUpdateMetadata(t *testing.T) {
 	require.NoError(err)
 	assert.Equal(expectedMetaData, newMessage.Metadata)
 }
+
+func TestUpdateMetadataWithNil(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+	msg := wrp.Message{
+		Type:            wrp.SimpleEventMessageType,
+		Source:          "external.com",
+		Destination:     "mac:FFEEAADD44443333",
+		TransactionUUID: "DEADBEEF",
+		Headers:         []string{"Header1", "Header2"},
+		Spans:           [][]string{{"1", "2"}, {"3"}},
+		Payload:         []byte{1, 2, 3, 4, 0xff, 0xce},
+		PartnerIDs:      []string{"foo"},
+	}
+	originalContents := []byte{}
+	err := wrp.NewEncoderBytes(&originalContents, wrp.Msgpack).Encode(&msg)
+	require.NoError(err)
+	device := newDevice(deviceOptions{
+		ID:          "mac:FFEEAADD44443333",
+		C:           nil,
+		Compliance:  0,
+		PartnerIDs:  nil,
+		SatClientID: "",
+		Trust:       "",
+		QueueSize:   0,
+		ConnectedAt: time.Time{},
+		Logger:      nil,
+	})
+	originalEvent := Event{
+		Type:     MessageReceived,
+		Device:   device,
+		Message:  &msg,
+		Format:   wrp.Msgpack,
+		Contents: originalContents,
+	}
+
+	event := updateEventMetadata(originalEvent)
+
+	assert.Equal(originalEvent.Device, event.Device)
+	assert.Equal(originalEvent.Message, event.Message)
+	assert.NotEqual(originalEvent.Contents, event.Contents)
+	assert.Equal(originalEvent.Format, event.Format)
+
+	expectedMetaData := map[string]string{"session-id": device.SessionID(), "partner-ids": strings.Join(device.PartnerIDs(), ",")}
+
+	newMessage := new(wrp.Message)
+	err = wrp.NewDecoderBytes(event.Contents, event.Format).Decode(newMessage)
+	require.NoError(err)
+	assert.Equal(expectedMetaData, newMessage.Metadata)
+}