Merge pull request #276 from AvdLee/feature/console-configuration

kean · web-flow · commit 895fb6f8b03b · 2024-07-01T08:20:56.000-04:00
Console configuration
diff --git a/Pulse.xcodeproj/project.pbxproj b/Pulse.xcodeproj/project.pbxproj
@@ -275,6 +275,7 @@
 		0CFF79E229EC1FA200BE767B /* ImageProcessor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CFF79E029EC1F7800BE767B /* ImageProcessor.swift */; };
 		25E740012BE0FA58008C6DC3 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = 25E740002BE0FA58008C6DC3 /* PrivacyInfo.xcprivacy */; };
 		25E740072BE10B4C008C6DC3 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = 25E740062BE10B4C008C6DC3 /* PrivacyInfo.xcprivacy */; };
+		849DD7D92C32A9CE002D6787 /* ConsoleConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 849DD7D82C32A9CE002D6787 /* ConsoleConfiguration.swift */; };
 		E95D6C562B7314E6004D28E4 /* HARDocument.swift in Sources */ = {isa = PBXBuildFile; fileRef = E95D6C552B7314E6004D28E4 /* HARDocument.swift */; };
 /* End PBXBuildFile section */
 
@@ -737,6 +738,7 @@
 		25E740062BE10B4C008C6DC3 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
 		49E82A8526D107A00070244F /* AlamofireIntegration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlamofireIntegration.swift; sourceTree = "<group>"; };
 		49E82A8826D1083D0070244F /* MoyaIntegration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MoyaIntegration.swift; sourceTree = "<group>"; };
+		849DD7D82C32A9CE002D6787 /* ConsoleConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConsoleConfiguration.swift; sourceTree = "<group>"; };
 		E95D6C552B7314E6004D28E4 /* HARDocument.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HARDocument.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -1398,6 +1400,7 @@
 				0CA2632D2BFA3855003C8E97 /* ConsoleDelegate.swift */,
 				0CF0D60A296F189600EED9D4 /* ConsoleEnvironment.swift */,
 				0CECF63C2996BE12000F9CCD /* ConsoleDataSource.swift */,
+				849DD7D82C32A9CE002D6787 /* ConsoleConfiguration.swift */,
 			);
 			path = Console;
 			sourceTree = "<group>";
@@ -2136,6 +2139,7 @@
 				0CDC3BED2971B936003BD1FF /* ConsoleSearchLogLevelsCell.swift in Sources */,
 				0CF0D620296F189600EED9D4 /* Foundation+Extensions.swift in Sources */,
 				0CF0D66C296F189600EED9D4 /* NetworkRequestInfoCell.swift in Sources */,
+				849DD7D92C32A9CE002D6787 /* ConsoleConfiguration.swift in Sources */,
 				0CB63A15297438A600525165 /* ConsoleSearchViewModel.swift in Sources */,
 				0CF0D632296F189600EED9D4 /* ShareStoreView.swift in Sources */,
 				0C9751582A32CCC400DC46FF /* RemoteLoggerEnterPasswordView.swift in Sources */,
