fix(logging): delete logs when user identifier changes (#3110)

* fix(logging): flush logs when user identifier changes

* fix(logging): add unit test

* fix(logging): delete logs when identifier changes

* fix(logging): update per review comment

Author: phantumcode

Diff for: AmplifyPlugins/Logging/Sources/AWSCloudWatchLoggingPlugin/AWSCloudWatchLoggingSessionController.swift

@@ -140,6 +140,7 @@ final class AWSCloudWatchLoggingSessionController {
     }
 
     private func userIdentifierDidChange() {
+        resetCurrentLogs()
         updateSession()
         updateConsumer()
         connectProducerAndConsumer()
@@ -165,6 +166,16 @@ final class AWSCloudWatchLoggingSessionController {
     func flushLogs() async throws {
         try await session?.logger.flushLogs()
     }
+    
+    private func resetCurrentLogs() {
+        Task {
+            do {
+                try await session?.logger.resetLogs()
+            } catch {
+                Amplify.Logging.error("Error resetting logs with \(error)")
+            }
+        }
+    }
 }
 
 extension AWSCloudWatchLoggingSessionController: Logger {

Diff for: AmplifyPlugins/Logging/Sources/AWSCloudWatchLoggingPlugin/Persistence/LogActor.swift

@@ -56,4 +56,9 @@ actor LogActor {
             rotationSubject.send(log)
         }
     }
+    
+    func deleteLogs() throws {
+        try rotation.reset()
+        try synchronize()
+    }
 }

Diff for: AmplifyPlugins/Logging/Sources/AWSCloudWatchLoggingPlugin/Producer/RotatingLogger.swift

@@ -48,6 +48,10 @@ final class RotatingLogger {
         try await actor.flushLogs()
     }
 
+    func resetLogs() async throws {
+        try await actor.deleteLogs()
+    }
+    
     func record(level: LogLevel, message: @autoclosure () -> String) async throws {
         try await setupSubscription()
         let entry = LogEntry(category: self.category, namespace: self.namespace, level: level, message: message())

Diff for: AmplifyPlugins/Logging/Tests/AWSCloudWatchLoggingPluginTests/AWSCloudWatchLoggingSessionControllerTests.swift

@@ -20,9 +20,13 @@ final class AWSCloudWatchLoggingSessionControllerTests: XCTestCase {
     let mockCloudWatchLogClient = MockCloudWatchLogsClient()
     let mockLoggingNetworkMonitor = MockLoggingNetworkMonitor()
     let category = "amplifytest"
+    var unsubscribeToken: UnsubscribeToken?
 
     override func tearDown() async throws {
         systemUnderTest = nil
+        if let token = unsubscribeToken {
+            Amplify.Hub.removeListener(token)
+        }
         let file = getLogFile()
         do {
             try FileManager.default.removeItem(atPath: file.path)
@@ -36,7 +40,7 @@ final class AWSCloudWatchLoggingSessionControllerTests: XCTestCase {
     /// Then: a flushLogFailure Hub Event is sent to the Logging channel
     func testConsumeFailureSendsHubEvent() async throws {
         let hubEventExpectation = expectation(description: "Should receive the hub event")
-        _ = Amplify.Hub.listen(to: .logging) { payload in
+        unsubscribeToken = Amplify.Hub.listen(to: .logging) { payload in
             switch payload.eventName {
             case HubPayload.EventName.Logging.flushLogFailure:
                 hubEventExpectation.fulfill()

Diff for: AmplifyPlugins/Logging/Tests/AWSCloudWatchLoggingPluginTests/LogActorTests.swift

@@ -90,4 +90,23 @@ final class LogActorTests: XCTestCase {
         }
         XCTAssertEqual(decoded.sorted(), entries.sorted())
     }
+    
+    /// Given: a Log file
+    /// When: LogActor deletes the log
+    /// Then: the log file is emptied
+    func testLogActorDeletesEntry() async throws {
+        let entry = LogEntry(category: "LogActorTests", namespace: nil, level: .error, message: UUID().uuidString, created: .init(timeIntervalSince1970: 0))
+        try await systemUnderTest.record(entry)
+        try await systemUnderTest.synchronize()
+        
+        let files = try FileManager.default.contentsOfDirectory(at: directory, includingPropertiesForKeys: nil)
+        let fileURL = try XCTUnwrap(files.first)
+        var contents = try XCTUnwrap(FileManager.default.contents(atPath: fileURL.path))
+        XCTAssertNotNil(contents)
+        
+        try await systemUnderTest.deleteLogs()
+        contents = try XCTUnwrap(FileManager.default.contents(atPath: fileURL.path))
+        XCTAssertTrue(contents.isEmpty)
+    }
+    
 }

Diff for: AmplifyPlugins/Logging/Tests/AWSCloudWatchLoggingPluginTests/LogRotationTests.swift

@@ -163,4 +163,30 @@ final class LogRotationTests: XCTestCase {
             }
         }
     }
+    
+    /// Given: a log rotation
+    /// When: reset is executed
+    /// Then: log rotation is reset to 0
+    func testLogRotationResets() throws {
+        let originalContents = try FileManager.default.contentsOfDirectory(at: directory, includingPropertiesForKeys: nil)
+        XCTAssertEqual(originalContents.map { $0.lastPathComponent }, [
+            "amplify.0.log"
+        ])
+
+        systemUnderTest = try LogRotation(directory: directory,
+                                          fileSizeLimitInBytes: fileSizeLimitInBytes)
+        XCTAssertEqual(systemUnderTest.currentLogFile.fileURL.lastPathComponent, "amplify.1.log")
+        try systemUnderTest.rotate()
+        
+        var rotatedContents = try FileManager.default.contentsOfDirectory(at: directory, includingPropertiesForKeys: nil)
+        XCTAssertEqual(rotatedContents.map { $0.lastPathComponent }, [
+            "amplify.2.log",
+            "amplify.1.log",
+            "amplify.0.log",
+        ])
+    
+        
+        try systemUnderTest.reset()
+        XCTAssertEqual(systemUnderTest.currentLogFile.fileURL.lastPathComponent, "amplify.0.log")
+    }
 }