Fix available uc scenarios on device removal

When a device was disconnected, the cache of available scenarios wasn’t properly updated and the entities of the disconnected device still remained being available. This update fixes the issue. In addition some method names where updated to better reflect their functionality
enbility · Dec 6, 2024 · 6df8552 · 6df8552
1 parent 82f4b31
commit 6df8552
Show file tree

Hide file tree

Showing 18 changed files with 101 additions and 38 deletions.
diff --git a/usecases/cem/cevc/events.go b/usecases/cem/cevc/events.go
@@ -17,7 +17,7 @@ func (e *CEVC) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.evConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/cem/evcc/events.go b/usecases/cem/evcc/events.go
@@ -17,10 +17,10 @@ func (e *EVCC) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.evConnected(payload)
 		return
-	} else if internal.IsEntityDisconnected(payload) {
+	} else if internal.IsEntityRemoved(payload) {
 		e.evDisconnected(payload)
 		return
 	}

diff --git a/usecases/cem/evcem/events.go b/usecases/cem/evcem/events.go
@@ -17,7 +17,7 @@ func (e *EVCEM) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.evConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/cem/evsecc/events.go b/usecases/cem/evsecc/events.go
@@ -15,10 +15,10 @@ func (e *EVSECC) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.evseConnected(payload)
 		return
-	} else if internal.IsEntityDisconnected(payload) {
+	} else if internal.IsEntityRemoved(payload) {
 		e.evseDisconnected(payload)
 		return
 	}

diff --git a/usecases/cem/evsoc/events.go b/usecases/cem/evsoc/events.go
@@ -16,7 +16,7 @@ func (e *EVSOC) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.evConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/cem/opev/events.go b/usecases/cem/opev/events.go
@@ -17,7 +17,7 @@ func (e *OPEV) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.evConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/cem/vabd/events.go b/usecases/cem/vabd/events.go
@@ -17,7 +17,7 @@ func (e *VABD) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.inverterConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/cem/vapd/events.go b/usecases/cem/vapd/events.go
@@ -17,7 +17,7 @@ func (e *VAPD) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.inverterConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/eg/lpc/events.go b/usecases/eg/lpc/events.go
@@ -14,7 +14,7 @@ func (e *LPC) HandleEvent(payload spineapi.EventPayload) {
 	if !e.IsCompatibleEntityType(payload.Entity) {
 		return
 	}
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.connected(payload.Entity)
 		return
 	}

diff --git a/usecases/eg/lpp/events.go b/usecases/eg/lpp/events.go
@@ -15,7 +15,7 @@ func (e *LPP) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.connected(payload.Entity)
 		return
 	}

diff --git a/usecases/internal/helper.go b/usecases/internal/helper.go
@@ -11,12 +11,12 @@ func IsDeviceConnected(payload spineapi.EventPayload) bool {
 }
 
 func IsDeviceDisconnected(payload spineapi.EventPayload) bool {
-	return payload.Device != nil &&
+	return len(payload.Ski) > 0 &&
 		payload.EventType == spineapi.EventTypeDeviceChange &&
 		payload.ChangeType == spineapi.ElementChangeRemove
 }
 
