shopify-cli 2.12.0 → 2.15.0

data/lib/shopify_cli/messages/messages.rb

@@ -15,7 +15,9 @@ module ShopifyCLI
       },
       core: {
         errors: {
-          missing_node: "Node is required to continue. Install node here: https://nodejs.org/en/download.",
+          missing_node: "Node.js is required to continue. Install Node.js here: https://nodejs.org/en/download.",
+          missing_npm: "npm is required to continue. Install npm here: https://www.npmjs.com/get-npm.",
+          missing_ruby: "Ruby is required to continue. Install Ruby here: https://www.ruby-lang.org/en/downloads.",
           option_parser: {
             invalid_option: "The option {{command:%s}} is not supported.",
             missing_argument: "The required argument {{command:%s}} is missing.",
@@ -95,8 +97,6 @@ module ShopifyCLI
               HELP
               error: {
                 node_required: "node is required to create an app project. Download at https://nodejs.org/en/download.",
-                node_version_failure: "Failed to get the current node version. Please make sure it is installed as " \
-                  "per the instructions at https://nodejs.org/en.",
                 npm_required: "npm is required to create an app project. Download at https://www.npmjs.com/get-npm.",
                 npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
                   "the instructions at https://www.npmjs.com/get-npm.",
@@ -131,8 +131,6 @@ module ShopifyCLI
                     {{underline:https://getcomposer.org/download/}}
                   COMPOSER
                 npm_required: "npm is required to create an app project. Download at https://www.npmjs.com/get-npm.",
-                npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
-                  "the instructions at https://www.npmjs.com/get-npm.",
                 app_setup: "Failed to set up the app",
               },
 
@@ -283,6 +281,8 @@ module ShopifyCLI
               localization: {
                 error: {
                   bundle_too_large: "Total size of all locale files must be less than %s.",
+                  duplicate_locale_code: "Duplicate locale found: `%s`; locale codes"\
+                    " should be unique and are case insensitive.",
                   file_empty: "Locale file `%s` is empty.",
                   file_too_large: "Locale file `%s` too large; size must be less than %s.",
                   invalid_file_extension: "Invalid locale filename: `%s`; only .json files are allowed.",

data/lib/shopify_cli/packager.rb

@@ -81,7 +81,7 @@ module ShopifyCLI
       puts "Grabbing sha256 checksum from Rubygems.org"
       require "digest/sha2"
       require "open-uri"
-      gem_checksum = open("https://rubygems.org/downloads/shopify-cli-#{ShopifyCLI::VERSION}.gem") do |io|
+      gem_checksum = URI.open("https://rubygems.org/downloads/shopify-cli-#{ShopifyCLI::VERSION}.gem") do |io|
         Digest::SHA256.new.hexdigest(io.read)
       end
 

data/lib/shopify_cli/result.rb

@@ -181,6 +181,13 @@ module ShopifyCLI
         self
       end
 
+      ##
+      # returns the value this success represents
+      #
+      def unwrap!
+        value
+      end
+
       ##
       # returns the success value and ignores the fallback value that was either
       # provided as a method argument or by passing a block. However, the caller
@@ -339,6 +346,13 @@ module ShopifyCLI
         raise ArgumentError, "expected either a fallback value or a block" unless (args.length == 1) ^ block
         block ? block.call(@error) : args.pop
       end
+
+      ##
+      # raises the error this failure represents
+      #
+      def unwrap!
+        raise error
+      end
     end
 
     ##

data/lib/shopify_cli/services/app/create/node_service.rb

@@ -88,24 +88,12 @@ module ShopifyCLI
           end
 
           def check_node
-            cmd_path = context.which("node")
-            context.abort(context.message("core.app.create.node.error.node_required")) if cmd_path.nil?
-
-            version, stat = context.capture2e("node", "-v")
-            unless stat.success?
-              context.abort(context.message("core.app.create.node.error.node_version_failure"))
-            end
-
+            version = ShopifyCLI::Environment.node_version(context: context)
             context.done(context.message("core.app.create.node.node_version", version))
           end
 
           def check_npm
-            cmd_path = context.which("npm")
-            context.abort(context.message("core.app.create.node.error.npm_required")) if cmd_path.nil?
-
-            version, stat = context.capture2e("npm", "-v")
-            context.abort(context.message("core.app.create.node.error.npm_version_failure")) unless stat.success?
-
+            version = ShopifyCLI::Environment.npm_version(context: context)
             context.done(context.message("core.app.create.node.npm_version", version))
           end
 

data/lib/shopify_cli/services/app/create/php_service.rb

@@ -69,12 +69,7 @@ module ShopifyCLI
           end
 
           def check_npm
-            cmd_path = context.which("npm")
-            context.abort(context.message("core.app.create.php.error.npm_required")) if cmd_path.nil?
-
-            version, stat = context.capture2e("npm", "-v")
-            context.abort(context.message("core.app.create.php.error.npm_version_failure")) unless stat.success?
-
+            version = ShopifyCLI::Environment.npm_version(context: context)
             context.done(context.message("core.app.create.php.npm_version", version))
           end
 

data/lib/shopify_cli/services/app/create/rails_service.rb

@@ -108,8 +108,8 @@ module ShopifyCLI
           end
 
           def check_ruby
-            ruby_version = Rails::Ruby.version(context)
-            return if ruby_version.satisfies?("~>2.5") || ruby_version.satisfies?("~>3.0.0")
+            ruby_version = Environment.ruby_version(context)
+            return if ruby_version.satisfies?("~>2.5") || ruby_version.satisfies?("~>3.1.0")
             context.abort(context.message("core.app.create.rails.error.invalid_ruby_version"))
           end
 
@@ -219,18 +219,10 @@ module ShopifyCLI
           end
 
           def install_webpacker?
-            rails_version < ::Semantic::Version.new("7.0.0") &&
-              !File.exist?(File.join(context.root, "config/webpacker.yml"))
-          end
-
-          def rails_version
-            output, status = context.capture2e("rails", "--version")
-            unless status.success?
-              context.abort(context.message("core.app.create.rails.error.install_failure", "rails"))
-            end
+            rails_version = Environment.rails_version(context: context)
+            webpacker_config = File.exist?(File.join(context.root, "config/webpacker.yml"))
 
-            version = output.scan(/Rails \d+\.\d+\.\d+/).first.split(" ").last
-            ::Semantic::Version.new(version)
+            rails_version < ::Semantic::Version.new("7.0.0") && !webpacker_config
           end
         end
       end

data/lib/shopify_cli/theme/dev_server/hot_reload/remote_file_reloader.rb

@@ -28,6 +28,10 @@ module ShopifyCLI
 
           private
 
+          def api_client
+            @api_client ||= ThemeAdminAPI.new(@ctx, @theme.shop)
+          end
+
           def updated_file?(body, file)
             remote_checksum = body.dig("asset", "checksum")
             local_checksum = file.checksum
@@ -45,12 +49,8 @@ module ShopifyCLI
           end
 
           def fetch_asset(file)
-            ShopifyCLI::AdminAPI.rest_request(
-              @ctx,
-              shop: @theme.shop,
+            api_client.get(
               path: "themes/#{@theme.id}/assets.json",
-              method: "GET",
-              api_version: "unstable",
               query: URI.encode_www_form("asset[key]" => file.relative_path.to_s),
             )
           rescue ShopifyCLI::API::APIRequestNotFoundError

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

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

data/lib/shopify_cli/theme/development_theme.rb

@@ -45,11 +45,8 @@ module ShopifyCLI
       def exists?
         return false unless id
 
-        ShopifyCLI::AdminAPI.rest_request(
-          @ctx,
-          shop: shop,
-          path: "themes/#{id}.json",
-          api_version: "unstable",
+        api_client.get(
+          path: "themes/#{id}.json"
         )
       rescue ShopifyCLI::API::APIRequestNotFoundError
         false

data/lib/shopify_cli/theme/syncer.rb

@@ -7,15 +7,15 @@ require "forwardable"
 require_relative "syncer/error_reporter"
 require_relative "syncer/standard_reporter"
 require_relative "syncer/operation"
+require_relative "theme_admin_api"
 
 module ShopifyCLI
   module Theme
     class Syncer
       extend Forwardable
 
-      API_VERSION = "unstable"
-
       attr_reader :checksums
+      attr_reader :checksums_mutex
       attr_accessor :include_filter
       attr_accessor :ignore_filter
 
@@ -39,6 +39,9 @@ module ShopifyCLI
         # 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 = {}
 
@@ -46,12 +49,16 @@ module ShopifyCLI
         @error_checksums = []
       end
 
+      def api_client
+        @api_client ||= ThemeAdminAPI.new(@ctx, @theme.shop)
+      end
+
       def lock_io!
-        @reporters.each { |reporter| reporter.disable! }
+        @reporters.each(&:disable!)
       end
 
       def unlock_io!
-        @reporters.each { |reporter| reporter.enable! }
+        @reporters.each(&:enable!)
       end
 
       def enqueue_updates(files)
@@ -96,11 +103,8 @@ module ShopifyCLI
       end
 
       def fetch_checksums!
-        _status, response = ShopifyCLI::AdminAPI.rest_request(
-          @ctx,
-          shop: @theme.shop,
-          path: "themes/#{@theme.id}/assets.json",
-          api_version: API_VERSION,
+        _status, response = api_client.get(
+          path: "themes/#{@theme.id}/assets.json"
         )
         update_checksums(response)
       end
@@ -118,7 +122,7 @@ module ShopifyCLI
               operation = @queue.pop
               break if operation.nil? # shutdown was called
               perform(operation)
-            rescue Exception => e
+            rescue Exception => e # rubocop:disable Lint/RescueException
               error_suffix = ": #{e}"
               error_suffix += + "\n\t#{e.backtrace.join("\n\t")}" if @ctx.debug?
               report_error(operation, error_suffix)
@@ -239,12 +243,8 @@ module ShopifyCLI
           asset[:attachment] = Base64.encode64(file.read)
         end
 
-        _status, body, response = ShopifyCLI::AdminAPI.rest_request(
-          @ctx,
-          shop: @theme.shop,
+        _status, body, response = api_client.put(
           path: "themes/#{@theme.id}/assets.json",
-          method: "PUT",
-          api_version: API_VERSION,
           body: JSON.generate(asset: asset)
         )
 
@@ -272,23 +272,19 @@ module ShopifyCLI
       end
 
       def ignored_by_include_filter?(path)
-        include_filter && !include_filter.match?(path)
+        !!include_filter && !include_filter.match?(path)
       end
 
       def get(file)
-        _status, body, response = ShopifyCLI::AdminAPI.rest_request(
-          @ctx,
-          shop: @theme.shop,
+        _status, body, response = api_client.get(
           path: "themes/#{@theme.id}/assets.json",
-          method: "GET",
-          api_version: API_VERSION,
           query: URI.encode_www_form("asset[key]" => file.relative_path.to_s),
         )
 
         update_checksums(body)
 
         attachment = body.dig("asset", "attachment")
-        value = if attachment
+        if attachment
           file.write(Base64.decode64(attachment))
         else
           file.write(body.dig("asset", "value"))
@@ -298,14 +294,10 @@ module ShopifyCLI
       end
 
       def delete(file)
-        _status, _body, response = ShopifyCLI::AdminAPI.rest_request(
-          @ctx,
-          shop: @theme.shop,
+        _status, _body, response = api_client.delete(
           path: "themes/#{@theme.id}/assets.json",
-          method: "DELETE",
-          api_version: API_VERSION,
           body: JSON.generate(asset: {
-            key: file.relative_path.to_s
+            key: file.relative_path.to_s,
           })
         )
 
@@ -314,14 +306,17 @@ module ShopifyCLI
 
       def update_checksums(api_response)
         api_response.values.flatten.each do |asset|
-          if asset["key"]
+          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.reject! { |key, _| @checksums.key?("#{key}.liquid") }
+        checksums_mutex.synchronize do
+          @checksums.reject! { |key, _| @checksums.key?("#{key}.liquid") }
+        end
       end
 
       def file_has_changed?(file)
@@ -332,7 +327,7 @@ module ShopifyCLI
         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 { |message| message.split("\n", 2).first }
+        [message].flatten.map { |mess| mess.split("\n", 2).first }
       rescue JSON::ParserError
         [exception.message]
       end
@@ -340,7 +335,7 @@ module ShopifyCLI
       def backoff_if_near_limit!(used, limit)
         if used > limit - @threads.size
           @ctx.debug("Near API call limit, waiting 2 sec…")
-          @backoff_mutex.synchronize { sleep 2 }
+          @backoff_mutex.synchronize { sleep(2) }
         end
       end
 

data/lib/shopify_cli/theme/theme.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative "file"
+require_relative "theme_admin_api"
 
 require "pathname"
 require "time"
@@ -59,7 +60,7 @@ module ShopifyCLI
       end
 
       def shop
-        AdminAPI.get_shop_or_abort(@ctx)
+        api_client.get_shop_or_abort
       end
 
       def editor_url
@@ -101,9 +102,7 @@ module ShopifyCLI
       def create
         raise InvalidThemeRole, "Can't create live theme. Use publish." if live?
 
-        _status, body = ShopifyCLI::AdminAPI.rest_request(
-          @ctx,
-          shop: shop,
+        _status, body = api_client.post(
           path: "themes.json",
           body: JSON.generate({
             theme: {
@@ -111,31 +110,21 @@ module ShopifyCLI
               role: role,
             },
           }),
-          method: "POST",
-          api_version: "unstable",
         )
 
         @id = body["theme"]["id"]
       end
 
       def delete
-        AdminAPI.rest_request(
-          @ctx,
-          shop: shop,
-          method: "DELETE",
-          path: "themes/#{id}.json",
-          api_version: "unstable",
+        api_client.delete(
+          path: "themes/#{id}.json"
         )
       end
 
       def publish
         return if live?
-        AdminAPI.rest_request(
-          @ctx,
-          shop: shop,
-          method: "PUT",
+        api_client.put(
           path: "themes/#{id}.json",
-          api_version: "unstable",
           body: JSON.generate(theme: {
             role: "main",
           })
@@ -205,23 +194,23 @@ module ShopifyCLI
         end
 
         def fetch_themes(ctx)
-          AdminAPI.rest_request(
-            ctx,
-            shop: AdminAPI.get_shop_or_abort(ctx),
-            path: "themes.json",
-            api_version: "unstable",
+          api_client = ThemeAdminAPI.new(ctx)
+
+          api_client.get(
+            path: "themes.json"
           )
         end
       end
 
       private
 
+      def api_client
+        @api_client ||= ThemeAdminAPI.new(@ctx)
+      end
+
       def load_info_from_api
-        _status, body = AdminAPI.rest_request(
-          @ctx,
-          shop: shop,
-          path: "themes/#{id}.json",
-          api_version: "unstable",
+        _status, body = api_client.get(
+          path: "themes/#{id}.json"
         )
 
         @name = body.dig("theme", "name")

data/lib/shopify_cli/theme/theme_admin_api.rb

@@ -0,0 +1,72 @@
+module ShopifyCLI
+  module Theme
+    class ThemeAdminAPI
+      API_VERSION = "unstable"
+
+      attr_reader :shop
+
+      def initialize(ctx, shop = nil)
+        @ctx = ctx
+        @shop = shop || get_shop_or_abort
+      end
+
+      def get(path:, **args)
+        rest_request(method: "GET", path: path, **args)
+      end
+
+      def put(path:, **args)
+        rest_request(method: "PUT", path: path, **args)
+      end
+
+      def post(path:, **args)
+        rest_request(method: "POST", path: path, **args)
+      end
+
+      def delete(path:, **args)
+        rest_request(method: "DELETE", path: path, **args)
+      end
+
+      def get_shop_or_abort # rubocop:disable Naming/AccessorMethodName
+        ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+      end
+
+      private
+
+      def rest_request(**args)
+        ShopifyCLI::AdminAPI.rest_request(
+          @ctx,
+          shop: @shop,
+          api_version: API_VERSION,
+          **args.compact
+        )
+      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 {}>
+        #
+        # * 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
+        end
+
+        raise error
+      end
+
+      def handle_permissions_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?
+      end
+    end
+  end
+end

data/lib/shopify_cli/transform_data_structure.rb

@@ -40,6 +40,7 @@ module ShopifyCLI
 
     property! :underscore_keys, accepts: [true, false], default: false, reader: :underscore_keys?
     property! :symbolize_keys, accepts: [true, false], default: false, reader: :symbolize_keys?
+    property! :shallow, accepts: [true, false], default: false, reader: :shallow?
     property! :associative_array_container,
       accepts: ->(c) { c.respond_to?(:new) && c.method_defined?(:[]=) },
       default: -> { Hash }
@@ -47,10 +48,10 @@ module ShopifyCLI
     def call(object)
       case object
       when Array
-        object.map(&self).map(&:value)
+        shallow? ? object.dup : object.map(&self).map(&:value)
       when Hash
         object.each.with_object(associative_array_container.new) do |(key, value), result|
-          result[transform_key(key)] = call(value).value
+          result[transform_key(key)] = shallow? ? value : call(value).value
         end
       else
         ShopifyCLI::Result.success(object)

data/lib/shopify_cli/version.rb

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

data/shipit.yml

@@ -0,0 +1,3 @@
+deploy:
+  post:
+    - bundle exec rake notify_version_to_bugsnag

data/shopify-cli.gemspec

@@ -35,11 +35,18 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "vendor"]
   spec.executables << "shopify"
 
-  spec.add_development_dependency("bundler", "~> 2.2.2")
+  spec.add_development_dependency("bundler", "~> 2.3.8")
   spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
   spec.add_development_dependency("minitest", "~> 5.0")
 
   spec.add_dependency("bugsnag", "~> 6.22")
   spec.add_dependency("listen", "~> 3.7.0")
-  spec.add_dependency("theme-check", "~> 1.9.0")
+
+  # We prefer being more strict here with the version range to have a more deterministic build.
+  # The added benefit is that, if the user upgrades the CLI, and we have "~> 1.10.1" version range,
+  # they will get a theme-check update.
+  # Whereas if we were to have "~> 1.9", that version would still be satisfied and thus not upgraded.
+  # 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")
 end

data/shopify-dev

@@ -3,16 +3,14 @@
 require_relative "./bin/load_shopify"
 
 exit(proc do
-  begin
-    ShopifyCLI::ErrorHandler.call do
-      ShopifyCLI::Core::EntryPoint.call(ARGV.dup)
-    end
-  rescue StandardError => error
-    ShopifyCLI::ErrorHandler.exception = error
-    if ShopifyCLI::Environment.print_stacktrace?
-      raise error
-    else
-      1
-    end
+  ShopifyCLI::ErrorHandler.call do
+    ShopifyCLI::Core::EntryPoint.call(ARGV.dup)
   end
+     rescue StandardError => error
+       ShopifyCLI::ErrorHandler.exception = error
+       if ShopifyCLI::Environment.print_stacktrace?
+         raise error
+       else
+         1
+       end
 end.call)