fastlane_hotfix 2.165.1 → 2.187.0

data/spaceship/lib/spaceship/base.rb

@@ -89,12 +89,12 @@ module Spaceship
       ##
       # Sets client and returns self for chaining.
       # @return (Spaceship::Base)
-      # rubocop:disable Style/AccessorMethodName
+      # rubocop:disable Naming/AccessorMethodName
       def set_client(client)
         self.client = client
         self
       end
-      # rubocop:enable Style/AccessorMethodName
+      # rubocop:enable Naming/AccessorMethodName
 
       ##
       # Binds attributes getters and setters to underlying data returned from the API.

data/spaceship/lib/spaceship/client.rb

@@ -57,6 +57,7 @@ module Spaceship
     InternalServerError = Spaceship::InternalServerError
     BadGatewayError = Spaceship::BadGatewayError
     AccessForbiddenError = Spaceship::AccessForbiddenError
+    TooManyRequestsError = Spaceship::TooManyRequestsError
 
     def self.hostname
       raise "You must implement self.hostname"
@@ -133,7 +134,7 @@ module Spaceship
       if teams.count > 1
         puts("The current user is in #{teams.count} teams. Pass a team ID or call `select_team` to choose a team. Using the first one for now.")
       end
-      @current_team_id ||= teams[0]['contentProvider']['contentProviderId']
+      @current_team_id ||= user_details_data['sessionToken']['contentProviderId']
     end
 
     # Set a new team ID which will be used from now on
@@ -146,7 +147,6 @@ module Spaceship
       available_teams = teams.collect do |team|
         {
           team_id: (team["contentProvider"] || {})["contentProviderId"],
-          public_team_id: (team["contentProvider"] || {})["contentProviderPublicId"],
           team_name: (team["contentProvider"] || {})["name"]
         }
       end
@@ -161,25 +161,19 @@ module Spaceship
       end
 
       response = request(:post) do |req|
-        req.url("https://appstoreconnect.apple.com/olympus/v1/providerSwitchRequests")
+        req.url("ra/v2/session/webSession")
         req.body = {
-          "data": {
-            "type": "providerSwitchRequests",
-            "relationships": {
-              "provider": {
-                "data": {
-                  "type": "providers",
-                  "id": result[:public_team_id]
-                }
-              }
-            }
-          }
+          contentProviderId: team_id,
+          dsId: user_detail_data.ds_id # https://github.com/fastlane/fastlane/issues/6711
         }.to_json
         req.headers['Content-Type'] = 'application/json'
       end
 
       handle_itc_response(response.body)
 
+      # clear user_details_data cache, as session switch will have changed sessionToken attribute
+      @_cached_user_details = nil
+
       @current_team_id = team_id
     end
 
@@ -412,6 +406,7 @@ module Spaceship
     # This will also handle 2 step verification and 2 factor authentication
     #
     # It is called in `send_login_request` of sub classes (which the method `login`, above, transferred over to via `do_login`)
+    # rubocop:disable Metrics/PerceivedComplexity
     def send_shared_login_request(user, password)
       # Check if we have a cached/valid session
       #
@@ -515,9 +510,19 @@ module Spaceship
           # User Credentials are wrong
           raise InvalidUserCredentialsError.new, "Invalid username and password combination. Used '#{user}' as the username."
         elsif response.status == 412 && AUTH_TYPES.include?(response.body["authType"])
+
+          if try_upgrade_2fa_later(response)
+            store_cookie
+            fetch_olympus_session
+            return true
+          end
+
           # Need to acknowledge Apple ID and Privacy statement - https://github.com/fastlane/fastlane/issues/12577
           # Looking for status of 412 might be enough but might be safer to keep looking only at what is being reported
-          raise AppleIDAndPrivacyAcknowledgementNeeded.new, "Need to acknowledge to Apple's Apple ID and Privacy statement. Please manually log into https://appleid.apple.com (or https://appstoreconnect.apple.com) to acknowledge the statement."
+          raise AppleIDAndPrivacyAcknowledgementNeeded.new, "Need to acknowledge to Apple's Apple ID and Privacy statement. " \
+                                                            "Please manually log into https://appleid.apple.com (or https://appstoreconnect.apple.com) to acknowledge the statement. " \
+                                                            "Your account might also be asked to upgrade to 2FA. " \
+                                                            "Set SPACESHIP_SKIP_2FA_UPGRADE=1 for fastlane to automaticaly bypass 2FA upgrade if possible."
         elsif (response['Set-Cookie'] || "").include?("itctx")
           raise "Looks like your Apple ID is not enabled for App Store Connect, make sure to be able to login online"
         else
@@ -526,6 +531,7 @@ module Spaceship
         end
       end
     end
