Display custom FIAMs with SwiftUI

.github/workflows/inappmessaging.yml

@@ -18,12 +18,15 @@ jobs:
     if: (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || github.event_name == 'pull_request'
 
     runs-on: macOS-latest
+    strategy:
+      matrix:
+        podspec: [FirebaseInAppMessaging.podspec, FirebaseInAppMessagingSwift.podspec]
     steps:
     - uses: actions/checkout@v2
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: FirebaseInAppMessaging
-      run: scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb FirebaseInAppMessaging.podspec
+      run: scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb ${{ matrix.podspec}}
 
   tests:
     # Don't run on private repo unless it is a PR.
@@ -38,9 +41,9 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Prereqs
-      run:  scripts/install_prereqs.sh InAppMessaging ${{ matrix.platform }} xcodebuild
+      run: scripts/install_prereqs.sh InAppMessaging ${{ matrix.platform }} xcodebuild
     - name: Build and test
-      run:  scripts/third_party/travis/retry.sh scripts/build.sh InAppMessaging ${{ matrix.platform }} xcodebuild
+      run: scripts/third_party/travis/retry.sh scripts/build.sh InAppMessaging ${{ matrix.platform }} xcodebuild
 
   spm:
     # Don't run on private repo unless it is a PR.

FirebaseInAppMessaging/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2021-3 -- v.7.9.0
+- [added] Added support for building custom in-app messages with SwiftUI (#7496).
+
 # 2021-2 -- v.7.7.0
 - [fixed] Fixed accessibility experience for in-app messages (#7445).
 - [fixed] Fixed conversion tracking for in-app messages with a conversion event but not a button / action URL (#7306).

FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingRendering.h

@@ -164,6 +164,13 @@ NS_SWIFT_NAME(InAppMessagingDisplayMessage)
 /// Unavailable.
 - (instancetype)init NS_UNAVAILABLE;
 
+/// Exposed for unit testing only. Don't instantiate this in your app directly.
+- (instancetype)initWithMessageID:(NSString *)messageID
+                     campaignName:(NSString *)campaignName
+              renderAsTestMessage:(BOOL)renderAsTestMessage
+                      messageType:(FIRInAppMessagingDisplayMessageType)messageType
+                      triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType;
+
 @end
 
 NS_SWIFT_NAME(InAppMessagingCardDisplay)

FirebaseInAppMessaging/Swift/Source/CustomInAppMessageDisplayViewModifier.swift

@@ -0,0 +1,191 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import FirebaseInAppMessaging
+import SwiftUI
+
+// MARK: Image-only messages.
+
+@available(iOS 13, tvOS 13, *)
+struct ImageOnlyInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
+  var closure: (InAppMessagingImageOnlyDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
+  @ObservedObject var delegateBridge = DelegateBridge.shared
+
+  func body(content: Content) -> some View {
+    return content.overlay(overlayView())
+  }
+
+  @ViewBuilder
+  func overlayView() -> some View {
+    if let (message, delegate) = delegateBridge.inAppMessageData,
+      let imageOnlyMessage = message as? InAppMessagingImageOnlyDisplay {
+      closure(imageOnlyMessage, delegate)
+        .onAppear { delegate.impressionDetected?(for: imageOnlyMessage) }
+    } else {
+      EmptyView()
+    }
+  }
+}
+
+@available(iOS 13, tvOS 13, *)
+public extension View {
+  /// Overrides the default display of an image only in-app message as defined on the Firebase console.
+  func imageOnlyInAppMessage<Content: View>(closure: @escaping (InAppMessagingImageOnlyDisplay,
+                                                                InAppMessagingDisplayDelegate)
+      -> Content)
+    -> some View {
+    modifier(ImageOnlyInAppMessageDisplayViewModifier(closure: closure))
+  }
+}
+
+// MARK: Banner messages.
+
+@available(iOS 13, tvOS 13, *)
+struct BannerInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
+  var closure: (InAppMessagingBannerDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
+  @ObservedObject var delegateBridge = DelegateBridge.shared
+
+  func body(content: Content) -> some View {
+    return content.overlay(overlayView())
+  }
+
+  @ViewBuilder
+  func overlayView() -> some View {
+    if let (message, delegate) = delegateBridge.inAppMessageData,
+      let bannerMessage = message as? InAppMessagingBannerDisplay {
+      closure(bannerMessage, delegate).onAppear { delegate.impressionDetected?(for: bannerMessage) }
+    } else {
+      EmptyView()
+    }
+  }
+}
+
+@available(iOS 13, tvOS 13, *)
+public extension View {
+  /// Overrides the default display of a banner in-app message as defined on the Firebase console.
+  func bannerInAppMessage<Content: View>(closure: @escaping (InAppMessagingBannerDisplay,
+                                                             InAppMessagingDisplayDelegate)
+      -> Content)
+    -> some View {
+    modifier(BannerInAppMessageDisplayViewModifier(closure: closure))
+  }
+}
+
+// MARK: Modal messages.
+
+@available(iOS 13, tvOS 13, *)
+struct ModalInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
+  var closure: (InAppMessagingModalDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
+  @ObservedObject var delegateBridge = DelegateBridge.shared
+
+  func body(content: Content) -> some View {
+    return content.overlay(overlayView())
+  }
+
+  @ViewBuilder
+  func overlayView() -> some View {
+    if let (message, delegate) = delegateBridge.inAppMessageData,
+      let modalMessage = message as? InAppMessagingModalDisplay {
+      closure(modalMessage, delegate).onAppear { delegate.impressionDetected?(for: modalMessage) }
+    } else {
+      EmptyView()
+    }
+  }
+}
+
+@available(iOS 13, tvOS 13, *)
+public extension View {
+  /// Overrides the default display of a modal in-app message as defined on the Firebase console.
+  func modalInAppMessage<Content: View>(closure: @escaping (InAppMessagingModalDisplay,
+                                                            InAppMessagingDisplayDelegate)
+      -> Content)
+    -> some View {
+    modifier(ModalInAppMessageDisplayViewModifier(closure: closure))
+  }
+}
+
+// MARK: Card messages.
+
+@available(iOS 13, tvOS 13, *)
+struct CardInAppMessageDisplayViewModifier<DisplayMessage: View>: ViewModifier {
+  var closure: (InAppMessagingCardDisplay, InAppMessagingDisplayDelegate) -> DisplayMessage
+  @ObservedObject var delegateBridge = DelegateBridge.shared
+
+  func body(content: Content) -> some View {
+    return content.overlay(overlayView())
+  }
+
+  @ViewBuilder
+  func overlayView() -> some View {
+    if let (message, delegate) = delegateBridge.inAppMessageData,
+      let cardMessage = message as? InAppMessagingCardDisplay {
+      closure(cardMessage, delegate).onAppear { delegate.impressionDetected?(for: cardMessage) }
+    } else {
+      EmptyView()
+    }
+  }
+}
+
+@available(iOS 13, tvOS 13, *)
+public extension View {
+  /// Overrides the default display of a card in-app message as defined on the Firebase console.
+  func cardInAppMessage<Content: View>(closure: @escaping (InAppMessagingCardDisplay,
+                                                           InAppMessagingDisplayDelegate)
+      -> Content)
+    -> some View {
+    modifier(CardInAppMessageDisplayViewModifier(closure: closure))
+  }
+}
+
+// MARK: Bridge to Firebase In-App Messaging SDK.
+
+/**
+ * A singleton that acts as the bridge between view modifiers for displaying custom in-app messages and the
+ * in-app message fetch/display/interaction flow.
+ */
+@available(iOS 13, tvOS 13, *)
+class DelegateBridge: NSObject, InAppMessagingDisplay, InAppMessagingDisplayDelegate,
+  ObservableObject {
+  @Published var inAppMessageData: (InAppMessagingDisplayMessage,
+                                    InAppMessagingDisplayDelegate)? = nil
+
+  static let shared = DelegateBridge()
+
+  override init() {
+    super.init()
+    InAppMessaging.inAppMessaging().messageDisplayComponent = self
+    InAppMessaging.inAppMessaging().delegate = self
+  }
+
+  func displayMessage(_ messageForDisplay: InAppMessagingDisplayMessage,
+                      displayDelegate: InAppMessagingDisplayDelegate) {
+    DispatchQueue.main.async {
+      self.inAppMessageData = (messageForDisplay, displayDelegate)
+    }
+  }
+
+  func messageClicked(_ inAppMessage: InAppMessagingDisplayMessage,
+                      with action: InAppMessagingAction) {
+    DispatchQueue.main.async {
+      self.inAppMessageData = nil
+    }
+  }
+
+  func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
+                        dismissType: FIRInAppMessagingDismissType) {
+    DispatchQueue.main.async {
+      self.inAppMessageData = nil
+    }
+  }
+}