diff --git a/Sources/PulseUI/Features/Console/ConsoleConfiguration.swift b/Sources/PulseUI/Features/Console/ConsoleConfiguration.swift
@@ -0,0 +1,26 @@
+// The MIT License (MIT)
+//
+//  Created by A.J. van der Lee on 01/07/2024.
+//  Copyright © 2024 kean. All rights reserved.
+//
+
+import Foundation
+
+/// Defines UI configurations to enable/disable elements or change behavior.
+public struct ConsoleConfiguration {
+    public static let `default` = ConsoleConfiguration()
+    
+    let shareStoreOutputs: [ShareStoreOutput]
+    let allowRemoteLogging: Bool
+    
+    /// Creates a new `ConsoleConfiguration`
+    /// - Parameter shareStoreOutputs: The available store share outputs. Defaults to `allCases`.
+    /// - Parameter allowRemoteLogging: Enable/disable the remote logging option.
+    public init(
+        shareStoreOutputs: [ShareStoreOutput] = ShareStoreOutput.allCases,
+        allowRemoteLogging: Bool = true
+    ) {
+        self.shareStoreOutputs = shareStoreOutputs
+        self.allowRemoteLogging = allowRemoteLogging
+    }
+}
diff --git a/Sources/PulseUI/Features/Console/ConsoleEnvironment.swift b/Sources/PulseUI/Features/Console/ConsoleEnvironment.swift
@@ -25,6 +25,7 @@ final class ConsoleEnvironment: ObservableObject {
 
     let initialMode: ConsoleMode
     let delegate: ConsoleViewDelegate
+    let configuration: ConsoleConfiguration
 
     @Published var mode: ConsoleMode
     @Published var listOptions: ConsoleListOptions = .init()
@@ -39,7 +40,7 @@ final class ConsoleEnvironment: ObservableObject {
 
     private var cancellables: [AnyCancellable] = []
 
-    init(store: LoggerStore, mode: ConsoleMode = .all, delegate: ConsoleViewDelegate = DefaultConsoleViewDelegate()) {
+    init(store: LoggerStore, mode: ConsoleMode = .all, configuration: ConsoleConfiguration = .default, delegate: ConsoleViewDelegate = DefaultConsoleViewDelegate()) {
         self.store = store
         switch mode {
         case .all: self.title = "Console"
@@ -55,6 +56,7 @@ final class ConsoleEnvironment: ObservableObject {
         }
 
         self.delegate = delegate
+        self.configuration = configuration
 
         func makeDefaultOptions() -> ConsoleDataSource.PredicateOptions {
             var options = ConsoleDataSource.PredicateOptions()
diff --git a/Sources/PulseUI/Features/Console/ConsoleView.swift b/Sources/PulseUI/Features/Console/ConsoleView.swift
@@ -9,19 +9,21 @@ import Combine
 
 extension ConsoleView {
     /// Initializes the console view.
-    ///
+    /// 
     /// - parameters:
     ///   - store: The store to display. By default, `LoggerStore/shared`.
     ///   - mode: The initial console mode. By default, ``ConsoleMode/all``. If you change
     ///   the mode to ``ConsoleMode/network``, the console will display the
     ///   network messages up on appearance.
+    ///   - configuration: Configuration options to alter the UI behavior and settings.
     ///   - delegate: The delegate that allows you to customize multiple aspects
     ///   of the console view.
     public init(
         store: LoggerStore = .shared,
         mode: ConsoleMode = .all,
+        configuration: ConsoleConfiguration = .default,
         delegate: ConsoleViewDelegate? = nil
     ) {
-        self.init(environment: .init(store: store, mode: mode, delegate: delegate ?? DefaultConsoleViewDelegate()))
+        self.init(environment: .init(store: store, mode: mode, configuration: configuration, delegate: delegate ?? DefaultConsoleViewDelegate()))
     }
 }
diff --git a/Sources/PulseUI/Features/Settings/SettingsView-macos.swift b/Sources/PulseUI/Features/Settings/SettingsView-macos.swift
@@ -12,14 +12,17 @@ struct SettingsView: View {
     @State private var shareItems: ShareItems?
 
     @Environment(\.store) private var store
+    @EnvironmentObject private var environment: ConsoleEnvironment
 
     var body: some View {
         List {
-            if store === RemoteLogger.shared.store {
-                RemoteLoggerSettingsView(viewModel: .shared)
-            } else {
-                Text("Not available")
-                    .foregroundColor(.secondary)
+            if environment.configuration.allowRemoteLogging {
+                if store === RemoteLogger.shared.store {
+                    RemoteLoggerSettingsView(viewModel: .shared)
+                } else {
+                    Text("Not available")
+                        .foregroundColor(.secondary)
+                }
             }
             Section(header: Text("Store")) {
                 if #available(macOS 13, *), let info = try? store.info() {
diff --git a/Sources/PulseUI/Helpers/ShareItems.swift b/Sources/PulseUI/Helpers/ShareItems.swift
@@ -6,7 +6,7 @@ import Foundation
 import Pulse
 import CoreData
 
-public enum ShareStoreOutput: String, RawRepresentable {
+public enum ShareStoreOutput: String, RawRepresentable, CaseIterable {
     case store, package, text, html, har
 
     var fileExtension: String {
@@ -17,6 +17,16 @@ public enum ShareStoreOutput: String, RawRepresentable {
         case .har: return "har"
         }
     }
+    
+    var interfaceTitle: String {
+        switch self {
+        case .store: "Pulse"
+        case .package: "Pulse (Package)"
+        case .text: "Plain Text"
+        case .html: "HTML"
+        case .har: "HAR"
+        }
+    }
 }
 
 struct ShareItems: Identifiable {
diff --git a/Sources/PulseUI/Views/ShareStoreView.swift b/Sources/PulseUI/Views/ShareStoreView.swift
@@ -20,6 +20,7 @@ struct ShareStoreView: View {
     @StateObject private var viewModel = ShareStoreViewModel()
 
     @Environment(\.store) private var store: LoggerStore
+    @EnvironmentObject private var environment: ConsoleEnvironment
 
     var body: some View {
         content
@@ -30,6 +31,7 @@ struct ShareStoreView: View {
                     viewModel.sessions = [store.session.id]
                 }
                 viewModel.store = store
+                viewModel.environment = environment
             }
     }
 
@@ -95,12 +97,12 @@ struct ShareStoreView: View {
         }
         Section {
             Picker("Output", selection: $viewModel.output) {
-                Text("Pulse").tag(ShareStoreOutput.store)
-                Text("Plain Text").tag(ShareStoreOutput.text)
-                Text("HTML").tag(ShareStoreOutput.html)
-                Text("HAR").tag(ShareStoreOutput.har)
-                Divider()
-                Text("Pulse (Package)").tag(ShareStoreOutput.package)
+                ForEach(viewModel.shareStoreOutputs, id: \.rawValue) { shareOutput in
+                    if shareOutput == .package {
+                        Divider()
+                    }
+                    Text(shareOutput.interfaceTitle).tag(shareOutput)
+                }
             }
 #if os(macOS)
             .labelsHidden()
diff --git a/Sources/PulseUI/Views/ShareStoreViewModel.swift b/Sources/PulseUI/Views/ShareStoreViewModel.swift
@@ -13,13 +13,19 @@ import Combine
     // Sharing options
     @Published var sessions: Set<UUID> = []
     @Published var logLevels = Set(LoggerStore.Level.allCases)
+    @Published var shareStoreOutputs: [ShareStoreOutput] = ShareStoreOutput.allCases
     @Published var output: ShareStoreOutput
 
     @Published private(set) var isPreparingForSharing = false
     @Published private(set) var errorMessage: String?
     @Published var shareItems: ShareItems?
 
     var store: LoggerStore?
+    var environment: ConsoleEnvironment? {
+        didSet {
+            updateForCurrentEnvironment()
+        }
+    }
 
     init() {
         output = UserSettings.shared.sharingOutput
@@ -31,6 +37,26 @@ import Combine
         saveSharingOptions()
         prepareForSharing()
     }
+    
+    private func updateForCurrentEnvironment() {
+        guard let environment else { return }
+        shareStoreOutputs = environment.configuration.shareStoreOutputs.sorted(by: { lhs, rhs in
+            /// Make sure the .package is always last since we show a Divider() in front of it.
+            switch (lhs, rhs) {
+            case (.package, _):
+                return false
+            case (_, .package):
+                return true
+            default:
+                return lhs.rawValue < rhs.rawValue
+            }
+        })
+        
+        if !shareStoreOutputs.contains(output), let shareStoreOutput = shareStoreOutputs.first {
+            /// Update the selected output to one of the available options.
+            output = shareStoreOutput
+        }
+    }
 
     private func saveSharingOptions() {
         UserSettings.shared.sharingOutput = output
