Reorganize FIAM's Resources for FIAM (#7788)

ncooke3 · web-flow · commit a05ce1cf0a51 · 2021-04-06T17:09:54.000-04:00
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Firebase-Package.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Firebase-Package.xcscheme
@@ -818,6 +818,48 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "Firebase_FirebaseInAppMessaging"
+               BuildableName = "Firebase_FirebaseInAppMessaging"
+               BlueprintName = "Firebase_FirebaseInAppMessaging"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "Firebase_FirebaseInAppMessaging_iOS"
+               BuildableName = "Firebase_FirebaseInAppMessaging_iOS"
+               BlueprintName = "Firebase_FirebaseInAppMessaging_iOS"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "FirebaseInAppMessaging_iOS"
+               BuildableName = "FirebaseInAppMessaging_iOS"
+               BlueprintName = "FirebaseInAppMessaging_iOS"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction
diff --git a/FirebaseInAppMessaging.podspec b/FirebaseInAppMessaging.podspec
@@ -63,15 +63,8 @@ See more product details at https://firebase.google.com/products/in-app-messagin
 
   s.ios.resource_bundles = {
     'InAppMessagingDisplayResources' => [
-       base_dir + 'Resources/FIRInAppMessageDisplayStoryboard.storyboard',
-       base_dir + 'Resources/*.png'
-     ]
-  }
-
-  s.tvos.resource_bundles = {
-    'InAppMessagingDisplayResources' => [
-       base_dir + 'Resources/FIRInAppMessageDisplayStoryboardTV.storyboard',
-       base_dir + 'Resources/*.png'
+       base_dir + 'iOS/Resources/FIRInAppMessageDisplayStoryboard.storyboard',
+       base_dir + 'Sources/Resources/Shared/*.png'
      ]
   }
 
