Skip to content

fix: debug logging for large/binary output #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danpalmer wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: debug logging for large/binary output #214

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8b2bfe
Fix debug logging for large/binary output
danpalmer Mar 3, 2025
86facd5
Fix type
danpalmer Mar 3, 2025
5857269
Fix autoclosure
danpalmer Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions Sources/Command/CommandRunner.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,11 @@ public enum CommandError: Error, CustomStringConvertible, Sendable {

public struct CommandRunner: CommandRunning, Sendable {
let logger: Logger?
let debugLogAsUTF8: Bool

public init(logger: Logger? = nil) {
public init(logger: Logger? = nil, debugLogAsUTF8: Bool = false) {
self.logger = logger
self.debugLogAsUTF8 = debugLogAsUTF8
}

// swiftlint:disable:next function_body_length
Expand All @@ -144,7 +146,7 @@ public struct CommandRunner: CommandRunning, Sendable {
workingDirectory = try! .init(validating: FileManager.default.currentDirectoryPath)
}

let collectedStdErr: ThreadSafe<String> = ThreadSafe("")
let collectedStdErr: ThreadSafe<Data> = ThreadSafe(.init())

// Process
let process = Process()
Expand All @@ -155,8 +157,14 @@ public struct CommandRunner: CommandRunning, Sendable {
do {
for try await data in stdoutPipe.fileHandleForReading.byteStream() {
continuation.yield(.standardOutput([UInt8](data)))
if let output = String(data: data, encoding: .utf8) {
logger?.debug("\(output)", metadata: loggerMetadata)
if debugLogAsUTF8 {
logger?.debug({
if let output = String(data: data, encoding: .utf8) {
return "\(output)"
} else {
return "\(data)"
}
}(), metadata: loggerMetadata)
}
}
} catch {
Expand All @@ -168,9 +176,15 @@ public struct CommandRunner: CommandRunning, Sendable {
do {
for try await data in stderrPipe.fileHandleForReading.byteStream() {
continuation.yield(.standardError([UInt8](data)))
if let output = String(data: data, encoding: .utf8) {
collectedStdErr.mutate { $0.append(output) }
logger?.error("\(output)", metadata: loggerMetadata)
collectedStdErr.mutate { $0.append(data) }
if debugLogAsUTF8 {
logger?.debug({
if let output = String(data: data, encoding: .utf8) {
return "\(output)"
} else {
return "\(data)"
}
}(), metadata: loggerMetadata)
}
}
} catch {
Expand Down Expand Up @@ -217,7 +231,8 @@ public struct CommandRunner: CommandRunning, Sendable {
switch process.terminationReason {
case .exit:
if process.terminationStatus != 0 {
throw CommandError.terminated(process.terminationStatus, stderr: collectedStdErr.value)
let stderr = String(data: collectedStdErr.value, encoding: .utf8) ?? "Failed to decode stderr"
throw CommandError.terminated(process.terminationStatus, stderr: stderr)
}
case .uncaughtSignal:
if process.terminationStatus != 0 {
Expand Down
Loading