Modify SDK build Cocoapods inclusion to use frameworks instead of libraries (#905)

jonsimantov · web-flow · commit 6c2f06783de5 · 2022-04-23T01:10:09.000Z
* Fix Cocoapod header inclusion path to work for framework-based pods.

These don't specify a Pods/Header directory, so the header has to come directly from the Sources/Public directory.

* Enable use_frameworks! on pods.

* Fix include paths for framework cocoapods.

Adds additional paths that are used by some dependency pods.

* Fix for GTMSessionFetcher path.

* Add use_frameworks! to all integration test podfiles as well.

* Set linkage to static for integration tests.

* Add git credentials to tvOS build (was mistakenly previously omitted).
diff --git a/.github/workflows/integration_tests.yml b/.github/workflows/integration_tests.yml
@@ -663,6 +663,12 @@ jobs:
         with:
           ref: ${{needs.check_and_prepare.outputs.github_ref}}
           submodules: true
+      - name: Store git credentials for all git commands
+        # Forces all git commands to use authenticated https, to prevent throttling.
+        shell: bash
+        run: |
+          git config --global credential.helper 'store --file /tmp/git-credentials'
+          echo 'https://${{ github.token }}@github.com' > /tmp/git-credentials
       - name: Setup python
         uses: actions/setup-python@v2
         with:
diff --git a/admob/integration_test/Podfile b/admob/integration_test/Podfile
@@ -1,6 +1,7 @@
 source 'https://github.com/CocoaPods/Specs.git'
 platform :ios, '10.0'
 # Firebase AdMob test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   pod 'Firebase/Analytics', '8.15.0'
diff --git a/analytics/integration_test/Podfile b/analytics/integration_test/Podfile
@@ -1,7 +1,7 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 platform :ios, '10.0'
 # Firebase Analytics test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/app/integration_test/Podfile b/app/integration_test/Podfile
@@ -1,7 +1,7 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 platform :ios, '10.0'
 # Firebase App test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   pod 'Firebase/Analytics', '8.15.0'
diff --git a/auth/integration_test/Podfile b/auth/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Firebase Auth test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/database/integration_test/Podfile b/database/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Firebase Realtime Database test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/dynamic_links/integration_test/Podfile b/dynamic_links/integration_test/Podfile
@@ -1,7 +1,7 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 platform :ios, '10.0'
 # Firebase Dynamic Links test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   pod 'Firebase/DynamicLinks', '8.15.0'
diff --git a/firestore/CMakeLists.txt b/firestore/CMakeLists.txt
@@ -392,7 +392,8 @@ elseif(IOS)
       nanopb
       gRPC-C++
       gRPC-Core
-  )
+      FirebaseAuth/Interop/Auth/Public
+)
 
   if (FIREBASE_XCODE_TARGET_FORMAT STREQUAL "frameworks")
     set_target_properties(firebase_firestore PROPERTIES
diff --git a/firestore/integration_test/Podfile b/firestore/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Firebase Realtime Firestore test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/functions/integration_test/Podfile b/functions/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Cloud Functions for Firebase test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/installations/integration_test/Podfile b/installations/integration_test/Podfile
@@ -1,7 +1,7 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 platform :ios, '10.0'
 # Firebase Installations test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   pod 'Firebase/Analytics', '8.15.0'
diff --git a/ios_pod/CMakeLists.txt b/ios_pod/CMakeLists.txt
@@ -83,19 +83,30 @@ function(setup_pod_headers target_name)
       target_include_directories(${target_name}
         # Link the Pods publicly, so that dependent libraries can access the necessary header files as well.
         # Same for the below workaround.
+        # Also link from the Sources/Public directories, for framework pods.
         PUBLIC
           ${FIREBASE_POD_HEADER_DIR}/${pod}
           ${FIREBASE_POD_HEADER_DIR}/${pod}/${pod}
-      )
+          ${FIREBASE_POD_DIR}/Pods/${pod}/${pod}/Sources/Public
+          ${FIREBASE_POD_DIR}/Pods/${pod}/${pod}/Sources/Public/${pod}
+	  ${FIREBASE_POD_DIR}/Pods/${pod}/${pod}/Source/Library/Public
+	  ${FIREBASE_POD_DIR}/Pods/${pod}/${pod}/Source/Library/Public/${pod}
+)
       if("${SETUP_POD_HEADERS_INCLUDE_PRIVATE_HEADERS}")
         # Workaround: Private/FirebaseCore/*.h headers include other FirebaseCore headers via the subdirectory, so
         # we need to include the top-level Private directory as a header path. This only affects Firestore at the moment, as
         # no other C++ library includes a private Pod header.
