fastlane-plugin-firebase_app_distribution 0.2.5 → 0.5.0

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

@@ -4,6 +4,14 @@ module Fastlane
   module Auth
     module FirebaseAppDistributionAuthClient
       TOKEN_CREDENTIAL_URI = "https://oauth2.googleapis.com/token"
+      REDACTION_EXPOSED_LENGTH = 5
+      REDACTION_CHARACTER = "X"
+      SCOPE = "https://www.googleapis.com/auth/cloud-platform"
+
+      # In this type of application, the client secret is not treated as a secret.
+      # See: https://developers.google.com/identity/protocols/OAuth2InstalledApp
+      CLIENT_ID = "563584335869-fgrhgmd47bqnekij5i8b5pr03ho849e6.apps.googleusercontent.com"
+      CLIENT_SECRET = "j9iVZfS8kkCEFUPaAeJV0sAi"
 
       # Returns the auth token for any of the auth methods (Firebase CLI token,
       # Google service account, firebase-tools). To ensure that a specific
@@ -11,80 +19,118 @@ module Fastlane
       #
       # args
       #   google_service_path - Absolute path to the Google service account file
-      #   firebase_cli_token - Firebase CLI refresh token from login action or
-      #                        CI environment
+      #   firebase_cli_token - Refresh token
+      #   debug - Whether to enable debug-level logging
       #
       # env variables
       #   GOOGLE_APPLICATION_CREDENTIALS - see google_service_path
       #   FIREBASE_TOKEN - see firebase_cli_token
       #
       # Crashes if given invalid or missing credentials