+    # rubocop:enable Metrics/PerceivedComplexity
 
     # Get the `itctx` from the new (22nd May 2017) API endpoint "olympus"
     # Update (29th March 2019) olympus migrates to new appstoreconnect API
@@ -655,6 +661,17 @@ module Spaceship
         retry
       end
       raise ex # re-raise the exception
+    rescue TooManyRequestsError => ex
+      tries -= 1
+      unless tries.zero?
+        msg = "Timeout received: '#{ex.class}', '#{ex.message}'. Retrying after #{ex.retry_after} seconds (remaining: #{tries})..."
+        puts(msg) if Spaceship::Globals.verbose?
+        logger.warn(msg)
+
+        sleep(ex.retry_after) unless Object.const_defined?("SpecHelper")
+        retry
+      end
+      raise ex # re-raise the exception
     rescue \
         Faraday::ParsingError, # <h2>Internal Server Error</h2> with content type json
         InternalServerError => ex
@@ -866,10 +883,7 @@ module Spaceship
         response = @client.send(method, url_or_path, params, headers, &block)
         log_response(method, url_or_path, response, headers, &block)
 
-        resp_hash = response.to_hash
-        if resp_hash[:status] == 401
-          handle_401(response)
-        end
+        handle_error(response)
 
         if response.body.to_s.include?("<title>302 Found</title>")
           raise AppleTimeoutError.new, "Apple 302 detected - this might be temporary server error, check https://developer.apple.com/system-status/ to see if there is a known downtime"
@@ -879,20 +893,23 @@ module Spaceship
           raise BadGatewayError.new, "Apple 502 detected - this might be temporary server error, try again later"
         end
 
-        if resp_hash[:status] == 403
-          msg = "Access forbidden"
-          logger.warn(msg)
-          raise AccessForbiddenError.new, msg
-        end
-
         return response
       end
     end
 
-    def handle_401(response)
-      msg = "Auth lost"
-      logger.warn(msg)
-      raise UnauthorizedAccessError.new, "Unauthorized Access"
+    def handle_error(response)
+      case response.status
+      when 401
+        msg = "Auth lost"
+        logger.warn(msg)
+        raise UnauthorizedAccessError.new, "Unauthorized Access"
+      when 403
+        msg = "Access forbidden"
+        logger.warn(msg)
+        raise AccessForbiddenError.new, msg
+      when 429
+        raise TooManyRequestsError, response.to_hash
+      end
     end
 
     def send_request_auto_paginate(method, url_or_path, params, headers, &block)
@@ -921,3 +938,4 @@ module Spaceship
 end
 
 require 'spaceship/two_step_or_factor_client'
+require 'spaceship/upgrade_2fa_later_client'

data/spaceship/lib/spaceship/commands_generator.rb

@@ -3,6 +3,7 @@ require 'highline'
 HighLine.track_eof = false
 
 require 'fastlane/version'
+require 'fastlane_core/ui/help_formatter'
 require_relative 'playground'
 require_relative 'spaceauth_runner'
 
@@ -21,7 +22,7 @@ module Spaceship
       program :help, 'Author', 'Felix Krause <spaceship@krausefx.com>'
       program :help, 'Website', 'https://fastlane.tools'
       program :help, 'GitHub', 'https://github.com/fastlane/fastlane/tree/master/spaceship'
-      program :help_formatter, :compact
+      program :help_formatter, FastlaneCore::HelpFormatter
 
       global_option('-u', '--user USERNAME', 'Specify the Apple ID you want to log in with')
       global_option('--verbose') { FastlaneCore::Globals.verbose = true }
@@ -39,9 +40,10 @@ module Spaceship
       command :spaceauth do |c|
         c.syntax = 'fastlane spaceship spaceauth'
         c.description = 'Authentication helper for spaceship/fastlane to work with Apple 2-Step/2FA'
+        c.option('--copy_to_clipboard', 'Whether the session string should be copied to clipboard. For more info see https://docs.fastlane.tools/best-practices/continuous-integration/#storing-a-manually-verified-session-using-spaceauth`')
 
         c.action do |args, options|
-          Spaceship::SpaceauthRunner.new(username: options.user).run
+          Spaceship::SpaceauthRunner.new(username: options.user, copy_to_clipboard: options.copy_to_clipboard).run
         end
       end
 

data/spaceship/lib/spaceship/connect_api.rb

@@ -35,6 +35,12 @@ require 'spaceship/connect_api/models/custom_app_organization'
 require 'spaceship/connect_api/models/custom_app_user'
 require 'spaceship/connect_api/models/pre_release_version'
 
