feat: adapt Websocket for consumable notifications - WPB-17225

WireAPI/Sources/WireAPI/APIs/PushChannelAPI/NewPushChannelAPI.swift

@@ -0,0 +1,33 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+
+// sourcery: AutoMockable
+/// An API access object for endpoints concerning the push channel.
+public protocol NewPushChannelAPI {
+
+    /// Create a new push channel.
+    ///
+    /// - Parameter clientID: The id of the self client.
+    /// - Returns: A push channel.
+
+    func createPushChannel(clientID: String) async throws -> AnyNewPushChannel
+
+}
+
+// Workaround for automockable compiler error.
+public typealias AnyNewPushChannel = any NewPushChannelProtocol

WireAPI/Sources/WireAPI/APIs/PushChannelAPI/NewPushChannelAPIBuilder.swift

@@ -0,0 +1,40 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+import Foundation
+
+public struct NewPushChannelAPIBuilder {
+
+    private let pushChannelService: PushChannelService
+
+    /// Create a new builder.
+    ///
+    /// - Parameter pushChannelService: A push channel service to execute requests.
+    ///
+    public init(pushChannelService: PushChannelService) {
+        self.pushChannelService = pushChannelService
+    }
+
+    /// Make a `PushChannelAPI`.
+    ///
+    /// - Returns: A `PushChannelAPI`.
+
+    public func makeAPI(for apiVersion: APIVersion) -> any NewPushChannelAPI {
+        NewPushChannelAPIImpl(pushChannelService: pushChannelService, apiVersion: apiVersion)
+    }
+
+}

WireAPI/Sources/WireAPI/APIs/PushChannelAPI/NewPushChannelAPIImpl.swift

@@ -0,0 +1,41 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+
+
+final class NewPushChannelAPIImpl: NewPushChannelAPI, VersionedAPI {
+
+    let pushChannelService: any PushChannelServiceProtocol
+    let apiVersion: APIVersion
+
+    init(pushChannelService: any PushChannelServiceProtocol, apiVersion: APIVersion) {
+        self.pushChannelService = pushChannelService
+        self.apiVersion = apiVersion
+    }
+
+    func createPushChannel(clientID: String) async throws -> any NewPushChannelProtocol {
+        let path = "\(pathPrefix)/events"
+
+        let request = try URLRequestBuilder(path: path)
+            .withMethod(.get)
+            .withQueryItem(name: "client", value: clientID)
+            .build()
+
+        return try await pushChannelService.createNewPushChannel(request)
+    }
+
+}

WireAPI/Sources/WireAPI/APIs/PushChannelAPI/PushChannelAPIBuilder.swift

