Improve internal Logger (#2361)

Sources/MapboxMaps/Annotations/Annotation.swift

@@ -87,7 +87,7 @@ extension Array where Element: Annotation {
         let duplicates = self.removeDuplicates(by: \.id)
         if !duplicates.isEmpty {
             let ids = duplicates.lazy.map(\.id).joined(separator: ", ")
-            Log.error(forMessage: "Duplicated annotations: \(ids)", category: "Annotations")
+            Log.error("Duplicated annotations: \(ids)", category: "Annotations")
         }
     }
 }

Sources/MapboxMaps/Annotations/AnnotationImagesManager.swift

@@ -60,7 +60,7 @@ internal final class AnnotationImagesManager: AnnotationImagesManagerProtocol {
             addedAnnotationImages.insert(id)
         } catch {
             Log.warning(
-                forMessage: "Could not add image to style due to error: \(error)",
+                "Could not add image to style due to error: \(error)",
                 category: "Annnotations")
         }
     }
@@ -75,7 +75,7 @@ internal final class AnnotationImagesManager: AnnotationImagesManagerProtocol {
             addedAnnotationImages.remove(imageName)
         } catch {
             Log.warning(
-                forMessage: "Could not remove image from style due to error: \(error)",
+                "Could not remove image from style due to error: \(error)",
                 category: "Annnotations")
         }
     }

Sources/MapboxMaps/Annotations/AnnotationManagerImpl.swift

@@ -96,7 +96,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
             do {
                 try style.moveLayer(withId: id, to: layerPosition ?? .default)
             } catch {
-                Log.error(forMessage: "Failed to mover layer to a new position. Error: \(error)", category: "Annotations")
+                Log.error("Failed to mover layer to a new position. Error: \(error)", category: "Annotations")
             }
         }
     }
@@ -135,7 +135,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
             try style.addPersistentLayer(layer, layerPosition: layerPosition)
         } catch {
             Log.error(
-                forMessage: "Failed to create source / layer in \(implementationName). Error: \(error)",
+                "Failed to create source / layer in \(implementationName). Error: \(error)",
                 category: "Annotations")
         }
 
@@ -160,7 +160,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
             )
         } catch {
             Log.error(
-                forMessage: "Failed to add cluster layer in \(implementationName). Error: \(error)",
+                "Failed to add cluster layer in \(implementationName). Error: \(error)",
                 category: "Annotations")
         }
     }
@@ -197,7 +197,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
             try style.removeLayer(withId: "mapbox-iOS-cluster-text-layer-manager-" + id)
         } catch {
             Log.error(
-                forMessage: "Failed to remove cluster layer in \(implementationName). Error: \(error)",
+                "Failed to remove cluster layer in \(implementationName). Error: \(error)",
                 category: "Annotations")
         }
     }
@@ -232,7 +232,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
                 try body()
             } catch {
                 Log.warning(
-                    forMessage: "Failed to remove \(what) for \(implementationName) with id \(id) due to error: \(error)",
+                    "Failed to remove \(what) for \(implementationName) with id \(id) due to error: \(error)",
                     category: "Annotations")
             }
         }
@@ -326,7 +326,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
             }
         } catch {
             Log.error(
-                forMessage: "Could not set layer properties in PointAnnotationManager due to error \(error)",
+                "Could not set layer properties in PointAnnotationManager due to error \(error)",
                 category: "Annotations")
         }
     }
@@ -500,7 +500,7 @@ final class AnnotationManagerImpl<AnnotationType: Annotation & AnnotationInterna
                 try style.addSource(GeoJSONSource(id: dragId))
                 try style.addPersistentLayer(AnnotationType.makeLayer(id: dragId), layerPosition: .above(id))
             } catch {
-                Log.error(forMessage: "Add drag source/layer \(error)", category: "Annotations")
+                Log.error("Add drag source/layer \(error)", category: "Annotations")
             }
         }
     }

Sources/MapboxMaps/Annotations/AnnotationOrchestrator.swift

@@ -170,7 +170,7 @@ public final class AnnotationOrchestrator {
 
         if let manager, warnIfRemoved {
             Log.warning(
-                forMessage: "\(type(of: manager)) with id \(id) was removed implicitly when invoking \(function) with the same id.",
+                "\(type(of: manager)) with id \(id) was removed implicitly when invoking \(function) with the same id.",
                 category: "Annotations")
         }
     }

