fastlane-plugin-firebase_app_distribution 0.3.6 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbab06941b8df52d0959f4792a5414de798b9038f89c8774b5e35afd57019729
-  data.tar.gz: 4b64872b0d8bc723fcb85bdf31d447bfd0ac001595c27e2209faa792d31a79ca
+  metadata.gz: 9054b14c72ce1d0b5ee23da37fc3da51a2860b3249b07e5271d281c47570e5d0
+  data.tar.gz: 22e4f72109457476f1ab857e6dad86146ae3733972fda42cb80c8c73b89d42fc
 SHA512:
-  metadata.gz: 27fc550a02fad5d23cca0ac7abf1b1787df45ff01facf402a1a64bff6d1489c61058e1a92a78027779f0ef2f55308dab59a87052ad326ef8ce050a643cc65c3c
-  data.tar.gz: 862ccc4890c1f7c76ae2c1491da5c039551de3c016e405052f3487b702fcdf897dad14ae0513c70b79e657d61abbd397b7c66b1969685808d1c3c73f60e94ff5
+  metadata.gz: 80f3d004d4f6263a15c6aba591bb5ae10705dca4c9c31c8f6f0dc4f513e6fbe50310e605cae5b30a4c3bc28ac0eadca29d4bcd51b19b2ed3f970001df1b6d8fa
+  data.tar.gz: 4f4b8f3780fd86299ea1c393e6446e02e5e4414b498b4f85b764a27f8584395f88b40325d54e33bd6e782bc9fe3b58960e8ba72fd5e6e453aba3d563e555e14b

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

@@ -15,6 +15,8 @@ module Fastlane
       extend Auth::FirebaseAppDistributionAuthClient
       extend Helper::FirebaseAppDistributionHelper
 
+      DEFAULT_UPLOAD_TIMEOUT_SECONDS = 300
+
       def self.run(params)
         params.values # to validate all inputs before looking for the ipa/apk/aab
 
@@ -42,7 +44,9 @@ module Fastlane
           validate_aab_setup!(aab_info)
         end
 
-        release_name = fad_api_client.upload(app_name, binary_path, platform.to_s)
+        upload_timeout = get_upload_timeout(params)
+
+        release_name = fad_api_client.upload(app_name, binary_path, platform.to_s, upload_timeout)
 
         if binary_type == :AAB && aab_info && !aab_info.certs_provided?
           updated_aab_info = fad_api_client.get_aab_info(app_name)
@@ -135,6 +139,14 @@ module Fastlane
         end
       end
 
+      def self.get_upload_timeout(params)
+        if params[:upload_timeout]
+          return params[:upload_timeout]
+        else
+          return DEFAULT_UPLOAD_TIMEOUT_SECONDS
+        end
+      end
+
       def self.validate_aab_setup!(aab_info)
         if aab_info && aab_info.integration_state != AabInfo::AabState::INTEGRATED && aab_info.integration_state != AabInfo::AabState::UNAVAILABLE
           case aab_info.integration_state
@@ -242,7 +254,12 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :service_credentials_file,
                                        description: "Path to Google service account json",
                                        optional: true,
-                                       type: String)
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :upload_timeout,
+                                       description: "The amount of seconds before the upload will timeout, if not completed",
+                                       optional: true,
+                                       default_value: DEFAULT_UPLOAD_TIMEOUT_SECONDS,
+                                       type: Integer)
         ]
       end
 

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

@@ -106,11 +106,12 @@ module Fastlane
       #   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
       #
       # Throws a user_error if the binary file does not exist
-      def upload_binary(app_name, binary_path, platform)
+      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 = 300 # seconds
+          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
@@ -130,16 +131,17 @@ module Fastlane
       # args
       #   app_name - Firebase App resource name
       #   binary_path - Absolute path to your app's aab/apk/ipa file
+      #   timeout - The amount of seconds before the upload will timeout, if not completed
       #
       # Returns the release_name of the uploaded release.
       #
       # Crashes if the number of polling retries exceeds MAX_POLLING_RETRIES or if the binary cannot
       # be uploaded.
-      def upload(app_name, binary_path, platform)
+      def upload(app_name, binary_path, platform, timeout)
         binary_type = binary_type_from_path(binary_path)
 
         UI.message("⌛ Uploading the #{binary_type}.")
-        operation_name = upload_binary(app_name, binary_path, platform)
+        operation_name = upload_binary(app_name, binary_path, platform, timeout)
 
         upload_status_response = get_upload_status(operation_name)
         MAX_POLLING_RETRIES.times do

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

@@ -24,44 +24,50 @@ module Fastlane
       # Crashes if given invalid or missing credentials
       def fetch_auth_token(google_service_path, firebase_cli_token, debug = false)
         if !google_service_path.nil? && !google_service_path.empty?
-          UI.message("Authenticating with --service_credentials_file path parameter: #{google_service_path}")
+          UI.message("🔐 Authenticating with --service_credentials_file path parameter: #{google_service_path}")
           token = service_account(google_service_path, debug)
         elsif !firebase_cli_token.nil? && !firebase_cli_token.empty?
