Update mobile GMA dependencies - Wed Mar 13 2024 (#1553)

* Update mobile dependencies - Wed Mar 13 2024

### Android

- com.google.android.gms.play_services_ads → 23.0.0

### iOS

- Google-Mobile-Ads-SDK → 11.1.0
- GoogleUserMessagingPlatform → 2.2.0

> Created by [Update Android and iOS dependencies workflow](https://github.com/firebase/firebase-cpp-sdk/actions/runs/8271821999).

* Add flag to update script to ignore or not ignore GMA.

* Add flag for updating GMA to the workflow.

---------

Co-authored-by: firebase-workflow-trigger-bot <[email protected]>
Co-authored-by: Jon Simantov <[email protected]>

Author: 3 people

.github/workflows/update-dependencies.yml

@@ -8,6 +8,9 @@ on:
       updateiOS:
         description: 'update iOS dependencies?'
         default: 1
+      includeGMA:
+        description: 'include GMA?'
+        default: 0
       triggerTests:
         description: 'trigger tests on PR?'
         default: 1
@@ -63,16 +66,20 @@ jobs:
 
       - name: Run update script
         run: |
+          gma_flag=
+          if [[ ${{ github.event.inputs.includeGMA }} -eq 1 ]]; then
+            gma_flag="--include_gma"
+          fi
           if [[ ${{ github.event.inputs.updateiOS }} -eq 1 ]]; then
             if [[ ${{ github.event.inputs.updateAndroid }} -eq 1 ]]; then
               # Update both
               echo "Updating all dependencies"
-              python scripts/update_android_ios_dependencies.py --logfile=${UPDATE_LOGFILE}
+              python scripts/update_android_ios_dependencies.py --logfile=${UPDATE_LOGFILE} ${gma_flag}
               echo "CHOSEN_DEPS=mobile" >> $GITHUB_ENV
             else
               # Update iOS only
               echo "Updating iOS dependencies only"
-              python scripts/update_android_ios_dependencies.py --skip_android --logfile=${UPDATE_LOGFILE}
+              python scripts/update_android_ios_dependencies.py --skip_android --logfile=${UPDATE_LOGFILE} ${gma_flag}
               echo "CHOSEN_DEPS=iOS" >> $GITHUB_ENV
             fi
             # iOS: Update Firestore external version to match Firestore Cocoapod version.
@@ -156,7 +163,7 @@ jobs:
           elif [[ ${{ github.event.inputs.updateAndroid }} -eq 1 ]]; then
             # Update Android only
             echo "Updating Android dependencies only"
-            python scripts/update_android_ios_dependencies.py --skip_ios --logfile=${UPDATE_LOGFILE}
+            python scripts/update_android_ios_dependencies.py --skip_ios --logfile=${UPDATE_LOGFILE} ${gma_flag}
             echo "CHOSEN_DEPS=Android" >> $GITHUB_ENV
           else
             echo "::error ::Neither Android nor iOS selected. Exiting."

Android/firebase_dependencies.gradle

@@ -27,7 +27,7 @@ def firebaseDependenciesMap = [
   'dynamic_links' : ['com.google.firebase:firebase-dynamic-links'],
   'firestore' : ['com.google.firebase:firebase-firestore'],
   'functions' : ['com.google.firebase:firebase-functions'],
-  'gma' : ['com.google.android.gms:play-services-ads:22.6.0',
+  'gma' : ['com.google.android.gms:play-services-ads:23.0.0',
            'com.google.android.ump:user-messaging-platform:2.2.0'],
   'installations' : ['com.google.firebase:firebase-installations'],
   'invites' : ['com.google.firebase:firebase-invites'],

gma/gma_resources/build.gradle

@@ -52,7 +52,7 @@ android {
 dependencies {
   implementation platform('com.google.firebase:firebase-bom:32.7.4')
   implementation 'com.google.firebase:firebase-analytics'
-  implementation 'com.google.android.gms:play-services-ads:22.6.0'
+  implementation 'com.google.android.gms:play-services-ads:23.0.0'
   implementation 'com.google.android.ump:user-messaging-platform:2.2.0'
 }
 

gma/integration_test/Podfile

@@ -6,8 +6,8 @@ use_frameworks! :linkage => :static
 target 'integration_test' do
   platform :ios, '12.0'
   pod 'Firebase/CoreOnly', '10.22.0'
-  pod 'Google-Mobile-Ads-SDK', '11.0.1'
-  pod 'GoogleUserMessagingPlatform', '2.1.0'
+  pod 'Google-Mobile-Ads-SDK', '11.1.0'
+  pod 'GoogleUserMessagingPlatform', '2.2.0'
 end
 
 post_install do |installer|

gma/src/android/gma_android.h

@@ -41,16 +41,20 @@ namespace gma {
   X(Constructor, "<init>", "()V"),                                           \
   X(Build, "build", "()Lcom/google/android/gms/ads/AdRequest;"),             \
   X(AddKeyword, "addKeyword",                                                \
-      "(Ljava/lang/String;)Lcom/google/android/gms/ads/AdRequest$Builder;"), \
+    "(Ljava/lang/String;)"                                                   \
+    "Lcom/google/android/gms/ads/AbstractAdRequestBuilder;"),                \
   X(AddNetworkExtrasBundle, "addNetworkExtrasBundle",                        \
-      "(Ljava/lang/Class;Landroid/os/Bundle;)"                               \
-      "Lcom/google/android/gms/ads/AdRequest$Builder;"),                     \
+    "(Ljava/lang/Class;Landroid/os/Bundle;)"                                 \
+    "Lcom/google/android/gms/ads/AbstractAdRequestBuilder;"),                \
   X(SetContentUrl, "setContentUrl",                                          \
-      "(Ljava/lang/String;)Lcom/google/android/gms/ads/AdRequest$Builder;"), \
+    "(Ljava/lang/String;)"                                                   \
+    "Lcom/google/android/gms/ads/AbstractAdRequestBuilder;"),                \
   X(SetNeighboringContentUrls, "setNeighboringContentUrls",                  \
-      "(Ljava/util/List;)Lcom/google/android/gms/ads/AdRequest$Builder;"),   \
+    "(Ljava/util/List;)"                                                     \
+    "Lcom/google/android/gms/ads/AbstractAdRequestBuilder;"),                \
   X(SetRequestAgent, "setRequestAgent",                                      \
-      "(Ljava/lang/String;)Lcom/google/android/gms/ads/AdRequest$Builder;")
+    "(Ljava/lang/String;)"                                                   \
+    "Lcom/google/android/gms/ads/AbstractAdRequestBuilder;")
 // clang-format on
 
 // clang-format off

ios_pod/Podfile

@@ -5,8 +5,8 @@ use_frameworks!
 target 'GetPods' do
   pod 'Firebase/Core', '10.22.0'
 
-  pod 'Google-Mobile-Ads-SDK', '11.0.1'
-  pod 'GoogleUserMessagingPlatform', '2.1.0'
+  pod 'Google-Mobile-Ads-SDK', '11.1.0'
+  pod 'GoogleUserMessagingPlatform', '2.2.0'
   pod 'Firebase/Analytics', '10.22.0'
   pod 'Firebase/AppCheck', '10.22.0'
   pod 'Firebase/Auth', '10.22.0'

release_build_files/Android/firebase_dependencies.gradle

@@ -27,7 +27,7 @@ def firebaseDependenciesMap = [
   'dynamic_links' : ['com.google.firebase:firebase-dynamic-links'],
   'firestore' : ['com.google.firebase:firebase-firestore'],
   'functions' : ['com.google.firebase:firebase-functions'],
-  'gma' : ['com.google.android.gms:play-services-ads:22.6.0',
+  'gma' : ['com.google.android.gms:play-services-ads:23.0.0',
            'com.google.android.ump:user-messaging-platform:2.2.0'],
   'installations' : ['com.google.firebase:firebase-installations'],
   'invites' : ['com.google.firebase:firebase-invites'],

release_build_files/readme.md

@@ -134,7 +134,7 @@ Google Mobile Ads          | libfirebase_gma.a
 |                          | libfirebase_app.a
 |                          | com.google.firebase:firebase-analytics
 |                          | (Maven package)
-|                          | com.google.android.gms:play-services-ads:22.6.0
+|                          | com.google.android.gms:play-services-ads:23.0.0
 |                          | (Maven package)
 |                          | com.google.android.ump:user-messaging-platform:2.2.0
 |                          | (Maven package)
@@ -253,8 +253,8 @@ Firebase Functions         | firebase_functions.xcframework
 Google Mobile Ads          | firebase_gma.xcframework
 |                          | firebase.xcframework
 |                          | Firebase/CoreOnly Cocoapod (10.22.0)
-|                          | Google-Mobile-Ads-SDK Cocoapod (10.14.0)
-|                          | GoogleUserMessagingPlatform Cocoapod (2.1.0)
+|                          | Google-Mobile-Ads-SDK Cocoapod (11.1.0)
+|                          | GoogleUserMessagingPlatform Cocoapod (2.2.0)
 Firebase Installations     | firebase_installations.xcframework
 |                          | firebase.xcframework
 |                          | FirebaseInstallations Cocoapod (10.22.0)
@@ -316,8 +316,8 @@ Firebase Functions         | libfirebase_functions.a
 Google Mobile Ads          | libfirebase_gma.a
 |                          | libfirebase_app.a
 |                          | Firebase/CoreOnly Cocoapod (10.22.0)
-|                          | Google-Mobile-Ads-SDK Cocoapod (10.14.0)
-|                          | GoogleUserMessagingPlatform Cocoapod (2.1.0)
+|                          | Google-Mobile-Ads-SDK Cocoapod (11.1.0)
+|                          | GoogleUserMessagingPlatform Cocoapod (2.2.0)
 Firebase Installations     | libfirebase_installations.a
 |                          | libfirebase_app.a
 |                          | FirebaseInstallations Cocoapod (10.22.0)

scripts/update_android_ios_dependencies.py

@@ -168,7 +168,7 @@ def get_files(dirs_and_files, file_extension, file_name=None,
 PODSPEC_REPOSITORY = 'https://github.com/CocoaPods/Specs.git'
 
 # List of Pods that we are interested in.
-PODS = (
+PODS = [
   'Firebase',
   'FirebaseCore',
   'FirebaseAnalytics',
@@ -183,9 +183,19 @@ def get_files(dirs_and_files, file_extension, file_name=None,
   'FirebaseMessaging',
   'FirebaseRemoteConfig',
   'FirebaseStorage',
-  'Google-Mobile-Ads-SDK'
-)
+]
+
+# List of GMA pods we are also interested in.
+PODS_GMA = [
+  'Google-Mobile-Ads-SDK',
+  'GoogleUserMessagingPlatform'
+]
 
+ANDROID_GMA_PACKAGES = [
+  'firebase-ads',
+  'play-services-ads',
+  'user-messaging-platform',
+]
 
 def get_pod_versions(specs_repo, pods=PODS, ignore_pods=None,
                      allow_experimental=False):
@@ -275,8 +285,14 @@ def get_latest_pod_versions(specs_repo=None, pods=PODS, ignore_pods=None,
     #  { 'PodnameA' : ['1.0.1', '2.0.4'], 'PodnameB': ['3.0.4', '1.0.2'] }
     # Convert string version numbers to semantic version objects
     # for easier comparison and get the latest version.
-    latest_version = max([packaging.version.parse(v)
-                        for v in all_versions[pod]])
+    parsed_versions = []
+    for v in all_versions[pod]:
+      try:
+        parsed_versions.append(packaging.version.parse(v))
+      except:
+        # Sometimes version numbers don't parse; ignore them.
+        continue
+    latest_version = max(parsed_versions)
     # Replace the list of versions with just the latest version
     latest_versions[pod] = latest_version.base_version
   print("Latest pod versions retreived from cocoapods specs repo: \n")
@@ -695,7 +711,6 @@ def parse_cmdline_args():
   # iOS options
   parser.add_argument('--skip_ios', action='store_true',
             help='Skip iOS pod version update completely.')
-  # TODO: remove default values when Ads SDK does not need to be pinned.
   parser.add_argument('--ignore_ios_pods', nargs='+', default=(),
             help='Ignore iOS pods which have any of the items specified in '
                  'this list as substrings.')
@@ -709,11 +724,11 @@ def parse_cmdline_args():
   # Android options
   parser.add_argument('--skip_android', action='store_true',
             help='Skip Android libraries version update completely.')
-  # TODO: remove default values when Ads SDK does not need to be pinned.
-  parser.add_argument('--ignore_android_packages', nargs='+',
-            default=('firebase-ads',),
+  parser.add_argument('--ignore_android_packages', nargs='+', default=(),
             help='Ignore Android packages which have any of the items '
                  'specified in this list as substrings.')
+  parser.add_argument('--include_gma', action='store_true',
+                      help='Also update GMA dependencies')
   parser.add_argument('--depfiles', nargs='+',
             default=('Android/firebase_dependencies.gradle',
                     'release_build_files/Android/firebase_dependencies.gradle'),
@@ -758,7 +773,9 @@ def main():
                            file_name='readme')
 
   if not args.skip_ios:
-    latest_pod_versions_map = get_latest_pod_versions(args.specs_repo, PODS,
+    latest_pod_versions_map = get_latest_pod_versions(
+      args.specs_repo,
+      (PODS + PODS_GMA) if args.include_gma else PODS,
       set(args.ignore_ios_pods), args.allow_experimental)
     pod_files = get_files(args.podfiles, file_extension='', file_name='Podfile',
                           ignore_directories=set(args.ignore_directories))
@@ -769,8 +786,11 @@ def main():
       modify_readme_file_pods(readme_file, latest_pod_versions_map, args.dryrun)
 
   if not args.skip_android:
+    ignore_android_packages = set(args.ignore_android_packages)
+    if not args.include_gma:
+      ignore_android_packages.update(ANDROID_GMA_PACKAGES)
     latest_android_versions_map = get_latest_maven_versions(
-      set(args.ignore_android_packages), args.allow_experimental)
+      ignore_android_packages, args.allow_experimental)
     dep_files = get_files(args.depfiles, file_extension='.gradle',
                           file_name='firebase_dependencies.gradle',
                           ignore_directories=set(args.ignore_directories))