Sources/MapboxMaps/Annotations/ViewAnnotation.swift

@@ -357,7 +357,7 @@ public final class ViewAnnotation {
         do {
             try body()
         } catch {
-            Log.error(forMessage: "Failed to \(action) annotation \(id): \(error)", category: "ViewAnnotation")
+            Log.error("Failed to \(action) annotation \(id): \(error)", category: "ViewAnnotation")
         }
     }
 

Sources/MapboxMaps/Annotations/ViewAnnotationManager.swift

@@ -580,7 +580,7 @@ extension ViewAnnotationManager {
 func validateAnnotationSuperview(_ view: UIView, expected: UIView?) {
     // Re-add the view if the superview of the annotation view is different than the container
     if view.superview != expected {
-        Log.warning(forMessage: "Superview changed for annotation view. Use `ViewAnnotationManager.remove(_ view: UIView)` instead to remove it from the layout calculation.", category: "Annotations")
+        Log.warning("Superview changed for annotation view. Use `ViewAnnotationManager.remove(_ view: UIView)` instead to remove it from the layout calculation.", category: "Annotations")
         view.removeFromSuperview()
         expected?.addSubview(view)
     }
@@ -589,7 +589,7 @@ func validateAnnotationSuperview(_ view: UIView, expected: UIView?) {
 func validateAnnotationHidden(_ view: UIView, expected: Bool) {
     // View is still considered for layout calculation, users should not modify the visibility of view directly
     if view.isHidden != expected {
-        Log.warning(forMessage: "Visibility changed for annotation view. Use `ViewAnnotationManager.update(view: UIView, options: ViewAnnotationOptions)` instead to update visibility and remove the view from layout calculation.", category: "Annotations")
+        Log.warning("Visibility changed for annotation view. Use `ViewAnnotationManager.update(view: UIView, options: ViewAnnotationOptions)` instead to update visibility and remove the view from layout calculation.", category: "Annotations")
         view.isHidden = expected
     }
 }

Sources/MapboxMaps/Camera/SimpleCameraAnimator.swift

@@ -44,7 +44,7 @@ internal final class SimpleCameraAnimator: SimpleCameraAnimatorProtocol {
                 hasNilMismatch(for: \.anchor) ||
                 hasNilMismatch(for: \.bearing) ||
                 hasNilMismatch(for: \.pitch) {
-                Log.warning(forMessage: "Animator updated with differing non-nil to-value properties.", category: "maps-ios")
+                Log.warning("Animator updated with differing non-nil to-value properties.", category: "maps-ios")
             }
         }
     }

Sources/MapboxMaps/ContentBuilders/MapContent/MapContentUniqueProperties.swift

@@ -81,7 +81,7 @@ extension MapContentUniqueProperties {
                 case .flat:
                     lights.flat = try? lightContainer.decode(FlatLight.self)
                 default:
-                    Log.warning(forMessage: "Incorrect light configuration. Specify both directional and ambient lights OR flat light.", category: "StyleDSL")
+                    Log.warning("Incorrect light configuration. Specify both directional and ambient lights OR flat light.", category: "StyleDSL")
                 }
             }
         }
@@ -96,7 +96,7 @@ private extension MapContentUniqueProperties.Lights {
                     os_log(.debug, log: .contentDSL, "set 3d lights")
                     try style.setLights(ambient: ambient, directional: directional)
                 } else if directional != nil || ambient != nil {
-                    Log.warning(forMessage: "Incorrect 3D light configuration. Specify both directional and ambient lights.", category: "StyleDSL")
+                    Log.warning("Incorrect 3D light configuration. Specify both directional and ambient lights.", category: "StyleDSL")
                 } else if let flat = flat {
                     os_log(.debug, log: .contentDSL, "set flat light")
                     try style.setLights(flat)

Sources/MapboxMaps/ContentBuilders/MapContent/MapStyleReconciler.swift

@@ -124,7 +124,7 @@ extension MapStyleReconciler {
                 }
             }
         } catch {
-            Log.error(forMessage: "Failed updating import config properties, \(error)")
+            Log.error("Failed updating import config properties, \(error)")
         }
     }
 }

Sources/MapboxMaps/ContentBuilders/MapContent/MountedViewAnnotation.swift

