shopify-cli 2.15.0 → 2.15.3

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

@@ -21,11 +21,11 @@ module ShopifyCLI
       end
 
       def theme_files
-        glob(["**/*.liquid", "**/*.json", "assets/*"]).uniq
+        (glob(["**/*.liquid", "**/*.json"]) + static_asset_files).uniq
       end
 
       def static_asset_files
-        glob("assets/*").reject(&:liquid?)
+        glob("assets/*", raise_on_dir: true).reject(&:liquid?)
       end
 
       def liquid_files
@@ -36,8 +36,11 @@ module ShopifyCLI
         glob("**/*.json")
       end
 
-      def glob(pattern)
-        root.glob(pattern).map { |path| File.new(path, root) }
+      def glob(pattern, raise_on_dir: false)
+        root
+          .glob(pattern)
+          .select { |path| file?(path, raise_on_dir) }
+          .map { |path| File.new(path, root) }
       end
 
       def theme_file?(file)
@@ -152,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)
 
@@ -179,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)
 
@@ -218,6 +232,14 @@ module ShopifyCLI
 
         self
       end
+
+      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
 end

data/lib/shopify_cli/theme/theme_admin_api.rb

@@ -41,31 +41,46 @@ module ShopifyCLI
         )
       rescue ShopifyCLI::API::APIRequestForbiddenError,
              ShopifyCLI::API::APIRequestUnauthorizedError => error
+
+        ##
         # The Admin API returns 403 Forbidden responses on different
         # scenarios:
         #
         # * when a user doesn't have permissions for a request:
-        #   <APIRequestForbiddenError: 403 {}>
+        #   - <APIRequestForbiddenError: 403 {}>
+        #   - <APIRequestForbiddenError: 403 {"errors":"Unauthorized Access"}>
         #
         # * when an asset operation cannot be performed:
-        #   <APIRequestForbiddenError: 403 {"message":"templates/gift_card.liquid could not be deleted"}>
-        if empty_response_error?(error)
-          return handle_permissions_error
+        #   - <APIRequestForbiddenError: 403 {"message":"templates/gift_card.liquid could not be deleted"}>
+        #
+        if empty_response?(error) || unauthorized_response?(error)
+          return permission_error
         end
 
         raise error
       end
 
-      def handle_permissions_error
+      def permission_error
         ensure_user_error = @ctx.message("theme.ensure_user_error", shop)
         ensure_user_try_this = @ctx.message("theme.ensure_user_try_this")
 
         @ctx.abort(ensure_user_error, ensure_user_try_this)
       end
 
-      def empty_response_error?(error)
-        error_message = error&.response&.body.to_s
-        error_message.empty?
+      def empty_response?(error)
+        response_body(error).empty?
+      end
+
+      def unauthorized_response?(error)
+        parsed_body = JSON.parse(response_body(error))
+        errors = parsed_body["errors"].to_s
+        errors.match?(/Unauthorized Access/)
+      rescue JSON::ParserError
+        false
+      end
+
+      def response_body(error)
+        error&.response&.body.to_s
       end
     end
   end

data/lib/shopify_cli/thread_pool/job.rb

@@ -3,10 +3,14 @@
 module ShopifyCLI
   class ThreadPool
     class Job
-      attr_reader :error
+      attr_reader :error, :interval
+
+      def initialize(interval = 0)
+        @interval = interval
+      end
 
       def perform!
-        raise "`#{self.class.name}#perform!` must be defined"
+        raise "`#{self.class.name}#perform!' must be defined"
       end
 
       def call
@@ -22,6 +26,10 @@ module ShopifyCLI
       def error?
         !!@error
       end
+
+      def recurring?
+        !interval.zero?
+      end
     end
   end
 end

data/lib/shopify_cli/thread_pool.rb

@@ -27,11 +27,23 @@ module ShopifyCLI
     def spawn_thread
       Thread.new do
         catch(:stop_thread) do
-          loop do
-            @jobs.pop.call
-          end
+          loop { perform(@jobs.pop) }
         end
       end
     end
+
+    def perform(job)
+      job.call
+      reschedule(job) if job.recurring?
+    end
+
+    def reschedule(job)
+      wait(job.interval)
+      schedule(job)
+    end
+
+    def wait(seconds)
+      sleep(seconds)
+    end
   end
 end

data/lib/shopify_cli/tunnel.rb

