Extra profile refresh for the new users (#615)

Author: pinarol

Sources/GravatarUI/SwiftUI/AvatarPicker/AvatarPickerViewModel.swift

@@ -29,24 +29,7 @@ class AvatarPickerViewModel: ObservableObject {
     @Published private(set) var backendSelectedAvatarURL: URL?
     @Published private(set) var gridResponseStatus: Result<Void, Error>?
     @Published private(set) var grid: AvatarGridModel = .init(avatars: [])
-
-    private var profileResult: Result<ProfileSummaryModel, Error>? {
-        didSet {
-            switch profileResult {
-            case .success(let value):
-                profileModel = .init(
-                    displayName: value.displayName,
-                    location: value.location,
-                    profileURL: value.profileURL,
-                    pronunciation: value.pronunciation,
-                    pronouns: value.pronouns
-                )
-            default:
-                profileModel = nil
-            }
-        }
-    }
-
+    @Published private(set) var profileResult: Result<ProfileSummaryModel, Error>?
     @Published var isProfileLoading: Bool = false
     @Published private(set) var isAvatarsLoading: Bool = false
     @Published var avatarIdentifier: AvatarIdentifier?
@@ -55,6 +38,7 @@ class AvatarPickerViewModel: ObservableObject {
     @Published var shouldDisplayNoSelectedAvatarWarning: Bool = false
     @ObservedObject var toastManager: ToastManager = .init()
     private var cancellables = Set<AnyCancellable>()
+    private(set) var compensatingFetchProfileTask: Task<Void, Never>? // for unit testing
 
     init(
         email: Email,
@@ -128,6 +112,52 @@ class AvatarPickerViewModel: ObservableObject {
             }
             .assign(to: \.shouldDisplayNoSelectedAvatarWarning, on: self)
             .store(in: &cancellables)
+
+        $profileResult
+            .combineLatest($gridResponseStatus)
+            .map { profileResult, gridResponseStatus in
+                let isProfileStatus404 = switch profileResult {
+                case .failure(APIError.responseError(let .invalidHTTPStatusCode(response, _))) where response.statusCode == HTTPStatus.notFound.rawValue:
+                    true
+                default:
+                    false
+                }
+
+                let isGridResponseSuccess = switch gridResponseStatus {
+                case .success:
+                    true
+                default:
+                    false
+                }
+                return isProfileStatus404 && isGridResponseSuccess
+            }
+            .filter { $0 == true }
+            .removeDuplicates()
+            .sink { [weak self] _ in
+                self?.compensatingFetchProfileTask = Task {
+                    // Profile does not exist but `/v3/me/avatars` is success. This means it's a new account. Backend creates a new
+                    // profile during the first GET `/v3/me/avatars` of a new user. So we refresh the profile to fetch it.
+                    // Happens only when the token is passed externally.
+                    await self?.fetchProfile()
+                }
+            }
+            .store(in: &cancellables)
+
+        $profileResult.sink { [weak self] profileResult in
+            switch profileResult {
+            case .success(let value):
+                self?.profileModel = .init(
+                    displayName: value.displayName,
+                    location: value.location,
+                    profileURL: value.profileURL,
+                    pronunciation: value.pronunciation,
+                    pronouns: value.pronouns
+                )
+            default:
+                self?.profileModel = nil
+            }
+        }
+        .store(in: &cancellables)
     }
 
     func selectAvatar(with id: String) async -> Avatar? {

Tests/GravatarUITests/AvatarPickerViewModelTests.swift

@@ -15,7 +15,7 @@ final class AvatarPickerViewModelTests {
     }
 
     static func createModel(
-        session: URLSessionAvatarPickerMock = .init(),
+        session: URLSessionProtocol = URLSessionAvatarPickerMock(),
         imageDownloader: ImageDownloader = TestImageFetcher(result: .success)
     ) -> AvatarPickerViewModel {
         .init(
@@ -209,7 +209,7 @@ final class AvatarPickerViewModelTests {
 
     @Test
     func testUploadErrorTooLarge() async throws {
-        model = Self.createModel(session: .init(returnErrorCode: HTTPStatus.payloadTooLarge.rawValue))
+        model = Self.createModel(session: URLSessionAvatarPickerMock(returnErrorCode: HTTPStatus.payloadTooLarge.rawValue))
         model.grid.setAvatars([])
 
         await confirmation { confirmation in
@@ -277,7 +277,7 @@ final class AvatarPickerViewModelTests {
     @Test("Test success deletion when the response is a 404 error")
     func testDeleteError404() async throws {
         let avatarToDelete = Self.createImageModel(id: "1", source: .remote(url: ""))
-        model = Self.createModel(session: .init(returnErrorCode: HTTPStatus.notFound.rawValue))
+        model = Self.createModel(session: URLSessionAvatarPickerMock(returnErrorCode: HTTPStatus.notFound.rawValue))
         model.grid.setAvatars([avatarToDelete])
 
         #expect(await model.delete(avatarToDelete))
@@ -287,7 +287,7 @@ final class AvatarPickerViewModelTests {
     @Test("Test success deletion of selected avatar when the response is a 404 error")
     func testDeleteSelectedAvatarError404() async throws {
         let avatarToDelete = Self.createImageModel(id: "1", source: .remote(url: ""), isSelected: true)
-        model = Self.createModel(session: .init(returnErrorCode: HTTPStatus.notFound.rawValue))
+        model = Self.createModel(session: URLSessionAvatarPickerMock(returnErrorCode: HTTPStatus.notFound.rawValue))
         model.grid.setAvatars([avatarToDelete])
         #expect(model.grid.selectedAvatar != nil)
 
@@ -308,7 +308,7 @@ final class AvatarPickerViewModelTests {
     @Test("Test error deletion when the response is an error different to 404")
     func testDeleteErrorFails() async throws {
         let avatarToDelete = Self.createImageModel(id: "1", source: .remote(url: ""))
-        model = Self.createModel(session: .init(returnErrorCode: HTTPStatus.unauthorized.rawValue))
+        model = Self.createModel(session: URLSessionAvatarPickerMock(returnErrorCode: HTTPStatus.unauthorized.rawValue))
         model.grid.setAvatars([avatarToDelete])
 
         #expect(await model.delete(avatarToDelete) == false, "Delete request should fail")
@@ -345,7 +345,7 @@ final class AvatarPickerViewModelTests {
     )
     func changeAvatarRatingReturnsError(httpStatus: HTTPStatus) async throws {
         let testAvatarID = "991a7b71cf9f34..."
-        model = Self.createModel(session: .init(returnErrorCode: httpStatus.rawValue))
+        model = Self.createModel(session: URLSessionAvatarPickerMock(returnErrorCode: httpStatus.rawValue))
 
         await model.refresh()
         let avatar = try #require(model.grid.avatars.first(where: { $0.id == testAvatarID }), "No avatar found")
@@ -381,12 +381,30 @@ final class AvatarPickerViewModelTests {
         #expect(updatedAvatar.altText == newAltText)
     }
 
+    @Test
+    func testNewAccountProfileRefresh() async throws {
+        let session = URLSessionAvatarPickerMockNewAccount()
+        model = Self.createModel(session: session)
+        await model.refresh()
+        let task = try #require(model.compensatingFetchProfileTask, "No profile task found")
+        // `await confirmation { ... }` doesn't await the unstructured `Task` so we need to await it.
+        // For context: https://forums.swift.org/t/testing-closure-based-asynchronous-apis/73705/9
+        await task.value
+        let isProfileFetched = switch model.profileResult {
+        case .success:
+            true
+        default:
+            false
+        }
+        #expect(isProfileFetched)
+    }
+
     @Test(
         "Handle avatar alt text change: Failure",
         arguments: [HTTPStatus.unauthorized, .forbidden]
     )
     func testUpdateAltTextError(httpStatus: HTTPStatus) async throws {
-        model = Self.createModel(session: .init(returnErrorCode: httpStatus.rawValue))
+        model = Self.createModel(session: URLSessionAvatarPickerMock(returnErrorCode: httpStatus.rawValue))
         await model.refresh()
         let avatar = model.grid.avatars[0]
         let originalAltText = avatar.altText
@@ -540,3 +558,29 @@ extension Data? {
         return (try? decoder.decode(T.self, from: self)) != nil
     }
 }
+
+// Simulates profile creation at the BE side on the very first avatar request.
+actor URLSessionAvatarPickerMockNewAccount: URLSessionProtocol {
+    func data(for request: URLRequest) async throws -> (Data, URLResponse) {
+        if request.isProfilesRequest {
+            if profileRequestCount == 0 {
+                profileRequestCount += 1
+                // profile is missing on the first call
+                return ("{\"error\":\"error\"".data(using: .utf8)!, HTTPURLResponse.errorResponse(code: 404))
+            } else {
+                return (Bundle.fullProfileJsonData, HTTPURLResponse.successResponse()) // Profile data
+            }
+        } else if request.isAvatarsRequest == true {
+            return (Bundle.getAvatarsJsonData, HTTPURLResponse.successResponse()) // Avatars data
+        }
+        throw TestURLSessionError(message: "Unexpected request")
+    }
+
+    func upload(for request: URLRequest, from bodyData: Data) async throws -> (Data, URLResponse) {
+        (Bundle.postAvatarUploadJsonData, HTTPURLResponse.successResponse())
+    }
+
+    private var profileRequestCount: Int = 0
+
+    init() {}
+}