diff --git a/FirebaseInAppMessaging/CHANGELOG.md b/FirebaseInAppMessaging/CHANGELOG.md
@@ -1,3 +1,6 @@
+# Unreleased
+- [fixed] Fixed SPM resource inclusion for in-app messages (#7715).
+
 # 2021-3 -- v.7.9.0
 - [added] Added support for building custom in-app messages with SwiftUI (#7496).
 
diff --git a/FirebaseInAppMessaging/Resources/FIRInAppMessageDisplayStoryboardTV.storyboard b/FirebaseInAppMessaging/Resources/FIRInAppMessageDisplayStoryboardTV.storyboard
diff --git a/FirebaseInAppMessaging/Sources/DefaultUI/FIRIAMDefaultDisplayImpl.m b/FirebaseInAppMessaging/Sources/DefaultUI/FIRIAMDefaultDisplayImpl.m
@@ -17,8 +17,6 @@
 #import <TargetConditionals.h>
 #if TARGET_OS_IOS
 
-#import <Foundation/Foundation.h>
-
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
 #import "FirebaseInAppMessaging/Sources/DefaultUI/Banner/FIRIAMBannerViewController.h"
@@ -30,7 +28,6 @@
 #import "FirebaseInAppMessaging/Sources/DefaultUI/Modal/FIRIAMModalViewController.h"
 #import "FirebaseInAppMessaging/Sources/Private/Util/FIRIAMTimeFetcher.h"
 #import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessaging.h"
-#import "FirebaseInAppMessaging/Sources/Public/FirebaseInAppMessaging/FIRInAppMessagingRendering.h"
 
 @implementation FIRIAMDefaultDisplayImpl
 
@@ -56,14 +53,25 @@ + (NSBundle *)getViewResourceBundle {
   Class myClass = [self class];
 
   dispatch_once(&onceToken, ^{
+    NSString *bundledResource;
+
+    // When using SPM, Xcode scopes resources to a target, creating a bundle.
+#if SWIFT_PACKAGE
+    // FIAM only provides default UIs for iOS. FIAM for tvOS will not attempt to provide a default
+    // display.
+    bundledResource = @"Firebase_FirebaseInAppMessaging_iOS";
+#else
+    bundledResource = @"InAppMessagingDisplayResources";
+#endif  // SWIFT_PACKAGE
+
     NSBundle *containingBundle;
     NSURL *bundleURL;
     // The containing bundle is different whether FIAM is statically or dynamically linked.
     for (containingBundle in @[ [NSBundle mainBundle], [NSBundle bundleForClass:myClass] ]) {
-      bundleURL = [containingBundle URLForResource:@"InAppMessagingDisplayResources"
-                                     withExtension:@"bundle"];
+      bundleURL = [containingBundle URLForResource:bundledResource withExtension:@"bundle"];
       if (bundleURL != nil) break;
     }
+
     if (bundleURL == nil) {
       FIRLogWarning(kFIRLoggerInAppMessagingDisplay, @"I-FID100007",
                     @"FIAM Display Resource bundle "
diff --git a/FirebaseInAppMessaging/iOS/FirebaseInAppMessaging_iOS.m b/FirebaseInAppMessaging/iOS/FirebaseInAppMessaging_iOS.m
@@ -0,0 +1,18 @@
+// 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 <TargetConditionals.h>
+#if !(TARGET_OS_IOS || TARGET_OS_TVOS)
+#warning "Firebase In App Messaging only supports the iOS and tvOS platforms."
+#endif
diff --git a/FirebaseInAppMessaging/iOS/Resources/FIRInAppMessageDisplayStoryboard.storyboard b/FirebaseInAppMessaging/iOS/Resources/FIRInAppMessageDisplayStoryboard.storyboard
diff --git a/FirebaseInAppMessaging/iOS/Resources/close-with-transparency.png b/FirebaseInAppMessaging/iOS/Resources/close-with-transparency.png
diff --git a/FirebaseInAppMessaging/iOS/Resources/close-with-transparency@2x.png b/FirebaseInAppMessaging/iOS/Resources/close-with-transparency@2x.png
diff --git a/FirebaseInAppMessaging/iOS/include/FirebaseInAppMessaging_iOS.h b/FirebaseInAppMessaging/iOS/include/FirebaseInAppMessaging_iOS.h
@@ -0,0 +1,15 @@
+// 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.
+
+// Prevent a missing umbrella header warning.
diff --git a/Package.swift b/Package.swift
@@ -584,8 +584,9 @@ let package = Package(
 
     .target(
       name: "FirebaseInAppMessagingTarget",
-      dependencies: [.target(name: "FirebaseInAppMessaging",
-                             condition: .when(platforms: [.iOS]))],
+      dependencies: [
+        .target(name: "FirebaseInAppMessaging", condition: .when(platforms: [.iOS, .tvOS])),
+      ],
       path: "SwiftPM-PlatformExclude/FirebaseInAppMessagingWrap"
     ),
 
@@ -597,13 +598,13 @@ let package = Package(
         "FirebaseABTesting",
         .product(name: "GULEnvironment", package: "GoogleUtilities"),
         .product(name: "nanopb", package: "nanopb"),
+        .target(name: "FirebaseInAppMessaging_iOS", condition: .when(platforms: [.iOS])),
       ],
       path: "FirebaseInAppMessaging/Sources",
       exclude: [
         "DefaultUI/CHANGELOG.md",
         "DefaultUI/README.md",
       ],
-      resources: [.process("Resources")],
       publicHeadersPath: "Public",
       cSettings: [
         .headerSearchPath("../../"),
@@ -613,6 +614,12 @@ let package = Package(
       ]
     ),
 
+    .target(
+      name: "FirebaseInAppMessaging_iOS",
+      path: "FirebaseInAppMessaging/iOS",
+      resources: [.process("Resources")]
+    ),
+
     .target(
       name: "FirebaseInAppMessagingSwift",
       dependencies: ["FirebaseInAppMessaging"],
diff --git a/SwiftPM-PlatformExclude/FirebaseInAppMessagingWrap/dummy.m b/SwiftPM-PlatformExclude/FirebaseInAppMessagingWrap/dummy.m
@@ -13,6 +13,6 @@
 // limitations under the License.
 
 #import <TargetConditionals.h>
-#if !TARGET_OS_IOS
-#warning "Firebase In App Messaging only supports the iOS platform"
+#if !(TARGET_OS_IOS || TARGET_OS_TV)
+#warning "Firebase In App Messaging only supports the iOS and tvOS platforms."
 #endif
diff --git a/SwiftPMTests/objc-import-test/objc-header.m b/SwiftPMTests/objc-import-test/objc-header.m
@@ -24,7 +24,9 @@
 #import "FirebaseDynamicLinks/FirebaseDynamicLinks.h"
 #import "FirebaseFirestore/FirebaseFirestore.h"
 #import "FirebaseFunctions/FirebaseFunctions.h"
+#if TARGET_OS_IOS || TARGET_OS_TVOS
 #import "FirebaseInAppMessaging/FirebaseInAppMessaging.h"
+#endif
 #import "FirebaseInstallations/FirebaseInstallations.h"
 #import "FirebaseMessaging/FirebaseMessaging.h"
 #import "FirebaseRemoteConfig/FirebaseRemoteConfig.h"
@@ -43,7 +45,9 @@
 #import <FirebaseDynamicLinks/FirebaseDynamicLinks.h>
 #import <FirebaseFirestore/FirebaseFirestore.h>
 #import <FirebaseFunctions/FirebaseFunctions.h>
+#if TARGET_OS_IOS || TARGET_OS_TVOS
 #import <FirebaseInAppMessaging/FirebaseInAppMessaging.h>
+#endif
 #import <FirebaseInstallations/FirebaseInstallations.h>
 #import <FirebaseMessaging/FirebaseMessaging.h>
 #import <FirebaseRemoteConfig/FirebaseRemoteConfig.h>
diff --git a/SwiftPMTests/objc-import-test/objc-module.m b/SwiftPMTests/objc-import-test/objc-module.m
@@ -24,6 +24,9 @@
 @import FirebaseDynamicLinks;
 @import FirebaseFirestore;
 @import FirebaseFunctions;
+#if TARGET_OS_IOS || TARGET_OS_TVOS
+@import FirebaseInAppMessaging;
+#endif
 @import FirebaseInstallations;
 @import FirebaseMessaging;
 @import FirebaseRemoteConfig;
diff --git a/SwiftPMTests/swift-test/main.swift b/SwiftPMTests/swift-test/main.swift
@@ -25,8 +25,8 @@ import FirebaseDynamicLinks
 import FirebaseFirestore
 import FirebaseFirestoreSwift
 import FirebaseFunctions
-import FirebaseInAppMessaging
 #if (os(iOS) || os(tvOS)) && !targetEnvironment(macCatalyst)
+  import FirebaseInAppMessaging
   @testable import FirebaseInAppMessagingSwift
   import SwiftUI
 #endif
