fastlane_hotfix 2.165.0 → 2.187.0

data/deliver/lib/deliver/app_screenshot.rb

@@ -82,15 +82,12 @@ module Deliver
     # @param path (String) path to the screenshot file
     # @param language (String) Language of this screenshot (e.g. English)
     # @param screen_size (Deliver::AppScreenshot::ScreenSize) the screen size, which
-    #  will automatically be calculated when you don't set it.
+    #  will automatically be calculated when you don't set it. (Deprecated)
     def initialize(path, language, screen_size = nil)
+      UI.deprecated('`screen_size` for Deliver::AppScreenshot.new is deprecated in favor of the default behavior to calculate size automatically. Passed value is no longer validated.') if screen_size
       self.path = path
       self.language = language
-      screen_size ||= self.class.calculate_screen_size(path)
-
-      self.screen_size = screen_size
-
-      UI.error("Looks like the screenshot given (#{path}) does not match the requirements of #{screen_size}") unless self.is_valid?
+      self.screen_size = screen_size || self.class.calculate_screen_size(path)
     end
 
     # The iTC API requires a different notation for the device
@@ -161,6 +158,7 @@ module Deliver
 
     # Validates the given screenshots (size and format)
     def is_valid?
+      UI.deprecated('Deliver::AppScreenshot#is_valid? is deprecated in favor of Deliver::AppScreenshotValidator')
       return false unless ["png", "PNG", "jpg", "JPG", "jpeg", "JPEG"].include?(self.path.split(".").last)
 
       return self.screen_size == self.class.calculate_screen_size(self.path)
