shopify-cli 2.11.0 → 2.12.0

data/lib/project_types/theme/commands/push.rb

@@ -4,14 +4,21 @@ require "shopify_cli/theme/development_theme"
 require "shopify_cli/theme/ignore_filter"
 require "shopify_cli/theme/include_filter"
 require "shopify_cli/theme/syncer"
+require "project_types/theme/commands/common/root_helper"
+require "project_types/theme/conversions/include_glob"
+require "project_types/theme/conversions/ignore_glob"
 
 module Theme
   class Command
     class Push < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
+      include Common::RootHelper
+
       recommend_default_ruby_range
 
       options do |parser, flags|
+        Conversions::IncludeGlob.register(parser)
+        Conversions::IgnoreGlob.register(parser)
+
         parser.on("-n", "--nodelete") { flags[:nodelete] = true }
         parser.on("-i", "--themeid=ID") { |theme_id| flags[:theme_id] = theme_id }
         parser.on("-t", "--theme=NAME_OR_ID") { |theme| flags[:theme] = theme }
@@ -21,18 +28,18 @@ module Theme
         parser.on("-j", "--json") { flags[:json] = true }
         parser.on("-a", "--allow-live") { flags[:allow_live] = true }
         parser.on("-p", "--publish") { flags[:publish] = true }
-        parser.on("-o", "--only=PATTERN") do |pattern|
+        parser.on("-o", "--only=PATTERN", Conversions::IncludeGlob) do |pattern|
           flags[:includes] ||= []
-          flags[:includes] << pattern
+          flags[:includes] += pattern
         end
-        parser.on("-x", "--ignore=PATTERN") do |pattern|
+        parser.on("-x", "--ignore=PATTERN", Conversions::IgnoreGlob) do |pattern|
           flags[:ignores] ||= []
-          flags[:ignores] << pattern
+          flags[:ignores] += pattern
         end
       end
 
-      def call(args, _name)
-        root = args.first || "."
+      def call(_args, name)
+        root = root_value(options, name)
         delete = !options.flags[:nodelete]
         theme = find_theme(root, **options.flags)
         return if theme.nil?
@@ -43,7 +50,7 @@ module Theme
           return unless CLI::UI::Prompt.confirm(question)
         end
 
-        include_filter = ShopifyCLI::Theme::IncludeFilter.new(options.flags[:includes])
+        include_filter = ShopifyCLI::Theme::IncludeFilter.new(root, options.flags[:includes])
         ignore_filter = ShopifyCLI::Theme::IgnoreFilter.from_path(root)
         ignore_filter.add_patterns(options.flags[:ignores]) if options.flags[:ignores]
 
@@ -92,9 +99,7 @@ module Theme
         end
 
         if development
-          new_theme = ShopifyCLI::Theme::DevelopmentTheme.new(@ctx, root: root)
-          new_theme.ensure_exists!
-          return new_theme
+          return ShopifyCLI::Theme::DevelopmentTheme.find_or_create!(@ctx, root: root)
         end
 
         if unpublished

data/lib/project_types/theme/commands/serve.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 require "shopify_cli/theme/dev_server"
+require "project_types/theme/commands/common/root_helper"
 
 module Theme
   class Command
     class Serve < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
+      include Common::RootHelper
+
       recommend_default_ruby_range
 
       DEFAULT_HTTP_HOST = "127.0.0.1"
@@ -16,10 +18,11 @@ module Theme
         parser.on("--live-reload=MODE") { |mode| flags[:mode] = as_reload_mode(mode) }
       end
 
-      def call(*)
+      def call(_args, name)
+        root = root_value(options, name)
         flags = options.flags.dup
         host = flags[:host] || DEFAULT_HTTP_HOST
-        ShopifyCLI::Theme::DevServer.start(@ctx, ".", host: host, **flags) do |syncer|
+        ShopifyCLI::Theme::DevServer.start(@ctx, root, host: host, **flags) do |syncer|
           UI::SyncProgressBar.new(syncer).progress(:upload_theme!, delay_low_priority_files: true)
         end
       rescue ShopifyCLI::Theme::DevServer::AddressBindingError

