Use generated API clients (#347)

* use generated API client for upload (reverts commit c313e1c)
* check/use cached Firebase CLI credential before Application Default Credentials
* fix upload performance
* more progress messages
* update version to 0.8.0

Author: kaibolay

.tool-versions

@@ -1 +1 @@
-ruby 2.7.6
+ruby 3.0.6

fastlane-plugin-firebase_app_distribution.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency('google-apis-firebaseappdistribution_v1', '~> 0.3.0')
+  spec.add_dependency('google-apis-firebaseappdistribution_v1alpha', '~> 0.2.0')
 
   spec.add_development_dependency('pry')
   spec.add_development_dependency('bundler')

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb

@@ -37,34 +37,23 @@ def self.run(params)
 
         # TODO(lkellogg): This sets the send timeout for all POST requests made by the client, but
         # ideally the timeout should only apply to the binary upload
-        client = init_client(params[:service_credentials_file],
-                             params[:firebase_cli_token],
-                             params[:debug],
-                             timeout)
+        client = init_v1_client(params[:service_credentials_file],
+                                params[:firebase_cli_token],
+                                params[:debug],
+                                timeout)
 
-        # If binary is an AAB, get the AAB info for this app, which includes the integration state and certificate data
+        # If binary is an AAB, get the AAB info for this app, which includes the integration state
+        # and certificate data
         if binary_type == :AAB
           aab_info = get_aab_info(client, app_name)
           validate_aab_setup!(aab_info)
         end
 
         binary_type = binary_type_from_path(binary_path)
         UI.message("⌛ Uploading the #{binary_type}.")
-
-        # For some reason calling the client.upload_medium returns nil when
-        # it should return a long running operation object
-        # (https://github.com/googleapis/google-api-ruby-client/blob/main/generated/google-apis-firebaseappdistribution_v1/lib/google/apis/firebaseappdistribution_v1/service.rb#L79).
-        # We could use client.http, but is much slower
-        # (https://github.com/firebase/fastlane-plugin-firebase_app_distribution/issues/330),
-        # so we still use the old client for now.
-        # TODO(kbolay) Prefer client.upload_medium, assuming it is sufficiently fast
-        fad_api_client = Client::FirebaseAppDistributionApiClient.new(client.authorization.access_token, params[:debug])
-        operation_name = fad_api_client.upload_binary(app_name,
-                                                      binary_path,
-                                                      platform.to_s,
-                                                      get_upload_timeout(params))
-
-        release = poll_upload_release_operation(client, operation_name, binary_type)
+        operation = upload_binary(app_name, binary_path, client, timeout)
+        UI.message("🕵️ Validating upload.")
+        release = poll_upload_release_operation(client, operation, binary_type)
 
         if binary_type == :AAB && aab_info && !aab_certs_included?(aab_info.test_certificate)
           updated_aab_info = get_aab_info(client, app_name)
@@ -86,6 +75,7 @@ def self.run(params)
           release.release_notes = Google::Apis::FirebaseappdistributionV1::GoogleFirebaseAppdistroV1ReleaseNotes.new(
             text: release_notes
           )
+          UI.message("📜 Setting release notes.")
           release = update_release(client, release)
         end
 
@@ -98,6 +88,7 @@ def self.run(params)
             tester_emails: emails,
             group_aliases: group_aliases
           )
+          UI.message("📦 Distributing release.")
           distribute_release(client, release, request)
         else
           UI.message("⏩ No testers or groups passed in. Skipping this step.")
@@ -222,8 +213,8 @@ def self.release_notes(params)
         release_notes_param || Actions.lane_context[SharedValues::FL_CHANGELOG]
       end
 
-      def self.poll_upload_release_operation(client, operation_name, binary_type)
-        operation = client.get_project_app_release_operation(operation_name)
+      def self.poll_upload_release_operation(client, operation, binary_type)
+        operation = client.get_project_app_release_operation(operation.name)
         MAX_POLLING_RETRIES.times do
           if operation.done && operation.response && operation.response['release']
             release = extract_release(operation)
@@ -257,6 +248,30 @@ def self.poll_upload_release_operation(client, operation_name, binary_type)
         extract_release(operation)
       end
 
