From 898d8c085dc78324304218ca44175a0001cf60e2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20R=C3=B6nnqvist?= <ronnqvist@apple.com>
Date: Wed, 24 Sep 2025 12:12:57 +0200
Subject: [PATCH] Update the bin/benchmark script to Swift 6

---
 bin/benchmark/Package.swift                   |  4 +-
 .../benchmark/BenchmarkResultSeries.swift     |  2 +-
 .../Sources/benchmark/Commands.swift          |  7 ++-
 .../Sources/benchmark/Diff/DiffAnalysis.swift |  4 ++
 .../benchmark/Diff/DiffResultsTable.swift     | 63 ++++++++++++++-----
 .../Subcommands/CommitCommands.swift          |  3 +-
 .../Sources/benchmark/Subcommands/Diff.swift  | 11 ++--
 .../benchmark/Subcommands/Measure.swift       |  4 +-
 .../benchmark/Subcommands/RenderTrend.swift   |  5 +-
 9 files changed, 73 insertions(+), 30 deletions(-)

diff --git a/bin/benchmark/Package.swift b/bin/benchmark/Package.swift
index 7d52848664..046395b282 100644
--- a/bin/benchmark/Package.swift
+++ b/bin/benchmark/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version: 5.5
+// swift-tools-version: 6.0
 /*
  This source file is part of the Swift.org open source project
 
@@ -14,7 +14,7 @@ import PackageDescription
 let package = Package(
     name: "benchmark",
     platforms: [
-        .macOS(.v12)
+        .macOS(.v13)
     ],
     products: [
         .executable(
diff --git a/bin/benchmark/Sources/benchmark/BenchmarkResultSeries.swift b/bin/benchmark/Sources/benchmark/BenchmarkResultSeries.swift
index c0f2d7582f..008a206e46 100644
--- a/bin/benchmark/Sources/benchmark/BenchmarkResultSeries.swift
+++ b/bin/benchmark/Sources/benchmark/BenchmarkResultSeries.swift
@@ -77,7 +77,7 @@ struct BenchmarkResultSeries: Codable, Equatable {
     /// The list of metrics gathered in these benchmark runs.
     public var metrics: [MetricSeries]
     
-    static var empty = BenchmarkResultSeries(platformName: "", timestamp: Date(), doccArguments: [], metrics: [])
+    static let empty = BenchmarkResultSeries(platformName: "", timestamp: Date(), doccArguments: [], metrics: [])
     
     enum Error: Swift.Error, CustomStringConvertible {
         case addedResultHasDifferentConfiguration
diff --git a/bin/benchmark/Sources/benchmark/Commands.swift b/bin/benchmark/Sources/benchmark/Commands.swift
index 3c41f28a27..4eb1fff713 100644
--- a/bin/benchmark/Sources/benchmark/Commands.swift
+++ b/bin/benchmark/Sources/benchmark/Commands.swift
@@ -12,15 +12,16 @@ import ArgumentParser
 import Foundation
 
 @main
-struct BenchmarkCommand: ParsableCommand {
-    static var configuration = CommandConfiguration(
+struct BenchmarkCommand: @MainActor ParsableCommand {
+    @MainActor
+    static let configuration = CommandConfiguration(
             abstract: "A utility for performing benchmarks for Swift-DocC.",
             subcommands: [Measure.self, Diff.self, CompareTo.self, MeasureCommits.self, RenderTrend.self],
             defaultSubcommand: Measure.self)
 }
 
 let doccProjectRootURL: URL = {
-    let url = URL(fileURLWithPath: #file)
+    let url = URL(fileURLWithPath: #filePath)
         .deletingLastPathComponent() // Commands.swift
         .deletingLastPathComponent() // benchmark
         .deletingLastPathComponent() // Sources
diff --git a/bin/benchmark/Sources/benchmark/Diff/DiffAnalysis.swift b/bin/benchmark/Sources/benchmark/Diff/DiffAnalysis.swift
index cffe3e6c49..a6874188da 100644
--- a/bin/benchmark/Sources/benchmark/Diff/DiffAnalysis.swift
+++ b/bin/benchmark/Sources/benchmark/Diff/DiffAnalysis.swift
@@ -22,6 +22,7 @@ extension DiffResults {
         }
     }
     
+    @MainActor
     static func analyze(before beforeMetric: BenchmarkResultSeries.MetricSeries?, after afterMetric: BenchmarkResultSeries.MetricSeries) throws -> DiffResults.MetricAnalysis {
         guard let beforeMetric else {
             return DiffResults.MetricAnalysis(
@@ -129,6 +130,7 @@ extension DiffResults {
         )
     }
     
+    @MainActor
     private static func inputBiasDescription(metric: BenchmarkResultSeries.MetricSeries, sampleName: String, numbers: [Double]) -> String {
         // Turn the single metric series into an array of single values metric series to render the trend bars.
         
@@ -164,6 +166,7 @@ extension DiffResults {
 }
 
 extension BenchmarkResultSeries.MetricSeries.ValueSeries {
+    @MainActor
     func formatted() -> String {
         switch self {
             case .duration(let value):
@@ -190,6 +193,7 @@ extension BenchmarkResultSeries.MetricSeries.ValueSeries {
 }
 
 #if os(macOS) || os(iOS)
+@MainActor
 private let durationFormatter: MeasurementFormatter = {
     let fmt = MeasurementFormatter()
     fmt.unitStyle = .medium
diff --git a/bin/benchmark/Sources/benchmark/Diff/DiffResultsTable.swift b/bin/benchmark/Sources/benchmark/Diff/DiffResultsTable.swift
index be8c39db52..2060053326 100644
--- a/bin/benchmark/Sources/benchmark/Diff/DiffResultsTable.swift
+++ b/bin/benchmark/Sources/benchmark/Diff/DiffResultsTable.swift
@@ -11,18 +11,40 @@
 import Foundation
 
 struct DiffResultsTable {
-    static var columns: [(name: String, width: Int)] = [
-        ("Metric", 40),
-        ("Change", 15),
-        ("Before", 20),
-        ("After", 20),
-    ]
-    static var totalWidth: Int {
-        return columns.reduce(0, { $0 + $1.width + 3 }) - 1
+    struct Columns {
+        typealias Column = (name: String, width: Int)
+        var data: [Column]
+        
+        init() {
+            data = [
+                ("Metric", 40),
+                ("Change", 15),
+                ("Before", 20),
+                ("After", 20),
+            ]
+        }
+        
+        var beforeInfo: Column {
+            get { data[2] }
+            set { data[2] = newValue }
+        }
+        
+        var afterInfo: Column {
+            get { data[3] }
+            set { data[3] = newValue }
+        }
+        
+        var totalWidth: Int {
+            data.reduce(0, { $0 + $1.width + 3 }) - 1
+        }
+        
+        var names: [String] {
+            data.map { $0.name }
+        }
     }
     
     private(set) var output: String
-    init(results: DiffResults) {
+    init(results: DiffResults, columns: Columns) {
         var output = ""
         
         let allWarnings = results.analysis.flatMap { $0.warnings ?? [] }
@@ -30,9 +52,10 @@ struct DiffResultsTable {
             output += "\(warning)\n"
         }
         
-        output += "┌\(String(repeating: "─", count: Self.totalWidth))┐\n"
-        output += Self.formattedRow(columnValues: Self.columns.map { $0.name })
-        output += "├\(String(repeating: "─", count: Self.totalWidth))┤\n"
+        let totalWidth = columns.totalWidth
+        output += "┌\(String(repeating: "─", count: totalWidth))┐\n"
+        output += Self.formattedRow(columns: columns)
+        output += "├\(String(repeating: "─", count: totalWidth))┤\n"
         
         var footnoteCounter = 0
         
@@ -61,10 +84,16 @@ struct DiffResultsTable {
                 footnoteCounter += footnotes.count
             }
             
-            output += Self.formattedRow(columnValues: [analysis.metricName, change, analysis.before ?? "-", analysis.after], colorInfo: colorInfo)
+            var analysisColumns = columns
+            analysisColumns.data[0].name = analysis.metricName
+            analysisColumns.data[1].name = change
+            analysisColumns.data[2].name = analysis.before ?? "-"
+            analysisColumns.data[3].name = analysis.after
+            
+            output += Self.formattedRow(columns: analysisColumns, colorInfo: colorInfo)
         }
                     
-        output += "└\(String(repeating: "─", count: Self.totalWidth))┘\n"
+        output += "└\(String(repeating: "─", count: totalWidth))┘\n"
         
         let allFootnotes = results.analysis.flatMap { $0.footnotes ?? [] }
         if !allFootnotes.isEmpty {
@@ -117,9 +146,9 @@ struct DiffResultsTable {
         let upTo: String.Index
     }
     
-    private static func formattedRow(columnValues: [String], colorInfo: [ColumnColorInfo] = []) -> String {
-        let values: [String] = columnValues.enumerated().map { (index, value) in
-            let row = value.padding(toLength: Self.columns[index].width, withPad: " ", startingAt: 0)
+    private static func formattedRow(columns: Columns, colorInfo: [ColumnColorInfo] = []) -> String {
+        let values: [String] = columns.names.enumerated().map { (index, value) in
+            let row = value.padding(toLength: columns.data[index].width, withPad: " ", startingAt: 0)
             if let colorInfo = colorInfo.first(where: { $0.index == index }) {
                 return String(row[..<colorInfo.upTo]).colored(colorInfo.color) + String(row[colorInfo.upTo...])
             }
diff --git a/bin/benchmark/Sources/benchmark/Subcommands/CommitCommands.swift b/bin/benchmark/Sources/benchmark/Subcommands/CommitCommands.swift
index ca00daaf2c..82680dddab 100644
--- a/bin/benchmark/Sources/benchmark/Subcommands/CommitCommands.swift
+++ b/bin/benchmark/Sources/benchmark/Subcommands/CommitCommands.swift
@@ -12,7 +12,7 @@ import Foundation
 import ArgumentParser
 import SwiftDocC
 
-struct CompareTo: ParsableCommand {
+struct CompareTo: @MainActor ParsableCommand {
     @Argument(
         help: "The baseline 'commit-ish' to compare the current checkout against."
     )
@@ -31,6 +31,7 @@ struct CompareTo: ParsableCommand {
         return outputDirectory ?? URL(fileURLWithPath: ".") // fallback to the current directory
     }
     
+    @MainActor
     mutating func run() throws {
         let currentDocCExecutable = try MeasureAction.buildDocC(at: doccProjectRootURL)
         let currentBenchmarkResult = try MeasureAction.gatherMeasurements(
diff --git a/bin/benchmark/Sources/benchmark/Subcommands/Diff.swift b/bin/benchmark/Sources/benchmark/Subcommands/Diff.swift
index 44f0c2f152..9523d73c1b 100644
--- a/bin/benchmark/Sources/benchmark/Subcommands/Diff.swift
+++ b/bin/benchmark/Sources/benchmark/Subcommands/Diff.swift
@@ -14,7 +14,7 @@ import SwiftDocC
 
 // For argument parsing and validation
 
-struct Diff: ParsableCommand {
+struct Diff: @MainActor ParsableCommand {
     @Argument(
         help: "The benchmark.json file to treat as the 'before' values in the diff.",
         transform: { URL(fileURLWithPath: $0) }
@@ -34,6 +34,7 @@ struct Diff: ParsableCommand {
     )
     var jsonOutputFile: URL?
     
+    @MainActor
     mutating func run() throws {
         try DiffAction(
             beforeFile: beforeFile,
@@ -50,6 +51,7 @@ struct DiffAction {
     var afterFile: URL
     var jsonOutputFile: URL?
     
+    @MainActor
     func run() throws {
         let beforeMetrics = try JSONDecoder().decode(BenchmarkResultSeries.self, from: Data(contentsOf: beforeFile)).metrics
         let afterMetrics = try JSONDecoder().decode(BenchmarkResultSeries.self, from: Data(contentsOf: afterFile)).metrics
@@ -62,10 +64,11 @@ struct DiffAction {
             try result.analysis.append(DiffResults.analyze(before: beforeMetric, after: afterMetric))
         }
         
-        DiffResultsTable.columns[2] = tableColumnInfo(file: beforeFile)
-        DiffResultsTable.columns[3] = tableColumnInfo(file: afterFile)
+        var columns = DiffResultsTable.Columns()
+        columns.beforeInfo = tableColumnInfo(file: beforeFile)
+        columns.afterInfo  = tableColumnInfo(file: afterFile)
         
-        let table = DiffResultsTable(results: result)
+        let table = DiffResultsTable(results: result, columns: columns)
         print(table.output)
         
         if let jsonOutputFile {
diff --git a/bin/benchmark/Sources/benchmark/Subcommands/Measure.swift b/bin/benchmark/Sources/benchmark/Subcommands/Measure.swift
index 429bee638c..ad4555dfe1 100644
--- a/bin/benchmark/Sources/benchmark/Subcommands/Measure.swift
+++ b/bin/benchmark/Sources/benchmark/Subcommands/Measure.swift
@@ -56,7 +56,7 @@ struct MeasureOptions: ParsableCommand {
     }
 }
 
-struct Measure: ParsableCommand {
+struct Measure: @MainActor ParsableCommand {
     @Option(
         name: .customLong("output"),
         help: "The path to write the output benchmark measurements file.",
@@ -93,6 +93,7 @@ struct Measure: ParsableCommand {
         }
     }
     
+    @MainActor
     mutating func run() throws {
         try MeasureAction(
             repeatCount: measureOptions.repeatCount,
@@ -111,6 +112,7 @@ struct MeasureAction {
     var doccConvertCommand: [String]
     var computeMissingOutputSizeMetrics: Bool
     
+    @MainActor
     func run() throws {
         print("Building docc in release configuration".styled(.bold))
         let doccURL = try Self.buildDocC(at: doccProjectRootURL)
diff --git a/bin/benchmark/Sources/benchmark/Subcommands/RenderTrend.swift b/bin/benchmark/Sources/benchmark/Subcommands/RenderTrend.swift
index 1b583209fc..bc0d91a232 100644
--- a/bin/benchmark/Sources/benchmark/Subcommands/RenderTrend.swift
+++ b/bin/benchmark/Sources/benchmark/Subcommands/RenderTrend.swift
@@ -14,7 +14,7 @@ import SwiftDocC
 
 // For argument parsing and validation
 
-struct RenderTrend: ParsableCommand {
+struct RenderTrend: @MainActor ParsableCommand {
     @Option(
         name: .customLong("filter"),
         help: "A list metric IDs to render trends for. If no filters are specified, trends are rendered for all numeric metrics."
@@ -27,6 +27,7 @@ struct RenderTrend: ParsableCommand {
     )
     var benchmarkResults: [URL]
     
+    @MainActor
     mutating func run() throws {
         try RenderTrendAction(
             metricFilters: metricFilters,
@@ -41,6 +42,7 @@ struct RenderTrendAction {
     var metricFilters: [String]
     var benchmarkResults: [URL]
     
+    @MainActor
     func run() throws {
         // Map the metric ID to the measured values across the benchmarks
         var trendValues: [String: [BenchmarkResultSeries.MetricSeries]] = [:]
@@ -76,6 +78,7 @@ struct RenderTrendAction {
         }
     }
 
+    @MainActor
     static func renderTrendBars(metrics: [BenchmarkResultSeries.MetricSeries]) -> String {
         var output = ""