@@ -70,7 +70,7 @@ final class MountedViewAnnotation: MapContentMountedComponent {
 
     func unmount(with context: MapContentNodeContext) throws {
         guard let remove else {
-            return Log.error(forMessage: "Could not remove the view annotation", category: "Annotations")
+            return Log.error("Could not remove the view annotation", category: "Annotations")
         }
         remove()
     }

Sources/MapboxMaps/ContentBuilders/Tree/MapContentNode.swift

@@ -99,7 +99,7 @@ final class MapContentNode: Identifiable {
                     return
                 }
             } catch {
-                Log.error(forMessage: "\(error)", category: "StyleDSL")
+                Log.error("\(error)", category: "StyleDSL")
             }
 
         }
@@ -160,7 +160,7 @@ func wrapStyleDSLError(_ closure: () throws -> Void) {
     do {
         try closure()
     } catch {
-        Log.error(forMessage: "\(error)", category: "StyleDSL")
+        Log.error("\(error)", category: "StyleDSL")
     }
 }
 

Sources/MapboxMaps/ContentBuilders/Tree/MapContentReconciler.swift

@@ -113,7 +113,7 @@ private extension MapContentNodeContext {
                 initialMapUniqueProperties.transition = TransitionOptions(style.styleManager.getStyleTransition())
                 return initialMapUniqueProperties
             } catch {
-                Log.warning(forMessage: "Unable to decode initial MapContentUniqueProperties \(error) from StyleJSON", category: "StyleDSL")
+                Log.warning("Unable to decode initial MapContentUniqueProperties \(error) from StyleJSON", category: "StyleDSL")
                 return nil
             }
         }

Sources/MapboxMaps/Foundation/Extensions/Core/RenderedQueryOptions.swift

@@ -13,7 +13,7 @@ extension RenderedQueryOptions {
             do {
                 filterJson = try filter.toJSON()
             } catch {
-                Log.error(forMessage: "Filter expression could not be encoded", category: "RenderedQueryOptions")
+                Log.error("Filter expression could not be encoded", category: "RenderedQueryOptions")
             }
         }
 
@@ -30,7 +30,7 @@ extension RenderedQueryOptions {
             let filterData = try JSONSerialization.data(withJSONObject: filter, options: [])
             filterExp = try JSONDecoder().decode(Exp.self, from: filterData)
         } catch {
-            Log.error(forMessage: "Filter expression could not be decoded", category: "RenderedQueryOptions")
+            Log.error("Filter expression could not be decoded", category: "RenderedQueryOptions")
         }
 
         return filterExp

Sources/MapboxMaps/Foundation/Extensions/Image.swift

@@ -10,7 +10,7 @@ extension CoreMapsImage {
     ///   - uiImage: The source image.
     internal convenience init?(uiImage: UIImage) {
         guard let data = Data(uiImage: uiImage) else {
-            Log.warning(forMessage: "Failed to convert UIImage")
+            Log.warning("Failed to convert UIImage")
             return nil
         }
 

Sources/MapboxMaps/Foundation/Extensions/UIWindow+ParentScene.swift

@@ -49,7 +49,7 @@ extension UIScene {
             }
         }
 #endif
-        Log.info(forMessage: "Found no window attached to the current scene: \(self)")
+        Log.info("Found no window attached to the current scene: \(self)")
         return []
     }
 }

Sources/MapboxMaps/Foundation/Logger.swift

@@ -1,30 +1,64 @@
 import Foundation
 @_implementationOnly import MapboxCommon_Private.MBXLog_Internal
 