-func IsEntityConnected(payload spineapi.EventPayload) bool {
+func IsEntityAdded(payload spineapi.EventPayload) bool {
 	if payload.Entity != nil &&
 		payload.EventType == spineapi.EventTypeEntityChange &&
 		payload.ChangeType == spineapi.ElementChangeAdd {
@@ -26,7 +26,7 @@ func IsEntityConnected(payload spineapi.EventPayload) bool {
 	return false
 }
 
-func IsEntityDisconnected(payload spineapi.EventPayload) bool {
+func IsEntityRemoved(payload spineapi.EventPayload) bool {
 	if payload.Entity != nil &&
 		payload.EventType == spineapi.EventTypeEntityChange &&
 		payload.ChangeType == spineapi.ElementChangeRemove {

diff --git a/usecases/internal/helper_test.go b/usecases/internal/helper_test.go
@@ -28,6 +28,7 @@ func (s *InternalSuite) Test_IsDeviceDisconnected() {
 
 	device := mocks.NewDeviceRemoteInterface(s.T())
 	payload = spineapi.EventPayload{
+		Ski:        "12345",
 		Device:     device,
 		EventType:  spineapi.EventTypeDeviceChange,
 		ChangeType: spineapi.ElementChangeRemove,
@@ -36,30 +37,30 @@ func (s *InternalSuite) Test_IsDeviceDisconnected() {
 	assert.Equal(s.T(), true, result)
 }
 
-func (s *InternalSuite) Test_IsEntityConnected() {
+func (s *InternalSuite) Test_IsEntityAdded() {
 	payload := spineapi.EventPayload{}
-	result := IsEntityConnected(payload)
+	result := IsEntityAdded(payload)
 	assert.Equal(s.T(), false, result)
 
 	payload = spineapi.EventPayload{
 		Entity:     s.evseEntity,
 		EventType:  spineapi.EventTypeEntityChange,
 		ChangeType: spineapi.ElementChangeAdd,
 	}
-	result = IsEntityConnected(payload)
+	result = IsEntityAdded(payload)
 	assert.Equal(s.T(), true, result)
 }
 
-func (s *InternalSuite) Test_IsEntityDisconnected() {
+func (s *InternalSuite) Test_IsEntityRemoved() {
 	payload := spineapi.EventPayload{}
-	result := IsEntityDisconnected(payload)
+	result := IsEntityRemoved(payload)
 	assert.Equal(s.T(), false, result)
 
 	payload = spineapi.EventPayload{
 		Entity:     s.evseEntity,
 		EventType:  spineapi.EventTypeEntityChange,
 		ChangeType: spineapi.ElementChangeRemove,
 	}
-	result = IsEntityDisconnected(payload)
+	result = IsEntityRemoved(payload)
 	assert.Equal(s.T(), true, result)
 }
diff --git a/usecases/ma/mgcp/events.go b/usecases/ma/mgcp/events.go
@@ -17,7 +17,7 @@ func (e *MGCP) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.gridConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/ma/mpc/events.go b/usecases/ma/mpc/events.go
@@ -17,7 +17,7 @@ func (e *MPC) HandleEvent(payload spineapi.EventPayload) {
 		return
 	}
 
-	if internal.IsEntityConnected(payload) {
+	if internal.IsEntityAdded(payload) {
 		e.deviceConnected(payload.Entity)
 		return
 	}

diff --git a/usecases/usecase/events.go b/usecases/usecase/events.go
@@ -24,7 +24,16 @@ func (u *UseCaseBase) HandleEvent(payload spineapi.EventPayload) {
 }
 
 func (u *UseCaseBase) deviceOrEntityRemoved(payload spineapi.EventPayload) bool {
-	if internal.IsDeviceDisconnected(payload) || internal.IsEntityDisconnected(payload) {
+	if payload.EventType == spineapi.EventTypeDeviceChange &&
+		payload.ChangeType == spineapi.ElementChangeRemove &&
+		payload.Entity == nil {
+		// device was disconnected, remove all usecases related to this device
+		u.removeDeviceFromAvailableEntityScenarios(payload.Ski)
+		return true
+	}
+
+	if internal.IsEntityRemoved(payload) {
+		// entity was disconnected, remove all usecases related to this entity
 		u.removeEntityFromAvailableEntityScenarios(payload.Entity)
 		return true
 	}

diff --git a/usecases/usecase/events_test.go b/usecases/usecase/events_test.go
@@ -11,12 +11,16 @@ func (s *UseCaseSuite) Test_HandleEvent() {
 	payload := spineapi.EventPayload{}
 	s.uc.HandleEvent(payload)
 
+	payload.Ski = "test"
 	payload.Device = s.remoteDevice
 	payload.EventType = spineapi.EventTypeDeviceChange
 	payload.ChangeType = spineapi.ElementChangeRemove
 	s.uc.HandleEvent(payload)
 
+	payload.EventType = spineapi.EventTypeEntityChange
 	payload.Entity = s.remoteDevice.Entities()[0]
+	s.uc.HandleEvent(payload)
+
 	payload.EventType = spineapi.EventTypeDataChange
 	payload.ChangeType = spineapi.ElementChangeUpdate
 	payload.Data = &model.NodeManagementUseCaseDataType{}

diff --git a/usecases/usecase/usecase.go b/usecases/usecase/usecase.go
@@ -127,7 +127,7 @@ func (u *UseCaseBase) RemoteEntitiesScenarios() []api.RemoteEntityScenarios {
 
 // return the currently available scenarios for the use case for a remote entity
 func (u *UseCaseBase) AvailableScenariosForEntity(entity spineapi.EntityRemoteInterface) []uint {
-	_, scenarios := u.indexAndScenariosOfEntity(entity)
+	_, scenarios := u.entitiyScenarioIndexOfEntity(entity)
 
 	return scenarios
 }
@@ -137,24 +137,42 @@ func (u *UseCaseBase) IsScenarioAvailableAtEntity(
 	entity spineapi.EntityRemoteInterface,
 	scenario uint,
 ) bool {
-	if _, scenarios := u.indexAndScenariosOfEntity(entity); scenarios != nil {
+	if _, scenarios := u.entitiyScenarioIndexOfEntity(entity); scenarios != nil {
 		return slices.Contains(scenarios, scenario)
 	}
 
 	return false
 }
 
+// return the indices of all entities of the device in the available entity scenarios
+func (u *UseCaseBase) entityScenarioIndicesOfSki(ski string) []int {
+	u.mux.Lock()
+	defer u.mux.Unlock()
+
+	indices := []int{}
+
+	for i, remoteEntityScenarios := range u.availableEntityScenarios {
+		if remoteEntityScenarios.Entity != nil &&
+			remoteEntityScenarios.Entity.Device() != nil &&
+			remoteEntityScenarios.Entity.Device().Ski() == ski {
+			indices = append(indices, i)
+		}
+	}
+
+	return indices
+}
+
 // return the index and the scenarios of the entity in the available entity scenarios
 // and return -1 and nil if not found
-func (u *UseCaseBase) indexAndScenariosOfEntity(entity spineapi.EntityRemoteInterface) (int, []uint) {
+func (u *UseCaseBase) entitiyScenarioIndexOfEntity(entity spineapi.EntityRemoteInterface) (int, []uint) {
 	u.mux.Lock()
 	defer u.mux.Unlock()
 
-	for i, remoteEntity := range u.availableEntityScenarios {
-		if entity != nil && entity.Address() != nil && remoteEntity.Entity.Address() != nil &&
-			reflect.DeepEqual(entity.Address().Device, remoteEntity.Entity.Address().Device) &&
-			reflect.DeepEqual(entity.Address().Entity, remoteEntity.Entity.Address().Entity) {
-			return i, remoteEntity.Scenarios
+	for i, remoteEntityScenarios := range u.availableEntityScenarios {
+		if entity != nil && entity.Address() != nil && remoteEntityScenarios.Entity.Address() != nil &&
+			reflect.DeepEqual(entity.Address().Device, remoteEntityScenarios.Entity.Address().Device) &&
+			reflect.DeepEqual(entity.Address().Entity, remoteEntityScenarios.Entity.Address().Entity) {
+			return i, remoteEntityScenarios.Scenarios
 		}
 	}
 
@@ -173,7 +191,7 @@ func (u *UseCaseBase) updateRemoteEntityScenarios(
 		scenarioValues = append(scenarioValues, uint(scenario))
 	}
 
-	i, _ := u.indexAndScenariosOfEntity(entity)
+	i, _ := u.entitiyScenarioIndexOfEntity(entity)
 	if i == -1 {
 		newItem := api.RemoteEntityScenarios{
 			Entity:    entity,
@@ -198,19 +216,40 @@ func (u *UseCaseBase) updateRemoteEntityScenarios(
 	}
 }
 
+// remove all remote entities of a device from the use case
+func (u *UseCaseBase) removeDeviceFromAvailableEntityScenarios(ski string) {
+	remoteDevice := u.LocalEntity.Device().RemoteDeviceForSki(ski)
+
+	indicies := u.entityScenarioIndicesOfSki(ski)
+
+	for i := range indicies {
+		u.removeEntityIndexFromAvailableEntityScenarios(i)
+	}
+
+	if u.EventCB != nil && len(indicies) > 0 {
+		u.EventCB(ski, remoteDevice, nil, u.useCaseUpdateEvent)
+	}
+}
+
 // remove a remote entity from the use case
 func (u *UseCaseBase) removeEntityFromAvailableEntityScenarios(entity spineapi.EntityRemoteInterface) {
-	if i, _ := u.indexAndScenariosOfEntity(entity); i >= 0 {
-		u.mux.Lock()
-		u.availableEntityScenarios = append(u.availableEntityScenarios[:i], u.availableEntityScenarios[i+1:]...)
-		u.mux.Unlock()
+	if i, _ := u.entitiyScenarioIndexOfEntity(entity); i >= 0 {
+		u.removeEntityIndexFromAvailableEntityScenarios(i)
 
 		if u.EventCB != nil {
-			u.EventCB(entity.Device().Ski(), entity.Device(), entity, u.useCaseUpdateEvent)
+			remoteDevice := entity.Device()
+			u.EventCB(remoteDevice.Ski(), remoteDevice, entity, u.useCaseUpdateEvent)
 		}
 	}
 }
 
+// do the actual removal of the entity from the available entity scenarios
+func (u *UseCaseBase) removeEntityIndexFromAvailableEntityScenarios(index int) {
+	u.mux.Lock()
+	u.availableEntityScenarios = append(u.availableEntityScenarios[:index], u.availableEntityScenarios[index+1:]...)
+	u.mux.Unlock()
+}
+
 // return the required server features for a use case scenario
 func (u *UseCaseBase) requiredServerFeaturesForScenario(scenario model.UseCaseScenarioSupportType) []model.FeatureTypeType {
 	for _, serverFeatures := range u.useCaseScenarios {

diff --git a/usecases/usecase/usecase_test.go b/usecases/usecase/usecase_test.go
@@ -76,6 +76,16 @@ func (s *UseCaseSuite) Test_AvailableScenarios() {
 
 	result = s.uc.RemoteEntitiesScenarios()
 	assert.Equal(s.T(), 0, len(result))
+
+	s.uc.updateRemoteEntityScenarios(s.monitoredEntity, []model.UseCaseScenarioSupportType{1, 2, 3})
+
+	result = s.uc.RemoteEntitiesScenarios()
+	assert.Equal(s.T(), 1, len(result))
+
+	s.uc.removeDeviceFromAvailableEntityScenarios(s.monitoredEntity.Device().Ski())
+
+	result = s.uc.RemoteEntitiesScenarios()
+	assert.Equal(s.T(), 0, len(result))
 }
 
 func (s *UseCaseSuite) Test_RequiredServerFeatures() {
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,7 @@ func (e *CEVC) HandleEvent(payload spineapi.EventPayload) { @@
     		return
     	}
-    	if internal.IsEntityConnected(payload) {
+    	if internal.IsEntityAdded(payload) {
     		e.evConnected(payload.Entity)
     		return
     	}
@@ Expand Down @@