shopify-cli 2.15.1 → 2.15.4

data/lib/shopify_cli/theme/syncer/forms/base_strategy_form.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module Forms
+        class BaseStrategyForm < ShopifyCLI::Form
+          attr_accessor :strategy
+
+          def ask
+            ctx.puts(title_context(file))
+
+            self.strategy = CLI::UI::Prompt.ask(title_question, allow_empty: false) do |handler|
+              strategies.each do |strategy|
+                handler.option(as_text(strategy)) { strategy }
+              end
+            end
+
+            exit_cli if self.strategy == :exit
+
+            self
+          end
+
+          protected
+
+          ##
+          # List of strategies that populate the form options
+          #
+          def strategies
+            raise "`#{self.class.name}#strategies' must be defined"
+          end
+
+          ##
+          # Message prefix for the form title and options (strategies).
+          # See the methods `title` and `as_text`
+          #
+          def prefix
+            raise "`#{self.class.name}#prefix' must be defined"
+          end
+
+          private
+
+          def exit_cli
+            exit(0)
+          end
+
+          def title_context(file)
+            ctx.message("#{prefix}.title_context", file.relative_path)
+          end
+
+          def title_question
+            ctx.message("#{prefix}.title_question")
+          end
+
+          def as_text(strategy)
+            ctx.message("#{prefix}.#{strategy}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/forms/select_delete_strategy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "base_strategy_form"
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module Forms
+        class SelectDeleteStrategy < BaseStrategyForm
+          flag_arguments :file
+
+          def strategies
+            %i[
+              delete
+              restore
+              exit
+            ]
+          end
+
+          def prefix
+            "theme.serve.syncer.forms.delete_strategy"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/forms/select_update_strategy.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "base_strategy_form"
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module Forms
+        class SelectUpdateStrategy < BaseStrategyForm
+          flag_arguments :file
+
+          def strategies
+            %i[
+              keep_remote
+              keep_local
+              union_merge
+              exit
+            ]
+          end
+
+          def prefix
+            "theme.serve.syncer.forms.update_strategy"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/ignore_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module IgnoreHelper
+        def ignore_operation?(operation)
+          path = operation.file_path
+          ignore_path?(path)
+        end
+
+        def ignore_file?(file)
+          path = file.path
+          ignore_path?(path)
+        end
+
+        def ignore_path?(path)
+          ignored_by_ignore_filter?(path) || ignored_by_include_filter?(path)
+        end
+
+        private
+
+        def ignored_by_ignore_filter?(path)
+          ignore_filter&.ignore?(path)
+        end
+
+        def ignored_by_include_filter?(path)
+          !!include_filter && !include_filter.match?(path)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/json_delete_handler.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "forms/apply_to_all"
+require_relative "forms/select_delete_strategy"
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module JsonDeleteHandler
+        def enqueue_json_deletes(files)
+          files = files.select { |file| !ignore_file?(file) }
+
+          if overwrite_json?
+            enqueue_deletes(files)
+          else
+            # Handle conflicts when JSON files cannot be overwritten
+            handle_delete_conflicts(files)
+          end
+        end
+
+        private
+
+        def handle_delete_conflicts(files)
+          to_delete = []
+          to_get = []
+
+          apply_to_all = Forms::ApplyToAll.new(@ctx, files.size)
+
+          files.each do |file|
+            delete_strategy = apply_to_all.value || ask_delete_strategy(file)
+            apply_to_all.apply?(delete_strategy)
+
+            case delete_strategy
+            when :delete
+              to_delete << file
+            when :restore
+              to_get << file
+            end
+          end
+
+          enqueue_deletes(to_delete)
+          enqueue_get(to_get)
+        end
+
+        def ask_delete_strategy(file)
+          Forms::SelectDeleteStrategy.ask(@ctx, [], file: file).strategy
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/json_update_handler.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "forms/apply_to_all"
+require_relative "forms/select_update_strategy"
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module JsonUpdateHandler
+        def enqueue_json_updates(files)
+          # Some files must be uploaded after the other ones
+          delayed_files = [
+            theme["config/settings_schema.json"],
+            theme["config/settings_data.json"],
+          ]
+
+          # Update remote JSON files and delays `delayed_files` update
+          files = files
+            .select { |file| !ignore_file?(file) && file.exist? && checksums.file_has_changed?(file) }
+            .sort_by { |file| delayed_files.include?(file) ? 1 : 0 }
+
+          if overwrite_json?
+            enqueue_updates(files)
+          else
+            # Handle conflicts when JSON files cannot be overwritten
+            handle_update_conflicts(files)
+          end
+        end
+
+        private
+
+        def handle_update_conflicts(files)
+          to_get = []
+          to_delete = []
+          to_update = []
+          to_union_merge = []
+
+          apply_to_all = Forms::ApplyToAll.new(@ctx, files.size)
+
+          files.each do |file|
+            update_strategy = apply_to_all.value || ask_update_strategy(file)
+            apply_to_all.apply?(update_strategy)
+
+            case update_strategy
+            when :keep_remote
+              if file_exist_remotely?(file)
+                to_get << file
+              else
+                delete_locally(file)
+              end
+            when :keep_local
+              to_update << file
+            when :union_merge
+              if file_exist_remotely?(file)
+                to_union_merge << file
+              else
+                to_update << file
+              end
+            end
+          end
+
+          enqueue_get(to_get)
+          enqueue_deletes(to_delete)
+          enqueue_updates(to_update)
+          enqueue_union_merges(to_union_merge)
+        end
+
+        def file_exist_remotely?(file)
+          !checksums[file.relative_path].nil?
+        end
+
+        def delete_locally(file)
+          ::File.delete(file.absolute_path)
+        end
+
+        def ask_update_strategy(file)
+          Forms::SelectUpdateStrategy.ask(@ctx, [], file: file).strategy
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/merger.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      class Merger
+        class << self
+          ##
+          # Merge `theme_file` with the `new_content` by relying on the union merge
+          #
+          def union_merge(theme_file, new_content)
+            git_merge(theme_file, new_content, ["--union", "-p"])
+          end
+
+          private
+
+          ##
+          # Merge theme file (`ShopifyCLI::Theme::File`) with a new content (String),
+          # by creating a temporary file based on the `new_content`.
+          #
+          def git_merge(theme_file, new_content, opts)
+            remote_file = create_tmp_file(tmp_file_name(theme_file), new_content)
+            empty_file = create_tmp_file("empty")
+
+            ShopifyCLI::Git.merge_file(
+              theme_file.absolute_path,
+              empty_file.path,
+              remote_file.path,
+              opts
+            )
+          ensure
+            # Remove temporary files on Windows as well
+            remote_file.close!
+            empty_file.close!
+          end
+
+          def create_tmp_file(basename, content = "")
+            tmp_file = Tempfile.new(basename)
+            tmp_file.write(content)
+            tmp_file.close # Make it ready to merge
+            tmp_file
+          end
+
+          def tmp_file_name(ref_file)
+            "shopify-cli-merge-#{ref_file.name(".*")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer/operation.rb

@@ -35,7 +35,7 @@ module ShopifyCLI
         end
 
         def file_path
-          file&.relative_path.to_s
+          file&.relative_path
         end
 
         private

data/lib/shopify_cli/theme/syncer.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+
 require "thread"
 require "json"
 require "base64"
 require "forwardable"
 
+require_relative "syncer/checksums"
 require_relative "syncer/error_reporter"
-require_relative "syncer/standard_reporter"
+require_relative "syncer/ignore_helper"
+require_relative "syncer/json_delete_handler"
+require_relative "syncer/json_update_handler"
+require_relative "syncer/merger"
 require_relative "syncer/operation"
+require_relative "syncer/standard_reporter"
 require_relative "theme_admin_api"
 
 module ShopifyCLI
@@ -14,36 +20,46 @@ module ShopifyCLI
     class Syncer
       extend Forwardable
 
-      attr_reader :checksums
-      attr_reader :checksums_mutex
-      attr_accessor :include_filter
-      attr_accessor :ignore_filter
+      include IgnoreHelper
+      include JsonDeleteHandler
+      include JsonUpdateHandler
+
+      QUEUEABLE_METHODS = [
+        :get,         # - Updates the local file with the remote file content
+        :update,      # - Updates the remote file with the local file content
+        :delete,      # - Deletes the remote file
+        :union_merge, # - Union merges the local file content with the remote file content
+      ]
+
+      attr_reader :theme, :checksums, :error_checksums
+      attr_accessor :include_filter, :ignore_filter
 
       def_delegators :@error_reporter, :has_any_error?
 
-      def initialize(ctx, theme:, include_filter: nil, ignore_filter: nil)
+      def initialize(ctx, theme:, include_filter: nil, ignore_filter: nil, overwrite_json: true)
         @ctx = ctx
         @theme = theme
         @include_filter = include_filter
         @ignore_filter = ignore_filter
+        @overwrite_json = overwrite_json
         @error_reporter = ErrorReporter.new(ctx)
         @standard_reporter = StandardReporter.new(ctx)
         @reporters = [@error_reporter, @standard_reporter]
 
         # Queue of `Operation`s waiting to be picked up from a thread for processing.
         @queue = Queue.new
+
         # `Operation`s will be removed from this Array completed.
         @pending = []
+
         # Thread making the API requests.
         @threads = []
+
         # Mutex used to pause all threads when backing-off when hitting API rate limits
         @backoff_mutex = Mutex.new
 
-        # Mutex used to coordinate changes in the checksums (shared accross all threads)
-        @checksums_mutex = Mutex.new
-
         # Latest theme assets checksums. Updated on each upload.
-        @checksums = {}
+        @checksums = Checksums.new(theme)
 
         # Checksums of assets with errors.
         @error_checksums = []
@@ -73,6 +89,10 @@ module ShopifyCLI
         files.each { |file| enqueue(:delete, file) }
       end
 
+      def enqueue_union_merges(files)
+        files.each { |file| enqueue(:union_merge, file) }
+      end
+
       def size
         @pending.size
       end
@@ -86,7 +106,11 @@ module ShopifyCLI
       end
 
       def remote_file?(file)
-        checksums.key?(@theme[file].relative_path.to_s)
+        checksums.has?(file)
+      end
+
+      def broken_file?(file)
+        error_checksums.include?(checksums[file.relative_path])
       end
 
       def wait!
@@ -135,20 +159,18 @@ module ShopifyCLI
         fetch_checksums!
 
         if delete
-          # Delete remote files not present locally
-          removed_files = checksums.keys - @theme.theme_files.map { |file| file.relative_path.to_s }
+          removed_json_files, removed_files = checksums
+            .keys
+            .-(@theme.theme_files.map(&:relative_path))
+            .map { |file| @theme[file] }
+            .partition(&:json?)
+
           enqueue_deletes(removed_files)
+          enqueue_json_deletes(removed_json_files)
         end
 
-        # Some files must be uploaded after the other ones
-        delayed_config_files = [
-          @theme["config/settings_schema.json"],
-          @theme["config/settings_data.json"],
-        ]
-
         enqueue_updates(@theme.liquid_files)
-        enqueue_updates(@theme.json_files - delayed_config_files)
-        enqueue_updates(delayed_config_files)
+        enqueue_json_updates(@theme.json_files)
 
         if delay_low_priority_files
           # Wait for liquid & JSON files to upload, because those are rendered remotely
@@ -171,7 +193,7 @@ module ShopifyCLI
         if delete
           # Delete local files not present remotely
           missing_files = @theme.theme_files
-            .reject { |file| checksums.key?(file.relative_path.to_s) }.uniq
+            .reject { |file| checksums.has?(file) }.uniq
             .reject { |file| ignore_file?(file) }
           missing_files.each do |file|
             @ctx.debug("rm #{file.relative_path}")
@@ -187,12 +209,13 @@ module ShopifyCLI
       private
 
       def report_error(operation, error_suffix = "")
-        @error_checksums << @checksums[operation.file_path]
+        @error_checksums << checksums[operation.file_path]
         @error_reporter.report("#{operation.as_error_message}#{error_suffix}")
       end
 
       def enqueue(method, file)
         raise ArgumentError, "file required" unless file
+        raise ArgumentError, "method '#{method}' cannot be queued" unless QUEUEABLE_METHODS.include?(method)
 
         operation = Operation.new(@ctx, method, @theme[file])
 
@@ -204,10 +227,10 @@ module ShopifyCLI
           return
         end
 
-        if [:update, :get].include?(method) && operation.file.exist? && !file_has_changed?(operation.file)
+        if [:update, :get].include?(method) && operation.file.exist?
           is_fixed = !!@error_checksums.delete(operation.file.checksum)
           @standard_reporter.report(operation.as_fix_message) if is_fixed
-          return
+          return unless checksums.file_has_changed?(operation.file)
         end
 
         @pending << operation
@@ -236,7 +259,7 @@ module ShopifyCLI
       end
 
       def update(file)
-        asset = { key: file.relative_path.to_s }
+        asset = { key: file.relative_path }
         if file.text?
           asset[:value] = file.read
         else
@@ -253,32 +276,10 @@ module ShopifyCLI
         response
       end
 
-      def ignore_operation?(operation)
-        path = operation.file_path
-        ignore_path?(path)
-      end
-
-      def ignore_file?(file)
-        path = file.path
-        ignore_path?(path)
-      end
-
-      def ignore_path?(path)
-        ignored_by_ignore_filter?(path) || ignored_by_include_filter?(path)
-      end
-
-      def ignored_by_ignore_filter?(path)
-        ignore_filter&.ignore?(path)
-      end
-
-      def ignored_by_include_filter?(path)
-        !!include_filter && !include_filter.match?(path)
-      end
-
       def get(file)
         _status, body, response = api_client.get(
           path: "themes/#{@theme.id}/assets.json",
-          query: URI.encode_www_form("asset[key]" => file.relative_path.to_s),
+          query: URI.encode_www_form("asset[key]" => file.relative_path),
         )
 
         update_checksums(body)
@@ -297,37 +298,48 @@ module ShopifyCLI
         _status, _body, response = api_client.delete(
           path: "themes/#{@theme.id}/assets.json",
           body: JSON.generate(asset: {
-            key: file.relative_path.to_s,
+            key: file.relative_path,
           })
         )
 
         response
       end
 
+      def union_merge(file)
+        _status, body, response = api_client.get(
+          path: "themes/#{@theme.id}/assets.json",
+          query: URI.encode_www_form("asset[key]" => file.relative_path),
+        )
+
+        return response unless file.text?
+
+        remote_content = body.dig("asset", "value")
+
+        return response if remote_content.nil?
+
+        content = Merger.union_merge(file, remote_content)
+
+        file.write(content)
+
+        enqueue(:update, file)
+
+        response
+      end
+
       def update_checksums(api_response)
         api_response.values.flatten.each do |asset|
           next unless asset["key"]
-          checksums_mutex.synchronize do
-            @checksums[asset["key"]] = asset["checksum"]
-          end
-        end
-        # Generate .liquid asset files are reported twice in checksum:
-        # once of generated, once for .liquid. We only keep the .liquid, that's the one we have
-        # on disk.
-        checksums_mutex.synchronize do
-          @checksums.reject! { |key, _| @checksums.key?("#{key}.liquid") }
+          checksums[asset["key"]] = asset["checksum"]
         end
-      end
 
-      def file_has_changed?(file)
-        file.checksum != @checksums[file.relative_path.to_s]
+        checksums.reject_duplicated_checksums!
       end
 
       def parse_api_errors(exception)
         parsed_body = JSON.parse(exception&.response&.body)
         message = parsed_body.dig("errors", "asset") || parsed_body["message"] || exception.message
         # Truncate to first lines
-        [message].flatten.map { |mess| mess.split("\n", 2).first }
+        [message].flatten.map { |m| m.split("\n", 2).first }
       rescue JSON::ParserError
         [exception.message]
       end
@@ -339,6 +351,10 @@ module ShopifyCLI
         end
       end
 
+      def overwrite_json?
+        @overwrite_json
+      end
+
       def backingoff?
         @backoff_mutex.locked?
       end

data/lib/shopify_cli/theme/theme.rb

@@ -37,10 +37,10 @@ module ShopifyCLI
       end
 
       def glob(pattern, raise_on_dir: false)
-        root.glob(pattern).map do |path|
-          abort_if_directory!(path) if raise_on_dir
-          File.new(path, root)
-        end
+        root
+          .glob(pattern)
+          .select { |path| file?(path, raise_on_dir) }
+          .map { |path| File.new(path, root) }
       end
 
       def theme_file?(file)
@@ -155,6 +155,13 @@ module ShopifyCLI
       end
 
       class << self
+        def create_unpublished(ctx, root: nil, name: nil)
+          name ||= random_name
+          theme = new(ctx, root: root, name: name, role: "unpublished")
+          theme.create
+          theme
+        end
+
         def all(ctx, root: nil)
           _status, body = fetch_themes(ctx)
 
@@ -182,6 +189,10 @@ module ShopifyCLI
 
         private
 
+        def random_name
+          ShopifyCLI::Helpers::Haikunator.haikunate(9999)
+        end
+
         def find(ctx, root, &block)
           _status, body = fetch_themes(ctx)
 
@@ -222,9 +233,12 @@ module ShopifyCLI
         self
       end
 
-      def abort_if_directory!(path)
-        return unless ::File.directory?(path)
-        @ctx.abort(@ctx.message("theme.serve.error.invalid_subdirectory", path.to_s))
+      def file?(path, raise_on_dir = false)
+        if raise_on_dir && ::File.directory?(path)
+          @ctx.abort(@ctx.message("theme.serve.error.invalid_subdirectory", path.to_s))
+        end
+
+        ::File.file?(path)
       end
     end
   end