diff --git a/internal/logging/clear.go b/internal/logging/clear.go index e5d6f60e..4059d1e1 100644 --- a/internal/logging/clear.go +++ b/internal/logging/clear.go @@ -18,67 +18,52 @@ package logging import ( + "fmt" + "io/fs" "os" "path/filepath" - "sort" + "github.com/bradenaw/juniper/xslices" "github.com/sirupsen/logrus" + "golang.org/x/exp/slices" ) func clearLogs(logDir string, maxLogs int, maxCrashes int) error { files, err := os.ReadDir(logDir) if err != nil { - return err + return fmt.Errorf("failed to read log directory: %w", err) } - var logsWithPrefix []string - var crashesWithPrefix []string + names := xslices.Map(files, func(file fs.DirEntry) string { + return file.Name() + }) - for _, file := range files { - if MatchLogName(file.Name()) { - if MatchStackTraceName(file.Name()) { - crashesWithPrefix = append(crashesWithPrefix, file.Name()) - } else { - logsWithPrefix = append(logsWithPrefix, file.Name()) - } - } else { - // Older versions of Bridge stored logs in subfolders for each version. - // That also has to be cleared and the functionality can be removed after some time. - if file.IsDir() { - if err := clearLogs(filepath.Join(logDir, file.Name()), maxLogs, maxCrashes); err != nil { - return err - } - } else { - removeLog(logDir, file.Name()) - } - } - } + // Remove old logs. + removeOldLogs(logDir, xslices.Filter(names, func(name string) bool { + return MatchLogName(name) && !MatchStackTraceName(name) + }), maxLogs) - removeOldLogs(logDir, logsWithPrefix, maxLogs) - removeOldLogs(logDir, crashesWithPrefix, maxCrashes) + // Remove old stack traces. + removeOldLogs(logDir, xslices.Filter(names, func(name string) bool { + return MatchLogName(name) && MatchStackTraceName(name) + }), maxCrashes) return nil } -func removeOldLogs(logDir string, filenames []string, maxLogs int) { - count := len(filenames) - if count <= maxLogs { +func removeOldLogs(dir string, names []string, max int) { + if count := len(names); count <= max { return } - sort.Strings(filenames) // Sorted by timestamp: oldest first. - for _, filename := range filenames[:count-maxLogs] { - removeLog(logDir, filename) - } -} + // Sort by timestamp, oldest first. + slices.SortFunc(names, func(a, b string) bool { + return getLogTime(a) < getLogTime(b) + }) -func removeLog(logDir, filename string) { - // We need to be sure to delete only log files. - // Directory with logs can also contain other files. - if !MatchLogName(filename) { - return - } - if err := os.Remove(filepath.Join(logDir, filename)); err != nil { - logrus.WithError(err).Error("Failed to remove", filepath.Join(logDir, filename)) + for _, path := range xslices.Map(names[:len(names)-max], func(name string) string { return filepath.Join(dir, name) }) { + if err := os.Remove(path); err != nil { + logrus.WithError(err).WithField("path", path).Warn("Failed to remove old log file") + } } } diff --git a/internal/logging/logging.go b/internal/logging/logging.go index a523e2f9..c7203127 100644 --- a/internal/logging/logging.go +++ b/internal/logging/logging.go @@ -24,6 +24,7 @@ import ( "os" "path/filepath" "regexp" + "strconv" "time" "github.com/ProtonMail/proton-bridge/v3/internal/constants" @@ -141,6 +142,17 @@ func getLogName(version, revision string) string { return fmt.Sprintf("v%v_%v_%v.log", version, revision, time.Now().Unix()) } +func getLogTime(name string) int { + re := regexp.MustCompile(`^v.*_.*_(?P\d+).log$`) + + timestamp, err := strconv.Atoi(re.FindStringSubmatch(name)[re.SubexpIndex("timestamp")]) + if err != nil { + return 0 + } + + return timestamp +} + func MatchLogName(name string) bool { return regexp.MustCompile(`^v.*\.log$`).MatchString(name) } diff --git a/internal/logging/logging_test.go b/internal/logging/logging_test.go index 725a3389..09381178 100644 --- a/internal/logging/logging_test.go +++ b/internal/logging/logging_test.go @@ -29,24 +29,39 @@ import ( func TestClearLogs(t *testing.T) { dir := t.TempDir() + // Create some old log files. require.NoError(t, os.WriteFile(filepath.Join(dir, "other.log"), []byte("Hello"), 0o755)) - require.NoError(t, os.WriteFile(filepath.Join(dir, "v1_10.log"), []byte("Hello"), 0o755)) - require.NoError(t, os.WriteFile(filepath.Join(dir, "v1_11.log"), []byte("Hello"), 0o755)) - require.NoError(t, os.WriteFile(filepath.Join(dir, "v2_12.log"), []byte("Hello"), 0o755)) - require.NoError(t, os.WriteFile(filepath.Join(dir, "v2_13.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.4.7_debe87f2f5_0000000001.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.4.8_debe87f2f5_0000000002.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.4.9_debe87f2f5_0000000003.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.0_debe87f2f5_0000000004.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.1_debe87f2f5_0000000005.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.2_debe87f2f5_0000000006.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.3_debe87f2f5_0000000007.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.4_debe87f2f5_0000000008.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.5_debe87f2f5_0000000009.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.6_debe87f2f5_0000000010.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.7_debe87f2f5_0000000011.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.8_debe87f2f5_0000000012.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.12_debe87f2f5_0000000013.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.9_debe87f2f5_0000000014.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.10_debe87f2f5_0000000015.log"), []byte("Hello"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "v2.5.11_debe87f2f5_0000000016.log"), []byte("Hello"), 0o755)) + // Clear the logs. require.NoError(t, clearLogs(dir, 3, 0)) + + // We should only clear matching files, and keep the 3 most recent ones. checkFileNames(t, dir, []string{ "other.log", - "v1_11.log", - "v2_12.log", - "v2_13.log", + "v2.5.9_debe87f2f5_0000000014.log", + "v2.5.10_debe87f2f5_0000000015.log", + "v2.5.11_debe87f2f5_0000000016.log", }) } func checkFileNames(t *testing.T, dir string, expectedFileNames []string) { - fileNames := getFileNames(t, dir) - require.Equal(t, expectedFileNames, fileNames) + require.ElementsMatch(t, expectedFileNames, getFileNames(t, dir)) } func getFileNames(t *testing.T, dir string) []string {