chore: extract WireLogger into Swift package - WPB-11881 (#1938)

.github/workflows/test_pr_changes.yml

@@ -51,11 +51,15 @@ jobs:
               - 'wire-ios-request-strategy/**'
             WireAPI:
               - 'WireAPI/**'
+              - 'wire-ios-mono.xcworkspace/xcshareddata/xcschemes/WireAPIAll.xcscheme'
             WireAnalytics:
-              - 'WireAnalytics/Sources/WireAnalytics/**'
-              - 'WireAnalytics/Sources/WireDatadog/**'
+              - 'WireAnalytics/**'
+              - 'wire-ios-mono.xcworkspace/xcshareddata/xcschemes/WireAnalyticsAll.xcscheme'
             WireDomain:
               - 'WireDomain/**'
+            WireLogging:
+              - 'WireLogging/**'
+              - 'wire-ios-mono.xcworkspace/xcshareddata/xcschemes/WireLoggingAll.xcscheme'
             wire-ios-data-model:
               - 'wire-ios-data-model/**'
             wire-ios-transport:

.gitignore

@@ -50,6 +50,9 @@ playground.xcworkspace
 # .swiftpm
 
 .build/
+# Ignore Package.resolved files in packages and projects, only track the one in the workspace.
+**/Package.resolved
+!wire-ios-mono.xcworkspace/xcshareddata/swiftpm/Package.resolved
 
 # CocoaPods
 #

WireAnalytics/Sources/WireAnalytics/Service/AnalyticsService.swift

@@ -44,7 +44,7 @@ public final class AnalyticsService: AnalyticsServiceProtocol {
 
     public convenience init(
         config: Config?,
-        logger: @escaping (String) -> Void
+        logger: @escaping (String) -> Void // TODO: [WPB-11881] import WireLogging and remove this workaround
     ) {
         self.init(
             config: config,

WireDomain/Sources/WireDomain/Event Decryption/UpdateEventDecryptor.swift

@@ -19,6 +19,7 @@
 import Foundation
 import WireAPI
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 /// Decrypt the E2EE content within update events.

WireDomain/Sources/WireDomain/Event Processing/ConversationEventProcessor/ConversationCreateEventProcessor.swift

@@ -17,6 +17,7 @@
 //
 
 import WireAPI
+import WireLogging
 import WireSystem
 
 /// Process conversation create events.

WireDomain/Sources/WireDomain/Event Processing/ConversationEventProcessor/ConversationReceiptModeUpdateEventProcessor.swift

@@ -17,6 +17,7 @@
 //
 
 import WireAPI
+import WireLogging
 import WireSystem
 
 /// Process conversation receipt mode update events.

WireDomain/Sources/WireDomain/Event Processing/UserEventProcessor/UserPropertiesDeleteEventProcessor.swift

@@ -17,6 +17,7 @@
 //
 
 import WireAPI
+import WireLogging
 import WireSystem
 
 /// Process user properties delete events.

WireDomain/Sources/WireDomain/Repositories/Conversations/ConversationLocalStore.swift

@@ -18,6 +18,7 @@
 
 import CoreData
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 /// A local store dedicated to conversations.

WireDomain/Sources/WireDomain/Repositories/Conversations/ConversationRepository.swift

@@ -19,6 +19,7 @@
 import Foundation
 import WireAPI
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 /// Facilitate access to conversations related domain objects.

WireDomain/Sources/WireDomain/Repositories/ConversationsLabels/ConversationLabelsLocalStore.swift

@@ -17,6 +17,7 @@
 //
 
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 public protocol ConversationLabelsLocalStoreProtocol {

WireDomain/Sources/WireDomain/Repositories/ConversationsLabels/ConversationLabelsRepository.swift

@@ -18,6 +18,7 @@
 
 import WireAPI
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 /// Facilitates access to conversation labels related domain objects.

WireDomain/Sources/WireDomain/Repositories/FeatureConfig/FeatureConfigLocalStore.swift

@@ -17,6 +17,7 @@
 //
 
 import WireDataModel
+import WireLogging
 
 protocol FeatureConfigLocalStoreProtocol {
 

WireDomain/Sources/WireDomain/Repositories/FeatureConfig/FeatureConfigRepository.swift

@@ -19,6 +19,7 @@
 import Combine
 import WireAPI
 import WireDataModel
+import WireLogging
 
 /// Facilitates access to feature configs related domain objects.
 protocol FeatureConfigRepositoryProtocol {

WireDomain/Sources/WireDomain/Repositories/UpdateEvents/UpdateEventsLocalStore.swift

@@ -18,6 +18,7 @@
 
 import WireDataModel
 import WireFoundation
+import WireLogging
 
 // sourcery: AutoMockable
 protocol UpdateEventsLocalStoreProtocol {

WireDomain/Sources/WireDomain/Repositories/UpdateEvents/UpdateEventsRepository.swift

@@ -20,6 +20,7 @@ import Foundation
 import WireAPI
 import WireDataModel
 import WireFoundation
+import WireLogging
 
 // sourcery: AutoMockable
 /// Access update events.

WireDomain/Sources/WireDomain/Repositories/User/UserLocalStore.swift

@@ -17,6 +17,7 @@
 //
 
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 /// A local store dedicated to user.

WireDomain/Sources/WireDomain/Repositories/User/UserRepository.swift

@@ -20,6 +20,7 @@ import Foundation
 import WireAPI
 import WireDataModel
 import WireFoundation
+import WireLogging
 
 // sourcery: AutoMockable
 /// Facilitate access to users related domain objects.

WireDomain/Sources/WireDomain/Repositories/UserClients/UserClientsLocalStore.swift

@@ -17,6 +17,7 @@
 //
 
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 public protocol UserClientsLocalStoreProtocol {

WireDomain/Sources/WireDomain/Synchronization/OneOnOneResolver.swift

@@ -19,6 +19,7 @@
 import CoreData
 import WireAPI
 import WireDataModel
+import WireLogging
 
 // sourcery: AutoMockable
 /// Resolves 1:1 conversations

WireDomain/Sources/WireDomain/Synchronization/SyncManager.swift

@@ -20,6 +20,7 @@ import CoreData
 import Foundation
 import WireAPI
 import WireDataModel
+import WireLogging
 import WireSystem
 
 protocol SyncManagerProtocol {

WireDomain/Sources/WireDomain/UseCases/PushSupportedProtocolsUseCase.swift

@@ -18,6 +18,7 @@
 
 import WireAPI
 import WireDataModel
+import WireLogging
 import WireSystem
 
 // sourcery: AutoMockable

WireDomain/Tests/WireDomainTests/Event Processing/FeatureConfigEventProcessor/FeatureConfigUpdateEventProcessorTests.swift

@@ -19,6 +19,7 @@
 import WireAPI
 import WireDomainSupport
 import XCTest
+
 @testable import WireDomain
 
 final class FeatureConfigUpdateEventProcessorTests: XCTestCase {

WireDomain/Tests/WireDomainTests/UseCases/PushSupportedProtocolsUseCaseTests.swift

@@ -21,6 +21,7 @@ import WireAPISupport
 import WireDataModel
 import WireDataModelSupport
 import XCTest
+
 @testable import WireDomain
 @testable import WireDomainSupport
 

WireFoundation/.swiftpm/xcode/xcshareddata/xcschemes/WireFoundation-Package.xcscheme

@@ -49,6 +49,34 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "WireLogging"
+               BuildableName = "WireLogging"
+               BlueprintName = "WireLogging"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "WireLoggingSupport"
+               BuildableName = "WireLoggingSupport"
+               BlueprintName = "WireLoggingSupport"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction
@@ -73,6 +101,16 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "WireLoggingTests"
+               BuildableName = "WireLoggingTests"
+               BlueprintName = "WireLoggingTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

WireFoundation/Package.swift

@@ -40,7 +40,6 @@ let package = Package(
 )
 
 for target in package.targets {
-    guard target.type != .plugin else { continue }
     target.swiftSettings = (target.swiftSettings ?? []) + [
         .enableUpcomingFeature("InternalImportsByDefault"),
         .enableUpcomingFeature("FullTypedThrows"),

WireFoundation/Tests/TestPlans/AllTests.xctestplan

@@ -14,6 +14,13 @@
     "testExecutionOrdering" : "random"
   },
   "testTargets" : [
+    {
+      "target" : {
+        "containerPath" : "container:WireFoundation",
+        "identifier" : "WireLoggingTests",
+        "name" : "WireLoggingTests"
+      }
+    },
     {
       "target" : {
         "containerPath" : "container:WireFoundation",

WireLogging/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

WireLogging/.swiftpm/xcode/package.xcworkspace/xcshareddata/IDETemplateMacros.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>FILEHEADER</key>
+	<string>
+// Wire
+// Copyright (C) ___YEAR___ Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//</string>
+</dict>
+</plist>

WireLogging/.swiftpm/xcode/package.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEWorkspaceSharedSettings_AutocreateContextsIfNeeded</key>
+	<false/>
+</dict>
+</plist>

WireLogging/Package.swift

@@ -0,0 +1,37 @@
+// swift-tools-version: 6.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "WireLogging",
+    platforms: [.iOS(.v16), .macOS(.v12)],
+    products: [
+        .library(name: "WireLogging", targets: ["WireLogging"]),
+        .library(name: "WireLoggingSupport", targets: ["WireLoggingSupport"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0"),
+        .package(path: "../WirePlugins")
+    ],
+    targets: [
+        .target(name: "WireLogging"),
+        .target(
+            name: "WireLoggingSupport",
+            dependencies: ["WireLogging"],
+            plugins: [.plugin(name: "SourceryPlugin", package: "WirePlugins")]
+        ),
+        .testTarget(
+            name: "WireLoggingTests",
+            dependencies: ["WireLogging", "WireLoggingSupport"]
+        )
+    ]
+)
+
+for target in package.targets {
+    target.swiftSettings = (target.swiftSettings ?? []) + [
+        .enableUpcomingFeature("InternalImportsByDefault"),
+        .enableUpcomingFeature("FullTypedThrows"),
+        .enableUpcomingFeature("ExistentialAny")
+    ]
+}

wire-ios-system/Source/Logging/AggregatedLogger.swift → WireLogging/Sources/WireLogging/AggregatedLogger.swift

@@ -16,6 +16,8 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
+import Foundation
+
 final class AggregatedLogger: LoggerProtocol {
     private var loggers: [any LoggerProtocol]
 

wire-ios-system/Source/Logging/LoggerProtocol.swift → WireLogging/Sources/WireLogging/LoggerProtocol.swift

@@ -16,6 +16,8 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
+public import Foundation
+
 public protocol LoggerProtocol {
 
     func debug(_ message: any LogConvertible, attributes: LogAttributes...)

wire-ios-system/Source/Logging/SystemLogger.swift → WireLogging/Sources/WireLogging/SystemLogger.swift

@@ -16,7 +16,8 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-import Foundation
+public import Foundation
+
 import OSLog
 
 public protocol FileLoggerDestination {

wire-ios-system/Source/Logging/WireLogger.swift → WireLogging/Sources/WireLogging/WireLogger.swift

@@ -16,6 +16,8 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
+public import Foundation
+
 public struct WireLogger: LoggerProtocol, Sendable {
 
     public static func initialize(loggers: [any LoggerProtocol]) {

WireLogging/Sources/WireLoggingSupport/Sourcery/AutoMockable.stencil

@@ -0,0 +1 @@
+../../../../WirePlugins/Plugins/SourceryPlugin/Stencils/AutoMockable.stencil