@@ -178,6 +178,15 @@ module ShopifyCLI
 
     def fetch_url(ctx, log_path)
       LogParser.new(log_path)
+    rescue NgrokError => e
+      # Full error messages/descriptions: https://ngrok.com/docs/errors
+      case e.message
+      when /ERR_NGROK_107/
+        ctx.abort(ctx.message("tunnel.invalid_token", e.message))
+      when /ERR_NGROK_108/
+        ctx.abort(ctx.message("tunnel.duplicate_session", e.message))
+      end
+      raise e.class, e.message
     rescue RuntimeError => e
       stop(ctx)
       raise e.class, e.message

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.15.0"
+  VERSION = "2.15.3"
 end

data/shopify-cli.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     %x(git ls-files -z).split("\x0").reject do |f|
       f.match(%r{^(test|spec|features|packaging)/}) ||
-      f.match(%r{^bin/(update-deps|shopify.bat)$})
+        f.match(%r{^bin/(update-deps|shopify.bat)$})
     end
   end
   spec.bindir = "bin"
@@ -49,4 +49,6 @@ Gem::Specification.new do |spec|
   # Both shopify-cli and theme-check gems are owned and developed by Shopify.
   # These gems are currently being actively developed and it's easiest to update them together.
   spec.add_dependency("theme-check", "~> 1.10.1")
+
+  spec.extensions = ["ext/shopify-extensions/extconf.rb"]
 end

data/vendor/deps/cli-ui/lib/cli/ui/os.rb

@@ -35,6 +35,10 @@ module CLI
           def shift_cursor_on_line_reset?
             false
           end
+
+          def path_separator
+            ":"
+          end
         end
       end
 
@@ -58,6 +62,10 @@ module CLI
           def shift_cursor_on_line_reset?
             true
           end
+
+          def path_separator
+            ";"
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.15.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,8 @@ email:
 - dev-tools-education@shopify.com
 executables:
 - shopify
-extensions: []
+extensions:
+- ext/shopify-extensions/extconf.rb
 extra_rdoc_files: []
 files:
 - ".devcontainer.json"
@@ -157,15 +158,19 @@ files:
 - ext/javy/hashes/javy-arm-macos-v0.1.0.gz.sha256
 - ext/javy/hashes/javy-arm-macos-v0.2.0.gz.sha256
 - ext/javy/hashes/javy-arm-macos-v0.2.1.gz.sha256
+- ext/javy/hashes/javy-arm-macos-v0.3.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-linux-v0.1.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-linux-v0.2.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-linux-v0.2.1.gz.sha256
+- ext/javy/hashes/javy-x86_64-linux-v0.3.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-macos-v0.1.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-macos-v0.2.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-macos-v0.2.1.gz.sha256
+- ext/javy/hashes/javy-x86_64-macos-v0.3.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-windows-v0.1.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-windows-v0.2.0.gz.sha256
 - ext/javy/hashes/javy-x86_64-windows-v0.2.1.gz.sha256
+- ext/javy/hashes/javy-x86_64-windows-v0.3.0.gz.sha256
 - ext/javy/javy.rb
 - ext/javy/version
 - ext/shopify-extensions/extconf.rb
@@ -246,6 +251,9 @@ files:
 - lib/project_types/extension/models/server_config/root.rb
 - lib/project_types/extension/models/server_config/user.rb
 - lib/project_types/extension/models/specification.rb
+- lib/project_types/extension/models/specification_handlers/beacon_extension.rb
+- lib/project_types/extension/models/specification_handlers/beacon_extension_utils/script_config.rb
+- lib/project_types/extension/models/specification_handlers/beacon_extension_utils/script_config_repository.rb
 - lib/project_types/extension/models/specification_handlers/checkout_post_purchase.rb
 - lib/project_types/extension/models/specification_handlers/checkout_ui_extension.rb
 - lib/project_types/extension/models/specification_handlers/default.rb
@@ -334,6 +342,7 @@ files:
 - lib/project_types/script/layers/infrastructure/script_service.rb
 - lib/project_types/script/layers/infrastructure/script_uploader.rb
 - lib/project_types/script/layers/infrastructure/service_locator.rb
+- lib/project_types/script/layers/infrastructure/sparse_checkout_details.rb
 - lib/project_types/script/loaders/project.rb
 - lib/project_types/script/loaders/specification_handler.rb
 - lib/project_types/script/messages/messages.rb