-          UI.message("Authenticating with --firebase_cli_token parameter")
+          UI.message("🔐 Authenticating with --firebase_cli_token parameter")
           token = firebase_token(firebase_cli_token, debug)
         elsif !ENV["FIREBASE_TOKEN"].nil? && !ENV["FIREBASE_TOKEN"].empty?
-          UI.message("Authenticating with FIREBASE_TOKEN environment variable")
+          UI.message("🔐 Authenticating with FIREBASE_TOKEN environment variable")
           token = firebase_token(ENV["FIREBASE_TOKEN"], debug)
         elsif !ENV["GOOGLE_APPLICATION_CREDENTIALS"].nil? && !ENV["GOOGLE_APPLICATION_CREDENTIALS"].empty?
-          UI.message("Authenticating with GOOGLE_APPLICATION_CREDENTIALS environment variable: #{ENV['GOOGLE_APPLICATION_CREDENTIALS']}")
+          UI.message("🔐 Authenticating with GOOGLE_APPLICATION_CREDENTIALS environment variable: #{ENV['GOOGLE_APPLICATION_CREDENTIALS']}")
           token = service_account(ENV["GOOGLE_APPLICATION_CREDENTIALS"], debug)
         elsif (refresh_token = refresh_token_from_firebase_tools)
-          UI.message("No authentication method specified. Using cached Firebase CLI credentials.")
+          UI.message("🔐 No authentication method specified. Using cached Firebase CLI credentials.")
           token = firebase_token(refresh_token, debug)
         else
           UI.user_error!(ErrorMessage::MISSING_CREDENTIALS)
         end
-        UI.success("🔐 Authenticated successfully.")
         token
       end
 
       private
 
       def refresh_token_from_firebase_tools
-        if ENV["XDG_CONFIG_HOME"].nil? || ENV["XDG_CONFIG_HOME"].empty?
-          config_path = File.expand_path(".config/configstore/firebase-tools.json", "~")
-        else
-          config_path = File.expand_path("configstore/firebase-tools.json", ENV["XDG_CONFIG_HOME"])
-        end
-
+        config_path = format_config_path
         if File.exist?(config_path)
           begin
-            refresh_token = JSON.parse(File.read(config_path))['tokens']['refresh_token']
-            refresh_token unless refresh_token.nil? || refresh_token.empty?
-          # TODO: Catch parser errors, improve error handling here
-          # Returns nil when there is an empty "tokens" field in the firebase-tools json
-          rescue NoMethodError
+            firebase_tools_tokens = JSON.parse(File.read(config_path))['tokens']
+            if firebase_tools_tokens.nil?
+              UI.user_error!(ErrorMessage::EMPTY_TOKENS_FIELD)
+              return
+            end
+            refresh_token = firebase_tools_tokens['refresh_token']
+          rescue JSON::ParserError
+            UI.user_error!(ErrorMessage::PARSE_FIREBASE_TOOLS_JSON_ERROR)
           end
+          refresh_token unless refresh_token.nil? || refresh_token.empty?
+        end
+      end
+
+      def format_config_path
+        if ENV["XDG_CONFIG_HOME"].nil? || ENV["XDG_CONFIG_HOME"].empty?
+          File.expand_path(".config/configstore/firebase-tools.json", "~")
+        else
+          File.expand_path("configstore/firebase-tools.json", ENV["XDG_CONFIG_HOME"])
         end
       end
 

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

@@ -3,6 +3,7 @@ module ErrorMessage
   MISSING_APP_ID = "Missing app id. Please check that the app parameter is set and try again"
   SERVICE_CREDENTIALS_NOT_FOUND = "Service credentials file does not exist. Please check the service credentials path and try again"
   PARSE_SERVICE_CREDENTIALS_ERROR = "Failed to extract service account information from the service credentials file"
+  PARSE_FIREBASE_TOOLS_JSON_ERROR = "Encountered error parsing json file. Ensure the firebase-tools.json file is formatted correctly"
   UPLOAD_RELEASE_NOTES_ERROR = "App Distribution halted because it had a problem uploading release notes"
   UPLOAD_TESTERS_ERROR = "App Distribution halted because it had a problem adding testers/groups"
   GET_RELEASE_TIMEOUT = "App Distribution failed to fetch release information"
@@ -20,6 +21,7 @@ module ErrorMessage
   PLAY_IAS_TERMS_NOT_ACCEPTED = "You must accept the Play Internal App Sharing (IAS) terms to upload AABs."
   INVALID_EMAIL_ADDRESS = "You passed an invalid email address."
   TESTER_LIMIT_VIOLATION = "Creating testers would exceed tester limit"
+  EMPTY_TOKENS_FIELD = "Unable to find \"tokens\" field in the firebase-tools.json file. Ensure that the file has a tokens field and try again"
 
   def self.aab_upload_error(aab_state)
     "Failed to process the AAB: #{aab_state}"

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

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.3.6"
+    VERSION = "0.3.8"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-firebase_app_distribution
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.8
 platform: ruby
 authors:
 - Stefan Natchev
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -149,6 +149,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- fad-icon.png
 - lib/fastlane/plugin/firebase_app_distribution.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb