refactor: streamline event tracking and logging in action executions

- Updated the event tracking logic in LogAction, DatabaseAction, BirdWeatherAction, and MqttAction to return early if the event should not be tracked, improving code clarity and reducing unnecessary processing. - Refactored logging for file and database operations to ensure errors are properly logged and handled. - Enhanced the BirdWeatherAction to include a confidence threshold check before uploading data, ensuring only relevant data is processed. - Overall, these changes improve the maintainability and efficiency of the action execution flow.
tphakala · Jan 15, 2025 · 925afed · 925afed
1 parent ec4bc1e
commit 925afed
Showing 1 changed file with 67 additions and 59 deletions.
diff --git a/internal/analysis/processor/actions.go b/internal/analysis/processor/actions.go
@@ -73,62 +73,62 @@ func (a LogAction) Execute(data interface{}) error {
 	species := strings.ToLower(a.Note.CommonName)
 
 	// Check if the event should be handled for this species
-	if a.EventTracker.TrackEvent(species, LogToFile) {
-		if err := observation.LogNoteToFile(a.Settings, a.Note); err != nil {
-			// If an error occurs when logging to a file, wrap and return the error.
-			log.Printf("Failed to log note to file: %v", err)
-		}
-		fmt.Printf("%s %s %.2f\n", a.Note.Time, a.Note.CommonName, a.Note.Confidence)
+	if !a.EventTracker.TrackEvent(species, LogToFile) {
 		return nil
 	}
 
-	//log.Printf("Log action throttled for species: %s", species)
+	// Log note to file
+	if err := observation.LogNoteToFile(a.Settings, a.Note); err != nil {
+		// If an error occurs when logging to a file, wrap and return the error.
+		log.Printf("Failed to log note to file: %v", err)
+	}
+	fmt.Printf("%s %s %.2f\n", a.Note.Time, a.Note.CommonName, a.Note.Confidence)
+
 	return nil
 }
 
 // Execute saves the note to the database
 func (a DatabaseAction) Execute(data interface{}) error {
 	species := strings.ToLower(a.Note.CommonName)
 
-	// Check if the event should be handled for this species
-	if a.EventTracker.TrackEvent(species, DatabaseSave) {
-		// Save note to database
-		if err := a.Ds.Save(&a.Note, a.Results); err != nil {
-			log.Printf("Failed to save note and results to database: %v", err)
+	// Check event frequency
+	if !a.EventTracker.TrackEvent(species, DatabaseSave) {
+		return nil
+	}
+
+	// Save note to database
+	if err := a.Ds.Save(&a.Note, a.Results); err != nil {
+		log.Printf("Failed to save note and results to database: %v", err)
+		return err
+	}
+
+	// Save audio clip to file if enabled
+	if a.Settings.Realtime.Audio.Export.Enabled {
+		// export audio clip from capture buffer
+		pcmData, err := myaudio.ReadSegmentFromCaptureBuffer(a.Note.Source, a.Note.BeginTime, 15)
+		if err != nil {
+			log.Printf("Failed to read audio segment from buffer: %v", err)
 			return err
 		}
 
-		// Save audio clip to file if enabled
-		if a.Settings.Realtime.Audio.Export.Enabled {
-			// export audio clip from capture buffer
-			pcmData, err := myaudio.ReadSegmentFromCaptureBuffer(a.Note.Source, a.Note.BeginTime, 15)
-			if err != nil {
-				log.Printf("Failed to read audio segment from buffer: %v", err)
-				return err
-			}
-
-			// Create a SaveAudioAction and execute it
-			saveAudioAction := SaveAudioAction{
-				Settings: a.Settings,
-				ClipName: a.Note.ClipName,
-				pcmData:  pcmData,
-			}
-
-			if err := saveAudioAction.Execute(nil); err != nil {
-				log.Printf("Failed to save audio clip: %v", err)
-				return err
-			}
-
-			if a.Settings.Debug {
-				log.Printf("Saved audio clip to %s\n", a.Note.ClipName)
-				log.Printf("detection time %v, begin time %v, end time %v\n", a.Note.Time, a.Note.BeginTime, time.Now())
-			}
+		// Create a SaveAudioAction and execute it
+		saveAudioAction := SaveAudioAction{
+			Settings: a.Settings,
+			ClipName: a.Note.ClipName,
+			pcmData:  pcmData,
 		}
 
-		return nil
+		if err := saveAudioAction.Execute(nil); err != nil {
+			log.Printf("Failed to save audio clip: %v", err)
+			return err
+		}
+
+		if a.Settings.Debug {
+			log.Printf("Saved audio clip to %s\n", a.Note.ClipName)
+			log.Printf("detection time %v, begin time %v, end time %v\n", a.Note.Time, a.Note.BeginTime, time.Now())
+		}
 	}
 
-	//log.Printf("Database save action throttled for species: %s", species)
 	return nil
 }
 
@@ -170,30 +170,31 @@ func (a SaveAudioAction) Execute(data interface{}) error {
 func (a BirdWeatherAction) Execute(data interface{}) error {
 	species := strings.ToLower(a.Note.CommonName)
 
-	if a.EventTracker.TrackEvent(species, BirdWeatherSubmit) {
-		// Add threshold check here
-		if a.Note.Confidence < float64(a.Settings.Realtime.Birdweather.Threshold) {
-			if a.Settings.Debug {
-				log.Printf("Skipping BirdWeather upload for %s: confidence %.2f below threshold %.2f\n",
-					species, a.Note.Confidence, a.Settings.Realtime.Birdweather.Threshold)
-			}
-			return nil
-		}
-
-		if a.BwClient == nil {
-			return fmt.Errorf("BirdWeather client is not initialized")
-		}
+	// Check event frequency
+	if !a.EventTracker.TrackEvent(species, BirdWeatherSubmit) {
+		return nil
+	}
 
-		if err := a.BwClient.Publish(a.Note, a.pcmData); err != nil {
-			log.Printf("error uploading to BirdWeather: %s\n", err)
-			return err
-		} else if a.Settings.Debug {
-			log.Printf("Uploaded %s to Birdweather\n", a.Note.ClipName)
+	// Add threshold check here
+	if a.Note.Confidence < float64(a.Settings.Realtime.Birdweather.Threshold) {
+		if a.Settings.Debug {
+			log.Printf("Skipping BirdWeather upload for %s: confidence %.2f below threshold %.2f\n",
+				species, a.Note.Confidence, a.Settings.Realtime.Birdweather.Threshold)
 		}
 		return nil
 	}
-	//log.Printf("BirdWeather Submit action throttled for species: %s", species)
-	return nil // return an error if the action fails
+
+	if a.BwClient == nil {
+		return fmt.Errorf("BirdWeather client is not initialized")
+	}
+
+	if err := a.BwClient.Publish(a.Note, a.pcmData); err != nil {
+		log.Printf("error uploading to BirdWeather: %s\n", err)
+		return err
+	} else if a.Settings.Debug {
+		log.Printf("Uploaded %s to Birdweather\n", a.Note.ClipName)
+	}
+	return nil
 }
 
 type NoteWithBirdImage struct {
@@ -203,6 +204,13 @@ type NoteWithBirdImage struct {
 
 // Execute sends the note to the MQTT broker
 func (a MqttAction) Execute(data interface{}) error {
+	species := strings.ToLower(a.Note.CommonName)
+
+	// Check event frequency
+	if !a.EventTracker.TrackEvent(species, MQTTPublish) {
+		return nil
+	}
+
 	// First, check if the MQTT client is connected
 	if !a.MqttClient.IsConnected() {
 		log.Println("MQTT client is not connected, skipping publish")