@@ -27,7 +27,7 @@ public struct PushChannelAPIBuilder {
     /// Create a new builder.
     ///
     /// - Parameter pushChannelService: A push channel service to execute requests.
-
+    ///
     public init(pushChannelService: PushChannelService) {
         self.pushChannelService = pushChannelService
     }
@@ -36,7 +36,7 @@ public struct PushChannelAPIBuilder {
     ///
     /// - Returns: A `PushChannelAPI`.
 
-    public func makeAPI() -> any PushChannelAPI {
+    public func makeAPI(for apiVersion: APIVersion) -> any PushChannelAPI {
         PushChannelAPIImpl(pushChannelService: pushChannelService)
     }
 

WireAPI/Sources/WireAPI/APIs/PushChannelAPI/PushChannelAPIImpl.swift

@@ -18,7 +18,7 @@
 
 import Foundation
 
-class PushChannelAPIImpl: PushChannelAPI {
+final class PushChannelAPIImpl: PushChannelAPI {
 
     let pushChannelService: any PushChannelServiceProtocol
 

WireAPI/Sources/WireAPI/APIs/UpdateEventsAPI/Responses/UpdateEventEnvelopeV0.swift

@@ -30,7 +30,8 @@ public struct UpdateEventEnvelopeV0: Decodable, ToAPIModelConvertible {
         UpdateEventEnvelope(
             id: id,
             events: (payload ?? []).map(\.updateEvent),
-            isTransient: transient ?? false
+            isTransient: transient ?? false,
+            deliveryTag: nil
         )
     }
 

WireAPI/Sources/WireAPI/APIs/UpdateEventsAPI/Responses/UpdateEventEnvelopeV8.swift

@@ -0,0 +1,29 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+
+import Foundation
+
+struct UpdateEventEnvelopeV8: Decodable {
+    enum CodingKeys: String, CodingKey {
+        case id
+        case payload
+    }
+
+    let id: UUID
+    let payload: [UpdateEventDecodingProxy]
+}

WireAPI/Sources/WireAPI/Assembly.swift

@@ -60,22 +60,6 @@ public final class Assembly {
         return service
     }()
 
-    private lazy var pushChannelService: some PushChannelServiceProtocol = PushChannelService(
-        networkService: pushChannelNetworkService,
-        authenticationManager: authenticationManager
-    )
-
-    private lazy var pushChannelNetworkService: NetworkService = {
-        let service = NetworkService(
-            baseURL: backendEnvironment.webSocketURL,
-            serverTrustValidator: serverTrustValidator
-        )
-        let config = urlSessionConfigurationFactory.makeWebSocketSessionConfiguration()
-        let session = URLSession(configuration: config, delegate: service, delegateQueue: nil)
-        service.configure(with: session)
-        return service
-    }()
-
     public lazy var authenticationManager: some AuthenticationManagerProtocol = AuthenticationManager(
         clientID: clientID,
         cookieStorage: cookieStorage,

WireAPI/Sources/WireAPI/Models/UpdateEvent/UpdateEventEnvelope.swift

@@ -37,6 +37,8 @@ public struct UpdateEventEnvelope: Equatable, Sendable {
 
     public let isTransient: Bool
 
+    public let deliveryTag: UInt64?
+
     /// Create a new `UpdateEventEnvelope`.
     ///
     /// - Parameters:
@@ -47,11 +49,13 @@ public struct UpdateEventEnvelope: Equatable, Sendable {
     public init(
         id: UUID,
         events: [UpdateEvent],
-        isTransient: Bool
+        isTransient: Bool,
+        deliveryTag: UInt64? = nil
     ) {
         self.id = id
         self.events = events
         self.isTransient = isTransient
+        self.deliveryTag = deliveryTag
     }
 
 }

WireAPI/Sources/WireAPI/Network/NetworkService/NetworkService.swift

@@ -17,6 +17,7 @@
 //
 
 import Foundation
+import WireLogging
 
 // sourcery: AutoMockable
 public protocol NetworkServiceProtocol {
@@ -102,7 +103,7 @@ extension NetworkService: URLSessionWebSocketDelegate {
         webSocketTask: URLSessionWebSocketTask,
         didOpenWithProtocol protocol: String?
     ) {
-        print("web socket task did open")
+        WireLogger.network.debug("web socket task did open")
     }
 
     public func urlSession(
@@ -128,9 +129,9 @@ extension NetworkService: URLSessionTaskDelegate {
     ) {
         // NOTE: This method is not called when when using async/await APIs.
         if let error {
-            print("task did complete with error: \(error)")
+            WireLogger.network.error("task did complete with error: \(error)")
         } else {
-            print("task did complete")
+            WireLogger.network.debug("task did complete")
         }
     }
 

WireAPI/Sources/WireAPI/Network/PushChannel/AcknowledgmentType.swift

@@ -0,0 +1,23 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+import Foundation
+
+enum AcknowledgmentType: String, Encodable {
+    case fullSync = "ack_full_sync"
+    case ack
+}

WireAPI/Sources/WireAPI/Network/PushChannel/EventAcknowledgmentNotification.swift

@@ -0,0 +1,38 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+import Foundation
+
+struct EventAcknowledgmentNotification: Encodable {
+
+    struct AcknowledgmentData: Encodable {
+        enum CodingKeys: String, CodingKey {
+            case deliveryTag = "delivery_tag"
+            case multiple
+        }
+
+        var deliveryTag: UInt64
+        var multiple: Bool
+    }
+
+    let type: AcknowledgmentType = .ack
+    var data: AcknowledgmentData
+
+    init(deliveryTag: UInt64, multiple: Bool) {
+        self.data = .init(deliveryTag: deliveryTag, multiple: multiple)
+    }
+}

WireAPI/Sources/WireAPI/Network/PushChannel/FullSyncAcknowledgmentNotification.swift

@@ -0,0 +1,22 @@
+//
+// Wire
+// Copyright (C) 2025 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/.
+//
+import Foundation
+
+struct FullSyncAcknowledgmentNotification: Encodable {
+    let type: AcknowledgmentType = .fullSync
+}