fix tests

Author: tomerd

Sources/Basics/Observability.swift

@@ -422,6 +422,21 @@ public struct ObservabilityMetadata: Equatable, CustomDebugStringConvertible {
         }
     }
 
+    //@available(*, deprecated, message: "temporary for transition DiagnosticsEngine -> DiagnosticsEmitter")
+    public func droppingLegacyKeys() -> ObservabilityMetadata? {
+        var metadata = ObservabilityMetadata()
+        self.forEach { (key, value) in
+            if key.keyType == LegacyLocationKey.self {
+                return
+            }
+            if key.keyType == LegacyDataKey.self {
+                return
+            }
+            metadata._storage[key] = value
+        }
+        return metadata.isEmpty ? .none : metadata
+    }
+
     /// A type-erased `ObservabilityMetadataKey` used when iterating through the `ObservabilityMetadata` using its `forEach` method.
     public struct AnyKey {
         /// The key's type represented erased to an `Any.Type`.
@@ -461,7 +476,9 @@ extension ObservabilityScope {
 extension Diagnostic {
     init?(_ diagnostic: TSCDiagnostic) {
         var metadata = ObservabilityMetadata()
-        metadata.legacyDiagnosticLocation = .init(diagnostic.location)
+        if !(diagnostic.location is UnknownLocation) {
+            metadata.legacyDiagnosticLocation = .init(diagnostic.location)
+        }
         metadata.legacyDiagnosticData = .init(diagnostic.data)
 
         switch diagnostic.behavior {
@@ -537,7 +554,7 @@ extension ObservabilityMetadata {
         }
     }
 
-    fileprivate enum LegacyLocationKey: Key {
+    private enum LegacyLocationKey: Key {
         typealias Value = DiagnosticLocationWrapper
     }
 
@@ -565,7 +582,7 @@ extension ObservabilityMetadata {
         }
     }
 
-    enum LegacyDataKey: Key {
+    private enum LegacyDataKey: Key {
         typealias Value = DiagnosticDataWrapper
     }
 

Sources/SPMTestSupport/Observability.swift

@@ -126,7 +126,9 @@ public class DiagnosticsTestResult {
 
         XCTAssertMatch(diagnostic.message, message, file: file, line: line)
         XCTAssertEqual(diagnostic.severity, severity, file: file, line: line)
-        XCTAssertEqual(diagnostic.metadata, metadata, file: file, line: line)
+        // FIXME: (diagnostics) compare complete metadata when legacy bridge is removed
+        //XCTAssertEqual(diagnostic.metadata, metadata, file: file, line: line)
+        XCTAssertEqual(diagnostic.metadata?.droppingLegacyKeys(), metadata?.droppingLegacyKeys(), file: file, line: line)
     }
 
     public func checkUnordered(
@@ -145,9 +147,13 @@ public class DiagnosticsTestResult {
             return XCTFail("No diagnostics match \(diagnosticPattern)", file: file, line: line)
         } else if matching.count == 1, let diagnostic = matching.first, let index = self.uncheckedDiagnostics.firstIndex(where: { $0 == diagnostic }) {
             XCTAssertEqual(diagnostic.severity, severity, file: file, line: line)
-            XCTAssertEqual(diagnostic.metadata, metadata, file: file, line: line)
+            // FIXME: (diagnostics) compare complete metadata when legacy bridge is removed
+            //XCTAssertEqual(diagnostic.metadata, metadata, file: file, line: line)
+            XCTAssertEqual(diagnostic.metadata?.droppingLegacyKeys(), metadata?.droppingLegacyKeys(), file: file, line: line)
             self.uncheckedDiagnostics.remove(at: index)
-        } else if let index = self.uncheckedDiagnostics.firstIndex(where: { diagnostic in diagnostic.severity == severity && diagnostic.metadata == metadata}) {
+        // FIXME: (diagnostics) compare complete metadata when legacy bridge is removed
+        //} else if let index = self.uncheckedDiagnostics.firstIndex(where: { diagnostic in diagnostic.severity == severity && diagnostic.metadata == metadata}) {
+        } else if let index = self.uncheckedDiagnostics.firstIndex(where: { diagnostic in diagnostic.severity == severity && diagnostic.metadata?.droppingLegacyKeys() == metadata?.droppingLegacyKeys()}) {
             self.uncheckedDiagnostics.remove(at: index)
         }
     }

Tests/BasicsTests/ObservabilitySystemTests.swift

@@ -159,50 +159,49 @@ final class ObservabilitySystemTest: XCTestCase {
             result.check(diagnostic: "warning", severity: .warning, metadata: diagnosticMergedMetadata)
         }
     }
-
+    
     @available(*, deprecated, message: "temporary for transition DiagnosticsEngine -> DiagnosticsEmitter")
     func testBridging() throws {
-
         do {
             let collector = Collector()
             let observabilitySystem = ObservabilitySystem(collector)
             let diagnosticsEngine = observabilitySystem.topScope.makeDiagnosticsEngine()
-
+            
             let data = TestData()
             let location = TestLocation()
-
+            
             diagnosticsEngine.emit(.error(data), location: location)
-            testDiagnostics(collector.diagnostics) { result in
-                var expectedMetadata = ObservabilityMetadata()
-                expectedMetadata.legacyDiagnosticLocation = .init(location)
-                expectedMetadata.legacyDiagnosticData = .init(data)
-                result.check(diagnostic: "\(data)", severity: .error, metadata: expectedMetadata)
-            }
+            
+            var expectedMetadata = ObservabilityMetadata()
+            expectedMetadata.legacyDiagnosticLocation = .init(location)
+            expectedMetadata.legacyDiagnosticData = .init(data)
+            
+            XCTAssertEqual(collector.diagnostics.count, 1)
+            XCTAssertEqual(collector.diagnostics.first?.metadata, expectedMetadata)
         }
-
+        
         do {
             let diagnosticsEngine1 = DiagnosticsEngine()
             let observabilitySystem = ObservabilitySystem(diagnosticEngine: diagnosticsEngine1)
             let diagnosticsEngine2 = observabilitySystem.topScope.makeDiagnosticsEngine()
-
+            
             let data = TestData()
             let location = TestLocation()
-
+            
             diagnosticsEngine2.emit(.error(data), location: location)
-
-
+            
             XCTAssertEqual(diagnosticsEngine1.diagnostics.count, 1)
             XCTAssertEqual(diagnosticsEngine1.diagnostics.first!.message.data as? TestData, data)
             XCTAssertEqual(diagnosticsEngine1.diagnostics.first!.location as? TestLocation, location)
         }
-
+        
         struct TestData: DiagnosticData, Equatable {
             var description: String = UUID().uuidString
         }
-
+        
         struct TestLocation: DiagnosticLocation, Equatable {
             var description: String = UUID().uuidString
-
+            
         }
     }