shopify-cli 2.15.0 → 2.15.3

data/lib/shopify_cli/theme/dev_server/remote_watcher.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "shopify_cli/thread_pool"
+
+require_relative "remote_watcher/json_files_update_job"
+
+module ShopifyCLI
+  module Theme
+    module DevServer
+      class RemoteWatcher
+        SYNC_INTERVAL = 3 # seconds
+
+        class << self
+          def to(theme:, syncer:)
+            new(theme, syncer)
+          end
+        end
+
+        def start
+          thread_pool.schedule(recurring_job)
+        end
+
+        def stop
+          thread_pool.shutdown
+        end
+
+        private
+
+        def initialize(theme, syncer)
+          @theme = theme
+          @syncer = syncer
+        end
+
+        def thread_pool
+          @thread_pool ||= ShopifyCLI::ThreadPool.new(pool_size: 1)
+        end
+
+        def recurring_job
+          JsonFilesUpdateJob.new(@theme, @syncer, SYNC_INTERVAL)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/dev_server/watcher.rb

@@ -46,20 +46,14 @@ module ShopifyCLI
           files
             .select { |file| @theme.theme_file?(file) }
             .map { |file| @theme[file] }
-            .reject { |file| ignore_file?(file) }
+            .reject { |file| @syncer.ignore_file?(file) }
         end
 
         def filter_remote_files(files)
           files
             .select { |file| @syncer.remote_file?(file) }
             .map { |file| @theme[file] }
-            .reject { |file| ignore_file?(file) }
-        end
-
-        private
-
-        def ignore_file?(file)
-          @ignore_filter&.ignore?(file.relative_path.to_s)
+            .reject { |file| @syncer.ignore_file?(file) }
         end
       end
     end

data/lib/shopify_cli/theme/dev_server.rb

@@ -11,6 +11,7 @@ require_relative "dev_server/local_assets"
 require_relative "dev_server/proxy"
 require_relative "dev_server/sse"
 require_relative "dev_server/watcher"
+require_relative "dev_server/remote_watcher"
 require_relative "dev_server/web_server"
 require_relative "dev_server/certificate_manager"
 
@@ -26,12 +27,13 @@ module ShopifyCLI
       class << self
         attr_accessor :ctx
 
-        def start(ctx, root, host: "127.0.0.1", port: 9292, poll: false, mode: ReloadMode.default)
+        def start(ctx, root, host: "127.0.0.1", port: 9292, poll: false, editor_sync: false, mode: ReloadMode.default)
           @ctx = ctx
           theme = DevelopmentTheme.find_or_create!(ctx, root: root)
           ignore_filter = IgnoreFilter.from_path(root)
-          @syncer = Syncer.new(ctx, theme: theme, ignore_filter: ignore_filter)
-          watcher = Watcher.new(ctx, theme: theme, syncer: @syncer, ignore_filter: ignore_filter, poll: poll)
+          @syncer = Syncer.new(ctx, theme: theme, ignore_filter: ignore_filter, overwrite_json: !editor_sync)
+          watcher = Watcher.new(ctx, theme: theme, syncer: @syncer, poll: poll)
+          remote_watcher = RemoteWatcher.to(theme: theme, syncer: @syncer)
 
           # Setup the middleware stack. Mimics Rack::Builder / config.ru, but in reverse order
           @app = Proxy.new(ctx, theme: theme, syncer: @syncer)
@@ -57,9 +59,17 @@ module ShopifyCLI
 
             return if stopped
 
+            preview_suffix = editor_sync ? "" : ctx.message("theme.serve.download_changes")
+            preview_message = ctx.message(
+              "theme.serve.customize_or_preview",
+              preview_suffix,
+              theme.editor_url,
+              theme.preview_url
+            )
+
             ctx.puts(ctx.message("theme.serve.serving", theme.root))
             ctx.open_url!(address)
-            ctx.puts(ctx.message("theme.serve.customize_or_preview", theme.editor_url, theme.preview_url))
+            ctx.puts(preview_message)
           end
 
           logger = if ctx.debug?
@@ -69,6 +79,7 @@ module ShopifyCLI
           end
 
           watcher.start
+          remote_watcher.start if editor_sync
           WebServer.run(
             @app,
             BindAddress: host,
@@ -76,11 +87,13 @@ module ShopifyCLI
             Logger: logger,
             AccessLog: [],
           )
