WeTransfer · Feb 20, 2023 · Feb 20, 2023 · Feb 20, 2023 · Mar 21, 2023 · Mar 21, 2023
diff --git a/DiagnosticsTests/DiagnosticsReporterTests.swift b/DiagnosticsTests/DiagnosticsReporterTests.swift
@@ -22,63 +22,63 @@ final class DiagnosticsReporterTests: XCTestCase {
     }
 
     /// It should correctly generate HTML from the reporters.
-    func testHTMLGeneration() {
+    func testHTMLGeneration() async {
         let diagnosticsChapter = DiagnosticsChapter(title: UUID().uuidString, diagnostics: UUID().uuidString)
         var reporter = MockedReporter()
         reporter.diagnosticsChapter = diagnosticsChapter
         let reporters = [reporter]
-        let report = DiagnosticsReporter.create(using: reporters)
+        let report = await DiagnosticsReporter.create(using: reporters)
         let html = String(data: report.data, encoding: .utf8)!
 
         XCTAssertTrue(html.contains("<h3>\(diagnosticsChapter.title)</h3>"))
         XCTAssertTrue(html.contains(diagnosticsChapter.diagnostics as! String))
     }
 
     /// It should create a chapter for each reporter.
-    func testReportingChapters() {
-        let report = DiagnosticsReporter.create()
+    func testReportingChapters() async {
+        let report = await DiagnosticsReporter.create()
         let html = String(data: report.data, encoding: .utf8)!
         let expectedChaptersCount = DiagnosticsReporter.DefaultReporter.allCases.count
         let chaptersCount = html.components(separatedBy: "<div class=\"chapter\"").count - 1
         XCTAssertEqual(expectedChaptersCount, chaptersCount)
     }
 
     /// It should filter using passed filters.
-    func testFilters() {
+    func testFilters() async {
         let keyToFilter = UUID().uuidString
         let mockedReport = MockedReport(diagnostics: [keyToFilter: UUID().uuidString])
-        let report = DiagnosticsReporter.create(using: [mockedReport], filters: [MockedFilter.self])
+        let report = await DiagnosticsReporter.create(using: [mockedReport], filters: [MockedFilter.self])
         let html = String(data: report.data, encoding: .utf8)!
         XCTAssertFalse(html.contains(keyToFilter))
         XCTAssertTrue(html.contains("FILTERED"))
     }
 
-    func testWithoutProvidingSmartInsightsProvider() {
+    func testWithoutProvidingSmartInsightsProvider() async {
         let mockedReport = MockedReport(diagnostics: ["key": UUID().uuidString])
-        let report = DiagnosticsReporter.create(using: [mockedReport, SmartInsightsReporter()], filters: [MockedFilter.self], smartInsightsProvider: nil)
+        let report = await DiagnosticsReporter.create(using: [mockedReport, SmartInsightsReporter()], filters: [MockedFilter.self], smartInsightsProviders: [])
         let html = String(data: report.data, encoding: .utf8)!
         XCTAssertTrue(html.contains("Smart Insights"), "Default insights should still be added")
     }
 
-    func testWithSmartInsightsProviderReturningNoExtraInsights() {
+    func testWithSmartInsightsProviderReturningNoExtraInsights() async {
         let mockedReport = MockedReport(diagnostics: ["key": UUID().uuidString])
-        let report = DiagnosticsReporter.create(using: [mockedReport, SmartInsightsReporter()], filters: [MockedFilter.self], smartInsightsProvider: MockedInsightsProvider(insightToReturn: nil))
+        let report = await DiagnosticsReporter.create(using: [mockedReport, SmartInsightsReporter()], filters: [MockedFilter.self], smartInsightsProviders: [MockedInsightsProvider(insightToReturn: nil)])
         let html = String(data: report.data, encoding: .utf8)!
         XCTAssertTrue(html.contains("Smart Insights"), "Default insights should still be added")
     }
 
-    func testWithSmartInsightsProviderReturningExtraInsights() {
+    func testWithSmartInsightsProviderReturningExtraInsights() async {
         let mockedReport = MockedReport(diagnostics: ["key": UUID().uuidString])
         let insightToReturn = SmartInsight(name: UUID().uuidString, result: .success(message: UUID().uuidString))
-        let report = DiagnosticsReporter.create(using: [mockedReport, SmartInsightsReporter()], filters: [MockedFilter.self], smartInsightsProvider: MockedInsightsProvider(insightToReturn: insightToReturn))
+        let report = await DiagnosticsReporter.create(using: [mockedReport, SmartInsightsReporter()], filters: [MockedFilter.self], smartInsightsProviders: [MockedInsightsProvider(insightToReturn: insightToReturn)])
         let html = String(data: report.data, encoding: .utf8)!
         XCTAssertTrue(html.contains(insightToReturn.name))
         XCTAssertTrue(html.contains(insightToReturn.result.message))
     }
 
     /// It should correctly generate the header.
-    func testHeaderGeneration() {
-        let report = DiagnosticsReporter.create(using: [])
+    func testHeaderGeneration() async {
+        let report = await DiagnosticsReporter.create(using: [])
         let html = String(data: report.data, encoding: .utf8)!
 
         XCTAssertTrue(html.contains("<head>"))

diff --git a/Package.swift b/Package.swift
@@ -5,10 +5,10 @@ import PackageDescription
 
 let package = Package(name: "Diagnostics",
                       platforms: [
-                        .macOS(.v10_15),
-                        .iOS(.v11),
-                        .tvOS(.v12),
-                        .watchOS(.v6)],
+                        .macOS(.v12),
+                        .iOS(.v13),
+                        .tvOS(.v13),
+                        .watchOS(.v8)],
                       products: [
                         .library(name: "Diagnostics", targets: ["Diagnostics"])
                         ],

diff --git a/Sources/Device.swift b/Sources/Device.swift
@@ -9,29 +9,38 @@
 import Foundation
 #if os(macOS)
 import AppKit
+#elseif os(watchOS)
+import WatchKit
 #else
 import UIKit
 #endif
 
 enum Device {
     static var systemName: String {
-        #if os(macOS)
-        return ProcessInfo().hostName
+        #if os(macOS) || targetEnvironment(macCatalyst)
+        return ProcessInfo.systemName
+        #elseif os(watchOS)
+        return WKInterfaceDevice.current().systemName
         #else
         return UIDevice.current.systemName
         #endif
     }
 
     static var systemVersion: String {
-        #if os(macOS)
+        #if os(macOS) || targetEnvironment(macCatalyst)
         return ProcessInfo().operatingSystemVersionString
+        #elseif os(watchOS)
+        return WKInterfaceDevice.current().systemVersion
         #else
         return UIDevice.current.systemVersion
         #endif
     }
 
-    static var freeDiskSpace: ByteCountFormatter.Units.GigaBytes {
-        ByteCountFormatter.string(fromByteCount: freeDiskSpaceInBytes, countStyle: ByteCountFormatter.CountStyle.decimal)
+    static var freeDiskSpace: ByteCountFormatter.Units.GigaBytes? {
+        if let freeDiskSpaceInBytes {
+            return ByteCountFormatter.string(fromByteCount: freeDiskSpaceInBytes, countStyle: ByteCountFormatter.CountStyle.decimal)
+        }
+        return nil
     }
 
     static var totalDiskSpace: ByteCountFormatter.Units.GigaBytes {
@@ -47,12 +56,51 @@ enum Device {
         return Int64(space)
     }
 
-    static var freeDiskSpaceInBytes: ByteCountFormatter.Units.Bytes {
+    static var freeDiskSpaceInBytes: ByteCountFormatter.Units.Bytes? {
+#if !os(watchOS)
         guard let space = try? URL(fileURLWithPath: NSHomeDirectory() as String)
             .resourceValues(forKeys: [URLResourceKey.volumeAvailableCapacityForOpportunisticUsageKey])
             .volumeAvailableCapacityForOpportunisticUsage else {
-            return 0
+            return nil
         }
         return space
+#else
+        return nil
+#endif
+    }
+}
+
+#if os(macOS) || targetEnvironment(macCatalyst)
+extension ProcessInfo {
+    static var model: String {
+        if #available(macCatalyst 15.0, *) {
+            let service = IOServiceGetMatchingService(kIOMainPortDefault,
+                                                      IOServiceMatching("IOPlatformExpertDevice"))
+
+            var modelIdentifier: String?
+            if let modelData = IORegistryEntryCreateCFProperty(service, "model" as CFString, kCFAllocatorDefault, 0).takeRetainedValue() as? Data {
+                modelIdentifier = String(data: modelData, encoding: .utf8)?.trimmingCharacters(in: .controlCharacters)
+            }
+
+            IOObjectRelease(service)
+            return modelIdentifier ?? "macOS"
+        } else {
+            return "macOS"
+        }
+    }
+
+    static var systemName: String {
+        var sysinfo = utsname()
+        let result = uname(&sysinfo)
+        guard result == EXIT_SUCCESS else { return "macOS (unknown)" }
+        let data = Data(bytes: &sysinfo.machine, count: Int(_SYS_NAMELEN))
+        guard let identifier = String(bytes: data, encoding: .ascii) else { return "macOS (unknown)" }
+        let arch = identifier.trimmingCharacters(in: .controlCharacters)
+        switch arch {
+        case "arm64": return "macOS (Apple Silicon)"
+        case "x86_64": return "macOS (Intel)"
+        default: return "macOS (\(arch))"
+        }
     }
 }
+#endif
diff --git a/Sources/Diagnostics.swift b/Sources/Diagnostics.swift
@@ -14,3 +14,4 @@ extension Dictionary: Diagnostics where Key == String { }
 extension KeyValuePairs: Diagnostics where Key == String, Value == String { }
 extension String: Diagnostics { }
 extension DirectoryTreeNode: Diagnostics { }
+extension Array: Diagnostics where Element == String { }
diff --git a/Sources/DiagnosticsReport.swift b/Sources/DiagnosticsReport.swift
@@ -40,7 +40,7 @@ public extension DiagnosticsReport {
             try? FileManager.default.createDirectory(atPath: folderPath, withIntermediateDirectories: true, attributes: nil)
             let filePath = folderPath + filename
             save(to: filePath)
-        #else
+        #elseif os(macOS)
             let folderPath = "/\(userPath)/Desktop/"
             saveUsingPanel(initialDirectoryPath: folderPath, filename: filename)
         #endif

diff --git a/Sources/DiagnosticsReporter.swift b/Sources/DiagnosticsReporter.swift
@@ -11,7 +11,7 @@ import Foundation
 
 public protocol DiagnosticsReporting {
     /// Creates the report chapter.
-    func report() -> DiagnosticsChapter
+    func report() async -> DiagnosticsChapter
 }
 
 public enum DiagnosticsReporter {
@@ -55,26 +55,26 @@ public enum DiagnosticsReporter {
     public static func create(
         filename: String = "Diagnostics-Report.html",
         using reporters: [DiagnosticsReporting] = DefaultReporter.allReporters,
-        filters: [DiagnosticsReportFilter.Type]? = nil,
-        smartInsightsProvider: SmartInsightsProviding? = nil
-    ) -> DiagnosticsReport {
+        filters: [DiagnosticsReportFilter.Type] = [],
+        smartInsightsProviders: [SmartInsightsProviding] = []
+    ) async -> DiagnosticsReport {
         /// We should be able to parse Smart insights out of other chapters.
         /// For example: read out errors from the log chapter and create insights out of it.
         ///
         /// Therefore, we are generating insights on the go and add them to the Smart Insights later.
-        var smartInsights: [SmartInsightProviding] = []
+        var smartInsights: [SmartInsightProviding] = await smartInsightsProviders.flatMap({
+            await $0.smartInsights()
+        })
 
-        var reportChapters = reporters
+        var reportChapters = await reporters
             .filter { ($0 is SmartInsightsReporter) == false }
-            .map { reporter -> DiagnosticsChapter in
-                var chapter = reporter.report()
-                if let filters = filters, !filters.isEmpty {
+            .map { reporter async -> DiagnosticsChapter in
+                var chapter = await reporter.report()
+                if filters.isEmpty {
                     chapter.applyingFilters(filters)
                 }
-                if let smartInsightsProvider = smartInsightsProvider {
-                    let insights = smartInsightsProvider.smartInsights(for: chapter)
-                    smartInsights.append(contentsOf: insights)
-                }
+                let insights = await smartInsightsProviders.flatMap({ await $0.smartInsights(for: chapter) })
+                smartInsights.append(contentsOf: insights)
 
                 return chapter
             }

diff --git a/Sources/Extensions/AsyncExtensions.swift b/Sources/Extensions/AsyncExtensions.swift
@@ -0,0 +1,25 @@
+extension Sequence {
+    func map<T>(
+        _ transform: (Element) async throws -> T
+    ) async rethrows -> [T] {
+        var values = [T]()
+
+        for element in self {
+            try await values.append(transform(element))
+        }
+
+        return values
+    }
+
+    func flatMap<SegmentOfResult>(
+        _ transform: (Self.Element) async throws -> SegmentOfResult
+    ) async rethrows -> [SegmentOfResult.Element] where SegmentOfResult : Sequence {
+        var values = [SegmentOfResult.Element]()
+        for element in self {
+            try await values.append(contentsOf: transform(element))
+        }
+
+        return values
+    }
+
+}
diff --git a/Sources/Extensions/OSLogEntryLog.swift b/Sources/Extensions/OSLogEntryLog.swift
@@ -0,0 +1,18 @@
+//
+//  OSLogEntryLog.swift
+//  
+//
+//  Created by Kanishka on 10/05/23.
+//
+
+import Foundation
+import OSLog
+
+@available(iOS 15.0, *)
+extension OSLogEntryLog {
+    var formattedMessage: String {
+        """
+        <p class="debug"><span class="log-date">\(DateFormatter.current.string(from: self.date))</span><span class="log-separator"> | </span><span class="log-prefix">\(self.subsystem)-\(self.category)</span><span class="log-separator"> | </span><span class="log-message">\(self.composedMessage)</span></p>
+        """
+    }
+}
diff --git a/Sources/HTMLGenerating.swift b/Sources/HTMLGenerating.swift
@@ -46,6 +46,20 @@ extension KeyValuePairs: HTMLGenerating where Key == String, Value == String {
     }
 }
 
+extension Array: HTMLGenerating where Element == String {
+    public func html() -> HTML {
+        var html = "<table>"
+
+        for element in self {
+            html += "<tr>\(element)</tr>"
+        }
+
+        html += "</table>"
+
+        return html
+    }
+}
+
 extension String: HTMLGenerating {
     public func html() -> HTML {
         return self
@@ -79,3 +93,25 @@ extension DiagnosticsChapter: HTMLGenerating {
         return html
     }
 }
+
+public struct JSONFormatting: HTMLFormatting {
+    public static func format(_ diagnostics: Diagnostics) -> HTML {
+        guard let text = diagnostics as? String else { return diagnostics.html() }
+        let id = UUID().uuidString.replacingOccurrences(of: "-", with: "")
+        return """
+        <a id="download-\(id)">Download</a>
+        <div id="content-\(id)">\(text)</div>
+        <script src="https://cdn.jsdelivr.net/gh/pgrabovets/json-view@master/dist/jsonview.js"></script>
+        <script>
+            var a = document.getElementById("download-\(id)");
+            var content = document.getElementById("content-\(id)").textContent;
+            a.download = "Export.json";
+            a.href = "data:application/json," + encodeURIComponent(content);
+            const tree\(id) = jsonview.create(content);
+            document.getElementById("content-\(id)").textContent = "";
+            jsonview.render(tree\(id), document.getElementById("content-\(id)"));
+            jsonview.expand(tree\(id));
+        </script>
+        """
+    }
+}