+require 'spaceship/connect_api/models/app_data_usage'
+require 'spaceship/connect_api/models/app_data_usage_category'
+require 'spaceship/connect_api/models/app_data_usage_data_protection'
+require 'spaceship/connect_api/models/app_data_usage_grouping'
+require 'spaceship/connect_api/models/app_data_usage_purposes'
+require 'spaceship/connect_api/models/app_data_usages_publish_state'
 require 'spaceship/connect_api/models/age_rating_declaration'
 require 'spaceship/connect_api/models/app_category'
 require 'spaceship/connect_api/models/app_info'

data/spaceship/lib/spaceship/connect_api/api_client.rb

@@ -150,6 +150,12 @@ module Spaceship
 
       protected
 
+      class TimeoutRetryError < StandardError
+        def initialize(msg)
+          super
+        end
+      end
+
       def with_asc_retry(tries = 5, &_block)
         tries = 1 if Object.const_defined?("SpecHelper")
 
@@ -159,7 +165,7 @@ module Spaceship
 
         if [500, 504].include?(status)
           msg = "Timeout received! Retrying after 3 seconds (remaining: #{tries})..."
-          raise msg
+          raise TimeoutRetryError, msg
         end
 
         return response
@@ -167,7 +173,7 @@ module Spaceship
         # Catch unathorized access and re-raising
         # There is no need to try again
         raise error
-      rescue => error
+      rescue TimeoutRetryError => error
         tries -= 1
         puts(error) if Spaceship::Globals.verbose?
         if tries.zero?
@@ -190,20 +196,35 @@ module Spaceship
 
         raise UnexpectedResponse, response.body['error'] if response.body['error']
 
-        raise UnexpectedResponse, handle_errors(response) if response.body['errors']
+        raise UnexpectedResponse, format_errors(response) if response.body['errors']
 
         raise UnexpectedResponse, "Temporary App Store Connect error: #{response.body}" if response.body['statusCode'] == 'ERROR'
 
         store_csrf_tokens(response)
 
-        return Spaceship::ConnectAPI::Response.new(body: response.body, status: response.status, client: self)
+        return Spaceship::ConnectAPI::Response.new(body: response.body, status: response.status, headers: response.headers, client: self)
       end
 
-      def handle_401(response)
-        raise UnauthorizedAccessError, handle_errors(response) if response && (response.body || {})['errors']
+      # Overridden from Spaceship::Client
+      def handle_error(response)
+        body = response.body.empty? ? {} : response.body
+        body = JSON.parse(body) if body.kind_of?(String)
+
+        case response.status.to_i
+        when 401
+          raise UnauthorizedAccessError, format_errors(response)
+        when 403
+          error = (body['errors'] || []).first || {}
+          error_code = error['code']
+          if error_code == "FORBIDDEN.REQUIRED_AGREEMENTS_MISSING_OR_EXPIRED"
+            raise ProgramLicenseAgreementUpdated, format_errors(response)
+          else
+            raise AccessForbiddenError, format_errors(response)
+          end
+        end
       end
 
-      def handle_errors(response)
+      def format_errors(response)
         # Example error format
         # {
         # "errors":[
@@ -247,8 +268,39 @@ module Spaceship
         # ]
         # }
 
-        return response.body['errors'].map do |error|
-          messages = [[error['title'], error['detail']].compact.join(" - ")]
+        # Detail is missing in this response making debugging super hard
+        # {"errors" =>
+        #   [
+        #     {
+        #       "id"=>"80ea6cff-0043-4543-9cd1-3e26b0fce383",
+        #       "status"=>"409",
+        #       "code"=>"ENTITY_ERROR.RELATIONSHIP.INVALID",
+        #       "title"=>"The provided entity includes a relationship with an invalid value",
+        #       "source"=>{
+        #         "pointer"=>"/data/relationships/primarySubcategoryOne"
+        #       }
+        #     }
+        #   ]
+        # }
+
+        # Membership expired
+        # {
+        #   "errors" : [
+        #     {
+        #       "id" : "UUID",
+        #       "status" : "403",
+        #       "code" : "FORBIDDEN_ERROR",
+        #       "title" : "This request is forbidden for security reasons",
+        #       "detail" : "Team ID: 'ID' is not associated with an active membership. To check your teams membership status, sign in your account on the developer website. https://developer.apple.com/account/"
+        #     }
+        #   ]
+        # }
+
+        body = response.body.empty? ? {} : response.body
+        body = JSON.parse(body) if body.kind_of?(String)
+
+        formatted_errors = (body['errors'] || []).map do |error|
+          messages = [[error['title'], error['detail'], error.dig("source", "pointer")].compact.join(" - ")]
 
           meta = error["meta"] || {}
           associated_errors = meta["associatedErrors"] || {}
@@ -257,6 +309,12 @@ module Spaceship
             [[associated_error["title"], associated_error["detail"]].compact.join(" - ")]
           end
         end.flatten.join("\n")