@@ -353,6 +362,7 @@ files:
 - lib/project_types/theme/commands/pull.rb
 - lib/project_types/theme/commands/push.rb
 - lib/project_types/theme/commands/serve.rb
+- lib/project_types/theme/commands/share.rb
 - lib/project_types/theme/conversions/base_glob.rb
 - lib/project_types/theme/conversions/ignore_glob.rb
 - lib/project_types/theme/conversions/include_glob.rb
@@ -369,6 +379,7 @@ files:
 - lib/shopify_cli/admin_api/schema.rb
 - lib/shopify_cli/api.rb
 - lib/shopify_cli/app_type_detector.rb
+- lib/shopify_cli/changelog.rb
 - lib/shopify_cli/command.rb
 - lib/shopify_cli/command/app_sub_command.rb
 - lib/shopify_cli/command/project_command.rb
@@ -444,11 +455,13 @@ files:
 - lib/shopify_cli/project.rb
 - lib/shopify_cli/project_commands.rb
 - lib/shopify_cli/project_type.rb
+- lib/shopify_cli/release.rb
 - lib/shopify_cli/reporting_configuration_controller.rb
 - lib/shopify_cli/resolve_constant.rb
 - lib/shopify_cli/resources.rb
 - lib/shopify_cli/resources/env_file.rb
 - lib/shopify_cli/result.rb
+- lib/shopify_cli/sed.rb
 - lib/shopify_cli/services.rb
 - lib/shopify_cli/services/app/connect_service.rb
 - lib/shopify_cli/services/app/create/node_service.rb
@@ -461,6 +474,7 @@ files:
 - lib/shopify_cli/services/app/serve/node_service.rb
 - lib/shopify_cli/services/app/serve/php_service.rb
 - lib/shopify_cli/services/app/serve/rails_service.rb
+- lib/shopify_cli/services/app/serve/serve_service.rb
 - lib/shopify_cli/services/app/tunnel/auth_service.rb
 - lib/shopify_cli/services/app/tunnel/start_service.rb
 - lib/shopify_cli/services/app/tunnel/stop_service.rb
@@ -486,10 +500,13 @@ files:
 - lib/shopify_cli/theme/dev_server/hot-reload.js
 - lib/shopify_cli/theme/dev_server/hot_reload.rb
 - lib/shopify_cli/theme/dev_server/hot_reload/remote_file_reloader.rb
+- lib/shopify_cli/theme/dev_server/hot_reload/sections_index.rb
 - lib/shopify_cli/theme/dev_server/local_assets.rb
 - lib/shopify_cli/theme/dev_server/proxy.rb
 - lib/shopify_cli/theme/dev_server/proxy/template_param_builder.rb
 - lib/shopify_cli/theme/dev_server/reload_mode.rb
+- lib/shopify_cli/theme/dev_server/remote_watcher.rb
+- lib/shopify_cli/theme/dev_server/remote_watcher/json_files_update_job.rb
 - lib/shopify_cli/theme/dev_server/sse.rb
 - lib/shopify_cli/theme/dev_server/watcher.rb
 - lib/shopify_cli/theme/dev_server/web_server.rb
@@ -500,7 +517,17 @@ files:
 - lib/shopify_cli/theme/include_filter.rb
 - lib/shopify_cli/theme/mime_type.rb
 - lib/shopify_cli/theme/syncer.rb
+- lib/shopify_cli/theme/syncer/checksums.rb
 - lib/shopify_cli/theme/syncer/error_reporter.rb
+- lib/shopify_cli/theme/syncer/forms/apply_to_all.rb
+- lib/shopify_cli/theme/syncer/forms/apply_to_all_form.rb
+- lib/shopify_cli/theme/syncer/forms/base_strategy_form.rb
+- lib/shopify_cli/theme/syncer/forms/select_delete_strategy.rb
+- lib/shopify_cli/theme/syncer/forms/select_update_strategy.rb
+- lib/shopify_cli/theme/syncer/ignore_helper.rb
+- lib/shopify_cli/theme/syncer/json_delete_handler.rb
+- lib/shopify_cli/theme/syncer/json_update_handler.rb
+- lib/shopify_cli/theme/syncer/merger.rb
 - lib/shopify_cli/theme/syncer/operation.rb
 - lib/shopify_cli/theme/syncer/standard_reporter.rb
 - lib/shopify_cli/theme/theme.rb