fastlane-plugin-firebase_app_distribution 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472d779b44b65f59dd24063df03381828252f70e5a5e7b539607eae358adf97c
-  data.tar.gz: c0ffd2c61d9929eeaa51dd6f91d46ba2eb7eca99c3a190cddbb27f09b282b9f9
+  metadata.gz: 825076928662d5ad48eb2ad1990c68952c93785d118c46911a5aa5cdc365cc03
+  data.tar.gz: 6ac4fe07a6460242f75e08f13bb57cf2079365f89bca7c981d82574908947904
 SHA512:
-  metadata.gz: 1dae30f5fe89bf653fd9577474e896aa058de406f31c3ec677e793cfef03bf3c760d853da130a82ec14c1d7290e91afb65fb2c6e843612dc03b3b2662ba81a4b
-  data.tar.gz: b95312cb73b0c05ef27f868130a9a56bedf085416b6cccabe8e6f194de5e132e6ac4500641430fb3695f77b4653fa20cc6209c366690483e4693a1ad8b882ab7
+  metadata.gz: 457efecae9d8b5e9b2462f8f0557de75998d077aab9dd2177105d9ab0b958c1f13a7a53dada5ec156d08a8c330cae70c6a3d9b5d8cd5752721e95632571d6893
+  data.tar.gz: b8a4603cafe2e129b942a28a3d739d35048972bd8a726db4fc56295aa907703c66622563de59ca3910ee8a32a7ba89d2c2f276b7caa77ea20caaab093def915a

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

@@ -37,12 +37,13 @@ module Fastlane
 
         # 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)
@@ -50,21 +51,9 @@ module Fastlane
 
         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 @@ module Fastlane
           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 @@ module Fastlane
             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 @@ module Fastlane
         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 @@ module Fastlane
         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

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

@@ -11,7 +11,7 @@ module Fastlane
       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`.")

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

@@ -11,8 +11,6 @@ module Fastlane
       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 @@ module Fastlane
           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 @@ module Fastlane
         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
         )

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

@@ -11,7 +11,7 @@ module Fastlane
       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`.")

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

@@ -13,7 +13,7 @@ module Fastlane
       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]}...")
 

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

@@ -4,7 +4,6 @@ require 'shellwords'
 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 @@ module Fastlane
       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 @@ module Fastlane
         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 @@ module Fastlane
 
       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",

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