data/lib/project_types/theme/conversions/base_glob.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Theme
+  module Conversions
+    class BaseGlob
+      class << self
+        def register(parser)
+          parser.accept(self) { |_val| convert(parser) }
+        end
+
+        def convert(parser)
+          argv = parser.default_argv
+          option_index = argv.index { |v| options.include?(v) }
+
+          return [] if option_index.nil?
+
+          start_index = option_index + 1
+          option_by_key = options_map(parser)
+          values = []
+
+          argv[start_index..-1].each do |value|
+            return values unless option_by_key[value].nil?
+            values << value
+          end
+
+          values
+        end
+
+        def options
+          raise "`#{self.class.name}#options` must be defined"
+        end
+
+        private
+
+        def options_map(parser)
+          map = {}
+          parser.top.list.each do |option|
+            map[option.short.first] = option
+            map[option.long.first] = option
+          end
+          map
+        end
+
+        def parameter?(value)
+          value.start_with?("-")
+        end
+      end
+    end
+  end
+end

data/lib/project_types/theme/conversions/ignore_glob.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base_glob"
+
+module Theme
+  module Conversions
+    class IgnoreGlob < BaseGlob
+      class << self
+        def options
+          %w(-x --ignore)
+        end
+      end
+    end
+  end
+end

data/lib/project_types/theme/conversions/include_glob.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base_glob"
+
+module Theme
+  module Conversions
+    class IncludeGlob < BaseGlob
+      class << self
+        def options
+          %w(-o --only)
+        end
+      end
+    end
+  end
+end

data/lib/project_types/theme/messages/messages.rb

@@ -65,8 +65,8 @@ module Theme
                 {{command:-j, --json}}             Output JSON instead of a UI.
                 {{command:-a, --allow-live}}       Allow push to a live theme.
                 {{command:-p, --publish}}          Publish as the live theme after uploading.
-                {{command:-o, --only}}             Upload only the specified files.
-                {{command:-x, --ignore}}           Skip uploading the specified files.
+                {{command:-o, --only}}             Upload only the specified files (Multiple flags allowed).
+                {{command:-x, --ignore}}           Skip uploading the specified files (Multiple flags allowed).
 
               Run without options to select theme from a list.
           HELP
@@ -96,7 +96,7 @@ module Theme
           help: <<~HELP,
             Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.
 
-            Usage: {{command:%s theme serve}}
+            Usage: {{command:%s theme serve [ ROOT ]}}
 
             Options:
               {{command:--port=PORT}}        Local port to serve theme preview from.
@@ -202,8 +202,8 @@ module Theme
               {{command:-l, --live}}             Pull theme files from your remote live theme.
               {{command:-d, --development}}      Pull theme files from your remote development theme.
               {{command:-n, --nodelete}}         Runs the pull command without deleting local files.
-              {{command:-o, --only}}             Download only the specified files.
-              {{command:-x, --ignore}}           Skip downloading the specified files.
+              {{command:-o, --only}}             Download only the specified files (Multiple flags allowed).
+              {{command:-x, --ignore}}           Skip downloading the specified files (Multiple flags allowed).
 
             Run without options to select theme from a list.
           HELP

data/lib/shopify_cli/command.rb

@@ -100,14 +100,22 @@ module ShopifyCLI
       end
 
       def check_node_version
+        return unless @compatible_node_range
+
+        context = Context.new
+        if context.which("node").nil?
+          raise ShopifyCLI::Abort, context.message("core.errors.missing_node")
+        end
+
         check_version(
           Environment.node_version,
           range: @compatible_node_range,
-          runtime: "Node"
+          runtime: "Node",
+          context: context
         )
       end
 
-      def check_version(version, range:, runtime:)
+      def check_version(version, range:, runtime:, context: Context.new)
         return if Environment.test?
         return if range.nil?
 