+        # Also link from the Sources/Private directory, for framework pods.
         target_include_directories(${target_name}
           PUBLIC
             ${FIREBASE_POD_PRIVATE_HEADER_DIR}/
             ${FIREBASE_POD_PRIVATE_HEADER_DIR}/${pod}
             ${FIREBASE_POD_PRIVATE_HEADER_DIR}/${pod}/${pod}
+            ${FIREBASE_POD_DIR}/Pods/${pod}
+            ${FIREBASE_POD_DIR}/Pods/${pod}/include
+            ${FIREBASE_POD_DIR}/Pods/${pod}/${pod}/Sources/Private
+            ${FIREBASE_POD_DIR}/Pods/${pod}/${pod}/Sources
+            ${FIREBASE_POD_DIR}/Pods/${pod}/Source
         )
       endif()
 
diff --git a/ios_pod/Podfile b/ios_pod/Podfile
@@ -1,5 +1,6 @@
 source 'https://github.com/CocoaPods/Specs.git'
 platform :ios, '10.0'
+use_frameworks!
 
 target 'GetPods' do
   pod 'Firebase/Core', '8.15.0'
diff --git a/messaging/integration_test/Podfile b/messaging/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Firebase Cloud Messaging test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/remote_config/integration_test/Podfile b/remote_config/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Firebase Remote Config test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/storage/CMakeLists.txt b/storage/CMakeLists.txt
@@ -124,11 +124,12 @@ elseif(IOS)
   target_link_libraries(firebase_storage
                         PUBLIC "-fembed-bitcode")
 
-  # Empty entry to point to the GTMSessionFetcher folder '.'
+  # Include GTMSessionFetcher which uses the private directory.
   setup_pod_headers(
     firebase_storage
+    INCLUDE_PRIVATE_HEADERS
     POD_NAMES
-      .
+      GTMSessionFetcher
       FirebaseCore
       FirebaseStorage
   )
diff --git a/storage/integration_test/Podfile b/storage/integration_test/Podfile
@@ -1,6 +1,6 @@
-
 source 'https://github.com/CocoaPods/Specs.git'
 # Cloud Storage for Firebase test application.
+use_frameworks! :linkage => :static
 
 target 'integration_test' do
   platform :ios, '10.0'
diff --git a/storage/src/ios/storage_ios.h b/storage/src/ios/storage_ios.h
@@ -30,8 +30,8 @@
 
 #ifdef __OBJC__
 #import "FIRStorage.h"
-#import "GTMSessionFetcher/GTMSessionFetcher.h"
-#import "GTMSessionFetcher/GTMSessionFetcherService.h"
+#import "GTMSessionFetcher.h"
+#import "GTMSessionFetcherService.h"
 
 // GTMSessionFetcherService implementation that yields a
 // FIRCPPGTMSessionFetcher class rather than the default implementation.
diff --git a/storage/src/ios/storage_ios.mm b/storage/src/ios/storage_ios.mm
@@ -22,8 +22,8 @@
 #include "storage/src/ios/storage_reference_ios.h"
 
 #import "FIRStorageReference.h"
-#import "GTMSessionFetcher/GTMSessionFetcher.h"
-#import "GTMSessionFetcher/GTMSessionFetcherService.h"
+#import "GTMSessionFetcher.h"
+#import "GTMSessionFetcherService.h"
 
 // WARNING: Private methods in FIRStorage.
 @interface FIRStorage ()
