shopify-cli 2.6.6 → 2.7.3

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

@@ -3,18 +3,24 @@ require "shopify_cli/theme/dev_server"
 
 module Theme
   class Command
-    class Serve < ShopifyCLI::SubCommand
+    class Serve < ShopifyCLI::Command::SubCommand
+      DEFAULT_HTTP_HOST = "127.0.0.1"
+
       options do |parser, flags|
-        parser.on("--bind=HOST") { |bind| flags[:bind] = bind.to_s }
+        parser.on("--host=HOST") { |host| flags[:host] = host.to_s }
         parser.on("--port=PORT") { |port| flags[:port] = port.to_i }
         parser.on("--poll") { flags[:poll] = true }
       end
 
       def call(*)
         flags = options.flags.dup
-        ShopifyCLI::Theme::DevServer.start(@ctx, ".", **flags) do |syncer|
+        host = flags[:host] || DEFAULT_HTTP_HOST
+        ShopifyCLI::Theme::DevServer.start(@ctx, ".", host: host, **flags) do |syncer|
           UI::SyncProgressBar.new(syncer).progress(:upload_theme!, delay_low_priority_files: true)
         end
+      rescue ShopifyCLI::Theme::DevServer::AddressBindingError
+        raise ShopifyCLI::Abort,
+          ShopifyCLI::Context.message("theme.serve.error.address_binding_error", ShopifyCLI::TOOL_NAME)
       end
 
       def self.help

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

@@ -58,6 +58,7 @@ module Theme
 
               Options:
                 {{command:-i, --themeid=THEMEID}} Theme ID. Must be an existing theme on your store.
+                {{command:-l, --live}}            Push to your remote live theme, and update your live store.
                 {{command:-d, --development}}     Push to your remote development theme, and create it if needed.
                 {{command:-u, --unpublished}}     Create a new unpublished theme and push to it.
                 {{command:-n, --nodelete}}        Runs the push command without deleting remote files from Shopify.
@@ -94,10 +95,45 @@ module Theme
             Options:
               {{command:--port=PORT}} Local port to serve theme preview from
               {{command:--poll}}      Force polling to detect file changes
-              {{command:--bind=HOST}} Set which network interface the web server listens on
+              {{command:--host=HOST}} Set which network interface the web server listens on. The default value is 127.0.0.1.
           HELP
-          serve: "Viewing theme…",
+          viewing_theme: "Viewing theme…",
+          syncing_theme: "Syncing theme #%s on %s",
           open_fail: "Couldn't open the theme",