@@ -11,7 +11,7 @@ module Fastlane
       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`.")

data/lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_auth_client.rb

@@ -38,16 +38,12 @@ module Fastlane
         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 @@ module Fastlane
 
       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)
@@ -99,7 +101,10 @@ module Fastlane
       end
 
       def service_account(google_service_path, debug)
-        service_account_credentials = Google::Auth::ServiceAccountCredentials.make_creds(
+        # check if it's an external account or service account
+        json_file = JSON.parse(File.read(google_service_path))
+        auth = json_file["type"] == "external_account" ? Google::Auth::ExternalAccount::Credentials : Google::Auth::ServiceAccountCredentials
+        service_account_credentials = auth.make_creds(
           json_key_io: File.open(google_service_path),
           scope: SCOPE
         )

data/lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_helper.rb

@@ -1,5 +1,8 @@
 require 'fastlane_core/ui/ui'
+require 'google/apis/firebaseappdistribution_v1'
+require 'google/apis/firebaseappdistribution_v1alpha'
 require 'cfpropertylist'
+
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
   module Helper
@@ -53,8 +56,12 @@ module Fastlane
         !blank?(value)
       end
 
+      def project_number_from_app_id(app_id)
+        app_id.split(':')[1]
+      end
+
       def app_name_from_app_id(app_id)
-        "#{project_name(app_id.split(':')[1])}/apps/#{app_id}"
+        "#{project_name(project_number_from_app_id(app_id))}/apps/#{app_id}"
       end
 
       def project_name(project_number)
@@ -65,7 +72,17 @@ module Fastlane
         "#{project_name(project_number)}/groups/#{group_alias}"
       end
 
-      def init_client(service_credentials_file, firebase_cli_token, debug, timeout = nil)
+      def init_v1_client(service_credentials_file, firebase_cli_token, debug, timeout = nil)
+        init_client(Google::Apis::FirebaseappdistributionV1::FirebaseAppDistributionService.new,
+                    service_credentials_file, firebase_cli_token, debug, timeout)
+      end
+
+      def init_v1alpha_client(service_credentials_file, firebase_cli_token, debug, timeout = nil)
+        init_client(Google::Apis::FirebaseappdistributionV1alpha::FirebaseAppDistributionService.new,
+                    service_credentials_file, firebase_cli_token, debug, timeout)
+      end
+
+      def init_client(client, service_credentials_file, firebase_cli_token, debug, timeout = nil)
         if debug
           UI.important("Warning: Debug logging enabled. Output may include sensitive information.")
           Google::Apis.logger.level = Logger::DEBUG
@@ -77,7 +94,6 @@ module Fastlane
           Google::Apis::ClientOptions.default.send_timeout_sec = timeout
         end
 
-        client = Google::Apis::FirebaseappdistributionV1::FirebaseAppDistributionService.new
         client.authorization = get_authorization(service_credentials_file, firebase_cli_token, debug)
         client
       end

data/lib/fastlane/plugin/firebase_app_distribution/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.7.4"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-firebase_app_distribution
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Stefan Natchev
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-firebaseappdistribution_v1
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: google-apis-firebaseappdistribution_v1alpha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +186,6 @@ files:
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_latest_release.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_udids.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_remove_testers_action.rb
-- lib/fastlane/plugin/firebase_app_distribution/client/firebase_app_distribution_api_client.rb
 - lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_auth_client.rb
 - lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_error_message.rb
 - lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_helper.rb
@@ -196,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Release your beta builds to Firebase App Distribution. https://firebase.google.com/docs/app-distribution

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

@@ -1,97 +0,0 @@
-require 'fastlane_core/ui/ui'
-require_relative '../helper/firebase_app_distribution_helper'
-
-module Fastlane
-  module Client
-    class FirebaseAppDistributionApiClient
-      include Helper::FirebaseAppDistributionHelper
-
-      BASE_URL = "https://firebaseappdistribution.googleapis.com"
-      MAX_POLLING_RETRIES = 60
-      POLLING_INTERVAL_SECONDS = 5
-
-      AUTHORIZATION = "Authorization"
-      CONTENT_TYPE = "Content-Type"
-      APPLICATION_OCTET_STREAM = "application/octet-stream"
-      CLIENT_VERSION = "X-Client-Version"
-
-      def initialize(auth_token, debug = false)
-        @auth_token = auth_token
-        @debug = debug
-      end
-
-      # Uploads the app binary to the Firebase API
-      #
-      # args
-      #   app_name - Firebase App resource name
-      #   binary_path - Absolute path to your app's aab/apk/ipa file
-      #   platform - 'android' or 'ios'
-      #   timeout - The amount of seconds before the upload will timeout, if not completed
-      #
-      # Returns the long-running operation name.
-      #
-      # Throws a user_error if the binary file does not exist
-      def upload_binary(app_name, binary_path, platform, timeout)
-        response = connection.post(binary_upload_url(app_name), read_binary(binary_path)) do |request|
-          request.options.timeout = timeout # seconds
-          request.headers[AUTHORIZATION] = "Bearer " + @auth_token
-          request.headers[CONTENT_TYPE] = APPLICATION_OCTET_STREAM
-          request.headers[CLIENT_VERSION] = client_version_header_value
-          request.headers["X-Goog-Upload-File-Name"] = CGI.escape(File.basename(binary_path))
-          request.headers["X-Goog-Upload-Protocol"] = "raw"
-        end
-
-        response.body[:name] || ''
-      rescue Errno::ENOENT # Raised when binary_path file does not exist
-        binary_type = binary_type_from_path(binary_path)
-        UI.user_error!("#{ErrorMessage.binary_not_found(binary_type)}: #{binary_path}")
-      end
-
-      # Get tester UDIDs
-      #
-      # args
-      #   app_name - Firebase App resource name
-      #
-      # Returns a list of hashes containing tester device info
-      def get_udids(app_id)
-        begin
-          response = connection.get(get_udids_url(app_id)) do |request|
-            request.headers[AUTHORIZATION] = "Bearer " + @auth_token
-            request.headers[CLIENT_VERSION] = client_version_header_value
-          end
-        rescue Faraday::ResourceNotFound
-          UI.user_error!("#{ErrorMessage::INVALID_APP_ID}: #{app_id}")
-        end
-        response.body[:testerUdids] || []
-      end
-
-      private
-
-      def client_version_header_value
-        "fastlane/#{Fastlane::FirebaseAppDistribution::VERSION}"
-      end
-
-      def binary_upload_url(app_name)
-        "/upload/v1/#{app_name}/releases:upload"
-      end
-
-      def get_udids_url(app_id)
-        "/v1alpha/apps/#{app_id}/testers:getTesterUdids"
-      end
-
-      def connection
-        @connection ||= Faraday.new(url: BASE_URL) do |conn|
-          conn.response(:json, parser_options: { symbolize_names: true })
-          conn.response(:raise_error) # raise_error middleware will run before the json middleware
-          conn.response(:logger, nil, { headers: false, bodies: { response: true }, log_level: :debug }) if @debug
-          conn.adapter(Faraday.default_adapter)
-        end
-      end
-
-      def read_binary(path)
-        # File must be read in binary mode to work on Windows
-        File.open(path, 'rb').read
-      end
-    end
-  end
-end