[fix]: short circuit worker logging & require explicit opt-in

square · Jun 18, 2024 · 21f66c7 · 21f66c7
1 parent 15d7d29
commit 21f66c7
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 2 deletions.
diff --git a/WorkflowCombine/Sources/Logger.swift b/WorkflowCombine/Sources/Logger.swift
@@ -14,8 +14,14 @@
  * limitations under the License.
  */
 
+import Foundation
 import os.signpost
 
+private let workerLoggingEnabled: Bool = {
+    let env = ProcessInfo.processInfo.environment
+    return env["com.squareup.workflow.workerLogging"] != nil
+}()
+
 private extension OSLog {
     static let worker = OSLog(subsystem: "com.squareup.WorkflowCombine", category: "Worker")
 }
@@ -29,6 +35,8 @@ final class WorkerLogger<WorkerType: Worker> {
     // MARK: - Workers
 
     func logStarted() {
+        guard workerLoggingEnabled else { return }
+
         os_signpost(
             .begin,
             log: .worker,
@@ -40,6 +48,8 @@ final class WorkerLogger<WorkerType: Worker> {
     }
 
     func logFinished(status: StaticString) {
+        guard workerLoggingEnabled else { return }
+
         os_signpost(
             .end,
             log: .worker,
@@ -50,6 +60,8 @@ final class WorkerLogger<WorkerType: Worker> {
     }
 
     func logOutput() {
+        guard workerLoggingEnabled else { return }
+
         os_signpost(
             .event,
             log: .worker,

diff --git a/WorkflowConcurrency/Sources/Logger.swift b/WorkflowConcurrency/Sources/Logger.swift
@@ -14,8 +14,14 @@
  * limitations under the License.
  */
 
+import Foundation
 import os.signpost
 
+private let workerLoggingEnabled: Bool = {
+    let env = ProcessInfo.processInfo.environment
+    return env["com.squareup.workflow.workerLogging"] != nil
+}()
+
 private extension OSLog {
     static let worker = OSLog(subsystem: "com.squareup.WorkflowConcurrency", category: "Worker")
 }
@@ -29,6 +35,8 @@ final class WorkerLogger<WorkerType: Worker> {
     // MARK: - Workers
 
     func logStarted() {
+        guard workerLoggingEnabled else { return }
+
         os_signpost(
             .begin,
             log: .worker,
@@ -40,6 +48,8 @@ final class WorkerLogger<WorkerType: Worker> {
     }
 
     func logFinished(status: StaticString) {
+        guard workerLoggingEnabled else { return }
+
         os_signpost(
             .end,
             log: .worker,
@@ -50,6 +60,8 @@ final class WorkerLogger<WorkerType: Worker> {
     }
 
     func logOutput() {
+        guard workerLoggingEnabled else { return }
+
         os_signpost(
             .event,
             log: .worker,

diff --git a/WorkflowReactiveSwift/Sources/Logger.swift b/WorkflowReactiveSwift/Sources/Logger.swift
@@ -14,11 +14,17 @@
  * limitations under the License.
  */
 
+import Foundation
 import os.signpost
 
 // Namespace for Worker logging
 public enum WorkerLogging {}
 
+private let workerLoggingEnabled: Bool = {
+    let env = ProcessInfo.processInfo.environment
+    return env["com.squareup.workflow.workerLogging"] != nil
+}()
+
 extension WorkerLogging {
     public static var enabled: Bool {
         get { OSLog.active === OSLog.worker }
@@ -29,7 +35,9 @@ extension WorkerLogging {
 private extension OSLog {
     static let worker = OSLog(subsystem: "com.squareup.WorkflowReactiveSwift", category: "Worker")
 
-    static var active: OSLog = .disabled
+    static var active: OSLog = {
+        workerLoggingEnabled ? .worker : .disabled
+    }()
 }
 
 // MARK: -
@@ -43,6 +51,8 @@ final class WorkerLogger<WorkerType: Worker> {
     // MARK: - Workers
 
     func logStarted() {
+        guard WorkerLogging.enabled else { return }
+
         os_signpost(
             .begin,
             log: .active,
@@ -54,10 +64,14 @@ final class WorkerLogger<WorkerType: Worker> {
     }
 
     func logFinished(status: StaticString) {
+        guard WorkerLogging.enabled else { return }
+
         os_signpost(.end, log: .active, name: "Running", signpostID: signpostID, status)
     }
 
     func logOutput() {
+        guard WorkerLogging.enabled else { return }
+
         os_signpost(
             .event,
             log: .active,

diff --git a/WorkflowRxSwift/Sources/Logger.swift b/WorkflowRxSwift/Sources/Logger.swift
@@ -14,11 +14,17 @@
  * limitations under the License.
  */
 
+import Foundation
 import os.signpost
 
 // Namespace for Worker logging
 public enum WorkerLogging {}
 
+private let workerLoggingEnabled: Bool = {
+    let env = ProcessInfo.processInfo.environment
+    return env["com.squareup.workflow.workerLogging"] != nil
+}()
+
 extension WorkerLogging {
     public static var enabled: Bool {
         get { OSLog.active === OSLog.worker }
@@ -29,7 +35,9 @@ extension WorkerLogging {
 private extension OSLog {
     static let worker = OSLog(subsystem: "com.squareup.WorkflowRxSwift", category: "Worker")
 
-    static var active: OSLog = .disabled
+    static var active: OSLog = {
+        workerLoggingEnabled ? .worker : .disabled
+    }()
 }
 
 // MARK: -
@@ -43,6 +51,8 @@ final class WorkerLogger<WorkerType: Worker> {
     // MARK: - Workers
 
     func logStarted() {
+        guard WorkerLogging.enabled else { return }
+
         os_signpost(
             .begin,
             log: .active,
@@ -54,10 +64,14 @@ final class WorkerLogger<WorkerType: Worker> {
     }
 
     func logFinished(status: StaticString) {
+        guard WorkerLogging.enabled else { return }
+
         os_signpost(.end, log: .active, name: "Running", signpostID: signpostID, status)
     }
 
     func logOutput() {
+        guard WorkerLogging.enabled else { return }
+
         os_signpost(
             .event,
             log: .active,