Jetpack Setup: Update response for Jetpack connection data request (#15971)

Author: itsmeichigo

Modules/Sources/Fakes/Networking.generated.swift

@@ -631,6 +631,18 @@ extension Networking.InboxNote {
         )
     }
 }
+extension Networking.JetpackConnectionData {
+    /// Returns a "ready to use" type filled with fake values.
+    ///
+    public static func fake() -> Networking.JetpackConnectionData {
+        .init(
+            currentUser: .fake(),
+            isRegistered: .fake(),
+            connectionOwner: .fake(),
+            blogID: .fake()
+        )
+    }
+}
 extension Networking.JetpackUser {
     /// Returns a "ready to use" type filled with fake values.
     ///
@@ -640,7 +652,8 @@ extension Networking.JetpackUser {
             isPrimary: .fake(),
             username: .fake(),
             wpcomUser: .fake(),
-            gravatar: .fake()
+            gravatar: .fake(),
+            blogID: .fake()
         )
     }
 }

Modules/Sources/Networking/Mapper/JetpackConnectionDataMapper.swift

@@ -0,0 +1,60 @@
+import Codegen
+import Foundation
+
+/// Mapper: Jetpack connection data
+///
+struct JetpackConnectionDataMapper: Mapper {
+
+    func map(response: Data) throws -> JetpackConnectionData {
+        let decoder = JSONDecoder()
+        return try decoder.decode(JetpackConnectionData.self, from: response)
+    }
+}
+
+/// JetpackConnectionData Disposable Entity:
+/// This entity allows us to parse JetpackUser with JSONDecoder.
+///
+public struct JetpackConnectionData: Decodable, GeneratedFakeable, GeneratedCopiable {
+    /// The connection state for the authenticated user
+    public let currentUser: JetpackUser
+
+    /// Whether the site is already registered with Jetpack.
+    /// This field is available only from Jetpack 14.4, so would be nil on older versions.
+    /// Ref: pe5sF9-401-p2
+    /// periphery: ignore - used in UI module
+    public let isRegistered: Bool?
+
+    /// Username of the Jetpack connection owner.
+    /// This field is non-nil for sites that already register a connection with Jetpack.
+    /// periphery: ignore - used in UI module
+    public let connectionOwner: String?
+
+    /// WP blog ID, available only if site has once connected to Jetpack.
+    /// periphery: ignore - used in UI module
+    public let blogID: Int64?
+
+    /// periphery: ignore - used by codegen
+    public init(currentUser: JetpackUser,
+                isRegistered: Bool?,
+                connectionOwner: String?,
+                blogID: Int64?) {
+        self.currentUser = currentUser
+        self.isRegistered = isRegistered
+        self.connectionOwner = connectionOwner
+        self.blogID = blogID
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        currentUser = try container.decode(JetpackUser.self, forKey: .currentUser)
+        isRegistered = try container.decodeIfPresent(Bool.self, forKey: .isRegistered)
+        connectionOwner = try? container.decodeIfPresent(String.self, forKey: .connectionOwner)
+        blogID = currentUser.blogID // moved to data for easier access
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case currentUser
+        case isRegistered
+        case connectionOwner
+    }
+}

Modules/Sources/Networking/Mapper/JetpackUserMapper.swift

@@ -994,26 +994,50 @@ extension Networking.InboxNote {
     }
 }
 
+extension Networking.JetpackConnectionData {
+    public func copy(
+        currentUser: CopiableProp<JetpackUser> = .copy,
+        isRegistered: NullableCopiableProp<Bool> = .copy,
+        connectionOwner: NullableCopiableProp<String> = .copy,
+        blogID: NullableCopiableProp<Int64> = .copy
+    ) -> Networking.JetpackConnectionData {
+        let currentUser = currentUser ?? self.currentUser
+        let isRegistered = isRegistered ?? self.isRegistered
+        let connectionOwner = connectionOwner ?? self.connectionOwner
+        let blogID = blogID ?? self.blogID
+
+        return Networking.JetpackConnectionData(
+            currentUser: currentUser,
+            isRegistered: isRegistered,
+            connectionOwner: connectionOwner,
+            blogID: blogID
+        )
+    }
+}
+
 extension Networking.JetpackUser {
     public func copy(
         isConnected: CopiableProp<Bool> = .copy,
         isPrimary: CopiableProp<Bool> = .copy,
         username: CopiableProp<String> = .copy,
         wpcomUser: NullableCopiableProp<DotcomUser> = .copy,
-        gravatar: NullableCopiableProp<String> = .copy
+        gravatar: NullableCopiableProp<String> = .copy,
+        blogID: NullableCopiableProp<Int64> = .copy
     ) -> Networking.JetpackUser {
         let isConnected = isConnected ?? self.isConnected
         let isPrimary = isPrimary ?? self.isPrimary
         let username = username ?? self.username
         let wpcomUser = wpcomUser ?? self.wpcomUser
         let gravatar = gravatar ?? self.gravatar
+        let blogID = blogID ?? self.blogID
 
         return Networking.JetpackUser(
             isConnected: isConnected,
             isPrimary: isPrimary,
             username: username,
             wpcomUser: wpcomUser,
-            gravatar: gravatar
+            gravatar: gravatar,
+            blogID: blogID
         )
     }
 }

