Swift Testing: Reset file counter for each test (#966)

* Swift Testing: Reset file counter for each test

This introduces a new task local to the test scoping trait to allow a
test to be repeatedly run.

Fixes #963.

* wip

Author: stephencelis

Sources/SnapshotTesting/AssertSnapshot.swift

@@ -318,12 +318,9 @@ public func verifySnapshot<Value, Format>(
       if let name = name {
         identifier = sanitizePathComponent(name)
       } else {
-        let counter = counterQueue.sync { () -> Int in
-          let key = snapshotDirectoryUrl.appendingPathComponent(testName)
-          counterMap[key, default: 0] += 1
-          return counterMap[key]!
-        }
-        identifier = String(counter)
+        identifier = String(
+          counter.next(for: snapshotDirectoryUrl.appendingPathComponent(testName).absoluteString)
+        )
       }
 
       let testName = sanitizePathComponent(testName)
@@ -504,8 +501,19 @@ public func verifySnapshot<Value, Format>(
 
 // MARK: - Private
 
-private let counterQueue = DispatchQueue(label: "co.pointfree.SnapshotTesting.counter")
-private var counterMap: [URL: Int] = [:]
+private var counter: File.Counter {
+  #if canImport(Testing)
+    if Test.current != nil {
+      return File.counter
+    } else {
+      return _counter
+    }
+  #else
+    return _counter
+  #endif
+}
+
+private let _counter = File.Counter()
 
 func sanitizePathComponent(_ string: String) -> String {
   return
@@ -546,8 +554,30 @@ private class CleanCounterBetweenTestCases: NSObject, XCTestObservation {
   }
 
   func testCaseDidFinish(_ testCase: XCTestCase) {
-    counterQueue.sync {
-      counterMap = [:]
+    _counter.reset()
+  }
+}
+
+enum File {
+  @TaskLocal static var counter = Counter()
+
+  final class Counter: @unchecked Sendable {
+    private var counts: [String: Int] = [:]
+    private let lock = NSLock()
+
+    init() {}
+
+    func next(for key: String) -> Int {
+      lock.lock()
+      defer { lock.unlock() }
+      counts[key, default: 0] += 1
+      return counts[key]!
+    }
+
+    func reset() {
+      lock.lock()
+      defer { lock.unlock() }
+      counts.removeAll()
     }
   }
 }

Sources/SnapshotTesting/SnapshotsTestTrait.swift

@@ -8,6 +8,11 @@
   }
 
   extension Trait where Self == _SnapshotsTestTrait {
+    /// Configure snapshot testing in a suite or test.
+    public static var snapshots: Self {
+      snapshots()
+    }
+
     /// Configure snapshot testing in a suite or test.
     ///
     /// - Parameters:
@@ -46,7 +51,9 @@
           record: configuration.record,
           diffTool: configuration.diffTool
         ) {
-          try await function()
+          try await File.$counter.withValue(File.Counter()) {
+            try await function()
+          }
         }
       }
     }