fix(backend, logger): create boards with the same Allowed Vars

Author: JavierRibaldelRio

backend/pkg/logger/data/logger.go

@@ -16,6 +16,8 @@ import (
 	"github.com/HyperloopUPV-H8/h9-backend/pkg/transport/packet/data"
 )
 
+type loggerAccess string
+
 const (
 	Name abstraction.LoggerName = "data"
 )
@@ -26,7 +28,7 @@ type Logger struct {
 
 	fileLock *sync.RWMutex
 	// saveFiles is a map that contains the file of each value
-	saveFiles map[data.ValueName]*file.CSV
+	saveFiles map[loggerAccess]*file.CSV
 	// allowedVars contains the full names (board/valueName) to be logged
 	allowedVars map[string]struct{}
 }
@@ -40,7 +42,7 @@ func NewLogger() *Logger {
 	logger := &Logger{
 
 		BaseLogger:  loggerbase.NewBaseLogger(Name),
-		saveFiles:   make(map[data.ValueName]*file.CSV),
+		saveFiles:   make(map[loggerAccess]*file.CSV),
 		fileLock:    &sync.RWMutex{},
 		allowedVars: nil, // no filter by default
 	}
@@ -130,16 +132,19 @@ func (sublogger *Logger) getFile(valueName data.ValueName, board string) (*file.
 	sublogger.fileLock.Lock()
 	defer sublogger.fileLock.Unlock()
 
+	// Takes into account that several boards might have the same valueName,
+	valueNameBoard := internalLoggerName(valueName, board)
+
 	// Check if the file already exists
-	valueFile, ok := sublogger.saveFiles[valueName]
+	valueFile, ok := sublogger.saveFiles[valueNameBoard]
 	if ok {
 		return valueFile, nil
 	}
 
 	valueFileRaw, err := sublogger.createFile(valueName, board)
-	sublogger.saveFiles[valueName] = file.NewCSV(valueFileRaw)
+	sublogger.saveFiles[valueNameBoard] = file.NewCSV(valueFileRaw)
 
-	return sublogger.saveFiles[valueName], err
+	return sublogger.saveFiles[valueNameBoard], err
 }
 
 // override createFile from BaseLogger to add specific path
@@ -173,8 +178,14 @@ func (sublogger *Logger) Stop() error {
 			}
 		}
 
-		sublogger.saveFiles = make(map[data.ValueName]*file.CSV, len(sublogger.saveFiles))
+		sublogger.saveFiles = make(map[loggerAccess]*file.CSV, len(sublogger.saveFiles))
 
 		return closeErr
 	})
 }
+
+// This function avoids conflict between two boards that have the same variable to represent
+// should be called only when using  saveFiles
+func internalLoggerName(valueName data.ValueName, board string) loggerAccess {
+	return loggerAccess(string(valueName) + "-" + string(board))
+}

backend/pkg/logger/data/logger_test.go

@@ -414,72 +414,84 @@ func TestPushRecord(t *testing.T) {
 			}
 		})
 
-		//! TEST DOES NOT WORK IF WE MONITOR THE SAME VARIABLE ACROSS MULTIPLE BOARDS
-		t.Run("With allowed variables (multiple boards)", func(t *testing.T) {
-			logger := createLoggerForTest(t)
-			logger.Start()
+		t.Run("With allowed variables (multiple boards, different values Name)", func(t *testing.T) {
+			multipleBoardsValueNames(t, []string{"def", "def2"})
+		})
 
-			//variables
+		// The same as before but the loggers have the same value Name
+		t.Run("With allowed variables (multiple boards, same value Name)", func(t *testing.T) {
 
-			values := []string{"def", "def2"}
+			multipleBoardsValueNames(t, []string{"def", "def"})
 
-			// values to log per board
-			vals := map[string]float64{
-				"Pikachu":   11.11,
-				"Bulbasaur": 22.22,
-			}
+		})
 
-			// push one record per board using "def" and unique packet IDs
-			var id abstraction.PacketId = 1
-			for b, v := range vals {
-				pkt := data.NewPacket(id).
-					SetValue(data.ValueName(values[id-1]), data.NewNumericValue(v), true)
-				id++
-
-				rec := Record{
-					Packet:    pkt,
-					From:      b,
-					To:        "Logger",
-					Timestamp: time.Now(),
-				}
+	})
 
-				if err := logger.PushRecord(&rec); err != nil {
-					t.Fatalf("PushRecord failed for board %s: %v", b, err)
-				}
-			}
+}
 
