Omit stepping fraction for events with negative progress step

Author: bripeticca

Sources/Basics/ProgressAnimation/NinjaProgressAnimation.swift

@@ -18,14 +18,15 @@ extension ProgressAnimation {
     @_spi(SwiftPMInternal)
     public static func ninja(
         stream: WritableByteStream,
-        verbose: Bool
+        verbose: Bool,
+        normalizeStep: Bool = true
     ) -> any ProgressAnimationProtocol {
         Self.dynamic(
             stream: stream,
             verbose: verbose,
-            ttyTerminalAnimationFactory: { RedrawingNinjaProgressAnimation(terminal: $0) },
+            ttyTerminalAnimationFactory: { RedrawingNinjaProgressAnimation(terminal: $0, normalizeStep: normalizeStep) },
             dumbTerminalAnimationFactory: { SingleLinePercentProgressAnimation(stream: stream, header: nil) },
-            defaultAnimationFactory: { MultiLineNinjaProgressAnimation(stream: stream) }
+            defaultAnimationFactory: { MultiLineNinjaProgressAnimation(stream: stream, normalizeStep: normalizeStep) }
         )
     }
 }
@@ -34,17 +35,24 @@ extension ProgressAnimation {
 final class RedrawingNinjaProgressAnimation: ProgressAnimationProtocol {
     private let terminal: TerminalController
     private var hasDisplayedProgress = false
+    private let normalizeStep: Bool
 
-    init(terminal: TerminalController) {
+    init(terminal: TerminalController, normalizeStep: Bool) {
         self.terminal = terminal
+        self.normalizeStep = normalizeStep
     }
 
     func update(step: Int, total: Int, text: String) {
         assert(step <= total)
 
         terminal.clearLine()
-
-        let progressText = "[\(step)/\(total)] \(text)"
+        var progressText = ""
+        if step < 0 && normalizeStep {
+            let normalizedStep = max(0, step)
+            progressText = "[\(normalizedStep)/\(total)] \(text)"
+        } else {
+            progressText = "\(text)"
+        }
         let width = terminal.width
         if progressText.utf8.count > width {
             let suffix = "…"
@@ -78,17 +86,24 @@ final class MultiLineNinjaProgressAnimation: ProgressAnimationProtocol {
 
     private let stream: WritableByteStream
     private var lastDisplayedText: String? = nil
+    private let normalizeStep: Bool
 
-    init(stream: WritableByteStream) {
+    init(stream: WritableByteStream, normalizeStep: Bool) {
         self.stream = stream
+        self.normalizeStep = normalizeStep
     }
 
     func update(step: Int, total: Int, text: String) {
         assert(step <= total)
 
         guard text != lastDisplayedText else { return }
 
-        stream.send("[\(step)/\(total)] ").send(text)
+        if step < 0 && normalizeStep {
+            let normalizedStep = max(0, step)
+            stream.send("[\(normalizedStep)/\(total)] ")
+        }
+
+        stream.send(text)
         stream.send("\n")
         stream.flush()
         lastDisplayedText = text

Sources/SwiftBuildSupport/SwiftBuildSystemMessageHandler.swift

@@ -64,7 +64,8 @@ public final class SwiftBuildSystemMessageHandler {
         self.logLevel = logLevel
         self.progressAnimation = ProgressAnimation.ninja(
             stream: outputStream,
-            verbose: self.logLevel.isVerbose
+            verbose: self.logLevel.isVerbose,
+            normalizeStep: false
         )
         self.enableBacktraces = enableBacktraces
         self.buildDelegate = buildDelegate
@@ -216,13 +217,13 @@ public final class SwiftBuildSystemMessageHandler {
                 }
             }
         case .didUpdateProgress(let progressInfo):
-            var step = Int(progressInfo.percentComplete)
-            if step < 0 { step = 0 }
+            let step = Int(progressInfo.percentComplete)
             let message = if let targetName = progressInfo.targetName {
                 "\(targetName) \(progressInfo.message)"
             } else {
                 "\(progressInfo.message)"
             }
+            // TODO bp: some message suffixes seems to have its own stepping fraction.
             progressAnimation.update(step: step, total: 100, text: message)
             callback = { [weak self] buildSystem in
                 self?.buildDelegate?.buildSystem(buildSystem, didUpdateTaskProgress: message)
@@ -770,7 +771,6 @@ extension SwiftBuildMessage.LocationContext {
     }
 }
 
-
 fileprivate extension SwiftBuild.SwiftBuildMessage.DiagnosticInfo.Location {
     var userDescription: String? {
         switch self {