Merge pull request #8001 from woocommerce/issue/7854-delete-jitm

[Just In Time Messages] Dismiss JITM

Author: joshheald

Networking/Networking.xcodeproj/project.pbxproj

@@ -102,6 +102,7 @@
 		0359EA2127AAE58C0048DE2D /* wcpay-charge-card-present.json in Resources */ = {isa = PBXBuildFile; fileRef = 0359EA2027AAE58C0048DE2D /* wcpay-charge-card-present.json */; };
 		0359EA2527AAF7D60048DE2D /* wcpay-charge-card.json in Resources */ = {isa = PBXBuildFile; fileRef = 0359EA2427AAF7D60048DE2D /* wcpay-charge-card.json */; };
 		0359EA2927AC2AAD0048DE2D /* wcpay-charge-error.json in Resources */ = {isa = PBXBuildFile; fileRef = 0359EA2827AC2AAD0048DE2D /* wcpay-charge-error.json */; };
+		035BA3AA29113CBD0056F0AD /* DataBoolMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 035BA3A929113CBD0056F0AD /* DataBoolMapper.swift */; };
 		036563DB2906938600D84BFD /* JustInTimeMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 036563DA2906938600D84BFD /* JustInTimeMessage.swift */; };
 		036563DD29069BE400D84BFD /* JustInTimeMessageListMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 036563DC29069BE400D84BFD /* JustInTimeMessageListMapper.swift */; };
 		036563DF29069C8F00D84BFD /* JustInTimeMessageListMapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 036563DE29069C8F00D84BFD /* JustInTimeMessageListMapperTests.swift */; };
@@ -835,6 +836,7 @@
 		0359EA2027AAE58C0048DE2D /* wcpay-charge-card-present.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-charge-card-present.json"; sourceTree = "<group>"; };
 		0359EA2427AAF7D60048DE2D /* wcpay-charge-card.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-charge-card.json"; sourceTree = "<group>"; };
 		0359EA2827AC2AAD0048DE2D /* wcpay-charge-error.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-charge-error.json"; sourceTree = "<group>"; };
+		035BA3A929113CBD0056F0AD /* DataBoolMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DataBoolMapper.swift; sourceTree = "<group>"; };
 		036563DA2906938600D84BFD /* JustInTimeMessage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JustInTimeMessage.swift; sourceTree = "<group>"; };
 		036563DC29069BE400D84BFD /* JustInTimeMessageListMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JustInTimeMessageListMapper.swift; sourceTree = "<group>"; };
 		036563DE29069C8F00D84BFD /* JustInTimeMessageListMapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JustInTimeMessageListMapperTests.swift; sourceTree = "<group>"; };
@@ -2219,6 +2221,7 @@
 				03DCB785262739D200C8953D /* CouponMapper.swift */,
 				DE2095BE279583A100171F1C /* CouponReportListMapper.swift */,
 				45150A9D26836A57006922EA /* CountryListMapper.swift */,
+				035BA3A929113CBD0056F0AD /* DataBoolMapper.swift */,
 				B524193E21AC5FE400D6FC0A /* DotcomDeviceMapper.swift */,
 				2676F4CD290AE6BB00C7A15B /* EntityIDMapper.swift */,
 				24F98C572502EA8800F49B68 /* FeatureFlagMapper.swift */,
@@ -3161,6 +3164,7 @@
 				B963A5CC2853870000EFADA0 /* OrderItemRefundMetaData.swift in Sources */,
 				E18152BE28F85B5B0011A0EC /* InAppPurchasesRemote.swift in Sources */,
 				0329CF9B27A82E19008AFF91 /* WCPayCharge.swift in Sources */,
+				035BA3AA29113CBD0056F0AD /* DataBoolMapper.swift in Sources */,
 				74749B97224134FF005C4CF2 /* ProductMapper.swift in Sources */,
 				26455E2A25F669F0008A1D32 /* ProductAttributeTermMapper.swift in Sources */,
 				0359EA1127AAC6740048DE2D /* WCPayPaymentMethodType.swift in Sources */,

Networking/Networking/Mapper/DataBoolMapper.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+/// Mapper: Bool Result Wrapped in `data` Key
+///
+struct DataBoolMapper: Mapper {
+
+    /// (Attempts) to extract the boolean flag from a given JSON Encoded response.
+    ///
+    func map(response: Data) throws -> Bool {
+        try JSONDecoder().decode(DataBool.self, from: response).data
+    }
+}
+
+/// DataBoolResultEnvelope Disposable Entity
+///
+/// Some endpoints return a Bool response in the `data` key. This entity
+/// allows us to parse that response with JSONDecoder.
+///
+private struct DataBool: Decodable {
+    let data: Bool
+
+    private enum CodingKeys: String, CodingKey {
+        case data
+    }
+}