+      def self.upload_binary(app_name, binary_path, client, timeout)
+        options = Google::Apis::RequestOptions.new
+        options.max_elapsed_time = timeout # includes retries (default = no retries)
+        options.header = {
+          'Content-Type' => 'application/octet-stream',
+          'X-Goog-Upload-File-Name' => CGI.escape(File.basename(binary_path)),
+          'X-Goog-Upload-Protocol' => 'raw'
+        }
+
+        # For some reason calling the client.upload_medium returns nil when
+        # it should return a long running operation object, so we make a
+        # standard http call instead and convert it to a long running object
+        # https://github.com/googleapis/google-api-ruby-client/blob/main/generated/google-apis-firebaseappdistribution_v1/lib/google/apis/firebaseappdistribution_v1/service.rb#L79
+        # TODO(kbolay) Prefer client.upload_medium
+        response = client.http(
+          :post,
+          "https://firebaseappdistribution.googleapis.com/upload/v1/#{app_name}/releases:upload",
+          body: File.open(binary_path, 'rb'),
+          options: options
+        )
+
+        Google::Apis::FirebaseappdistributionV1::GoogleLongrunningOperation.from_json(response)
+      end
+
       def self.extract_release(operation)
         Google::Apis::FirebaseappdistributionV1::GoogleFirebaseAppdistroV1Release.from_json(operation.response['release'].to_json)
       end

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb

@@ -11,7 +11,7 @@ class FirebaseAppDistributionAddTestersAction < Action
       extend Helper::FirebaseAppDistributionHelper
 
       def self.run(params)
-        client = init_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
+        client = init_v1_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
 
         if blank?(params[:emails]) && blank?(params[:file])
           UI.user_error!("Must specify `emails` or `file`.")

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb

@@ -11,8 +11,6 @@ class FirebaseAppDistributionCreateGroupAction < Action
       extend Auth::FirebaseAppDistributionAuthClient
       extend Helper::FirebaseAppDistributionHelper
 
-      FirebaseAppDistributionV1 = Google::Apis::FirebaseappdistributionV1
-
       def self.run(params)
         if blank?(params[:alias])
           UI.user_error!("Must specify `alias`.")
@@ -22,7 +20,7 @@ def self.run(params)
           UI.user_error!("Must specify `display_name`.")
         end
 
-        client = init_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
+        client = init_v1_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
 
         project_number = params[:project_number]
         group_alias = params[:alias]
@@ -31,7 +29,7 @@ def self.run(params)
         UI.message("⏳ Creating tester group '#{group_alias} (#{display_name})' in project #{project_number}...")
 
         parent = project_name(project_number)
