remove draw and clear api

Author: rauhul

Sources/Basics/ProgressAnimation/Concrete/BlastProgressAnimation.swift

@@ -90,22 +90,21 @@ extension BlastProgressAnimation: ProgressAnimationProtocol2 {
         self._flush()
     }
 
-    func draw() {
-        guard self.interactive else { return }
-        self._draw()
+    func interleave(_ bytes: some Collection<UInt8>) {
+        if self.interactive { 
+            self._clear()
+        }
+        self.terminal.write(bytes)
+        if self.interactive { 
+            self._draw()
+        }
         self._flush()
     }
 
     func complete() {
         self._complete()
         self._flush()
     }
-
-    func clear() {
-        guard self.interactive else { return }
-        self._clear()
-        self._flush()
-    }
 }
 
 extension BlastProgressAnimation {

Sources/Basics/ProgressAnimation/Concrete/NinjaMultiLineProgressAnimation.swift

@@ -37,8 +37,6 @@ final class NinjaMultiLineProgressAnimation {
 }
 
 extension NinjaMultiLineProgressAnimation: ProgressAnimationProtocol2 {
-
-
     func update(
         id: Int,
         name: String,
@@ -60,9 +58,10 @@ extension NinjaMultiLineProgressAnimation: ProgressAnimationProtocol2 {
         self.terminal.flush()
     }
 
-    func draw() {}
+    func interleave(_ bytes: some Collection<UInt8>) {
+        self.terminal.write(bytes)
+        self.terminal.flush()
+    }
 
     func complete() {}
-
-    func clear() {}
 }

Sources/Basics/ProgressAnimation/Concrete/NinjaRedrawingProgressAnimation.swift

@@ -56,7 +56,9 @@ extension NinjaRedrawingProgressAnimation: ProgressAnimationProtocol2 {
         self._flush()
     }
 
-    func draw() {
+    func interleave(_ bytes: some Collection<UInt8>) {
+        self._clear()
+        self.terminal.write(bytes)
         self._draw()
         self._flush()
     }
@@ -65,11 +67,6 @@ extension NinjaRedrawingProgressAnimation: ProgressAnimationProtocol2 {
         self._complete()
         self._flush()
     }
-
-    func clear() {
-        self._clear()
-        self._flush()
-    }
 }
 
 extension NinjaRedrawingProgressAnimation {

Sources/Basics/ProgressAnimation/Concrete/PercentMultiLineProgressAnimation.swift

@@ -67,9 +67,10 @@ extension PercentMultiLineProgressAnimation: ProgressAnimationProtocol2 {
         self.terminal.flush()
     }
 
-    func draw() {}
+    func interleave(_ bytes: some Collection<UInt8>) {
+        self.terminal.write(bytes)
+        self.terminal.flush()
+    }
 
     func complete() {}
-
-    func clear() {}
 }

Sources/Basics/ProgressAnimation/Concrete/PercentRedrawingProgressAnimation.swift

@@ -65,7 +65,9 @@ extension PercentRedrawingProgressAnimation: ProgressAnimationProtocol2 {
         self._flush()
     }
 
-    func draw() {
+    func interleave(_ bytes: some Collection<UInt8>) {
+        self._clear()
+        self.terminal.write(bytes)
         self._draw()
         self._flush()
     }
@@ -74,11 +76,6 @@ extension PercentRedrawingProgressAnimation: ProgressAnimationProtocol2 {
         self._complete()
         self._flush()
     }
-
-    func clear() {
-        self._clear()
-        self._flush()
-    }
 }
 
 extension PercentRedrawingProgressAnimation {

Sources/Basics/ProgressAnimation/Concrete/PercentSingleLineProgressAnimation.swift

@@ -71,9 +71,10 @@ extension PercentSingleLineProgressAnimation: ProgressAnimationProtocol2 {
         self.terminal.flush()
     }
 
-    func draw() {}
+    func interleave(_ bytes: some Collection<UInt8>) {
+        self.terminal.write(bytes)
+        self.terminal.flush()
+    }
 
     func complete() {}
-
-    func clear() {}
 }

Sources/Basics/ProgressAnimation/Misc/ProgressAnimationProtocol2.swift

@@ -27,12 +27,16 @@ package protocol ProgressAnimationProtocol2 {
         event: ProgressTaskState,
         at time: ContinuousClock.Instant)
 
+    /// Interleave some other output with the progress animation.
+    func interleave(_ bytes: some Collection<UInt8>)
+
     /// Complete the animation.
     func complete()
-
-    /// Draw the animation.
-    func draw()
-
-    /// Clear the animation.
-    func clear()
 }
+
+extension ProgressAnimationProtocol2 {
+    /// Interleave some other output with the progress animation.
+    package func interleave(_ text: String) {
+        self.interleave(text.utf8)
+    }
+}

Sources/Basics/ProgressAnimation/Terminal/BlastTerminalController.swift

@@ -26,7 +26,12 @@ struct BlastTerminalController {
 
     /// Writes a string to the stream.
     mutating func write(_ text: String) {
-        self.buffer.write(text)
+        self.buffer.write(text.utf8)
+    }
+
+    /// Writes bytes to the stream.
+    mutating func write(_ bytes: some Collection<UInt8>) {
+        self.buffer.write(bytes)
     }
 
     mutating func newLine() {

Sources/Build/BuildOperation.swift

@@ -828,7 +828,6 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         let progressTracker = LLBuildProgressTracker(
             buildSystem: self,
             buildExecutionContext: buildExecutionContext,
-            outputStream: config.outputStream,
             progressAnimation: progressAnimation,
             logLevel: config.logLevel,
             observabilityScope: config.observabilityScope,

Sources/Build/LLBuildProgressTracker.swift

@@ -136,7 +136,6 @@ public protocol PackageStructureDelegate {
 
 /// Convenient llbuild build system delegate implementation
 final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOutputParserDelegate {
-    private let outputStream: ThreadSafeOutputByteStream
     private let progressAnimation: ProgressAnimationProtocol2
     private let logLevel: Basics.Diagnostic.Severity
     private weak var delegate: SPMBuildCore.BuildSystemDelegate?
@@ -159,17 +158,13 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
     init(
         buildSystem: SPMBuildCore.BuildSystem,
         buildExecutionContext: BuildExecutionContext,
-        outputStream: OutputByteStream,
         progressAnimation: ProgressAnimationProtocol2,
         logLevel: Basics.Diagnostic.Severity,
         observabilityScope: ObservabilityScope,
         delegate: SPMBuildCore.BuildSystemDelegate?
     ) {
         self.buildSystem = buildSystem
         self.buildExecutionContext = buildExecutionContext
-        // FIXME: Implement a class convenience initializer that does this once they are supported
-        // https://forums.swift.org/t/allow-self-x-in-class-convenience-initializers/15924
-        self.outputStream = outputStream as? ThreadSafeOutputByteStream ?? ThreadSafeOutputByteStream(outputStream)
         self.progressAnimation = progressAnimation
         self.taskTracker = .init(progressAnimation: progressAnimation)
         self.logLevel = logLevel
@@ -256,9 +251,7 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
             self.delegate?.buildSystem(self.buildSystem, didStartCommand: BuildSystemCommand(command))
 
             if self.logLevel.isVerbose {
-                self.progressAnimation.clear()
-                self.outputStream.send("\(command.verboseDescription)\n")
-                self.outputStream.flush()
+                self.progressAnimation.interleave("\(command.verboseDescription)\n")
             }
 
             self.taskTracker.commandStarted(
@@ -341,9 +334,7 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
             .result != .failed
         self.queue.async {
             if let buffer = self.nonSwiftMessageBuffers[command.name], !shouldFilterOutput {
-                self.progressAnimation.clear()
-                self.outputStream.send(buffer)
-                self.outputStream.flush()
+                self.progressAnimation.interleave(buffer)
                 self.nonSwiftMessageBuffers[command.name] = nil
             }
         }
@@ -365,8 +356,7 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
                         command: command.name,
                         message: errorMessage
                     ) {
-                        self.outputStream.send("note: \(adviceMessage)\n")
-                        self.outputStream.flush()
+                        self.progressAnimation.interleave("note: \(adviceMessage)\n")
                     }
                 }
             }
@@ -400,11 +390,9 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
     /// Invoked when an action taken before building emits output.
     /// when verboseOnly is set to true, the output will only be printed in verbose logging mode
     func preparationStepHadOutput(_ name: String, output: String, verboseOnly: Bool) {
-        self.queue.async {
-            if !verboseOnly || self.logLevel.isVerbose {
-                self.progressAnimation.clear()
-                self.outputStream.send("\(output.spm_chomp())\n")
-                self.outputStream.flush()
+        if !verboseOnly || self.logLevel.isVerbose {
+            self.queue.async {
+                self.progressAnimation.interleave("\(output.spm_chomp())\n")
             }
         }
     }
@@ -423,15 +411,11 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
         let now = ContinuousClock.now
         self.queue.async {
             if self.logLevel.isVerbose, let text = message.verboseProgressText {
-                self.progressAnimation.clear()
-                self.outputStream.send("\(text)\n")
-                self.outputStream.flush()
+                self.progressAnimation.interleave("\(text)\n")
             }
 
             if let output = message.standardOutput {
-                self.progressAnimation.clear()
-                self.outputStream.send(output)
-                self.outputStream.flush()
+                self.progressAnimation.interleave(output)
 
                 // next we want to try and scoop out any errors from the output (if reasonable size, otherwise this
                 // will be very slow), so they can later be passed to the advice provider in case of failure.
@@ -462,9 +446,7 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
         action: String
     ) {
         self.queue.sync {
-            self.progressAnimation.clear()
-            self.outputStream.send("\(action) for \(configuration == .debug ? "debugging" : "production")...\n")
-            self.outputStream.flush()
+            self.progressAnimation.interleave("\(action) for \(configuration == .debug ? "debugging" : "production")...\n")
         }
     }
 
@@ -483,10 +465,8 @@ final class LLBuildProgressTracker: LLBuildBuildSystemDelegate, SwiftCompilerOut
         self.queue.sync {
             self.progressAnimation.complete()
             if success {
-                self.progressAnimation.clear()
                 let result = self.cancelled ? "cancelled" : "complete"
-                self.outputStream.send("\(action) \(subsetString)\(result)! (\(duration.descriptionInSeconds))\n")
-                self.outputStream.flush()
+                self.progressAnimation.interleave("\(action) \(subsetString)\(result)! (\(duration.descriptionInSeconds))\n")
             }
         }
     }