Improve message cache handling (#32)

- Refactor read message caching
  - Move to Sender, to be remote device specific
- Use for all request messages (read, subscribe, unsubscribe, bind,
unbind)
- WriteApproval handling updates
  - Clean up approval msg cache on device disconnects
  - Make them remote device specific
- ReponseMsgCallbacks updates
- Support multiple callbacks for a single msgCounter (required due to
request caching)
- datagram addition fixes

.github/workflows/default.yml

@@ -49,7 +49,7 @@ jobs:
           file: coverage.out
 
       - name: Run Gosec Security Scanner
-        uses: securego/gosec@master
+        uses: securego/gosec@v2.20.0
         with:
           # we let the report trigger content trigger a failure using the GitHub Security features.
           args: '-no-fail -fmt sarif -out results.sarif ./...'

api/feature.go

@@ -64,6 +64,9 @@ type FeatureLocalInterface interface {
 	// Overwrite the default 1 minute timeout for write approvals
 	SetWriteApprovalTimeout(duration time.Duration)
 
+	// Clean all device specific caches
+	CleanCaches(ski string)
+
 	// return all functions
 	Functions() []model.FunctionType
 

api/sender.go

@@ -10,6 +10,8 @@ type ComControlInterface interface {
 }
 
 type SenderInterface interface {
+	// Process a received message, e.g. for handling caching data
+	ProcessResponseForMsgCounterReference(msgCounterRef *model.MsgCounterType)
 	// Sends a read cmd to request some data
 	Request(cmdClassifier model.CmdClassifierType, senderAddress, destinationAddress *model.FeatureAddressType, ackRequest bool, cmd []model.CmdType) (*model.MsgCounterType, error)
 	// Sends a result cmd with no error to indicate that a message was processed successfully

model/datagram_additions.go

@@ -20,9 +20,18 @@ func (d *DatagramType) PrintMessageOverview(send bool, localFeature, remoteFeatu
 		device = fmt.Sprintf("%s:%s to %s", device, remoteFeature, localFeature)
 	}
 
-	cmdClassifier := *d.Header.CmdClassifier
-	msgCounter := *d.Header.MsgCounter
-	cmd := d.Payload.Cmd[0]
+	cmdClassifier := CmdClassifierType("Unknown")
+	if d.Header.CmdClassifier != nil {
+		cmdClassifier = *d.Header.CmdClassifier
+	}
+	msgCounter := MsgCounterType(0)
+	if d.Header.MsgCounter != nil {
+		msgCounter = *d.Header.MsgCounter
+	}
+	cmd := CmdType{}
+	if len(d.Payload.Cmd) > 0 {
+		cmd = d.Payload.Cmd[0]
+	}
 
 	switch cmdClassifier {
 	case CmdClassifierTypeRead:

model/datagram_additions_test.go

@@ -4,8 +4,18 @@ import (
 	"testing"
 
 	"github.com/enbility/spine-go/util"
+	"github.com/stretchr/testify/assert"
 )
 
+const emptyResult string = "Send:  Unknown 0 unknown"
+
+func TestTestPrintMessageOverview_Emtpty(t *testing.T) {
+	datagram := &DatagramType{}
+
+	result := datagram.PrintMessageOverview(true, "", "")
+	assert.Equal(t, emptyResult, result)
+}
+
 func TestPrintMessageOverview_Read_Send(t *testing.T) {
 	datagram := &DatagramType{
 		Header: HeaderType{
@@ -25,7 +35,8 @@ func TestPrintMessageOverview_Read_Send(t *testing.T) {
 		},
 	}
 
-	datagram.PrintMessageOverview(false, "", "")
+	result := datagram.PrintMessageOverview(false, "", "")
+	assert.NotEqual(t, emptyResult, result)
 }
 
 func TestPrintMessageOverview_Read_Recv(t *testing.T) {
@@ -45,7 +56,8 @@ func TestPrintMessageOverview_Read_Recv(t *testing.T) {
 		},
 	}
 
-	datagram.PrintMessageOverview(true, "", "")
+	result := datagram.PrintMessageOverview(true, "", "")
+	assert.NotEqual(t, emptyResult, result)
 }
 
 func TestPrintMessageOverview_Reply_Recv(t *testing.T) {
@@ -66,7 +78,8 @@ func TestPrintMessageOverview_Reply_Recv(t *testing.T) {
 		},
 	}
 
-	datagram.PrintMessageOverview(true, "", "")
+	result := datagram.PrintMessageOverview(true, "", "")
+	assert.NotEqual(t, emptyResult, result)
 }
 
 func TestPrintMessageOverview_Result_Recv(t *testing.T) {
@@ -91,7 +104,8 @@ func TestPrintMessageOverview_Result_Recv(t *testing.T) {
 		},
 	}
 
-	datagram.PrintMessageOverview(true, "", "")
+	result := datagram.PrintMessageOverview(true, "", "")
+	assert.NotEqual(t, emptyResult, result)
 }
 
 func TestPrintMessageOverview_Write_Recv(t *testing.T) {
@@ -112,5 +126,6 @@ func TestPrintMessageOverview_Write_Recv(t *testing.T) {
 		},
 	}
 
-	datagram.PrintMessageOverview(true, "", "")
+	result := datagram.PrintMessageOverview(true, "", "")
+	assert.NotEqual(t, emptyResult, result)
 }

spine/device_local.go

@@ -176,6 +176,13 @@ func (r *DeviceLocal) RemoveRemoteDevice(ski string) {
 	if len(r.remoteDevices) == 0 {
 		_ = Events.unsubscribe(api.EventHandlerLevelCore, r)
 	}
+
+	// remove all data caches for this device
+	for _, entity := range r.entities {
+		for _, feature := range entity.Features() {
+			feature.CleanCaches(ski)
+		}
+	}
 }
 
 func (r *DeviceLocal) RemoteDevices() []api.DeviceRemoteInterface {

spine/device_remote.go

@@ -155,6 +155,11 @@ func (d *DeviceRemote) HandleSpineMesssage(message []byte) (*model.MsgCounterTyp
 	if err := json.Unmarshal([]byte(message), &datagram); err != nil {
 		return nil, err
 	}
+
+	if datagram.Datagram.Header.MsgCounterReference != nil {
+		d.sender.ProcessResponseForMsgCounterReference(datagram.Datagram.Header.MsgCounterReference)
+	}
+
 	err := d.localDevice.ProcessCmd(datagram.Datagram, d)
 	if err != nil {
 		logging.Log().Trace(err)