+          operation: {
+            status: {
+              error: "ERROR",
+              synced: "Synced",
+              fixed: "Fixed",
+            },
+          },
+          error: {
+            address_binding_error: "Couldn't bind to localhost."\
+              " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
+          },
+          serving: <<~SERVING,
+
+            Serving %s
+
+          SERVING
+          customize_or_preview: <<~CUSTOMIZE_OR_PREVIEW,
+
+            Customize this theme in the Online Store Editor:
+            {{green:%s}}
+
+            Share this theme preview:
+            {{green:%s}}
+
+            (Use Ctrl-C to stop)
+          CUSTOMIZE_OR_PREVIEW
+          ensure_user: <<~ENSURE_USER,
+            You are not authorized to edit themes on %s.
+            Make sure you are a user of that store, and allowed to edit themes.
+          ENSURE_USER
+          already_in_use_error: "Error",
+          address_already_in_use: "The address \"%s\" is already in use.",
+          try_this: "Try this",
+          try_port_option: "Use the --port=PORT option to serve the theme in a different port.",
         },
         check: {
           help: <<~HELP,
@@ -153,6 +189,7 @@ module Theme
 
             Options:
               {{command:-i, --themeid=THEMEID}} The Theme ID. Must be an existing theme on your store.
+              {{command:-l, --live}}            Pull theme files from your remote live theme.
               {{command:-n, --nodelete}}        Runs the pull command without deleting local files.
 
             Run without options to select theme from a list.

data/lib/project_types/theme/ui/sync_progress_bar.rb

@@ -6,14 +6,14 @@ module Theme
       end
 
       def progress(method, **args)
-        @syncer.delay_errors!
+        @syncer.lock_io!
         CLI::UI::Progress.progress do |bar|
           @syncer.public_send(method, **args) do |left, total|
             bar.tick(set_percent: 1 - left.to_f / total)
           end
           bar.tick(set_percent: 1)
         end
-        @syncer.report_errors!
+        @syncer.unlock_io!
       end
     end
   end

data/lib/shopify_cli/admin_api/populate_resource_command.rb

@@ -3,7 +3,7 @@ require "optparse"
 
 module ShopifyCLI
   class AdminAPI
-    class PopulateResourceCommand < ShopifyCLI::SubCommand
+    class PopulateResourceCommand < ShopifyCLI::Command::SubCommand
       DEFAULT_COUNT = 5
 
       attr_reader :input

data/lib/shopify_cli/api.rb

@@ -108,9 +108,14 @@ module ShopifyCLI
     private
 
     def default_headers
+      sha = ShopifyCLI.sha
+      user_agent = "Shopify CLI; v=#{ShopifyCLI::VERSION}"
+      sec_ch_ua = user_agent
+      sec_ch_ua += " sha=#{sha}" unless sha.nil?
+
       {
-        "User-Agent" => "Shopify CLI; v=#{ShopifyCLI::VERSION}",
-        "Sec-CH-UA" => "Shopify CLI; v=#{ShopifyCLI::VERSION} sha=#{ShopifyCLI.sha}",
+        "User-Agent" => user_agent,
+        "Sec-CH-UA" => sec_ch_ua,
         "Sec-CH-UA-PLATFORM" => ctx.os.to_s,
         "X-Request-Id" => SecureRandom.uuid,
       }.tap do |headers|

data/lib/shopify_cli/app_type_detector.rb

@@ -3,30 +3,34 @@ require "json"
 module ShopifyCLI
   class AppTypeDetector
     Error = Class.new(StandardError)
+    MissingShopifyCLIYamlError = Class.new(Error)
     TypeNotFoundError = Class.new(Error)
-
-    def self.detect(project_directory:)
-      return :node if node?(project_directory: project_directory)
-      return :rails if rails?(project_directory: project_directory)
-      return :php if php?(project_directory: project_directory)
-      raise TypeNotFoundError, "Couldn't detect the project type in directory: #{project_directory}"
-    end
-
-    def self.node?(project_directory:)
-      package_json_path = File.join(project_directory, "package.json")
-      return false unless File.exist?(package_json_path)
-      package_json = JSON.parse(File.read(package_json_path))
-      !package_json.dig("scripts", "dev").nil?
+    class InvalidTypeError < Error
+      attr_reader :project_type
+      def initialize(message, project_type:)
+        @project_type = project_type
+        super(message)
+      end
     end
 
-    def self.rails?(project_directory:)
-      rails_binstub_path = File.join(project_directory, "bin/rails")
-      File.exist?(rails_binstub_path)
-    end
+    def self.detect(project_directory:)
+      require "yaml" # takes 20ms, so deferred as late as possible.
 
-    def self.php?(project_directory:)
-      bootstrap_app_path = File.join(project_directory, "bootstrap/app.php")
-      File.exist?(bootstrap_app_path)
+      shopify_cli_yml_path = File.join(project_directory, Constants::Files::SHOPIFY_CLI_YML)
+      unless File.exist?(shopify_cli_yml_path)
+        raise MissingShopifyCLIYamlError,
+          "#{Constants::Files::SHOPIFY_CLI_YML} was not found in directory #{project_directory}"
+      end
+      shopify_cli = YAML.load_file(shopify_cli_yml_path)
+      case shopify_cli["project_type"]&.to_sym
+      when :node, :rails, :php
+        shopify_cli["project_type"].to_sym
+      when nil
+        raise TypeNotFoundError, "Couldn't detect the project type in directory: #{project_directory}"
+      else
+        raise InvalidTypeError.new("The project found '' is not supported",
+          project_type: shopify_cli["project_type"])
+      end
     end
   end
 end

data/lib/shopify_cli/command/app_sub_command.rb

@@ -1,6 +1,16 @@
 module ShopifyCLI
   class Command
     class AppSubCommand < SubCommand
+      def detect_app(directory: Dir.pwd)
+        AppTypeDetector.detect(project_directory: directory)
+      rescue ShopifyCLI::AppTypeDetector::TypeNotFoundError
+        raise ShopifyCLI::Abort, @ctx.message("core.app.error.type_not_found", directory)
+      rescue ShopifyCLI::AppTypeDetector::MissingShopifyCLIYamlError
+        raise ShopifyCLI::Abort, @ctx.message("core.app.error.missing_shopify_cli_yml", directory)
+      rescue ShopifyCLI::AppTypeDetector::InvalidTypeError => error
+        raise ShopifyCLI::Abort, @ctx.message("core.app.error.invalid_project_type", error.project_type)
+      end
+
       class << self
         def call_help(*)
           output = help

data/lib/shopify_cli/command/project_command.rb

@@ -0,0 +1,31 @@
+module ShopifyCLI
+  class Command
+    class ProjectCommand < Command
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      class << self
+        def help
+          project_type = name.split("::")[0].downcase
+          ShopifyCLI::Context.message(
+            "#{project_type}.help",
+            ShopifyCLI::TOOL_NAME,
+            available_subcommands
+          )
+        end
+
+        private
+
+        def available_subcommands
+          subcommand_registry
+            .resolved_commands
+            .reject { |_name, command| command.hidden? }
+            .keys
+            .sort
+            .join(" | ")
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/command/sub_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module ShopifyCLI
+  class Command
+    class SubCommand < Command
+      class << self
+        def call(args, command_name, parent_command)
+          cmd = new(@ctx)
+          args = cmd.options.parse(@_options, args || [])
+          return call_help(parent_command, command_name) if cmd.options.help
+          run_prerequisites
+
+          cmd.call(args, command_name)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/command.rb

@@ -3,6 +3,10 @@ require "shopify_cli"
 
 module ShopifyCLI
   class Command < CLI::Kit::BaseCommand
+    autoload :SubCommand,     "shopify_cli/command/sub_command"
+    autoload :AppSubCommand,  "shopify_cli/command/app_sub_command"
+    autoload :ProjectCommand, "shopify_cli/command/project_command"
+
     extend Feature::Set
 
     attr_writer :ctx
@@ -11,12 +15,13 @@ module ShopifyCLI
     class << self
       attr_writer :ctx, :task_registry
 
-      def call(args, command_name)
+      def call(args, command_name, *)
         subcommand, resolved_name = subcommand_registry.lookup_command(args.first)
         if subcommand
           subcommand.ctx = @ctx
           subcommand.task_registry = @task_registry
-          subcommand.call(args, resolved_name, command_name)
+
+          subcommand.call(args.drop(1), resolved_name, command_name)
         else
           cmd = new(@ctx)
           cmd.options.parse(@_options, args)

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

@@ -0,0 +1,22 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Connect < ShopifyCLI::Command::AppSubCommand
+        def call(_args, _command_name, *)
+          app_type = detect_app(directory: Dir.pwd)
+          project = ShopifyCLI::Project.current
+
+          Services::App::ConnectService.call(
+            app_type: app_type,
+            project: project,
+            context: @ctx
+          )
+        end
+
+        def self.help
+          ShopifyCLI::Context.message("core.app.connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Create
+        class Node < ShopifyCLI::Command::AppSubCommand
+          prerequisite_task :ensure_authenticated
+
+          options do |parser, flags|
+            parser.on("--name=NAME") { |t| flags[:name] = t }
+            parser.on("--organization-id=ID") { |id| flags[:organization_id] = id }
+            parser.on("--store-domain=MYSHOPIFYDOMAIN") { |url| flags[:store_domain] = url }
+            parser.on("--type=APPTYPE") { |type| flags[:type] = type }
+            parser.on("--verbose") { flags[:verbose] = true }
+          end
+
+          def call(*)
+            Services::App::Create::NodeService.call(
+              name: options.flags[:name],
+              organization_id: options.flags[:organization_id],
+              store_domain: options.flags[:store_domain],
+              type: options.flags[:type],
+              verbose: !options.flags[:verbose].nil?,
+              context: @ctx
+            )
+          end
+
+          class << self
+            def help
+              ShopifyCLI::Context.message("core.app.create.node.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Create
+        class PHP < ShopifyCLI::Command::AppSubCommand
+          prerequisite_task :ensure_authenticated
+
+          options do |parser, flags|
+            parser.on("--name=NAME") { |name| flags[:name] = name }
+            parser.on("--organization-id=ID") { |organization_id| flags[:organization_id] = organization_id }
+            parser.on("--store-domain=MYSHOPIFYDOMAIN") { |url| flags[:store_domain] = url }
+            parser.on("--type=APPTYPE") { |type| flags[:type] = type }
+            parser.on("--verbose") { flags[:verbose] = true }
+          end
+
+          def call(*)
+            Services::App::Create::PHPService.call(
+              name: options.flags[:name],
+              organization_id: options.flags[:organization_id],
+              store_domain: options.flags[:store_domain],
+              type: options.flags[:type],
+              verbose: !options.flags[:verbose].nil?,
+              context: @ctx
+            )
+          end
+
+          class << self
+            def help
+              ShopifyCLI::Context.message("core.app.create.php.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Create
+        class Rails < ShopifyCLI::Command::AppSubCommand
+          prerequisite_task :ensure_authenticated
+
+          options do |parser, flags|
+            parser.on("--name=NAME") { |t| flags[:name] = t }
+            parser.on("--organization-id=ID") { |id| flags[:organization_id] = id }
+            parser.on("--store-domain=MYSHOPIFYDOMAIN") { |url| flags[:store_domain] = url }
+            parser.on("--type=APPTYPE") { |type| flags[:type] = type }
+            parser.on("--db=DB") { |db| flags[:db] = db }
+            parser.on("--rails-opts=RAILSOPTS") { |opts| flags[:rails_opts] = opts }
+          end
+
+          def call(*)
+            Services::App::Create::RailsService.call(
+              name: options.flags[:name],
+              organization_id: options.flags[:organization_id],
+              store_domain: options.flags[:store_domain],
+              type: options.flags[:type],
+              db: options.flags[:db],
+              rails_opts: options.flags[:rails_opts],
+              context: @ctx
+            )
+          end
+
+          class << self
+            def help
+              ShopifyCLI::Context.message("core.app.create.rails.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Create < ShopifyCLI::Command
+        subcommand :Rails, "rails", "shopify_cli/commands/app/create/rails"
+        subcommand :PHP, "php", "shopify_cli/commands/app/create/php"
+        subcommand :Node, "node", "shopify_cli/commands/app/create/node"
+
+        def call(_args, _command_name)
+          @ctx.puts(self.class.help)
+        end
+
+        def self.help
+          ShopifyCLI::Context.message("core.app.create.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        end
+
+        def self.call_help(*)
+          output = help
+          if respond_to?(:extended_help)
+            output += "\n"
+            output += extended_help
+          end
+          @ctx.puts(output)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Deploy < ShopifyCLI::Command::AppSubCommand
+        subcommand :Heroku, "heroku", "shopify_cli/commands/app/deploy/heroku"
+
+        def call(args, _name)
+          platform = args.shift
+          case platform
+          when "heroku"
+            case detect_app
+            when :rails
+              Services::App::Deploy::Heroku::RailsService.call(
+                context: @ctx
+              )
+            when :php
+              Services::App::Deploy::Heroku::PHPService.call(
+                context: @ctx
+              )
+            when :node
+              Services::App::Deploy::Heroku::NodeService.call(
+                context: @ctx
+              )
+            end
+          when nil
+            raise ShopifyCLI::Abort, @ctx.message(
+              "core.app.deploy.error.missing_platform",
+              ShopifyCLI::TOOL_NAME
+            )
+          else
+            raise ShopifyCLI::Abort, @ctx.message(
+              "core.app.deploy.error.invalid_platform",
+              platform,
+              ShopifyCLI::TOOL_NAME
+            )
+          end
+        end
+
+        def self.help
+          ShopifyCLI::Context.message("core.app.deploy.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        end
+
+        def self.extended_help
+          ShopifyCLI::Context.message("core.app.deploy.extended_help", ShopifyCLI::TOOL_NAME)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Open < ShopifyCLI::Command::AppSubCommand
+        def call(*)
+          project = ShopifyCLI::Project.current
+          Services::App::OpenService.call(
+            project: project,
+            context: @ctx
+          )
+        end
+
+        def self.help
+          ShopifyCLI::Context.message("core.app.open.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Serve < ShopifyCLI::Command::AppSubCommand
+        include ShopifyCLI::CommandOptions::CommandServeOptions
+
+        prerequisite_task :ensure_env, :ensure_dev_store
+
+        options do |parser, flags|
+          parser.on("--host=HOST") do |h|
+            flags[:host] = h.gsub('"', "")
+          end
+          parser.on("--port=PORT") { |port| flags[:port] = port }
+        end
+
+        def call(*)
+          case detect_app
+          when :rails
+            Services::App::Serve::RailsService.call(
+              host: host,
+              port: port,
+              context: @ctx
+            )
+          when :node
+            Services::App::Serve::NodeService.call(
+              host: host,
+              port: port,
+              context: @ctx
+            )
+          when :php
+            Services::App::Serve::PHPService.call(
+              host: host,
+              port: port,
+              context: @ctx
+            )
+          end
+        end
+
+        def self.help
+          ShopifyCLI::Context.message("core.app.serve.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        end
+
+        def self.extended_help
+          ShopifyCLI::Context.message("app.core.serve.extended_help")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require "project_types/node/cli"
+
+module ShopifyCLI
+  module Commands
+    class App
+      class Tunnel < ShopifyCLI::Command::AppSubCommand
+        def call(args, _name)
+          subcommand = args.shift
+          case subcommand
+          when "auth"
+            token = args.shift
+            if token.nil?
+              raise ShopifyCLI::Abort, @ctx.message("core.app.tunnel.error.token_argument_missing")
+            else
+              Services::App::Tunnel::AuthService.call(
+                token: token,
+                context: @ctx
+              )
+            end
+          when "start"
+            Services::App::Tunnel::StartService.call(
+              context: @ctx
+            )
+          when "stop"
+            Services::App::Tunnel::StopService.call(
+              context: @ctx
+            )
+          else
+            @ctx.puts(self.class.help)
+          end
+        end
+
+        def self.help
+          ShopifyCLI::Context.message("core.app.tunnel.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        end
+
+        def self.extended_help
+          ShopifyCLI::Context.message("core.app.tunnel.extended_help", ShopifyCLI::TOOL_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/commands/app.rb

@@ -0,0 +1,29 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class App < ShopifyCLI::Command
+      subcommand :Connect, "connect", "shopify_cli/commands/app/connect"
+      subcommand :Create, "create", "shopify_cli/commands/app/create"
+      subcommand :Deploy, "deploy", "shopify_cli/commands/app/deploy"
+      subcommand :Open, "open", "shopify_cli/commands/app/open"
+      subcommand :Serve, "serve", "shopify_cli/commands/app/serve"
+      subcommand :Tunnel, "tunnel", "shopify_cli/commands/app/tunnel"
+
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      class << self
+        def help
+          subcommands = subcommand_registry.command_names.join(" | ")
+          ShopifyCLI::Context.message("core.app.help", ShopifyCLI::TOOL_NAME, subcommands)
+        end
+
+        def call_help(*)
+          @ctx.puts(help)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/commands/config.rb

@@ -16,7 +16,7 @@ module ShopifyCLI
         ShopifyCLI::Context.message("core.config.help", ShopifyCLI::TOOL_NAME)
       end
 
-      class Feature < ShopifyCLI::SubCommand
+      class Feature < ShopifyCLI::Command::SubCommand
         def self.help
           ShopifyCLI::Context.message("core.config.feature.help", ShopifyCLI::TOOL_NAME)
         end
@@ -45,7 +45,7 @@ module ShopifyCLI
         end
       end
 
-      class Analytics < ShopifyCLI::SubCommand
+      class Analytics < ShopifyCLI::Command::SubCommand
         def self.help
           ShopifyCLI::Context.message("core.config.analytics.help", ShopifyCLI::TOOL_NAME)
         end