@@ -116,7 +124,7 @@ module ShopifyCLI
         is_lower_than_top = version_without_pre_nor_build < Utilities.version_dropping_pre_and_build(range.to)
         return if is_higher_than_bottom && is_lower_than_top
 
-        Context.new.warn("Your environment #{runtime} version, #{version},"\
+        context.warn("Your environment #{runtime} version, #{version},"\
           " is outside of the range supported by the CLI,"\
           " #{range.from}..<#{range.to},"\
           " and might cause incompatibility issues.")

data/lib/shopify_cli/commands/app/create/node.rb

@@ -4,6 +4,7 @@ module ShopifyCLI
       class Create
         class Node < ShopifyCLI::Command::AppSubCommand
           prerequisite_task :ensure_authenticated
+          prerequisite_task :ensure_git_dependency
 
           recommend_default_node_range
           recommend_default_ruby_range

data/lib/shopify_cli/commands/app/create/php.rb

@@ -4,6 +4,7 @@ module ShopifyCLI
       class Create
         class PHP < ShopifyCLI::Command::AppSubCommand
           prerequisite_task :ensure_authenticated
+          prerequisite_task :ensure_git_dependency
 
           options do |parser, flags|
             parser.on("--name=NAME") { |name| flags[:name] = name }

data/lib/shopify_cli/commands/app/create/rails.rb

@@ -4,9 +4,10 @@ module ShopifyCLI
       class Create
         class Rails < ShopifyCLI::Command::AppSubCommand
           prerequisite_task :ensure_authenticated
+          prerequisite_task :ensure_git_dependency
 
-          recommend_default_node_range
           recommend_default_ruby_range
+          recommend_default_node_range
 
           options do |parser, flags|
             parser.on("--name=NAME") { |t| flags[:name] = t }

data/lib/shopify_cli/commands/app/create.rb

@@ -6,9 +6,6 @@ module ShopifyCLI
         subcommand :PHP, "php", "shopify_cli/commands/app/create/php"
         subcommand :Node, "node", "shopify_cli/commands/app/create/node"
 
-        recommend_default_node_range
-        recommend_default_ruby_range
-
         def call(_args, _command_name)
           @ctx.puts(self.class.help)
         end

data/lib/shopify_cli/commands/app/deploy.rb

@@ -3,8 +3,8 @@ module ShopifyCLI
     class App
       class Deploy < ShopifyCLI::Command::AppSubCommand
         subcommand :Heroku, "heroku", "shopify_cli/commands/app/deploy/heroku"
+        prerequisite_task :ensure_git_dependency
 
-        recommend_default_node_range
         recommend_default_ruby_range
 
         def call(args, _name)

data/lib/shopify_cli/commands/app/serve.rb

@@ -7,7 +7,6 @@ module ShopifyCLI
         prerequisite_task :ensure_env, :ensure_dev_store
 
         recommend_default_ruby_range
-        recommend_default_node_range
 
         options do |parser, flags|
           parser.on("--host=HOST") do |h|

data/lib/shopify_cli/constants.rb

@@ -38,7 +38,7 @@ module ShopifyCLI
 
       # When true the CLI points to spin instances of services
       SPIN = "SPIN"
-      INFER_SPIN = "INFER_SPIN"
+      SPIN_INSTANCE = "SPIN_INSTANCE"
       SPIN_WORKSPACE = "SPIN_WORKSPACE"
       SPIN_NAMESPACE = "SPIN_NAMESPACE"
       SPIN_HOST = "SPIN_HOST"
@@ -65,7 +65,7 @@ module ShopifyCLI
       end
 
       module Node
-        FROM = "12.0.0"
+        FROM = "14.5.0"
         TO = "17.0.0"
       end
     end

data/lib/shopify_cli/environment.rb

@@ -5,6 +5,11 @@ module ShopifyCLI
   # the environment in which the CLI runs
   module Environment
     TRUTHY_ENV_VARIABLE_VALUES = ["1", "true", "TRUE", "yes", "YES"]
+    SPIN_OVERRIDE_ENV_NAMES = [
+      Constants::EnvironmentVariables::SPIN_WORKSPACE,
+      Constants::EnvironmentVariables::SPIN_NAMESPACE,
+      Constants::EnvironmentVariables::SPIN_HOST,
+    ]
 
     def self.ruby_version(context: Context.new)
       out, err, stat = context.capture3('ruby -e "puts RUBY_VERSION"')
@@ -20,6 +25,12 @@ module ShopifyCLI
       ::Semantic::Version.new(out.chomp)
     end
 
+    def self.npm_version(context: Context.new)
+      out, err, stat = context.capture3("npm", "--version")
+      raise ShopifyCLI::Abort, err unless stat.success?
+      ::Semantic::Version.new(out.chomp)
+    end
+
     def self.interactive=(interactive)
       @interactive = interactive
     end
@@ -87,6 +98,20 @@ module ShopifyCLI
       end
     end
 
+    def self.spin_url_override(env_variables: ENV)
+      tokens = SPIN_OVERRIDE_ENV_NAMES.map do |name|
+        env_variables[name]
+      end
+
+      return if tokens.all?(&:nil?)
+
+      if tokens.any?(&:nil?)
+        raise "To manually target a spin instance, you must set #{SPIN_OVERRIDE_ENV_NAMES}"
+      else
+        tokens.join(".")
+      end
+    end
+
     def self.use_spin?(env_variables: ENV)
       env_variable_truthy?(
         Constants::EnvironmentVariables::SPIN,
@@ -97,34 +122,31 @@ module ShopifyCLI
       )
     end
 
-    def self.infer_spin?(env_variables: ENV)
-      env_variable_truthy?(
-        Constants::EnvironmentVariables::INFER_SPIN,
-        env_variables: env_variables
-      )
-    end
-
     def self.spin_url(env_variables: ENV)
-      if infer_spin?(env_variables: env_variables)
-        # TODO: Remove version check and delete spin-legacy branch
-        #  once spin2 becomes the installed "spin" binary by default
-        spin_version = %x(spin version 2> /dev/null).strip
-        if spin_version.start_with?("spin-")
-          # spin2
-          raise ShopifyCLI:: Abort, "SPIN_INSTANCE must be specified" unless ENV.key?("SPIN_INSTANCE")
-          %x(spin show -o fqdn 2> /dev/null).strip
-        else
-          # spin-legacy
-          %x(spin info fqdn 2> /dev/null).strip
-        end
+      override = spin_url_override(env_variables: env_variables)
+      return override unless override.nil?
+
+      spin_response = if env_variables.key?(
+        Constants::EnvironmentVariables::SPIN_INSTANCE
+      )
+        spin_show
       else
-        spin_workspace = spin_workspace(env_variables: env_variables)
-        spin_namespace = spin_namespace(env_variables: env_variables)
-        spin_host = spin_host(env_variables: env_variables)
-        "#{spin_workspace}.#{spin_namespace}.#{spin_host}"
+        spin_show(latest: true)
+      end
+
+      begin
+        instance = JSON.parse(spin_response)
+        raise "Missing key 'fqdn' from spin show. Actual response: #{instance}" unless instance.include?("fqdn")
+        instance["fqdn"]
+      rescue => e
+        raise "Failed to infer spin environment from spin show response #{spin_response}: #{e}"
       end
     end
 
+    def self.spin_show(latest: false)
+      latest ? %x(spin show --latest --json) : %x(spin show --json)
+    end
+
     def self.send_monorail_events?(env_variables: ENV)
       env_variable_truthy?(
         Constants::EnvironmentVariables::MONORAIL_REAL_EVENTS,
@@ -139,27 +161,5 @@ module ShopifyCLI
     def self.env_variable_truthy?(variable_name, env_variables: ENV)
       TRUTHY_ENV_VARIABLE_VALUES.include?(env_variables[variable_name.to_s])
     end
-
-    def self.spin_workspace(env_variables: ENV)
-      env_value = env_variables[Constants::EnvironmentVariables::SPIN_WORKSPACE]
-      return env_value unless env_value.nil?
-
-      if env_value.nil?
-        raise "No value set for #{Constants::EnvironmentVariables::SPIN_WORKSPACE}"
-      end
-    end
-
-    def self.spin_namespace(env_variables: ENV)
-      env_value = env_variables[Constants::EnvironmentVariables::SPIN_NAMESPACE]
-      return env_value unless env_value.nil?
-
-      if env_value.nil?
-        raise "No value set for #{Constants::EnvironmentVariables::SPIN_NAMESPACE}"
-      end
-    end
-
-    def self.spin_host(env_variables: ENV)
-      env_variables[Constants::EnvironmentVariables::SPIN_HOST] || "us.spin.dev"
-    end
   end
 end

data/lib/shopify_cli/git.rb

@@ -4,7 +4,15 @@ module ShopifyCLI
   # git.
   class Git
     class << self
-      # Check if Git is available in the environment
+      # Check if Git exists in the environment
+      def exists?(ctx)
+        _output, status = ctx.capture2e("git", "version")
+        status.success?
+      rescue Errno::ENOENT # git is not installed
+        false
+      end
+
+      # Check if the current working directory is a Git repository
       def available?(ctx)
         _output, status = ctx.capture2e("git", "status")
         status.success?

data/lib/shopify_cli/messages/messages.rb

@@ -15,6 +15,7 @@ module ShopifyCLI
       },
       core: {
         errors: {
+          missing_node: "Node is required to continue. Install node here: https://nodejs.org/en/download.",
           option_parser: {
             invalid_option: "The option {{command:%s}} is not supported.",
             missing_argument: "The required argument {{command:%s}} is missing.",
@@ -41,7 +42,7 @@ module ShopifyCLI
             invalid_type: "The type %s is not supported. The only supported types are"\
               " {{command:[ rails | node | php ]}}",
             help: <<~HELP,
-            {{command:%s app create}}: Creates a ruby on rails app.
+            {{command:%s app create}}: Creates a new project in a subdirectory.
               Usage: {{command:%s app create [ rails | node | php ]}}
             HELP
             rails: {
@@ -276,6 +277,24 @@ module ShopifyCLI
               HELP
           },
         },
+        extension: {
+          push: {
+            checkout_ui_extension: {
+              localization: {
+                error: {
+                  bundle_too_large: "Total size of all locale files must be less than %s.",
+                  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.",
+                  invalid_locale_code: "Invalid locale filename: `%s`; locale code should be 2 or 3 letters,"\
+                    " optionally followed by a two-letter region code, e.g. `fr-CA`.",
+                  single_default_locale: "There must be one and only one locale identified as the default locale,"\
+                    " e.g. `en.default.json`",
+                },
+              },
+            },
+          },
+        },
         error_reporting: {
           unhandled_error: {
             message: "{{x}} {{red:An unexpected error occured.}}",
@@ -354,6 +373,7 @@ module ShopifyCLI
           error: {
             directory_exists: "Project directory already exists. Please create a project with a new name.",
             no_branches_found: "Could not find any git branches",
+            nonexistent: "Git needs to be installed: https://git-scm.com/download",
             repo_not_initiated:
               "Git repo is not initiated. Please run {{command:git init}} and make at least one commit.",
             no_commits_made: "No git commits have been made. Please make at least one commit.",
@@ -671,7 +691,8 @@ module ShopifyCLI
             },
           },
           ensure_dev_store: {
-            could_not_verify_store: "Couldn't verify your store %s",
+            could_not_verify_store: "Couldn't verify your store. If you don't have a development store set up, "\
+              "please create one in your Partners dashboard and run `shopify app connect`.",
             convert_to_dev_store: <<~MESSAGE,
               Do you want to convert %s to a development store?
               Doing this will allow you to install your app, but the store will become {{bold:transfer-disabled}}.

data/lib/shopify_cli/tasks/ensure_git_dependency.rb

@@ -0,0 +1,14 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Tasks
+    class EnsureGitDependency < ShopifyCLI::Task
+      def call(ctx)
+        return if ShopifyCLI::Environment.acceptance_test?
+        unless ShopifyCLI::Git.exists?(ctx)
+          raise ShopifyCLI::Abort, ctx.message("core.git.error.nonexistent")
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/tasks.rb

@@ -34,6 +34,7 @@ module ShopifyCLI
     register :CreateApiClient, :create_api_client, "shopify_cli/tasks/create_api_client"
     register :EnsureAuthenticated, :ensure_authenticated, "shopify_cli/tasks/ensure_authenticated"
     register :EnsureEnv, :ensure_env, "shopify_cli/tasks/ensure_env"
+    register :EnsureGitDependency, :ensure_git_dependency, "shopify_cli/tasks/ensure_git_dependency"
     register :EnsureLoopbackURL, :ensure_loopback_url, "shopify_cli/tasks/ensure_loopback_url"
     register :EnsureProjectType, :ensure_project_type, "shopify_cli/tasks/ensure_project_type"
     register :EnsureDevStore, :ensure_dev_store, "shopify_cli/tasks/ensure_dev_store"

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    module DevServer
+      class HotReload
+        class RemoteFileReloader
+          def initialize(ctx, theme:, streams:)
+            @ctx = ctx
+            @theme = theme
+            @streams = streams
+          end
+
+          def reload(file)
+            retries = 6
+
+            until retries.zero?
+              retries -= 1
+
+              _status, body = fetch_asset(file)
+              retries = 0 if updated_file?(body, file)
+
+              wait
+            end
+
+            notify(file)
+          end
+
+          private
+
+          def updated_file?(body, file)
+            remote_checksum = body.dig("asset", "checksum")
+            local_checksum = file.checksum
+
+            remote_checksum == local_checksum
+          end
+
+          def notify(file)
+            @streams.broadcast(JSON.generate(modified: [file]))
+            @ctx.debug("[RemoteFileReloader] Modified #{file}")
+          end
+
+          def wait
+            sleep(1)
+          end
+
+          def fetch_asset(file)
+            ShopifyCLI::AdminAPI.rest_request(
+              @ctx,
+              shop: @theme.shop,
+              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
+            [404, {}]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "hot_reload/remote_file_reloader"
+
 module ShopifyCLI
   module Theme
     module DevServer
@@ -10,6 +12,7 @@ module ShopifyCLI
           @theme = theme
           @mode = mode
           @streams = SSE::Streams.new
+          @remote_file_reloader = RemoteFileReloader.new(ctx, theme: @theme, streams: @streams)
           @watcher = watcher
           @watcher.add_observer(self, :notify_streams_of_file_change)
           @ignore_filter = ignore_filter
@@ -32,17 +35,30 @@ module ShopifyCLI
         end
 
         def notify_streams_of_file_change(modified, added, _removed)
-          files = (modified + added).reject { |file| @ignore_filter&.ignore?(file) }
-            .map { |file| @theme[file].relative_path }
+          files = (modified + added)
+            .reject { |file| @ignore_filter&.ignore?(file) }
+            .map { |file| @theme[file] }
 
-          unless files.empty?
-            @streams.broadcast(JSON.generate(modified: files))
-            @ctx.debug("[HotReload] Modified #{files.join(", ")}")
-          end
+          files -= liquid_css_files = files.select(&:liquid_css?)
+
+          hot_reload(files) unless files.empty?
+          remote_reload(liquid_css_files)
         end
 
         private
 
+        def hot_reload(files)
+          paths = files.map(&:relative_path)
+          @streams.broadcast(JSON.generate(modified: paths))
+          @ctx.debug("[HotReload] Modified #{paths.join(", ")}")
+        end
+
+        def remote_reload(files)
+          files.each do |file|
+            @remote_file_reloader.reload(file)
+          end
+        end
+
         def request_is_html?(headers)
           headers["content-type"]&.start_with?("text/html")
         end