Networking/Networking/Remote/JustInTimeMessagesRemote.swift

@@ -3,6 +3,9 @@ import Foundation
 public protocol JustInTimeMessagesRemoteProtocol {
     func loadAllJustInTimeMessages(for siteID: Int64,
                                    messagePath: JustInTimeMessagesRemote.MessagePath) async -> Result<[JustInTimeMessage], Error>
+    func dismissJustInTimeMessage(for siteID: Int64,
+                                  messageID: String,
+                                  featureClass: String) async -> Result<Bool, Error>
 }
 
 /// Just In Time Messages: Remote endpoints
@@ -15,7 +18,8 @@ public final class JustInTimeMessagesRemote: Remote, JustInTimeMessagesRemotePro
     /// - Parameters:
     ///     - siteID: The site for which we'll fetch JustInTimeMessages.
     ///     - messagePath: The location for JITMs to be displayed
-    ///     - completion: Closure to be executed upon completion.
+    /// - Returns:
+    ///     Async result with an array of `[JustInTimeMessage]` (usually contains one element) or an error
     ///
     public func loadAllJustInTimeMessages(for siteID: Int64,
                                           messagePath: JustInTimeMessagesRemote.MessagePath) async -> Result<[JustInTimeMessage], Error> {
@@ -34,6 +38,36 @@ public final class JustInTimeMessagesRemote: Remote, JustInTimeMessagesRemotePro
             return .failure(error)
         }
     }
+
+    /// Dismisses a `JustInTimeMessage` using the API.
+    ///
+    /// - Parameters:
+    ///     - siteID: The site for which we'll dismiss a JustInTimeMessage
+    ///     - messageID: The ID of the JustInTimeMessage that was dismissed
+    ///     - featureClass: The featureClass of the JustInTimeMessages that should be dismissed
+    /// - Returns:
+    ///     Async result with a `Bool` indicating whether dismissal was successful, or an error
+    ///
+    public func dismissJustInTimeMessage(for siteID: Int64,
+                                         messageID: String,
+                                         featureClass: String) async -> Result<Bool, Error> {
+
+        let parameters = [ParameterKey.featureClass: featureClass,
+                          ParameterKey.messageID: messageID]
+
+        let request = JetpackRequest(wooApiVersion: .none,
+                                     method: .post,
+                                     siteID: siteID,
+                                     path: Path.jitm,
+                                     parameters: parameters)
+
+        do {
+            let result = try await enqueue(request, mapper: DataBoolMapper())
+            return result
+        } catch {
+            return .failure(error)
+        }
+    }
 }
 
 // MARK: - Constants
@@ -45,6 +79,8 @@ public extension JustInTimeMessagesRemote {
 
     private enum ParameterKey {
         static let messagePath = "message_path"
+        static let featureClass = "feature_class"
+        static let messageID = "id"
     }
 
     /// Message Path parameter

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -639,6 +639,40 @@ extension WooAnalyticsEvent {
                                 Keys.justInTimeMessageGroup: featureClass
                               ])
         }
