Add creating symlink to the latest logs folder in LogsRotator

swiftyfinch · Mar 17, 2024 · 2e33669 · 2e33669
1 parent 723ba36
commit 2e33669
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/Sources/RugbyFoundation/Utils/Public/Logger/LogsRotator.swift b/Sources/RugbyFoundation/Utils/Public/Logger/LogsRotator.swift
@@ -4,9 +4,11 @@ import Foundation
 /// The service to keep only latest logs.
 public final class LogsRotator {
     private let logsPath: String
+    private let shellExecutor: IShellExecutor
 
     private let maxLogs = 10
     private var cachedLogsRecord: IFolder?
+    private let latestSymbolicLinkName = "+latest"
 
     private lazy var dateFormatter: DateFormatter = {
         let dateFormatter = DateFormatter()
@@ -18,8 +20,11 @@ public final class LogsRotator {
 
     /// Initializer.
     /// - Parameter logsPath: The path to the logs folder.
-    public init(logsPath: String) {
+    /// - Parameter shellExecutor: The service to execute shell commands from Rugby.
+    public init(logsPath: String,
+                shellExecutor: IShellExecutor) {
         self.logsPath = logsPath
+        self.shellExecutor = shellExecutor
     }
 
     /// Creates the new log file folder per a session and returns it.
@@ -37,6 +42,7 @@ public final class LogsRotator {
 
         let logsFolderName = dateFormatter.string(from: Date())
         let logsRecord = try logsFolder.createFolder(named: logsFolderName)
+        try createSymbolicLink(at: logsFolder.path, destinationPath: logsRecord.path)
         cachedLogsRecord = logsRecord
         return logsRecord
     }
@@ -58,4 +64,10 @@ public final class LogsRotator {
             return lhsDate.timeIntervalSinceReferenceDate < rhsDate.timeIntervalSinceReferenceDate
         }
     }
+
+    private func createSymbolicLink(at path: String, destinationPath: String) throws {
+        let latestLogFolderSymlink = "\(path)/\(latestSymbolicLinkName)"
+        shellExecutor.shell("rm -f \(latestLogFolderSymlink)")
+        try FileManager.default.createSymbolicLink(atPath: latestLogFolderSymlink, withDestinationPath: destinationPath)
+    }
 }
diff --git a/Sources/RugbyFoundation/Vault/Vault.swift b/Sources/RugbyFoundation/Vault/Vault.swift
@@ -87,7 +87,10 @@ public final class Vault {
     // MARK: - Logs
 
     /// The service to keep only latest logs.
-    public private(set) lazy var logsRotator = LogsRotator(logsPath: router.logsFolderPath)
+    public private(set) lazy var logsRotator = LogsRotator(
+        logsPath: router.logsFolderPath,
+        shellExecutor: shellExecutor
+    )
 
     /// The service to log commands metrics.
     public private(set) lazy var metricsLogger = MetricsLogger(folderPath: router.logsFolderPath)