-			// esperar a que terminen las escrituras asíncronas
-			time.Sleep(2 * time.Second)
+// Test Multiple boards with the valueNames got from input
 
-			i := 0
+func multipleBoardsValueNames(t *testing.T, values []string) {
 
-			// comprobar ficheros y valores
-			for b, v := range vals {
-				filePath := filepath.Join("logger", loggerHandler.Timestamp.Format(loggerHandler.TimestampFormat), "data", strings.ToUpper(b), values[i]+".csv")
-				i++
-				if _, err := os.Stat(filePath); err != nil {
-					t.Fatalf("expected file %s to exist, but got error: %v", filePath, err)
-				}
+	logger := createLoggerForTest(t)
+	logger.Start()
 
-				bts, err := os.ReadFile(filePath)
-				if err != nil {
-					t.Fatalf("could not read file %s: %v", filePath, err)
-				}
-				lines := strings.Split(strings.TrimSpace(string(bts)), "\n")
-				last := strings.TrimSpace(lines[len(lines)-1])
-				fields := strings.Split(last, ",")
-				if len(fields) < 1 {
-					t.Fatalf("unexpected CSV content in %s: %q", filePath, last)
-				}
-				got := fields[len(fields)-1]
-				want := strconv.FormatFloat(v, 'f', -1, 64)
-				if got != want {
-					t.Fatalf("unexpected value in %s: got %q, want %q", filePath, got, want)
-				}
-			}
-		})
-	})
+	//variables
+
+	// values to log per board
+	vals := map[string]float64{
+		"Pikachu":   11.11,
+		"Bulbasaur": 22.22,
+	}
+
+	// push one record per board using "def" and unique packet IDs
+	var id abstraction.PacketId = 1
+	for b, v := range vals {
+		pkt := data.NewPacket(id).
+			SetValue(data.ValueName(values[id-1]), data.NewNumericValue(v), true)
+		id++
 
+		rec := Record{
+			Packet:    pkt,
+			From:      b,
+			To:        "Logger",
+			Timestamp: time.Now(),
+		}
+
+		if err := logger.PushRecord(&rec); err != nil {
+			t.Fatalf("PushRecord failed for board %s: %v", b, err)
+		}
+	}
+
+	// esperar a que terminen las escrituras asíncronas
+	time.Sleep(2 * time.Second)
+
+	i := 0
+
+	// comprobar ficheros y valores
+	for b, v := range vals {
+		filePath := filepath.Join("logger", loggerHandler.Timestamp.Format(loggerHandler.TimestampFormat), "data", strings.ToUpper(b), values[i]+".csv")
+		i++
+		if _, err := os.Stat(filePath); err != nil {
+			t.Fatalf("expected file %s to exist, but got error: %v", filePath, err)
+		}
+
+		bts, err := os.ReadFile(filePath)
+		if err != nil {
+			t.Fatalf("could not read file %s: %v", filePath, err)
+		}
+		lines := strings.Split(strings.TrimSpace(string(bts)), "\n")
+		last := strings.TrimSpace(lines[len(lines)-1])
+		fields := strings.Split(last, ",")
+		if len(fields) < 1 {
+			t.Fatalf("unexpected CSV content in %s: %q", filePath, last)
+		}
+		got := fields[len(fields)-1]
+		want := strconv.FormatFloat(v, 'f', -1, 64)
+		if got != want {
+			t.Fatalf("unexpected value in %s: got %q, want %q", filePath, got, want)
+		}
+	}
 }
 
 /*************