+
+        static func dismissTapped(source: String,
+                                  messageID: String,
+                                  featureClass: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .justInTimeMessageDismissTapped,
+                              properties: [
+                                Keys.source: source,
+                                Keys.justInTimeMessageID: messageID,
+                                Keys.justInTimeMessageGroup: featureClass
+                              ])
+        }
+
+        static func dismissSuccess(source: String,
+                                  messageID: String,
+                                  featureClass: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .justInTimeMessageDismissSuccess, properties: [
+                Keys.source: source,
+                Keys.justInTimeMessageID: messageID,
+                Keys.justInTimeMessageGroup: featureClass
+              ])
+        }
+
+        static func dismissFailure(source: String,
+                                   messageID: String,
+                                   featureClass: String,
+                                   error: Error) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .justInTimeMessageDismissFailure,
+                              properties: [
+                                Keys.source: source,
+                                Keys.justInTimeMessageID: messageID,
+                                Keys.justInTimeMessageGroup: featureClass
+                              ],
+                              error: error)
+        }
     }
 }
 

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -629,6 +629,9 @@ public enum WooAnalyticsStat: String {
 
     // MARK: Just In Time Messages events
     case justInTimeMessageCallToActionTapped = "jitm_cta_tapped"
+    case justInTimeMessageDismissTapped = "jitm_dismissed"
+    case justInTimeMessageDismissSuccess = "jitm_dismiss_success"
+    case justInTimeMessageDismissFailure = "jitm_dismiss_failure"
 
     // MARK: Simple Payments events
     //

WooCommerce/Classes/ViewModels/Feature Announcement Cards/JustInTimeMessageAnnouncementCardViewModel.swift

@@ -9,6 +9,10 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode
 
     private let analytics: Analytics
 
+    private let stores: StoresManager
+
+    private let justInTimeMessage: YosemiteJustInTimeMessage
+
     // MARK: - Message properties
     let title: String
 
@@ -27,9 +31,11 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode
     init(justInTimeMessage: YosemiteJustInTimeMessage,
          screenName: String,
          siteID: Int64,
+         stores: StoresManager = ServiceLocator.stores,
          analytics: Analytics = ServiceLocator.analytics) {
         self.siteID = siteID
         self.analytics = analytics
+        self.stores = stores
         let utmProvider = WooCommerceComUTMProvider(
             campaign: "jitm_group_\(justInTimeMessage.featureClass)",
             source: screenName,
@@ -38,6 +44,7 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode
         self.url = utmProvider.urlWithUtmParams(string: justInTimeMessage.url)
         self.messageID = justInTimeMessage.messageID
         self.featureClass = justInTimeMessage.featureClass
+        self.justInTimeMessage = justInTimeMessage
         self.screenName = screenName
         self.title = justInTimeMessage.title
         self.message = justInTimeMessage.detail
@@ -68,10 +75,9 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode
     }
 
     func ctaTapped() {
-        analytics.track(event: WooAnalyticsEvent.JustInTimeMessage.callToActionTapped(
-            source: screenName,
-            messageID: messageID,
-            featureClass: featureClass))
+        analytics.track(event: .JustInTimeMessage.callToActionTapped(source: screenName,
+                                                                     messageID: messageID,
+                                                                     featureClass: featureClass))
 
         guard let url = url else {
             return
@@ -91,7 +97,30 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode
     }
 
     func dontShowAgainTapped() {
-        // No-op
+        analytics.track(event: .JustInTimeMessage.dismissTapped(source: screenName,
+                                                                messageID: messageID,
+                                                                featureClass: featureClass))
+        let action = JustInTimeMessageAction.dismissMessage(justInTimeMessage,
+                                                            siteID: siteID,
+                                                            completion: { result in
+            // We deliberately strongly capture self here: the owning reference to the VM may have been
+            // set to nil by now, in order to stop displaying the Just In Time Message.
+            // [weak self] will result in these two analytics never being logged.
+            switch result {
+            case .success(_):
+                self.analytics.track(event: .JustInTimeMessage.dismissSuccess(
+                    source: self.screenName,
+                    messageID: self.messageID,
+                    featureClass: self.featureClass))
+            case .failure(let error):
+                self.analytics.track(event: .JustInTimeMessage.dismissFailure(
+                    source: self.screenName,
+                    messageID: self.messageID,
+                    featureClass: self.featureClass,
+                    error: error))
+            }
+        })
+        stores.dispatch(action)
     }
 
     func remindLaterTapped() {

WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewController.swift

@@ -317,9 +317,12 @@ private extension DashboardViewController {
                 return
             }
 
-            let cardView = FeatureAnnouncementCardView(viewModel: viewModel,
-                                                       dismiss: {},
-                                                       callToAction: {})
+            let cardView = FeatureAnnouncementCardView(
+                viewModel: viewModel,
+                dismiss: { [weak self] in
+                    self?.viewModel.announcementViewModel = nil
+                },
+                callToAction: {})
 
             self.showAnnouncement(AnnouncementCardWrapper(cardView: cardView))
         }

WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewModel.swift

@@ -8,7 +8,7 @@ final class DashboardViewModel {
     /// Stats v4 is shown by default, then falls back to v3 if store stats are unavailable.
     @Published private(set) var statsVersion: StatsVersion = .v4
 
-    @Published private(set) var announcementViewModel: AnnouncementCardViewModelProtocol? = nil
+    @Published var announcementViewModel: AnnouncementCardViewModelProtocol? = nil
 
     @Published private(set) var showWebViewSheet: WebViewSheetViewModel? = nil