Add Loggable protocol for state and dependency

0xLeif · Sep 19, 2024 · 691b5de · 691b5de
1 parent 3b73abe
commit 691b5de
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/Sources/AppState/Application/Application+internal.swift b/Sources/AppState/Application/Application+internal.swift
@@ -3,7 +3,11 @@ extension Application {
     static var cacheDescription: String {
         shared.cache.allValues
             .map { key, value in
-                "\t- \(value)"
+                if let value = value as? Loggable {
+                    "\t- \(value.logValue)"
+                } else {
+                    "\t- \(value)"
+                }
             }
             .sorted(by: <)
             .joined(separator: "\n")

diff --git a/Sources/AppState/Application/Types/Dependency/Application+Dependency.swift b/Sources/AppState/Application/Types/Dependency/Application+Dependency.swift
@@ -4,7 +4,7 @@ extension Application {
     }
 
     /// `Dependency` struct encapsulates dependencies used throughout the app.
-    public struct Dependency<Value: Sendable>: CustomStringConvertible, Sendable {
+    public struct Dependency<Value: Sendable>: Sendable, Loggable {
         /// The dependency value.
         var value: Value
 
@@ -28,7 +28,7 @@ extension Application {
             self.scope = scope
         }
 
-        public var description: String {
+        public var logValue: String {
             "Dependency<\(Value.self)>(\(value)) (\(scope.key))"
         }
     }

diff --git a/Sources/AppState/Application/Types/Helper/Loggable.swift b/Sources/AppState/Application/Types/Helper/Loggable.swift
@@ -0,0 +1,4 @@
+protocol Loggable {
+    @MainActor
+    var logValue: String { get }
+}
diff --git a/Sources/AppState/Application/Types/State/Application+State.swift b/Sources/AppState/Application/Types/State/Application+State.swift
@@ -2,7 +2,7 @@ import Foundation
 
 extension Application {
     /// `State` encapsulates the value within the application's scope and allows any changes to be propagated throughout the scoped area.
-    public struct State<Value: Sendable>: MutableApplicationState, Sendable {
+    public struct State<Value: Sendable>: Sendable, MutableApplicationState, Loggable {
         /// Values that are available in the cache.
         enum StateType {
             case state
@@ -98,7 +98,7 @@ extension Application {
         }
 
         @MainActor
-        public var description: String {
+        public var logValue: String {
             switch type {
             case .state:    return "State<\(Value.self)>(\(value)) (\(scope.key))"
             case .stored:   return "StoredState<\(Value.self)>(\(value)) (\(scope.key))"