Skip to content

deprecate global and process verbosity #290

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

Merged
merged 2 commits into from
Feb 21, 2022
Merged

deprecate global and process verbosity #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21331b6
deprecate global and process verbosity
tomerd Feb 8, 2022
a79476b
fixup
tomerd Feb 18, 2022
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
233 changes: 203 additions & 30 deletions Sources/TSCBasic/Process.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,64 @@ public final class Process {
/// Typealias for stdout/stderr output closure.
public typealias OutputClosure = ([UInt8]) -> Void

/// Global default setting for verbose.
public static var verbose = false
/// Typealias for logging handling closure
public typealias LoggingHandler = (String) -> Void

/// If true, prints the subprocess arguments before launching it.
public let verbose: Bool
private static var _loggingHandler: LoggingHandler?
private static let loggingHandlerLock = Lock()

/// Global logging handler. Use with care! preferably use instance level instead of setting one globally.
public static var loggingHandler: LoggingHandler? {
get {
Self.loggingHandlerLock.withLock {
self._loggingHandler
}
} set {
Self.loggingHandlerLock.withLock {
self._loggingHandler = newValue
}
}
}

// deprecated 2/2022, remove once client migrate to logging handler
@available(*, deprecated)
public static var verbose: Bool {
get {
Self.loggingHandler != nil
} set {
Self.loggingHandler = newValue ? Self.logToStdout: .none
}
}

private var _loggingHandler: LoggingHandler?

// the log and setter are only required to backward support verbose setter.
// remove and make loggingHandler a let property once verbose is deprecated
private let loggingHandlerLock = Lock()
public private(set) var loggingHandler: LoggingHandler? {
get {
self.loggingHandlerLock.withLock {
self._loggingHandler
}
}
set {
self.loggingHandlerLock.withLock {
self._loggingHandler = newValue
}
}
}

// deprecated 2/2022, remove once client migrate to logging handler
// also simplify loggingHandler (see above) once this is removed
@available(*, deprecated)
public var verbose: Bool {
get {
self.loggingHandler != nil
}
set {
self.loggingHandler = newValue ? Self.logToStdout : .none
}
}

/// The current environment.
@available(*, deprecated, message: "use ProcessEnv.vars instead")
Expand Down Expand Up @@ -238,6 +291,7 @@ public final class Process {
// process execution mutable state
private var state: State = .idle
private let stateLock = Lock()

private static let sharedCompletionQueue = DispatchQueue(label: "org.swift.tools-support-core.process-completion")
private var completionQueue = Process.sharedCompletionQueue

Expand Down Expand Up @@ -286,24 +340,50 @@ public final class Process {
/// will be inherited.
/// - workingDirectory: The path to the directory under which to run the process.
/// - outputRedirection: How process redirects its output. Default value is .collect.
/// - verbose: If true, launch() will print the arguments of the subprocess before launching it.
/// - startNewProcessGroup: If true, a new progress group is created for the child making it
/// continue running even if the parent is killed or interrupted. Default value is true.
/// - loggingHandler: Handler for logging messages
///
@available(macOS 10.15, *)
public init(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
workingDirectory: AbsolutePath,
outputRedirection: OutputRedirection = .collect,
verbose: Bool = Process.verbose,
startNewProcessGroup: Bool = true
startNewProcessGroup: Bool = true,
loggingHandler: LoggingHandler? = .none
) {
self.arguments = arguments
self.environment = environment
self.workingDirectory = workingDirectory
self.outputRedirection = outputRedirection
self.verbose = verbose
self.startNewProcessGroup = startNewProcessGroup
self.loggingHandler = loggingHandler ?? Process.loggingHandler
}

// deprecated 2/2022
@_disfavoredOverload
@available(*, deprecated, message: "use version without verbosity flag")
@available(macOS 10.15, *)
public convenience init(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
workingDirectory: AbsolutePath,
outputRedirection: OutputRedirection = .collect,
verbose: Bool,
startNewProcessGroup: Bool = true
) {
self.init(
arguments: arguments,
environment: environment,
workingDirectory: workingDirectory,
outputRedirection: outputRedirection,
startNewProcessGroup: startNewProcessGroup,
loggingHandler: verbose ? { message in
stdoutStream <<< message <<< "\n"
stdoutStream.flush()
} : nil
)
}

/// Create a new process instance.
Expand All @@ -316,19 +396,52 @@ public final class Process {
/// - verbose: If true, launch() will print the arguments of the subprocess before launching it.
/// - startNewProcessGroup: If true, a new progress group is created for the child making it
/// continue running even if the parent is killed or interrupted. Default value is true.
/// - loggingHandler: Handler for logging messages
public init(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
outputRedirection: OutputRedirection = .collect,
verbose: Bool = Process.verbose,
startNewProcessGroup: Bool = true
startNewProcessGroup: Bool = true,
loggingHandler: LoggingHandler? = .none
) {
self.arguments = arguments
self.environment = environment
self.workingDirectory = nil
self.outputRedirection = outputRedirection
self.verbose = verbose
self.startNewProcessGroup = startNewProcessGroup
self.loggingHandler = loggingHandler ?? Process.loggingHandler
}

@_disfavoredOverload
@available(*, deprecated, message: "user version without verbosity flag")
public convenience init(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
outputRedirection: OutputRedirection = .collect,
verbose: Bool = Process.verbose,
startNewProcessGroup: Bool = true
) {
self.init(
arguments: arguments,
environment: environment,
outputRedirection: outputRedirection,
startNewProcessGroup: startNewProcessGroup,
loggingHandler: verbose ? Self.logToStdout : .none
)
}

public convenience init(
args: String...,
environment: [String: String] = ProcessEnv.vars,
outputRedirection: OutputRedirection = .collect,
loggingHandler: LoggingHandler? = .none
) {
self.init(
arguments: args,
environment: environment,
outputRedirection: outputRedirection,
loggingHandler: loggingHandler
)
}

/// Returns the path of the the given program if found in the search paths.
Expand Down Expand Up @@ -393,9 +506,8 @@ public final class Process {
}

// Print the arguments if we are verbose.
if self.verbose {
stdoutStream <<< arguments.map({ $0.spm_shellEscaped() }).joined(separator: " ") <<< "\n"
stdoutStream.flush()
if let loggingHandler = self.loggingHandler {
loggingHandler(arguments.map({ $0.spm_shellEscaped() }).joined(separator: " "))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\n not needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not any more, it was for the stream itself. the handler will decide what to do with it now

}

// Look for executable.
Expand Down Expand Up @@ -832,11 +944,23 @@ extension Process {
/// - arguments: The arguments for the subprocess.
/// - environment: The environment to pass to subprocess. By default the current process environment
/// will be inherited.
/// - Returns: The process result.
static public func popen(arguments: [String], environment: [String: String] = ProcessEnv.vars,
queue: DispatchQueue? = nil, completion: @escaping (Result<ProcessResult, Swift.Error>) -> Void) {
/// - loggingHandler: Handler for logging messages
/// - queue: Queue to use for callbacks
/// - completion: A completion handler to return the process result
static public func popen(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
loggingHandler: LoggingHandler? = .none,
queue: DispatchQueue? = nil,
completion: @escaping (Result<ProcessResult, Swift.Error>) -> Void
) {
do {
let process = Process(arguments: arguments, environment: environment, outputRedirection: .collect)
let process = Process(
arguments: arguments,
environment: environment,
outputRedirection: .collect,
loggingHandler: loggingHandler
)
process.completionQueue = queue ?? Self.sharedCompletionQueue
try process.launch()
process.waitUntilExit(completion)
Expand All @@ -851,17 +975,39 @@ extension Process {
/// - arguments: The arguments for the subprocess.
/// - environment: The environment to pass to subprocess. By default the current process environment
/// will be inherited.
/// - loggingHandler: Handler for logging messages
/// - Returns: The process result.
@discardableResult
static public func popen(arguments: [String], environment: [String: String] = ProcessEnv.vars) throws -> ProcessResult {
let process = Process(arguments: arguments, environment: environment, outputRedirection: .collect)
static public func popen(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
loggingHandler: LoggingHandler? = .none
) throws -> ProcessResult {
let process = Process(
arguments: arguments,
environment: environment,
outputRedirection: .collect,
loggingHandler: loggingHandler
)
try process.launch()
return try process.waitUntilExit()
}

/// Execute a subprocess and block until it finishes execution
///
/// - Parameters:
/// - args: The arguments for the subprocess.
/// - environment: The environment to pass to subprocess. By default the current process environment
/// will be inherited.
/// - loggingHandler: Handler for logging messages
/// - Returns: The process result.
@discardableResult
static public func popen(args: String..., environment: [String: String] = ProcessEnv.vars) throws -> ProcessResult {
return try Process.popen(arguments: args, environment: environment)
static public func popen(
args: String...,
environment: [String: String] = ProcessEnv.vars,
loggingHandler: LoggingHandler? = .none
) throws -> ProcessResult {
return try Process.popen(arguments: args, environment: environment, loggingHandler: loggingHandler)
}

/// Execute a subprocess and get its (UTF-8) output if it has a non zero exit.
Expand All @@ -870,10 +1016,20 @@ extension Process {
/// - arguments: The arguments for the subprocess.
/// - environment: The environment to pass to subprocess. By default the current process environment
/// will be inherited.
/// - loggingHandler: Handler for logging messages
/// - Returns: The process output (stdout + stderr).
@discardableResult
static public func checkNonZeroExit(arguments: [String], environment: [String: String] = ProcessEnv.vars) throws -> String {
let process = Process(arguments: arguments, environment: environment, outputRedirection: .collect)
static public func checkNonZeroExit(
arguments: [String],
environment: [String: String] = ProcessEnv.vars,
loggingHandler: LoggingHandler? = .none
) throws -> String {
let process = Process(
arguments: arguments,
environment: environment,
outputRedirection: .collect,
loggingHandler: loggingHandler
)
try process.launch()
let result = try process.waitUntilExit()
// Throw if there was a non zero termination.
Expand All @@ -883,13 +1039,21 @@ extension Process {
return try result.utf8Output()
}

/// Execute a subprocess and get its (UTF-8) output if it has a non zero exit.
///
/// - Parameters:
/// - arguments: The arguments for the subprocess.
/// - environment: The environment to pass to subprocess. By default the current process environment
/// will be inherited.
/// - loggingHandler: Handler for logging messages
/// - Returns: The process output (stdout + stderr).
@discardableResult
static public func checkNonZeroExit(args: String..., environment: [String: String] = ProcessEnv.vars) throws -> String {
return try checkNonZeroExit(arguments: args, environment: environment)
}

public convenience init(args: String..., environment: [String: String] = ProcessEnv.vars, outputRedirection: OutputRedirection = .collect) {
self.init(arguments: args, environment: environment, outputRedirection: outputRedirection)
static public func checkNonZeroExit(
args: String...,
environment: [String: String] = ProcessEnv.vars,
loggingHandler: LoggingHandler? = .none
) throws -> String {
return try checkNonZeroExit(arguments: args, environment: environment, loggingHandler: loggingHandler)
}
}

Expand Down Expand Up @@ -1032,3 +1196,12 @@ extension FileHandle: WritableByteStream {
}
}
#endif


extension Process {
@available(*, deprecated)
fileprivate static func logToStdout(_ message: String) {
stdoutStream <<< message <<< "\n"
stdoutStream.flush()
}
}
4 changes: 4 additions & 0 deletions Sources/TSCUtility/Verbosity.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

// verbose 2/2022
@available(*, deprecated)
public enum Verbosity: Int {
case concise
case verbose
Expand Down Expand Up @@ -37,4 +39,6 @@ public enum Verbosity: Int {
}
}

// verbose 2/2022
@available(*, deprecated)
public var verbosity = Verbosity.concise