Introduce storageGroup on Output (#9)

* Add storageGroup to Output

* Fix tests for storageGroup

* Encode filename to base16

* Add IDEWorkspaceChecks

* Add ignore rules for testing

* Add comment

* Modify comment

* Remove fileName prefix

Author: giginet

Puree.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

Sources/Puree/BufferedOutput.swift

@@ -76,7 +76,7 @@ open class BufferedOutput: Output {
     public func emit(log: LogEntry) {
         buffer.insert(log)
 
-        logStore.add(log, for: tagPattern.pattern, completion: nil)
+        logStore.add(log, for: storageGroup, completion: nil)
 
         if buffer.count >= logLimit {
             flush()
@@ -87,6 +87,11 @@ open class BufferedOutput: Output {
         completion(false)
     }
 
+    open var storageGroup: String {
+        let typeName = String(describing: type(of: self))
+        return "\(tagPattern.pattern)_\(typeName)"
+    }
+
     private func setUpTimer() {
         self.timer?.invalidate()
 
@@ -112,7 +117,7 @@ open class BufferedOutput: Output {
     private func reloadLogStore() {
         buffer.removeAll()
 
-        logStore.retrieveLogs(of: tagPattern.pattern) { logs in
+        logStore.retrieveLogs(of: storageGroup) { logs in
             buffer = buffer.union(logs)
         }
     }
@@ -139,7 +144,7 @@ open class BufferedOutput: Output {
     private func callWriteChunk(_ chunk: Chunk) {
         write(chunk) { success in
             if success {
-                self.logStore.remove(chunk.logs, from: self.tagPattern.pattern, completion: nil)
+                self.logStore.remove(chunk.logs, from: self.storageGroup, completion: nil)
                 return
             }
 

Sources/Puree/LogStore/FileLogStore.swift

@@ -49,16 +49,16 @@ struct SystemFileManager: FileManagerProtocol {
 }
 
 public class FileLogStore: LogStore {
-    private static let baseFileName = "com.cookpad.Puree.FileLogStore"
     private static let directoryName = "PureeLogs"
     private var bundle: Bundle = Bundle.main
     private var baseDirectoryURL: URL!
 
     public static let `default` = FileLogStore()
 
-    func fileURL(for outputTagPattern: String) -> URL {
-        let fileName = "\(FileLogStore.baseFileName)_\(outputTagPattern)"
-        return baseDirectoryURL.appendingPathComponent(fileName)
+    private func fileURL(for group: String) -> URL {
+        // Tag patterns usually contain '*'. However we don't want to use special characters in filenames
+        // so encode file names to Base16
+        return baseDirectoryURL.appendingPathComponent(encodeToBase16(group))
     }
     private var fileManager: FileManagerProtocol = SystemFileManager()
 
@@ -110,4 +110,8 @@ public class FileLogStore: LogStore {
         try? fileManager.removeDirectory(at: baseDirectoryURL)
         try? createCachesDirectory()
     }
+
+    private func encodeToBase16(_ string: String) -> String {
+        return string.data(using: .utf8)!.map { String(format: "%02hhx", $0) }.joined()
+    }
 }

Sources/Puree/TagPattern.swift

@@ -4,13 +4,17 @@ private let separator: Character = "."
 private let allWildcard = "**"
 private let wildcard = "*"
 
-public struct TagPattern {
+public struct TagPattern: CustomStringConvertible {
     struct Match {
         let captured: String?
     }
 
     public let pattern: String
 
+    public var description: String {
+        return pattern
+    }
+
     public init?(string patternString: String) {
         if TagPattern.isValidPattern(patternString) {
             pattern = patternString

Tests/.swiftlint.yml

@@ -1,3 +1,5 @@
 disabled_rules:
   - force_try
   - force_cast
+  - nesting
+  - identifier_name

Tests/PureeTests/BufferedOutputTests.swift

@@ -35,7 +35,7 @@ class BufferedOutputTests: XCTestCase {
 
     func testBufferedOutput() {
         output.configuration.logEntryCountLimit = 1
-        XCTAssertEqual(logStore.logs(for: "pv").count, 0)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 0)
         XCTAssertEqual(output.calledWriteCount, 0)
         output.emit(log: makeLog())
         XCTAssertEqual(output.calledWriteCount, 1)
@@ -46,21 +46,21 @@ class BufferedOutputTests: XCTestCase {
         output.configuration.flushInterval = 1
 
         let storedLogs: Set<LogEntry> = Set((0..<10).map { _ in LogEntry(tag: "pv", date: Date()) })
-        logStore.add(storedLogs, for: "pv", completion: nil)
+        logStore.add(storedLogs, for: "pv_TestingBufferedOutput", completion: nil)
 
-        XCTAssertEqual(logStore.logs(for: "pv").count, 10)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 10)
         XCTAssertEqual(output.calledWriteCount, 0)
 
         output.resume()
 
-        XCTAssertEqual(logStore.logs(for: "pv").count, 0)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 0)
         XCTAssertEqual(output.calledWriteCount, 1)
     }
 
     func testBufferedOutputFlushedByInterval() {
         output.configuration.logEntryCountLimit = 10
         output.configuration.flushInterval = 1
-        XCTAssertEqual(logStore.logs(for: "pv").count, 0)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 0)
         XCTAssertEqual(output.calledWriteCount, 0)
         output.emit(log: makeLog())
         XCTAssertEqual(output.calledWriteCount, 0)
@@ -75,7 +75,7 @@ class BufferedOutputTests: XCTestCase {
     func testBufferedOutputNotFlushed() {
         output.configuration.logEntryCountLimit = 10
         output.configuration.flushInterval = 10
-        XCTAssertEqual(logStore.logs(for: "pv").count, 0)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 0)
         XCTAssertEqual(output.calledWriteCount, 0)
         output.emit(log: makeLog())
         XCTAssertEqual(output.calledWriteCount, 0)
@@ -88,11 +88,11 @@ class BufferedOutputTests: XCTestCase {
 
     func testHittingLogLimit() {
         output.configuration.logEntryCountLimit = 10
-        XCTAssertEqual(logStore.logs(for: "pv").count, 0)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 0)
         XCTAssertEqual(output.calledWriteCount, 0)
         for i in 1..<10 {
             output.emit(log: makeLog())
-            XCTAssertEqual(logStore.logs(for: "pv").count, i)
+            XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, i)
         }
         XCTAssertEqual(output.calledWriteCount, 0)
 
@@ -112,23 +112,23 @@ class BufferedOutputTests: XCTestCase {
 
         var expectation = self.expectation(description: "retry writeChunk")
         XCTAssertEqual(output.calledWriteCount, 1)
-        XCTAssertEqual(logStore.logs(for: "pv").count, 10)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 10)
         output.writeCallback = {
             expectation.fulfill()
         }
         wait(for: [expectation], timeout: 1.0)
 
         expectation = self.expectation(description: "retry writeChunk")
         XCTAssertEqual(output.calledWriteCount, 2)
-        XCTAssertEqual(logStore.logs(for: "pv").count, 10)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 10)
         output.writeCallback = {
             expectation.fulfill()
         }
         wait(for: [expectation], timeout: 1.0)
 
         expectation = self.expectation(description: "retry writeChunk")
         XCTAssertEqual(output.calledWriteCount, 3)
-        XCTAssertEqual(logStore.logs(for: "pv").count, 10)
+        XCTAssertEqual(logStore.logs(for: "pv_TestingBufferedOutput").count, 10)
         output.writeCallback = {
             expectation.fulfill()
         }