+          remote_watcher.stop if editor_sync
           watcher.stop
 
         rescue ShopifyCLI::API::APIRequestForbiddenError,
                ShopifyCLI::API::APIRequestUnauthorizedError
-          raise ShopifyCLI::Abort, @ctx.message("theme.serve.ensure_user", theme.shop)
+          shop = ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+          raise ShopifyCLI::Abort, @ctx.message("theme.serve.ensure_user", shop)
         rescue Errno::EADDRINUSE
           error_message = @ctx.message("theme.serve.address_already_in_use", address)
           help_message = @ctx.message("theme.serve.try_port_option")

data/lib/shopify_cli/theme/file.rb

@@ -4,7 +4,6 @@ require_relative "mime_type"
 module ShopifyCLI
   module Theme
     class File < Struct.new(:path)
-      attr_reader :relative_path
       attr_accessor :remote_checksum
 
       def initialize(path, root)
@@ -42,7 +41,7 @@ module ShopifyCLI
       end
 
       def mime_type
-        @mime_type ||= MimeType.by_filename(relative_path)
+        @mime_type ||= MimeType.by_filename(@relative_path)
       end
 
       def text?
@@ -54,7 +53,7 @@ module ShopifyCLI
       end
 
       def liquid_css?
-        relative_path.to_s.end_with?(".css.liquid")
+        relative_path.end_with?(".css.liquid")
       end
 
       def json?
@@ -62,7 +61,7 @@ module ShopifyCLI
       end
 
       def template?
-        relative_path.to_s.start_with?("templates/")
+        relative_path.start_with?("templates/")
       end
 
       def checksum
@@ -84,6 +83,18 @@ module ShopifyCLI
         relative_path == other.relative_path
       end
 
+      def name(*args)
+        ::File.basename(path, *args)
+      end
+
+      def absolute_path
+        path.realpath.to_s
+      end
+
+      def relative_path
+        @relative_path.to_s
+      end
+
       private
 
       def normalize_json(content)

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      class Checksums
+        def initialize(theme)
+          @theme = theme
+          @checksum_by_key = {}
+
+          # Mutex used to coordinate changes in the checksums (shared accross `Syncer` threads)
+          @checksums_mutex = Mutex.new
+        end
+
+        def has?(file)
+          checksum_by_key.key?(to_key(file))
+        end
+
+        def file_has_changed?(file)
+          file.checksum != checksum_by_key[file.relative_path]
+        end
+
+        def keys
+          checksum_by_key.keys
+        end
+
+        def [](key)
+          checksum_by_key[key]
+        end
+
+        def []=(key, value)
+          checksums_mutex.synchronize do
+            checksum_by_key[key] = value
+          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.
+        def reject_duplicated_checksums!
+          checksums_mutex.synchronize do
+            checksum_by_key.reject! { |key, _| checksum_by_key.key?("#{key}.liquid") }
+          end
+        end
+
+        private
+
+        def to_key(file)
+          theme[file].relative_path
+        end
+
+        # Private getters only used in unit tests
+
+        attr_reader :checksum_by_key
+        attr_reader :theme
+        attr_reader :checksums_mutex
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "apply_to_all_form"
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module Forms
+        class ApplyToAll
+          attr_reader :value
+
+          def initialize(ctx, number_of_files)
+            @ctx = ctx
+            @number_of_files = number_of_files
+            @value = nil
+            @apply = nil
+          end
+
+          def apply?(value)
+            return unless @number_of_files > 1
+
+            if @apply.nil?
+              @apply = ask.apply?
+              @value = value if @apply
+            end
+
+            @apply
+          end
+
+          private
+
+          def ask
+            ApplyToAllForm.ask(@ctx, [], number_of_files: @number_of_files)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Syncer
+      module Forms
+        class ApplyToAllForm < ShopifyCLI::Form
+          attr_accessor :apply
+          flag_arguments :number_of_files
+
+          def ask
+            title = message("title", number_of_files - 1)
+
+            self.apply = CLI::UI::Prompt.ask(title, allow_empty: false) do |handler|
+              handler.option(message("yes")) { true }
+              handler.option(message("no")) { false }
+            end
+
+            self
+          end
+
+          def apply?
+            apply
+          end
+
+          private
+
+          def message(key, *params)
+            ctx.message("theme.serve.syncer.forms.apply_to_all.#{key}", *params)
+          end
+        end
+      end
+    end
+  end
+end

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