Correctly handle discovery cleanup

arduino · cmaglie · Aug 10, 2022 · Jul 13, 2022 · Jul 13, 2022 · Jul 13, 2022
commit 599fd0c17edb005812f8474a210dad1fc2e1aa78
diff --git a/arduino/discovery/discovery.go b/arduino/discovery/discovery.go
@@ -277,10 +277,7 @@ func (disc *PluggableDiscovery) killProcess() error {
 	}
 	disc.statusMutex.Lock()
 	defer disc.statusMutex.Unlock()
-	if disc.eventChan != nil {
-		close(disc.eventChan)
-		disc.eventChan = nil
-	}
+	disc.stopSync()
 	disc.state = Dead
 	logrus.Infof("killed discovery %s process", disc.id)
 	return nil
@@ -367,13 +364,18 @@ func (disc *PluggableDiscovery) Stop() error {
 	}
 	disc.statusMutex.Lock()
 	defer disc.statusMutex.Unlock()
-	disc.cachedPorts = map[string]*Port{}
+	disc.stopSync()
+	disc.state = Idling
+	return nil
+}
+
+func (disc *PluggableDiscovery) stopSync() {
 	if disc.eventChan != nil {
+		disc.eventChan <- &Event{"stop", nil, disc.GetID()}
 		close(disc.eventChan)
 		disc.eventChan = nil
+		disc.cachedPorts = map[string]*Port{}
 	}
-	disc.state = Idling
-	return nil
 }
 
 // Quit terminates the discovery. No more commands can be accepted by the discovery.
@@ -427,12 +429,8 @@ func (disc *PluggableDiscovery) StartSync(size int) (<-chan *Event, error) {
 	disc.statusMutex.Lock()
 	defer disc.statusMutex.Unlock()
 	disc.state = Syncing
-	disc.cachedPorts = map[string]*Port{}
-	if disc.eventChan != nil {
-		// In case there is already an existing event channel in use we close it
-		// before creating a new one.
-		close(disc.eventChan)
-	}
+	// In case there is already an existing event channel in use we close it before creating a new one.
+	disc.stopSync()
 	c := make(chan *Event, size)
 	disc.eventChan = c
 	return c, nil

diff --git a/arduino/discovery/discoverymanager/discoverymanager.go b/arduino/discovery/discoverymanager/discoverymanager.go
@@ -52,12 +52,15 @@ func New() *DiscoveryManager {
 // Clear resets the DiscoveryManager to its initial state
 func (dm *DiscoveryManager) Clear() {
 	dm.discoveriesMutex.Lock()
-	for _, d := range dm.discoveries {
-		d.Quit()
-		logrus.Infof("Closed and removed discovery %s", d.GetID())
+	defer dm.discoveriesMutex.Unlock()
+
+	if dm.discoveriesRunning {
+		for _, d := range dm.discoveries {
+			d.Quit()
+			logrus.Infof("Closed and removed discovery %s", d.GetID())
+		}
 	}
 	dm.discoveries = map[string]*discovery.PluggableDiscovery{}
-	dm.discoveriesMutex.Unlock()
 }
 
 // IDs returns the list of discoveries' ids in this DiscoveryManager
@@ -209,6 +212,9 @@ func (dm *DiscoveryManager) cacheEvent(ev *discovery.Event) {
 		cache[eventID] = ev
 	case "remove":
 		delete(cache, eventID)
+	case "quit":
+		// Remove all the events for this discovery
+		delete(dm.watchersCache, ev.DiscoveryID)
 	default:
 		logrus.Errorf("Unhandled event from discovery: %s", ev.Type)
 		return