Modules/Sources/Networking/Model/Copiable/Models+Copiable.generated.swift

@@ -19,13 +19,23 @@ public struct JetpackUser: Decodable, GeneratedFakeable, GeneratedCopiable {
     /// Gravatar link of the user
     public let gravatar: String?
 
+    /// WP blog ID, available only if site has once connected to Jetpack.
+    public let blogID: Int64?
+
     /// Member-wise initializer
-    public init(isConnected: Bool, isPrimary: Bool, username: String, wpcomUser: DotcomUser?, gravatar: String?) {
+    /// periphery: ignore - used by codegen
+    public init(isConnected: Bool,
+                isPrimary: Bool,
+                username: String,
+                wpcomUser: DotcomUser?,
+                gravatar: String?,
+                blogID: Int64?) {
         self.isConnected = isConnected
         self.isPrimary = isPrimary
         self.username = username
         self.wpcomUser = wpcomUser
         self.gravatar = gravatar
+        self.blogID = blogID
     }
 
     public init(from decoder: Decoder) throws {
@@ -35,6 +45,7 @@ public struct JetpackUser: Decodable, GeneratedFakeable, GeneratedCopiable {
         username = try container.decode(String.self, forKey: .username)
         wpcomUser = try? container.decode(DotcomUser.self, forKey: .wpcomUser)
         gravatar = try? container.decode(String.self, forKey: .gravatar)
+        blogID = try? container.decodeIfPresent(Int64.self, forKey: .blogId)
     }
 }
 
@@ -48,5 +59,6 @@ private extension JetpackUser {
         case username
         case wpcomUser
         case gravatar
+        case blogId
     }
 }

Modules/Sources/Networking/Model/JetpackUser.swift

@@ -49,11 +49,11 @@ public final class JetpackConnectionRemote: Remote {
         enqueue(request, mapper: mapper, completion: completion)
     }
 
-    /// Fetches the user connection state with the site's Jetpack.
+    /// Fetches the connection state with the site's Jetpack for the authenticated user.
     ///
-    public func fetchJetpackUser(completion: @escaping (Result<JetpackUser, Error>) -> Void) {
-        let request = RESTRequest(siteURL: siteURL, method: .get, path: Path.jetpackConnectionUser)
-        let mapper = JetpackUserMapper()
+    public func fetchJetpackConnectionData(completion: @escaping (Result<JetpackConnectionData, Error>) -> Void) {
+        let request = RESTRequest(siteURL: siteURL, method: .get, path: Path.jetpackConnectionData)
+        let mapper = JetpackConnectionDataMapper()
         enqueue(request, mapper: mapper, completion: completion)
     }
 }
@@ -68,7 +68,7 @@ public extension JetpackConnectionRemote {
 private extension JetpackConnectionRemote {
     enum Path {
         static let jetpackConnectionURL = "/jetpack/v4/connection/url"
-        static let jetpackConnectionUser = "/jetpack/v4/connection/data"
+        static let jetpackConnectionData = "/jetpack/v4/connection/data"
         static let plugins = "/wp/v2/plugins"
         static let jetpackModule = "/jetpack/v4/module"
     }

Modules/Sources/Networking/Remote/JetpackConnectionRemote.swift

@@ -14,8 +14,8 @@ public enum JetpackConnectionAction: Action {
     case activateJetpackPlugin(completion: (Result<Void, Error>) -> Void)
     /// Fetches the URL used for setting up Jetpack connection.
     case fetchJetpackConnectionURL(completion: (Result<URL, Error>) -> Void)
-    /// Fetches the user connection state with the given site's Jetpack.
-    case fetchJetpackUser(completion: (Result<JetpackUser, Error>) -> Void)
+    /// Fetches connection state with the given site's Jetpack.
+    case fetchJetpackConnectionData(completion: (Result<JetpackConnectionData, Error>) -> Void)
     /// Fetches the WPCom account with the given network
     case loadWPComAccount(network: Network, onCompletion: (Account?) -> Void)
 }

Modules/Sources/Yosemite/Actions/JetpackConnectionAction.swift

@@ -50,7 +50,7 @@ public typealias GoogleAdsCampaignStatsTotals = Networking.GoogleAdsCampaignStat
 public typealias GoogleAdsCampaignStatsItem = Networking.GoogleAdsCampaignStatsItem
 public typealias InboxNote = Networking.InboxNote
 public typealias InboxAction = Networking.InboxAction
-public typealias JetpackUser = Networking.JetpackUser
+public typealias JetpackConnectionData = Networking.JetpackConnectionData
 public typealias JustInTimeMessageHook = Networking.JustInTimeMessagesRemote.MessagePath.Hook
 public typealias Media = Networking.Media
 public typealias MetaContainer = Networking.MetaContainer

Modules/Sources/Yosemite/Model/Model.swift

@@ -40,8 +40,8 @@ public final class JetpackConnectionStore: DeauthenticatedStore {
             activateJetpackPlugin(completion: completion)
         case .fetchJetpackConnectionURL(let completion):
             fetchJetpackConnectionURL(completion: completion)
-        case .fetchJetpackUser(let completion):
-            fetchJetpackUser(completion: completion)
+        case .fetchJetpackConnectionData(let completion):
+            fetchJetpackConnectionData(completion: completion)
         case .loadWPComAccount(let network, let onCompletion):
             loadWPComAccount(network: network, onCompletion: onCompletion)
         }
@@ -83,8 +83,8 @@ private extension JetpackConnectionStore {
         jetpackConnectionRemote?.fetchJetpackConnectionURL(completion: completion)
     }
 
-    func fetchJetpackUser(completion: @escaping (Result<JetpackUser, Error>) -> Void) {
-        jetpackConnectionRemote?.fetchJetpackUser(completion: completion)
+    func fetchJetpackConnectionData(completion: @escaping (Result<JetpackConnectionData, Error>) -> Void) {
+        jetpackConnectionRemote?.fetchJetpackConnectionData(completion: completion)
     }
 
     func loadWPComAccount(network: Network, onCompletion: @escaping (Account?) -> Void) {

Modules/Sources/Yosemite/Stores/JetpackConnectionStore.swift

@@ -4,14 +4,19 @@ import XCTest
 
 /// JetpackUserMapper Unit Tests
 ///
-final class JetpackUserMapperTests: XCTestCase {
+final class JetpackConnectionDataMapperTests: XCTestCase {
 
     func test_all_fields_are_parsed_properly_when_user_is_connected() throws {
         // Given
-        let user = try mapUserFromMockResponse()
+        let data = try mapUserFromMockResponse()
+        let user = data.currentUser
         let wpcomUser = try XCTUnwrap(user.wpcomUser)
 
         // Then
+        XCTAssertEqual(data.isRegistered, true)
+        XCTAssertEqual(data.connectionOwner, "testuser")
+        XCTAssertEqual(data.blogID, 1244634)
+
         XCTAssertEqual(user.username, "admin")
         XCTAssertEqual(user.gravatar, "<img alt='' src='http://2.gravatar.com/avatar/5e1a8fhjd'/>")
         XCTAssertTrue(user.isPrimary)
@@ -26,9 +31,14 @@ final class JetpackUserMapperTests: XCTestCase {
 
     func test_all_fields_are_parsed_properly_when_user_is_not_connected() throws {
         // Given
-        let user = try mapNotConnectedUserFromMockResponse()
+        let data = try mapNotConnectedUserFromMockResponse()
+        let user = data.currentUser
 
         // Then
+        XCTAssertNil(data.isRegistered)
+        XCTAssertEqual(data.connectionOwner, "demo")
+        XCTAssertNil(data.blogID)
+
         XCTAssertFalse(user.isPrimary)
         XCTAssertFalse(user.isConnected)
         XCTAssertEqual(user.username, "test")
@@ -37,21 +47,21 @@ final class JetpackUserMapperTests: XCTestCase {
     }
 }
 
-private extension JetpackUserMapperTests {
-    func mapUserFromMockResponse() throws -> JetpackUser {
+private extension JetpackConnectionDataMapperTests {
+    func mapUserFromMockResponse() throws -> JetpackConnectionData {
         guard let response = Loader.contentsOf("jetpack-connected-user") else {
             throw FileNotFoundError()
         }
 
-        return try JetpackUserMapper().map(response: response)
+        return try JetpackConnectionDataMapper().map(response: response)
     }
 
-    func mapNotConnectedUserFromMockResponse() throws -> JetpackUser {
+    func mapNotConnectedUserFromMockResponse() throws -> JetpackConnectionData {
         guard let response = Loader.contentsOf("jetpack-user-not-connected") else {
             throw FileNotFoundError()
         }
 
-        return try JetpackUserMapper().map(response: response)
+        return try JetpackConnectionDataMapper().map(response: response)
     }
 
     struct FileNotFoundError: Error {}