Integrate Gravatar Quick Editor

Modules/Sources/WordPressShared/Utility/Notification+Gravatar.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public enum GravatarQEAvatarUpdateNotificationKeys: String {
+    case email
+}
+
+public extension NSNotification.Name {
+    /// Gravatar Quick Editor updated the avatar
+    static let GravatarQEAvatarUpdateNotification = NSNotification.Name(rawValue: "GravatarQEAvatarUpdateNotification")
+}
+
+extension Foundation.Notification {
+    public func userInfoHasEmail(_ email: String) -> Bool {
+        guard let userInfo = userInfo,
+              let notificationEmail = userInfo[GravatarQEAvatarUpdateNotificationKeys.email.rawValue] as? String else {
+                  return false
+              }
+        return email == notificationEmail
+    }
+}

RELEASE-NOTES.txt

@@ -1,6 +1,7 @@
 25.6
 -----
 * [*] [internal] Update Gravatar SDK to 3.0.0 [#23701]
+* [*] Use the Gravatar Quick Editor to update the avatar [#23729]
 * [*] (Hidden under a feature flag) User Management for self-hosted sites. [#23768]
 
 25.5

WordPress/Classes/Extensions/URL+Helpers.swift

@@ -151,4 +151,15 @@ extension URL {
         components?.queryItems = queryItems
         return components?.url ?? self
     }
+
+    /// Gravatar doesn't support "Cache-Control: none" header. So we add a random query parameter to
+    /// bypass the backend cache and get the latest image.
+    public func appendingGravatarCacheBusterParam() -> URL {
+        var urlComponents = URLComponents(url: self, resolvingAgainstBaseURL: false)
+        if urlComponents?.queryItems == nil {
+            urlComponents?.queryItems = []
+        }
+        urlComponents?.queryItems?.append(.init(name: "_", value: "\(NSDate().timeIntervalSince1970)"))
+        return urlComponents?.url ?? self
+    }
 }

WordPress/Classes/Utility/BuildInformation/RemoteFeatureFlag.swift

@@ -28,6 +28,7 @@ enum RemoteFeatureFlag: Int, CaseIterable {
     case siteMonitoring
     case readingPreferencesFeedback
     case inAppUpdates
+    case gravatarQuickEditor
     case dotComWebLogin
 
     var defaultValue: Bool {
@@ -84,6 +85,8 @@ enum RemoteFeatureFlag: Int, CaseIterable {
             return true
         case .inAppUpdates:
             return false
+        case .gravatarQuickEditor:
+            return BuildConfiguration.current ~= [.localDeveloper, .a8cBranchTest, .a8cPrereleaseTesting]
         case .dotComWebLogin:
             return false
         }
@@ -144,6 +147,8 @@ enum RemoteFeatureFlag: Int, CaseIterable {
             return "reading_preferences_feedback"
         case .inAppUpdates:
             return "in_app_updates"
+        case .gravatarQuickEditor:
+            return "gravatar_quick_editor"
         case .dotComWebLogin:
             return "jp_wpcom_web_login"
         }
@@ -203,6 +208,8 @@ enum RemoteFeatureFlag: Int, CaseIterable {
             return "Reading Preferences Feedback"
         case .inAppUpdates:
             return "In-App Updates"
+        case .gravatarQuickEditor:
+            return "Gravatar Quick Editor"
         case .dotComWebLogin:
             return "Log in to WordPress.com from web browser"
         }

WordPress/Classes/Utility/Media/ImageDownloader+Gravatar.swift

@@ -4,19 +4,22 @@ import Gravatar
 
 extension ImageDownloader {
 
-    nonisolated func downloadGravatarImage(with email: String, completion: @escaping (UIImage?) -> Void) {
+    nonisolated func downloadGravatarImage(with email: String, forceRefresh: Bool = false, completion: @escaping (UIImage?) -> Void) {
 
         guard let url = AvatarURL.url(for: email) else {
             completion(nil)
             return
         }
 
-        if let cachedImage = ImageCache.shared.getImage(forKey: url.absoluteString) {
+        if !forceRefresh, let cachedImage = ImageCache.shared.getImage(forKey: url.absoluteString) {
             completion(cachedImage)
             return
         }
-
-        downloadImage(at: url) { image, _ in
+        var urlToDownload = url
+        if forceRefresh {
+            urlToDownload = url.appendingGravatarCacheBusterParam()
+        }
+        downloadImage(at: urlToDownload) { image, _ in
             DispatchQueue.main.async {
 
                 guard let image else {

WordPress/Classes/Utility/Media/ImageDownloader.swift

@@ -102,6 +102,15 @@ actor ImageDownloader {
         return imageURL.absoluteString + (size.map { "?size=\($0)" } ?? "")
     }
 
+    func clearURLSessionCache() {
+        urlSessionWithCache.configuration.urlCache?.removeAllCachedResponses()
+        urlSession.configuration.urlCache?.removeAllCachedResponses()
+    }
+
+    func clearMemoryCache() {
+        self.cache.removeAllObjects()
+    }
+
     // MARK: - Networking
 
     private func data(for request: URLRequest, options: ImageRequestOptions) async throws -> Data {

WordPress/Classes/Utility/Media/ImageViewController.swift

@@ -6,7 +6,7 @@ final class ImageViewController {
     var downloader: ImageDownloader = .shared
     var onStateChanged: (State) -> Void = { _ in }
 
-    private var task: Task<Void, Never>?
+    private(set) var task: Task<Void, Never>?
 
     enum State {
         case loading

WordPress/Classes/Utility/Media/MemoryCache.swift

@@ -4,10 +4,12 @@ import WordPressUI
 
 protocol MemoryCacheProtocol: AnyObject {
     subscript(key: String) -> UIImage? { get set }
+    func removeAllObjects()
 }
 
 /// - note: The type is thread-safe because it uses thread-safe `NSCache`.
 final class MemoryCache: MemoryCacheProtocol, @unchecked Sendable {
+
     /// A shared image cache used by the entire system.
     static let shared = MemoryCache()
 
@@ -23,6 +25,10 @@ final class MemoryCache: MemoryCacheProtocol, @unchecked Sendable {
         cache.removeAllObjects()
     }
 
+    func removeAllObjects() {
+        cache.removeAllObjects()
+    }
+
     // MARK: - UIImage
 
     subscript(key: String) -> UIImage? {

WordPress/Classes/ViewRelated/Blog/Blog Details/BlogDetailsViewController+Me.swift

@@ -4,12 +4,12 @@ import Gravatar
 
 extension BlogDetailsViewController {
 
-    @objc func downloadGravatarImage(for row: BlogDetailsRow) {
+    @objc func downloadGravatarImage(for row: BlogDetailsRow, forceRefresh: Bool = false) {
         guard let email = blog.account?.email else {
             return
         }
 
-        ImageDownloader.shared.downloadGravatarImage(with: email) { [weak self] image in
+        ImageDownloader.shared.downloadGravatarImage(with: email, forceRefresh: forceRefresh) { [weak self] image in
             guard let image,
                   let gravatarIcon = image.gravatarIcon(size: Metrics.iconSize) else {
                 return
@@ -21,9 +21,17 @@ extension BlogDetailsViewController {
     }
 
     @objc func observeGravatarImageUpdate() {
+        NotificationCenter.default.addObserver(self, selector: #selector(refreshAvatar(_:)), name: .GravatarQEAvatarUpdateNotification, object: nil)
         NotificationCenter.default.addObserver(self, selector: #selector(updateGravatarImage(_:)), name: .GravatarImageUpdateNotification, object: nil)
     }
 
+    @objc private func refreshAvatar(_ notification: Foundation.Notification) {
+        guard let meRow,
+              let email = blog.account?.email,
+              notification.userInfoHasEmail(email) else { return }
+        downloadGravatarImage(for: meRow, forceRefresh: true)
+    }
+
     @objc private func updateGravatarImage(_ notification: Foundation.Notification) {
         guard let userInfo = notification.userInfo,
             let email = userInfo["email"] as? String,

WordPress/Classes/ViewRelated/Blog/Blog Details/BlogDetailsViewController.m

@@ -1350,7 +1350,7 @@ - (BlogDetailsSection *)configurationSectionViewModel
                                      callback:^{
                                          [weakSelf showMe];
                                      }];
-        [self downloadGravatarImageFor:row];
+        [self downloadGravatarImageFor:row forceRefresh: NO];
         self.meRow = row;
         [rows addObject:row];
     }

WordPress/Classes/ViewRelated/Gravatar/UIImageView+Gravatar.swift

@@ -34,16 +34,18 @@ extension UIImageView {
     ///   - email: The user's email
     ///   - gravatarRating: Expected image rating
     ///   - placeholderImage: Image to be used as Placeholder
+    ///   - forceRefresh: Skip the cache and fetch the latest version of the avatar.
     public func downloadGravatar(
         for email: String,
         gravatarRating: Rating = .general,
-        placeholderImage: UIImage = .gravatarPlaceholderImage
+        placeholderImage: UIImage = .gravatarPlaceholderImage,
+        forceRefresh: Bool = false
     ) {
         let avatarURL = AvatarURL.url(for: email, preferredSize: .pixels(gravatarDefaultSize()), gravatarRating: gravatarRating)
-        downloadGravatar(fullURL: avatarURL, placeholder: placeholderImage, animate: false)
+        downloadGravatar(fullURL: avatarURL, placeholder: placeholderImage, animate: false, forceRefresh: forceRefresh)
     }
 
-    public func downloadGravatar(_ gravatar: AvatarURL?, placeholder: UIImage, animate: Bool) {
+    public func downloadGravatar(_ gravatar: AvatarURL?, placeholder: UIImage, animate: Bool, forceRefresh: Bool = false) {
         guard let gravatar = gravatar else {
             self.image = placeholder
             return
@@ -56,14 +58,31 @@ extension UIImageView {
         layoutIfNeeded()
 
         let size = Int(ceil(frame.width * min(2, UIScreen.main.scale)))
-        let url = gravatar.replacing(options: .init(preferredSize: .pixels(size)))?.url
-        downloadGravatar(fullURL: url, placeholder: placeholder, animate: animate)
+        guard let url = gravatar.replacing(options: .init(preferredSize: .pixels(size)))?.url else { return }
+        downloadGravatar(fullURL: url, placeholder: placeholder, animate: animate, forceRefresh: forceRefresh)
     }
 
-    private func downloadGravatar(fullURL: URL?, placeholder: UIImage, animate: Bool) {
+    private func downloadGravatar(fullURL: URL?, placeholder: UIImage, animate: Bool, forceRefresh: Bool = false) {
         wp.prepareForReuse()
         if let fullURL {
-            wp.setImage(with: fullURL)
+            var urlToDownload = fullURL
+            if forceRefresh {
+                urlToDownload = fullURL.appendingGravatarCacheBusterParam()
+            }
+
+            wp.setImage(with: urlToDownload)
+
+            if forceRefresh {
+                // If this is a `forceRefresh`, the cache for the original URL should be updated too.
+                // Because the cache buster parameter modifies the download URL.
+                Task {
+                    await wp.controller.task?.value // Wait until setting the new image is done.
+                    if let image {
+                        ImageCache.shared.setImage(image, forKey: fullURL.absoluteString) // Update the cache for the original URL
+                    }
+                }
+            }
+
             if image == nil { // If image wasn't found synchronously in memory cache
                 image = placeholder
             }

WordPress/Classes/ViewRelated/Me/My Profile/Gravatar/GravatarQuickEditorPresenter.swift

@@ -0,0 +1,46 @@
+import Foundation
+import GravatarUI
+import WordPressShared
+import WordPressAuthenticator
+
+@MainActor
+struct GravatarQuickEditorPresenter {
+    let email: String
+    let authToken: String
+
+    init?(email: String) {
+        let context = ContextManager.sharedInstance().mainContext
+        guard let account = try? WPAccount.lookupDefaultWordPressComAccount(in: context) else {
+            return nil
+        }
+        self.email = email
+        self.authToken = account.authToken
+    }
+
+    func presentQuickEditor(on presentingViewController: UIViewController) {
+        let presenter = QuickEditorPresenter(
+            email: Email(email),
+            scope: .avatarPicker(AvatarPickerConfiguration(contentLayout: .horizontal())),
+            configuration: .init(
+                interfaceStyle: presentingViewController.traitCollection.userInterfaceStyle
+            ),
+            token: authToken
+        )
+        presenter.present(
+            in: presentingViewController,
+            onAvatarUpdated: {
+                AuthenticatorAnalyticsTracker.shared.track(click: .selectAvatar)
+                Task {
+                    // Purge the cache otherwise the old avatars remain around.
+                    await ImageDownloader.shared.clearURLSessionCache()
+                    await ImageDownloader.shared.clearMemoryCache()
+                    NotificationCenter.default.post(name: .GravatarQEAvatarUpdateNotification,
+                                                    object: self,
+                                                    userInfo: [GravatarQEAvatarUpdateNotificationKeys.email.rawValue: email])
+                }
+            }, onDismiss: {
+                // No op.
+            }
+        )
+    }
+}

WordPress/Classes/ViewRelated/Me/My Profile/MyProfileHeaderView.swift

@@ -5,7 +5,7 @@ class MyProfileHeaderView: UITableViewHeaderFooterView {
     // MARK: - Public Properties and Outlets
     @IBOutlet var gravatarImageView: CircularImageView!
     @IBOutlet var gravatarButton: UIButton!
-
+    weak var presentingViewController: UIViewController?
     // A fake button displayed on top of gravatarImageView.
     let imageViewButton = UIButton(type: .system)
 
@@ -24,8 +24,8 @@ class MyProfileHeaderView: UITableViewHeaderFooterView {
     }
     var gravatarEmail: String? = nil {
         didSet {
-            if let email = gravatarEmail {
-                gravatarImageView.downloadGravatar(for: email, gravatarRating: .x)
+            if gravatarEmail != nil {
+                downloadAvatar()
             }
         }
     }
@@ -51,10 +51,23 @@ class MyProfileHeaderView: UITableViewHeaderFooterView {
         configureGravatarButton()
     }
 
+    private func downloadAvatar(forceRefresh: Bool = false) {
+        if let email = gravatarEmail {
+            gravatarImageView.downloadGravatar(for: email, gravatarRating: .x, forceRefresh: forceRefresh)
+        }
+    }
+
+    @objc private func refreshAvatar(_ notification: Foundation.Notification) {
+        guard let email = gravatarEmail,
+              notification.userInfoHasEmail(email) else { return }
+        downloadAvatar(forceRefresh: true)
+    }
+
     /// Overrides the current Gravatar Image (set via Email) with a given image reference.
     /// Plus, the internal image cache is updated, to prevent undesired glitches upon refresh.
     ///
     func overrideGravatarImage(_ image: UIImage) {
+        guard !RemoteFeatureFlag.gravatarQuickEditor.enabled() else { return }
         gravatarImageView.image = image
 
         // Note:
@@ -81,9 +94,23 @@ class MyProfileHeaderView: UITableViewHeaderFooterView {
         gravatarImageView.addSubview(imageViewButton)
         imageViewButton.translatesAutoresizingMaskIntoConstraints = false
         imageViewButton.pinSubviewToAllEdges(gravatarImageView)
+        if RemoteFeatureFlag.gravatarQuickEditor.enabled() {
+            imageViewButton.addTarget(self, action: #selector(gravatarButtonTapped), for: .touchUpInside)
+            NotificationCenter.default.addObserver(self, selector: #selector(refreshAvatar), name: .GravatarQEAvatarUpdateNotification, object: nil)
+        }
     }
 
     private func configureGravatarButton() {
         gravatarButton.tintColor = UIAppColor.primary
+        if RemoteFeatureFlag.gravatarQuickEditor.enabled() {
+            gravatarButton.addTarget(self, action: #selector(gravatarButtonTapped), for: .touchUpInside)
+        }
+    }
+
+    @objc private func gravatarButtonTapped() {
+        guard let email = gravatarEmail,
+              let presenter = GravatarQuickEditorPresenter(email: email),
+              let presentingViewController else { return }
+        presenter.presentQuickEditor(on: presentingViewController)
     }
 }