-        group = FirebaseAppDistributionV1::GoogleFirebaseAppdistroV1Group.new(
+        group = Google::Apis::FirebaseappdistributionV1::GoogleFirebaseAppdistroV1Group.new(
           name: group_name(project_number, group_alias),
           display_name: display_name
         )

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_delete_group_action.rb

@@ -11,7 +11,7 @@ class FirebaseAppDistributionDeleteGroupAction < Action
       extend Helper::FirebaseAppDistributionHelper
 
       def self.run(params)
-        client = init_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
+        client = init_v1_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
 
         if blank?(params[:alias])
           UI.user_error!("Must specify `alias`.")

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_latest_release.rb

@@ -13,7 +13,7 @@ class FirebaseAppDistributionGetLatestReleaseAction < Action
       extend Helper::FirebaseAppDistributionHelper
 
       def self.run(params)
-        client = init_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
+        client = init_v1_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
 
         UI.message("⏳ Fetching latest release for app #{params[:app]}...")
 

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_udids.rb

@@ -4,7 +4,6 @@
 require 'googleauth'
 require_relative '../helper/firebase_app_distribution_helper'
 require_relative '../helper/firebase_app_distribution_error_message'
-require_relative '../client/firebase_app_distribution_api_client'
 require_relative '../helper/firebase_app_distribution_auth_client'
 
 module Fastlane
@@ -14,11 +13,17 @@ class FirebaseAppDistributionGetUdidsAction < Action
       extend Helper::FirebaseAppDistributionHelper
 
       def self.run(params)
-        client = init_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
-        fad_api_client = Client::FirebaseAppDistributionApiClient.new(client.authorization.access_token, params[:debug])
+        client = init_v1alpha_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
 
-        app_id = params[:app]
-        udids = fad_api_client.get_udids(app_id)
+        project_number = params[:project_number]
+        if blank?(project_number)
+          app_id = params[:app]
+          if blank?(app_id)
+            UI.user_error!("Must specify `project_number`.")
+          end
+          project_number = project_number_from_app_id(app_id)
+        end
+        udids = client.get_project_tester_udids(project_name(project_number)).tester_udids
 
         if udids.empty?
           UI.important("App Distribution fetched 0 tester UDIDs. Nothing written to output file.")
@@ -32,7 +37,7 @@ def self.write_udids_to_file(udids, output_file)
         File.open(output_file, 'w') do |f|
           f.write("Device ID\tDevice Name\tDevice Platform\n")
           udids.each do |tester_udid|
-            f.write("#{tester_udid[:udid]}\t#{tester_udid[:name]}\t#{tester_udid[:platform]}\n")
+            f.write("#{tester_udid.udid}\t#{tester_udid.name}\t#{tester_udid.platform}\n")
           end
         end
       end
@@ -52,10 +57,18 @@ def self.details
 
       def self.available_options
         [
+          FastlaneCore::ConfigItem.new(key: :project_number,
+                                       conflicting_options: [:app],
+                                       env_name: "FIREBASEAPPDISTRO_PROJECT_NUMBER",
+                                       description: "Your Firebase project number. You can find the project number in the Firebase console, on the General Settings page",
+                                       type: Integer,
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :app,
+                                       conflicting_options: [:project_number],
                                        env_name: "FIREBASEAPPDISTRO_APP",
                                        description: "Your app's Firebase App ID. You can find the App ID in the Firebase console, on the General Settings page",
-                                       optional: false,
+                                       optional: true,
+                                       deprecated: "Use project_number (FIREBASEAPPDISTRO_PROJECT_NUMBER) instead",
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :output_file,
                                        env_name: "FIREBASEAPPDISTRO_OUTPUT_FILE",

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_remove_testers_action.rb

@@ -11,7 +11,7 @@ class FirebaseAppDistributionRemoveTestersAction < Action
       extend Helper::FirebaseAppDistributionHelper
 
       def self.run(params)
-        client = init_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
+        client = init_v1_client(params[:service_credentials_file], params[:firebase_cli_token], params[:debug])
 
         if blank?(params[:emails]) && blank?(params[:file])
           UI.user_error!("Must specify `emails` or `file`.")

lib/fastlane/plugin/firebase_app_distribution/client/firebase_app_distribution_api_client.rb

@@ -38,16 +38,12 @@ def get_authorization(google_service_path, firebase_cli_token, debug = false)
         elsif !ENV["FIREBASE_TOKEN"].nil? && !ENV["FIREBASE_TOKEN"].empty?
           UI.message("🔐 Authenticating with FIREBASE_TOKEN environment variable")
           firebase_token(ENV["FIREBASE_TOKEN"], debug)
-        # TODO(lkellogg): Not using Google::Auth.get_application_default yet while we are still
-        # using the old client for uploads. ADC also does not work for the get_udids action:
-        # https://cloud.google.com/docs/authentication/troubleshoot-adc#user-creds-client-based
-        # For now go back to just using the environment variable:
-        elsif !ENV["GOOGLE_APPLICATION_CREDENTIALS"].nil? && !ENV["GOOGLE_APPLICATION_CREDENTIALS"].empty?
-          UI.message("🔐 Authenticating with GOOGLE_APPLICATION_CREDENTIALS environment variable: #{ENV['GOOGLE_APPLICATION_CREDENTIALS']}")
-          service_account(ENV["GOOGLE_APPLICATION_CREDENTIALS"], debug)
         elsif (refresh_token = refresh_token_from_firebase_tools)
-          UI.message("🔐 No authentication method found. Using cached Firebase CLI credentials.")
+          UI.message("🔐 Authenticating with cached Firebase CLI credentials")
           firebase_token(refresh_token, debug)
+        elsif !application_default_creds.nil?
+          UI.message("🔐 Authenticating with Application Default Credentials")
+          application_default_creds
         else
           UI.user_error!(ErrorMessage::MISSING_CREDENTIALS)
           nil
@@ -56,6 +52,12 @@ def get_authorization(google_service_path, firebase_cli_token, debug = false)
 
       private
 
+      def application_default_creds
+        Google::Auth.get_application_default([SCOPE])
+      rescue
+        nil
+      end
+
       def refresh_token_from_firebase_tools
         config_path = format_config_path
         if File.exist?(config_path)