-internal struct Log {
+/// A logging utility with MapboxCommon backend by default.
+@_spi(Logging) public struct Log {
     private typealias Logger = MapboxCommon_Private.Log
 
     private static func logCategory(_ additionalCategory: String?) -> String {
         let logPrefix = "maps-ios"
-        guard let additionalCategory = additionalCategory else {
+        guard let additionalCategory = additionalCategory, !additionalCategory.isEmpty else {
             return logPrefix
         }
         return "\(logPrefix)/\(additionalCategory)"
     }
 
-    internal static func debug(forMessage message: String, category: String? = nil) {
-        Logger.debug(forMessage: message, category: logCategory(category))
+    /// Log a debug message.
+    @_spi(Logging) public static func debug(_ message: String, category: Category? = nil) {
+        Logger.debug(forMessage: message, category: logCategory(category?.rawValue))
     }
 
-    internal static func info(forMessage message: String, category: String? = nil) {
-        Logger.info(forMessage: message, category: logCategory(category))
+    /// Log an info message.
+    @_spi(Logging) public static func info(_ message: String, category: Category? = nil) {
+        Logger.info(forMessage: message, category: logCategory(category?.rawValue))
     }
 
-    internal static func warning(forMessage message: String, category: String? = nil) {
-        Logger.warning(forMessage: message, category: logCategory(category))
+    /// Log a warning message.
+    @_spi(Logging) public static func warning(_ message: String, category: Category? = nil) {
+        Logger.warning(forMessage: message, category: logCategory(category?.rawValue))
     }
 
-    internal static func error(forMessage message: String, category: String? = nil) {
-        Logger.error(forMessage: message, category: logCategory(category))
+    /// Log an error message.
+    @_spi(Logging) public static func error(_ message: String, category: Category? = nil) {
+        Logger.error(forMessage: message, category: logCategory(category?.rawValue))
     }
 }
+
+extension Log {
+    @_spi(Logging) public struct Category: RawRepresentable, ExpressibleByStringLiteral {
+        public let rawValue: String
+
+        public init(rawValue: String) {
+            self.rawValue = rawValue
+        }
+
+        init(_ value: String) {
+            self.rawValue = value
+        }
+
+        public init(stringLiteral value: StringLiteralType) {
+            self.rawValue = value
+        }
+
+        public init(unicodeScalarLiteral value: String) {
+            self.rawValue = value
+        }
+
+        public init(extendedGraphemeClusterLiteral value: String) {
+            self.rawValue = value
+        }
+
+        static let `default` = Category("")
+    }
+
+}

Sources/MapboxMaps/Foundation/MapView+Attribution.swift

@@ -9,11 +9,11 @@ extension MapView: AttributionDialogManagerDelegate {
     func attributionDialogManager(_ attributionDialogManager: AttributionDialogManager, didTriggerActionFor attribution: Attribution) {
         switch attribution.kind {
         case .actionable(let url):
-            Log.debug(forMessage: "Open url: \(url))", category: "Attribution")
+            Log.debug("Open url: \(url))", category: "Attribution")
             attributionUrlOpener.openAttributionURL(url)
         case .feedback:
             let url = mapboxFeedbackURL()
-            Log.debug(forMessage: "Open url: \(url))", category: "Attribution")
+            Log.debug("Open url: \(url))", category: "Attribution")
             attributionUrlOpener.openAttributionURL(url)
         case .nonActionable:
             break

Sources/MapboxMaps/Foundation/MapView+Snapshot.swift

@@ -23,7 +23,7 @@ extension MapView {
         }
 
         guard let metalView = metalView else {
-            Log.error(forMessage: "No metal view present.", category: "MapView.snapshot")
+            Log.error("No metal view present.", category: "MapView.snapshot")
             throw SnapshotError.noMetalView
         }
 

Sources/MapboxMaps/Foundation/MapView.swift

@@ -520,12 +520,12 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
 
         // Metal is unavailable on older simulators
         guard ProcessInfo().isOperatingSystemAtLeast(OperatingSystemVersion(majorVersion: 13, minorVersion: 0, patchVersion: 0)) else {
-            Log.warning(forMessage: "Metal rendering is not supported on iOS versions < iOS 13. Please test on device or on iOS simulators version >= 13.", category: "MapView")
+            Log.warning("Metal rendering is not supported on iOS versions < iOS 13. Please test on device or on iOS simulators version >= 13.", category: "MapView")
             return
         }
 
         // Metal is unavailable for a different reason
-        Log.error(forMessage: "No suitable Metal simulator can be found.", category: "MapView")
+        Log.error("No suitable Metal simulator can be found.", category: "MapView")
         #endif
     }
 
@@ -576,7 +576,7 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         if metalView.contentScaleFactor != pixelRatio {
             // DrawableSize setter will recalculate `contentScaleFactor` if the new drawableSize doesn't fit into
             // the current bounds.size and scale.
-            Log.error(forMessage: "MetalView content scale factor \(metalView.contentScaleFactor) is not equal to pixel ratio \(pixelRatio)")
+            Log.error("MetalView content scale factor \(metalView.contentScaleFactor) is not equal to pixel ratio \(pixelRatio)")
         }
 
         // GL-Native will trigger update on `mapboxMap.size` update but it will come in the next frame.