@@ -187,7 +185,9 @@ module Deliver
       return {
         ScreenSize::IOS_65_MESSAGES => [
           [1242, 2688],
-          [2688, 1242]
+          [2688, 1242],
+          [1284, 2778],
+          [2778, 1284]
         ],
         ScreenSize::IOS_61_MESSAGES => [
           [828, 1792],
@@ -195,7 +195,9 @@ module Deliver
         ],
         ScreenSize::IOS_58_MESSAGES => [
           [1125, 2436],
-          [2436, 1125]
+          [2436, 1125],
+          [1170, 2532],
+          [2532, 1170]
         ],
         ScreenSize::IOS_55_MESSAGES => [
           [1242, 2208],
@@ -243,7 +245,9 @@ module Deliver
       return {
         ScreenSize::IOS_65 => [
           [1242, 2688],
-          [2688, 1242]
+          [2688, 1242],
+          [1284, 2778],
+          [2778, 1284]
         ],
         ScreenSize::IOS_61 => [
           [828, 1792],
@@ -251,7 +255,9 @@ module Deliver
         ],
         ScreenSize::IOS_58 => [
           [1125, 2436],
-          [2436, 1125]
+          [2436, 1125],
+          [1170, 2532],
+          [2532, 1170]
         ],
         ScreenSize::IOS_55 => [
           [1242, 2208],
@@ -346,7 +352,7 @@ module Deliver
         end
       end
 
-      UI.user_error!("Unsupported screen size #{size} for path '#{path}'")
+      nil
     end
   end
 

data/deliver/lib/deliver/app_screenshot_validator.rb

@@ -0,0 +1,108 @@
+require 'fastimage'
+
+module Deliver
+  class AppScreenshotValidator
+    # A simple structure that holds error information as well as formatted error messages consistently
+    # Set `to_skip` to `true` when just needing to skip uploading rather than causing a crash.
+    class ValidationError
+      # Constants that can be given to `type` param
+      INVALID_SCREEN_SIZE = 'Invalid screen size'.freeze
+      UNACCEPTABLE_DEVICE = 'Not an accepted App Store Connect device'.freeze
+      INVALID_FILE_EXTENSION = 'Invalid file extension'.freeze
+      FILE_EXTENSION_MISMATCH = 'File extension mismatches its image format'.freeze
+
+      attr_reader :type, :path, :debug_info, :to_skip
+
+      def initialize(type: nil, path: nil, debug_info: nil, to_skip: false)
+        @type = type
+        @path = path
+        @debug_info = debug_info
+        @to_skip = to_skip
+      end
+
+      def to_s
+        "#{to_skip ? '🏃 Skipping' : '🚫 Error'}: #{path} - #{type} (#{debug_info})"
+      end
+
+      def inspect
+        "\"#{type}\""
+      end
+    end
+
+    # Access each array by symbol returned from FastImage.type
+    ALLOWED_SCREENSHOT_FILE_EXTENSION = { png: ['png', 'PNG'], jpeg: ['jpg', 'JPG', 'jpeg', 'JPEG'] }.freeze
+
+    APP_SCREENSHOT_SPEC_URL = 'https://help.apple.com/app-store-connect/#/devd274dd925'.freeze
+
+    # Validate a screenshot and inform an error message via `errors` parameter. `errors` is mutated
+    # to append the messages and each message should contain the corresponding path to let users know which file is throwing the error.
+    #
+    # @param screenshot [AppScreenshot]
+    # @param errors [Array<Deliver::AppScreenshotValidator::ValidationError>] Pass an array object to add validation errors when detecting errors.
+    #   This will be mutated to add more error objects as validation detects errors.
+    # @return [Boolean] true if given screenshot is valid
+    def self.validate(screenshot, errors)
+      # Given screenshot will be diagnosed and errors found are accumulated
+      errors_found = []
+
+      validate_screen_size(screenshot, errors_found)
+      validate_device_type(screenshot, errors_found)
+      validate_file_extension_and_format(screenshot, errors_found)
+
+      # Merge errors found into given errors array
+      errors_found.each { |error| errors.push(error) }
+      errors_found.empty?
+    end
+
+    def self.validate_screen_size(screenshot, errors_found)
+      if screenshot.screen_size.nil?
+        errors_found << ValidationError.new(type: ValidationError::INVALID_SCREEN_SIZE,
+                                            path: screenshot.path,
+                                            debug_info: "Actual size is #{get_formatted_size(screenshot)}. See the specifications to fix #{APP_SCREENSHOT_SPEC_URL}")
+      end
+    end
+
+    # Checking if the device type exists in spaceship
+    # Ex: iPhone 6.1 inch isn't supported in App Store Connect but need
+    # to have it in there for frameit support
+    def self.validate_device_type(screenshot, errors_found)
+      if !screenshot.screen_size.nil? && screenshot.device_type.nil?
+        errors_found << ValidationError.new(type: ValidationError::UNACCEPTABLE_DEVICE,
+                                            path: screenshot.path,
+                                            debug_info: "Screen size #{screenshot.screen_size} is not accepted. See the specifications to fix #{APP_SCREENSHOT_SPEC_URL}",
+                                            to_skip: true)
+      end
+    end
+
+    def self.validate_file_extension_and_format(screenshot, errors_found)
+      extension = File.extname(screenshot.path).delete('.')
+      valid_file_extensions = ALLOWED_SCREENSHOT_FILE_EXTENSION.values.flatten
+      is_valid_extension = valid_file_extensions.include?(extension)
+
+      unless is_valid_extension
+        errors_found << ValidationError.new(type: ValidationError::INVALID_FILE_EXTENSION,
+                                            path: screenshot.path,
+                                            debug_info: "Only #{valid_file_extensions.join(', ')} are allowed")
+      end
+
+      format = FastImage.type(screenshot.path)
+      is_extension_matched = ALLOWED_SCREENSHOT_FILE_EXTENSION[format] &&
+                             ALLOWED_SCREENSHOT_FILE_EXTENSION[format].include?(extension)
+
+      # This error only appears when file extension is valid
+      if is_valid_extension && !is_extension_matched
+        expected_extension = ALLOWED_SCREENSHOT_FILE_EXTENSION[format].first
+        expected_filename = File.basename(screenshot.path, File.extname(screenshot.path)) + ".#{expected_extension}"
+        errors_found << ValidationError.new(type: ValidationError::FILE_EXTENSION_MISMATCH,
+                                            path: screenshot.path,
+                                            debug_info: %(Actual format is "#{format}". Rename the filename to "#{expected_filename}".))
+      end
+    end
+
+    def self.get_formatted_size(screenshot)
+      size = FastImage.size(screenshot.path)
+      return size.join('x') if size
+      nil
+    end
+  end
+end

data/deliver/lib/deliver/commands_generator.rb

@@ -1,5 +1,6 @@
 require 'commander'
 require 'fastlane/version'
+require 'fastlane_core/ui/help_formatter'
 
 require_relative 'download_screenshots'
 require_relative 'options'
@@ -48,7 +49,7 @@ module Deliver
       program :help, 'Author', 'Felix Krause <deliver@krausefx.com>'
       program :help, 'Website', 'https://fastlane.tools'
       program :help, 'Documentation', 'https://docs.fastlane.tools/actions/deliver/'
-      program :help_formatter, :compact
+      program :help_formatter, FastlaneCore::HelpFormatter
 
       global_option('--verbose') { FastlaneCore::Globals.verbose = true }
       global_option('--env STRING[,STRING2]', String, 'Add environment(s) to use with `dotenv`')
@@ -167,7 +168,7 @@ module Deliver
           return 0 unless res
 
           require 'deliver/setup'
-          app = options[:app]
+          app = Deliver.cache[:app]
           platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
           v = app.get_latest_app_store_version(platform: platform)
           if options[:app_version].to_s.length > 0
@@ -177,7 +178,7 @@ module Deliver
             end
           end
 
-          Deliver::Setup.new.generate_metadata_files(app, v, path)
+          Deliver::Setup.new.generate_metadata_files(app, v, path, options)
         end
       end
 

data/deliver/lib/deliver/detect_values.rb

@@ -10,6 +10,8 @@ require_relative 'languages'
 module Deliver
   class DetectValues
     def run!(options, skip_params = {})
+      Deliver.cache = {}
+
       find_platform(options)
       find_app_identifier(options)
       find_app(options)
@@ -46,9 +48,9 @@ module Deliver
         app = Spaceship::ConnectAPI::App.get(app_id: app_id)
       end
 
-      if app
-        options[:app] = app
-      else
+      Deliver.cache[:app] = app
+
+      unless app
         UI.user_error!("Could not find app with app identifier '#{options[:app_identifier]}' in your App Store Connect account (#{options[:username]} - Team: #{Spaceship::Tunes.client.team_id})")
       end
     end

data/deliver/lib/deliver/download_screenshots.rb

@@ -1,6 +1,5 @@
 require_relative 'module'
 require 'spaceship'
-require 'open-uri'
 
 module Deliver
   class DownloadScreenshots
@@ -14,7 +13,7 @@ module Deliver
     end
 
     def self.download(options, folder_path)
-      app = options[:app]
+      app = Deliver.cache[:app]
 
       platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
       if options[:use_live_version]
@@ -68,7 +67,7 @@ module Deliver
           end
 
           path = File.join(containing_folder, file_name)
-          File.binwrite(path, open(url).read)
+          File.binwrite(path, FastlaneCore::Helper.open_uri(url).read)
         end
       end
     end

data/deliver/lib/deliver/html_generator.rb

@@ -50,12 +50,12 @@ module Deliver
       @export_path = export_path
 
       @app_name = (options[:name]['en-US'] || options[:name].values.first) if options[:name]
-      @app_name ||= options[:app].name
+      @app_name ||= Deliver.cache[:app].name
 
       @languages = options[:description].keys if options[:description]
       @languages ||= begin
         platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
-        version = options[:app].get_edit_app_store_version(platform: platform)
+        version = Deliver.cache[:app].get_edit_app_store_version(platform: platform)
 
         version.get_app_store_version_localizations.collect(&:locale)
       end

data/deliver/lib/deliver/languages.rb

@@ -2,6 +2,6 @@ module Deliver
   module Languages
     # 2020-08-24 - Available locales are not available as an endpoint in App Store Connect
     # Update with Spaceship::Tunes.client.available_languages.sort (as long as endpoint is avilable)
-    ALL_LANGUAGES = ["ar-SA", "ca", "cs", "da", "de-DE", "el", "en-AU", "en-CA", "en-GB", "en-US", "es-ES", "es-MX", "fi", "fr-CA", "fr-FR", "he", "hi", "hr", "hu", "id", "it", "ja", "ko", "ms", "nl-NL", "no", "pl", "pt-BR", "pt-PT", "ro", "ru", "sk", "sv", "th", "tr", "uk", "vi", "zh-Hans", "zh-Hant"]
+    ALL_LANGUAGES = %w[ar-SA ca cs da de-DE el en-AU en-CA en-GB en-US es-ES es-MX fi fr-CA fr-FR he hi hr hu id it ja ko ms nl-NL no pl pt-BR pt-PT ro ru sk sv th tr uk vi zh-Hans zh-Hant]
   end
 end

data/deliver/lib/deliver/loader.rb

@@ -1,7 +1,6 @@
-require 'fastlane_core/languages'
-require 'spaceship/tunes/tunes'
-
 require_relative 'module'
+require_relative 'app_screenshot'
+require_relative 'app_screenshot_validator'
 require_relative 'upload_metadata'
 require_relative 'languages'
 
@@ -13,6 +12,7 @@ module Deliver
     IMESSAGE_DIR_NAME = "iMessage".freeze
     DEFAULT_DIR_NAME = "default".freeze
 
+    EXPANDABLE_DIR_NAMES = [APPLE_TV_DIR_NAME, IMESSAGE_DIR_NAME].freeze
     SPECIAL_DIR_NAMES = [APPLE_TV_DIR_NAME, IMESSAGE_DIR_NAME, DEFAULT_DIR_NAME].freeze
 
     # Some exception directories may exist from other actions that should not be iterated through
@@ -20,35 +20,137 @@ module Deliver
     FRAMEIT_FONTS_DIR_NAME = "fonts".freeze
     META_DIR_NAMES = UploadMetadata::ALL_META_SUB_DIRS.map(&:downcase)
 
-    EXCEPTION_DIRECTORIES =  (META_DIR_NAMES << SUPPLY_DIR_NAME << FRAMEIT_FONTS_DIR_NAME).freeze
+    EXCEPTION_DIRECTORIES = (META_DIR_NAMES << SUPPLY_DIR_NAME << FRAMEIT_FONTS_DIR_NAME).freeze
 
-    def self.language_folders(root, ignore_validation)
-      folders = Dir.glob(File.join(root, '*'))
+    # A class that represents language folder under screenshots or metadata folder
+    class LanguageFolder
+      attr_reader :path
+
+      # @return [String] A normalized language name that corresponds to the directory's name
+      attr_reader :language
+
+      def self.available_languages
+        # 2020-08-24 - Available locales are not available as an endpoint in App Store Connect
+        # Update with Spaceship::Tunes.client.available_languages.sort (as long as endpoint is avilable)
+        Deliver::Languages::ALL_LANGUAGES
+      end
+
+      def self.allowed_directory_names_with_case
+        available_languages + SPECIAL_DIR_NAMES
+      end
+
+      # @param path [String] A directory path otherwise this initializer fails
+      # @param nested [Boolan] Whether given path is nested of another special directory.
+      #  This affects `expandable?` to return `false` when this set to `true`.
+      def initialize(path, nested: false)
+        raise(ArgumentError, "Given path must be a directory path - #{path}") unless File.directory?(path)
+        @path = path
+        @language = self.class.available_languages.find { |lang| basename.casecmp?(lang) }
+        @nested = nested
+      end
 
-      # 2020-08-24 - Available locales are not available as an endpoint in App Store Connect
-      # Update with Spaceship::Tunes.client.available_languages.sort (as long as endpoint is avilable)
-      available_languages = Deliver::Languages::ALL_LANGUAGES
+      def nested?
+        @nested
+      end
 
-      allowed_directory_names_with_case = (available_languages + SPECIAL_DIR_NAMES)
-      allowed_directory_names = allowed_directory_names_with_case.map(&:downcase).freeze
+      def valid?
+        self.class.allowed_directory_names_with_case.any? { |name| name.casecmp?(basename) }
+      end
 
-      selected_folders = folders.select do |path|
-        File.directory?(path) && allowed_directory_names.include?(File.basename(path).downcase)
-      end.sort
+      def expandable?
+        !nested? && EXPANDABLE_DIR_NAMES.any? { |name| name.casecmp?(basename) }
+      end
 
-      # Gets list of folders that are not supported languages
-      rejected_folders = folders.select do |path|
-        normalized_path = File.basename(path).downcase
-        File.directory?(path) && !allowed_directory_names.include?(normalized_path) && !EXCEPTION_DIRECTORIES.include?(normalized_path)
-      end.sort
+      def skip?
+        EXCEPTION_DIRECTORIES.map(&:downcase).include?(basename.downcase)
+      end
+
+      def file_paths(extensions = '{png,jpg,jpeg}')
+        Dir.glob(File.join(path, "*.#{extensions}"), File::FNM_CASEFOLD).sort
+      end
+
+      def framed_file_paths(extensions = '{png,jpg,jpeg}')
+        Dir.glob(File.join(path, "*_framed.#{extensions}"), File::FNM_CASEFOLD).sort
+      end
+
+      def basename
+        File.basename(@path)
+      end
+    end
+
+    # Returns the list of valid app screenshot. When detecting invalid screenshots, this will cause an error.
+    #
+    # @param root [String] A directory path
+    # @param ignore_validation [String] Set false not to raise the error when finding invalid folder name
+    # @return [Array<AppScreenshot>] The list of AppScreenshot that exist under given `root` directory
+    def self.load_app_screenshots(root, ignore_validation)
+      screenshots = language_folders(root, ignore_validation, true).flat_map do |language_folder|
+        paths = if language_folder.framed_file_paths.count > 0
+                  UI.important("Framed screenshots are detected! 🖼 Non-framed screenshot files may be skipped. 🏃")
+                  # watchOS screenshots can be picked up even when framed ones were found since frameit doesn't support watchOS screenshots
+                  framed_or_watch, skipped = language_folder.file_paths.partition { |path| path.downcase.include?('framed') || path.downcase.include?('watch') }
+                  skipped.each { |path| UI.important("🏃 Skipping screenshot file: #{path}") }
+                  framed_or_watch
+                else
+                  language_folder.file_paths
+                end
+        paths.map { |path| AppScreenshot.new(path, language_folder.language) }
+      end
+
+      errors = []
+      valid_screenshots = screenshots.select { |screenshot| Deliver::AppScreenshotValidator.validate(screenshot, errors) }
+
+      errors_to_skip, errors_to_crash = errors.partition(&:to_skip)
+
+      unless errors_to_skip.empty?
+        UI.important("🏃 Screenshots to be skipped are detected!")
+        errors_to_skip.each { |error| UI.message(error) }
+      end
+
+      unless errors_to_crash.empty?
+        UI.important("🚫 Invalid screenshots were detected! Here are the reasons:")
+        errors_to_crash.each { |error| UI.error(error) }
+        UI.user_error!("Canceled uploading screenshots. Please check the error messages above and fix the screenshots.")
+      end
+
+      valid_screenshots
+    end
+
+    # Returns the list of language folders
+    #
+    # @param roort [String] A directory path to get the list of language folders
+    # @param ignore_validation [Boolean] Set false not to raise the error when finding invalid folder name
+    # @param expand_sub_folders [Boolean] Set true to expand special folders; such as "iMessage" to nested language folders
+    # @return [Array<LanguageFolder>] The list of LanguageFolder whose each of them
+    def self.language_folders(root, ignore_validation, expand_sub_folders = false)
+      folders = Dir.glob(File.join(root, '*'))
+                   .select { |path| File.directory?(path) }
+                   .map { |path| LanguageFolder.new(path, nested: false) }
+                   .reject(&:skip?)
+
+      selected_folders, rejected_folders = folders.partition(&:valid?)
 
       if !ignore_validation && !rejected_folders.empty?
-        rejected_folders = rejected_folders.map { |path| File.basename(path) }
+        rejected_folders = rejected_folders.map(&:basename)
         UI.user_error!("Unsupported directory name(s) for screenshots/metadata in '#{root}': #{rejected_folders.join(', ')}" \
-                       "\nValid directory names are: #{allowed_directory_names_with_case}" \
+                       "\nValid directory names are: #{LanguageFolder.allowed_directory_names_with_case}" \
                        "\n\nEnable 'ignore_language_directory_validation' to prevent this validation from happening")
       end
 
+      # Expand selected_folders for the special directories
+      if expand_sub_folders
+        selected_folders = selected_folders.flat_map do |folder|
+          if folder.expandable?
+            Dir.glob(File.join(folder.path, '*'))
+               .select { |p| File.directory?(p) }
+               .map { |p| LanguageFolder.new(p, nested: true) }
+               .select(&:valid?)
+          else
+            folder
+          end
+        end
+      end
+
       selected_folders
     end
   end