-      def fetch_auth_token(google_service_path, firebase_cli_token)
+      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}")
-          token = service_account(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")
-          token = firebase_token(firebase_cli_token)
+          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")
-          token = firebase_token(ENV["FIREBASE_TOKEN"])
+          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']}")
-          token = service_account(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.")
-          token = firebase_token(refresh_token)
+          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
 
-      def firebase_token(refresh_token)
+      def firebase_token(refresh_token, debug)
         client = Signet::OAuth2::Client.new(
           token_credential_uri: TOKEN_CREDENTIAL_URI,
-          client_id: Fastlane::Actions::FirebaseAppDistributionLoginAction::CLIENT_ID,
-          client_secret: Fastlane::Actions::FirebaseAppDistributionLoginAction::CLIENT_SECRET,
+          client_id: CLIENT_ID,
+          client_secret: CLIENT_SECRET,
           refresh_token: refresh_token
         )
         client.fetch_access_token!
         client.access_token
-      rescue Signet::AuthorizationError
-        UI.user_error!(ErrorMessage::REFRESH_TOKEN_ERROR)
+      rescue Signet::AuthorizationError => error
+        error_message = ErrorMessage::REFRESH_TOKEN_ERROR
+        if debug
+          error_message += "\nRefresh token used: #{format_token(refresh_token)}\n"
+          error_message += error_details(error)
+        else
+          error_message += " #{debug_instructions}"
+        end
+        UI.user_error!(error_message)
       end
 
-      def service_account(google_service_path)
+      def service_account(google_service_path, debug)
         service_account_credentials = Google::Auth::ServiceAccountCredentials.make_creds(
           json_key_io: File.open(google_service_path),
-          scope: Fastlane::Actions::FirebaseAppDistributionLoginAction::SCOPE
+          scope: SCOPE
         )
         service_account_credentials.fetch_access_token!["access_token"]
       rescue Errno::ENOENT
         UI.user_error!("#{ErrorMessage::SERVICE_CREDENTIALS_NOT_FOUND}: #{google_service_path}")
-      rescue Signet::AuthorizationError
-        UI.user_error!("#{ErrorMessage::SERVICE_CREDENTIALS_ERROR}: #{google_service_path}")
+      rescue Signet::AuthorizationError => error
+        error_message = "#{ErrorMessage::SERVICE_CREDENTIALS_ERROR}: \"#{google_service_path}\""
+        if debug
+          error_message += "\n#{error_details(error)}"
+        else
+          error_message += ". #{debug_instructions}"
+        end
+        UI.user_error!(error_message)
+      end
+
+      def error_details(error)
+        "#{error.message}\nResponse status: #{error.response.status}"
+      end
+
+      def debug_instructions
+        "For more information, try again with firebase_app_distribution's \"debug\" parameter set to \"true\"."
+      end
+
+      # Formats and redacts a token for printing out during debug logging. Examples:
+      #   'abcd' -> '"abcd"''
+      #   'abcdef1234' -> '"XXXXXf1234" (redacted)'
+      def format_token(str)
+        redaction_notice = str.length > REDACTION_EXPOSED_LENGTH ? " (redacted)" : ""
+        exposed_start_char = [str.length - REDACTION_EXPOSED_LENGTH, 0].max
+        exposed_characters = str[exposed_start_char, REDACTION_EXPOSED_LENGTH]
+        redacted_characters = REDACTION_CHARACTER * [str.length - REDACTION_EXPOSED_LENGTH, 0].max
+        "\"#{redacted_characters}#{exposed_characters}\"#{redaction_notice}"
       end
     end
   end

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

@@ -3,19 +3,29 @@ 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"
   REFRESH_TOKEN_ERROR = "App Distribution could not generate credentials from the refresh token specified."
-  GET_APP_ERROR = "App Distribution failed to fetch app information"
   APP_NOT_ONBOARDED_ERROR = "App Distribution not onboarded"
-  GET_APP_NO_CONTACT_EMAIL_ERROR = "App Distribution could not find a contact email associated with this app. Contact Email"
   INVALID_APP_ID = "App Distribution could not find your app. Make sure to onboard your app by pressing the \"Get started\" button on the App Distribution page in the Firebase console: https://console.firebase.google.com/project/_/appdistribution. App ID"
+  INVALID_PROJECT = "App Distribution could not find your Firebase project. Make sure to onboard an app in your project by pressing the \"Get started\" button on the App Distribution page in the Firebase console: https://console.firebase.google.com/project/_/appdistribution."
   INVALID_PATH = "Could not read content from"
-  INVALID_TESTERS = "Could not enable access for testers. Check that the groups exist and the tester emails are formatted correctly"
-  INVALID_RELEASE_ID = "App distribution failed to fetch release with id"
+  INVALID_TESTERS = "Could not enable access for testers. Check that the tester emails are formatted correctly, the groups exist and you are using group aliases (not group names) for specifying groups."
   INVALID_RELEASE_NOTES = "Failed to add release notes"
-  SERVICE_CREDENTIALS_ERROR = "App Distribution could not generate credentials from the service credentials file specified. Service Account Path"
+  SERVICE_CREDENTIALS_ERROR = "App Distribution could not generate credentials from the service credentials file specified"
+  PLAY_ACCOUNT_NOT_LINKED = "This project is not linked to a Google Play account."
+  APP_NOT_PUBLISHED = "This app is not published in the Google Play console."
+  NO_APP_WITH_GIVEN_BUNDLE_ID_IN_PLAY_ACCOUNT = "App with matching package name does not exist in Google Play."
+  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}"
+  end
 
   def self.binary_not_found(binary_type)
     "Could not find the #{binary_type}. Make sure you set the #{binary_type} path parameter to point to your #{binary_type}"

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

@@ -4,6 +4,15 @@ module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
   module Helper
     module FirebaseAppDistributionHelper
+      def binary_type_from_path(binary_path)
+        extension = File.extname(binary_path)
+        return :APK if extension == '.apk'
+        return :AAB if extension == '.aab'
+        return :IPA if extension == '.ipa'
+
+        UI.user_error!("Unsupported distribution file format, should be .ipa, .apk or .aab")
+      end
+
       def get_value_from_value_or_file(value, path)
         if (value.nil? || value.empty?) && !path.nil?
           begin
@@ -15,13 +24,12 @@ module Fastlane
         value
       end
 
-      # Returns the array representation of a string with comma seperated values.
-      #
-      # Does not work with strings whose individual values have spaces. EX "Hello World" the space will be removed to "HelloWorld"
+      # Returns the array representation of a string with trimmed comma
+      # seperated values.
       def string_to_array(string)
         return nil if string.nil? || string.empty?
-        string_array = string.gsub(/\s+/, '').split(",")
-        return string_array
+        # Strip string and then strip individual values
+        string.strip.split(",").map(&:strip)
       end
 
       def parse_plist(path)
@@ -35,6 +43,19 @@ module Fastlane
         UI.shell_error!("can't extract GOOGLE_APP_ID") if identifier.empty?
         return identifier
       end
+
+      def blank?(value)
+        # Taken from https://apidock.com/rails/Object/blank%3F
+        value.respond_to?(:empty?) ? value.empty? : !value
+      end
+
+      def present?(value)
+        !blank?(value)
+      end
+
+      def app_name_from_app_id(app_id)
+        "projects/#{app_id.split(':')[1]}/apps/#{app_id}"
+      end
     end
   end
 end

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

@@ -3,35 +3,75 @@ class UploadStatusResponse
     @response_json_hash = response_json_hash
   end
 
+  def done
+    !!@response_json_hash[:done]
+  end
+
+  def response
+    @response_json_hash[:response]
+  end
+
+  def release
+    response ? response[:release] : nil
+  end
+
+  def release_name
+    release ? release[:name] : nil
+  end
+
+  def release_version
+    if release
+      if release[:displayVersion] && release[:buildVersion]
+        "#{release[:displayVersion]} (#{release[:buildVersion]})"
+      elsif release[:displayVersion]
+        release[:displayVersion]
+      else
+        release[:buildVersion]
+      end
+    end
+  end
+
+  def firebase_console_uri
+    release ? release[:firebaseConsoleUri] : nil
+  end
+
+  def testing_uri
+    release ? release[:testingUri] : nil
+  end
+
+  def binary_download_uri
+    release ? release[:binaryDownloadUri] : nil
+  end
+
   def status
-    @response_json_hash[:status]
+    response ? response[:result] : nil
   end
 
-  def success?
-    status == 'SUCCESS'
+  def error
+    @response_json_hash[:error]
   end
 
-  def in_progress?
-    status == 'IN_PROGRESS'
+  def error_message
+    error ? error[:message] : nil
   end
 
-  def error?
-    status == 'ERROR'
+  def success?
+    done && !!release
   end
 
-  def already_uploaded?
-    status == 'ALREADY_UPLOADED'
+  def in_progress?
+    !done
   end
 
-  def release_hash
-    @response_json_hash[:release]
+  def error?
+    done && message
   end
 
-  def release_id
-    release_hash ? release_hash[:id] : nil
+  def release_updated?
+    done && status == 'RELEASE_UPDATED'
   end
 
-  def message
-    @response_json_hash[:message]
+  def release_unmodified?
+    done && status == 'RELEASE_UNMODIFIED'
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.2.5"
+    VERSION = "0.5.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.2.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Stefan Natchev
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -149,9 +149,14 @@ 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_login.rb
+- lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb
+- 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/aab_info.rb
 - lib/fastlane/plugin/firebase_app_distribution/client/error_response.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
@@ -178,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.6
 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/actions/firebase_app_distribution_login.rb

@@ -1,58 +0,0 @@
-require 'googleauth'
-require 'googleauth/stores/file_token_store'
-require "google/apis/people_v1"
-require "fileutils"
-
-module Fastlane
-  module Actions
-    class FirebaseAppDistributionLoginAction < Action
-      OOB_URI = "urn:ietf:wg:oauth:2.0:oob"
-      SCOPE = "https://www.googleapis.com/auth/cloud-platform"
-      CLIENT_ID = "563584335869-fgrhgmd47bqnekij5i8b5pr03ho849e6.apps.googleusercontent.com"
-      CLIENT_SECRET = "j9iVZfS8kkCEFUPaAeJV0sAi"
-
-      def self.run(params)
-        client_id = Google::Auth::ClientId.new(CLIENT_ID, CLIENT_SECRET)
-        authorizer = Google::Auth::UserAuthorizer.new(client_id, SCOPE, nil)
-        url = authorizer.get_authorization_url(base_url: OOB_URI)
-
-        UI.message("Open the following address in your browser and sign in with your Google account:")
-        UI.message(url)
-        UI.message("")
-        code = UI.input("Enter the resulting code here: ")
-        credentials = authorizer.get_credentials_from_code(code: code, base_url: OOB_URI)
-        UI.message("")
-
-        UI.success("Set the refresh token as the FIREBASE_TOKEN environment variable")
-        UI.success("Refresh Token: #{credentials.refresh_token}")
-      rescue Signet::AuthorizationError
-        UI.error("The code you entered is invalid. Copy and paste the code and try again.")
-      rescue => error
-        UI.error(error.to_s)
-        UI.crash!("An error has occured, please login again.")
-      end
-
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
-      def self.description
-        "Authenticate with Firebase App Distribution using a Google account."
-      end
-
-      def self.details
-        "Log in to Firebase App Distribution using a Google account to generate an authentication "\
-        "token. This token is stored within an environment variable and used to authenticate with your Firebase project. "\
-        "See https://firebase.google.com/docs/app-distribution/ios/distribute-fastlane for more information."
-      end
-
-      def self.authors
-        ["Manny Jimenez Github: mannyjimenez0810, Alonso Salas Infante Github: alonsosalasinfante"]
-      end
-
-      def self.is_supported?(platform)
-        [:ios, :android].include?(platform)
-      end
-    end
-  end
-end