+
+        if formatted_errors.empty?
+          formatted_errors << "Unknown error"
+        end
+
+        return formatted_errors
       end
 
       private

data/spaceship/lib/spaceship/connect_api/model.rb

@@ -30,7 +30,7 @@ module Spaceship
       # Creates alias for :minOsVersion to :min_os_version
       #
       def attr_mapping(attr_map)
-        self.reverse_attr_map ||= attr_map.invert.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
+        self.reverse_attr_map ||= attr_map.invert.transform_keys(&:to_sym)
         attr_map.each do |key, value|
           # Actual
           reader = value.to_sym

data/spaceship/lib/spaceship/connect_api/models/age_rating_declaration.rb

@@ -6,23 +6,29 @@ module Spaceship
 
       # Rating
       attr_accessor :alcohol_tobacco_or_drug_use_or_references
+      attr_accessor :contests
       attr_accessor :gambling_simulated
       attr_accessor :medical_or_treatment_information
       attr_accessor :profanity_or_crude_humor
       attr_accessor :sexual_content_graphic_and_nudity
+      attr_accessor :sexual_content_or_nudity
       attr_accessor :horror_or_fear_themes
       attr_accessor :mature_or_suggestive_themes
       attr_accessor :violence_cartoon_or_fantasy
       attr_accessor :violence_realistic_prolonged_graphic_or_sadistic
       attr_accessor :violence_realistic
 
-      # boolean
-      attr_accessor :gambling_and_contests
+      # Boolean
+      attr_accessor :gambling
+      attr_accessor :seventeen_plus
       attr_accessor :unrestricted_web_access
 
       # KidsAge
       attr_accessor :kids_age_band
 
+      # Deprecated as of App Store Connect API 1.3
+      attr_accessor :gambling_and_contests
+
       module Rating
         NONE = "NONE"
         INFREQUENT_OR_MILD = "INFREQUENT_OR_MILD"
@@ -37,10 +43,12 @@ module Spaceship
 
       attr_mapping({
         "alcoholTobaccoOrDrugUseOrReferences" => "alcohol_tobacco_or_drug_use_or_references",
-        "gamblingAndContests" => "gambling_and_contests",
+        "contests" => "contests",
+        "gambling" => "gambling",
         "gamblingSimulated" => "gambling_simulated",
         "medicalOrTreatmentInformation" => "medical_or_treatment_information",
         "profanityOrCrudeHumor" => "profanity_or_crude_humor",
+        "seventeenPlus" => "seventeen_plus",
         "sexualContentGraphicAndNudity" => "sexual_content_graphic_and_nudity",
         "sexualContentOrNudity" => "sexual_content_or_nudity",
         "horrorOrFearThemes" => "horror_or_fear_themes",
@@ -49,7 +57,10 @@ module Spaceship
         "violenceCartoonOrFantasy" => "violence_cartoon_or_fantasy",
         "violenceRealisticProlongedGraphicOrSadistic" => "violence_realistic_prolonged_graphic_or_sadistic",
         "violenceRealistic" => "violence_realistic",
-        "kidsAgeBand" => "kids_age_band"
+        "kidsAgeBand" => "kids_age_band",
+
+        # Deprecated as of App Store Connect API 1.3
+        "gamblingAndContests" => "gambling_and_contests",
       })
 
       def self.type
@@ -83,6 +94,27 @@ module Spaceship
         1 => true
       }
 
+      def self.map_deprecation_if_possible(attributes)
+        attributes = attributes.dup
+        messages = []
+        errors = []
+
+        value = attributes.delete('gamblingAndContests')
+        return attributes, messages, errors if value.nil?
+
+        messages << "Age Rating 'gamblingAndContests' has been deprecated and split into 'gambling' and 'contests'"
+
+        attributes['gambling'] = value
+        if value == true
+          errors << "'gamblingAndContests' could not be mapped to 'contests' - 'contests' requires a value of 'NONE', 'INFREQUENT_OR_MILD', or 'FREQUENT_OR_INTENSE'"
+          attributes['contests'] = value
+        else
+          attributes['contests'] = 'NONE'
+        end
+
+        return attributes, messages, errors
+      end
+
       def self.map_key_from_itc(key)
         key = key.gsub("MZGenre.", "")
         return nil if key.empty?
@@ -105,9 +137,10 @@ module Spaceship
       # API
       #
 
-      def update(attributes: nil)
+      def update(client: nil, attributes: nil)
+        client ||= Spaceship::ConnectAPI
         attributes = reverse_attr_mapping(attributes)
-        Spaceship::ConnectAPI.patch_age_rating_declaration(age_rating_declaration_id: id, attributes: attributes)
+        client.patch_age_rating_declaration(age_rating_declaration_id: id, attributes: attributes)
       end
     end
   end