shopify-cli 2.6.3 → 2.7.0

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

@@ -88,10 +88,20 @@ module Theme
         serve: {
           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}}
+
+            Options:
+              {{command:--port=PORT}} Local port to serve theme preview from
+              {{command:--poll}}      Force polling to detect file changes
+              {{command:--host=HOST}} Set which network interface the web server listens on. The default value is 127.0.0.1.
           HELP
           serve: "Viewing theme…",
           open_fail: "Couldn't open the theme",
+          error: {
+            address_binding_error: "Couldn't bind to localhost."\
+              " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
+          },
         },
         check: {
           help: <<~HELP,

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

@@ -0,0 +1,36 @@
+require "json"
+
+module ShopifyCLI
+  class AppTypeDetector
+    Error = Class.new(StandardError)
+    MissingShopifyCLIYamlError = Class.new(Error)
+    TypeNotFoundError = Class.new(Error)
+    class InvalidTypeError < Error
+      attr_reader :project_type
+      def initialize(message, project_type:)
+        @project_type = project_type
+        super(message)
+      end
+    end
+
+    def self.detect(project_directory:)
+      require "yaml" # takes 20ms, so deferred as late as possible.
+
+      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,18 @@
+module ShopifyCLI
+  class Command
+    class ProjectCommand < Command
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      def self.help
+        project_type = name.split("::")[0].downcase
+        ShopifyCLI::Context.message(
+          "#{project_type}.help",
+          ShopifyCLI::TOOL_NAME,
+          subcommand_registry.command_names.join(" | ")
+        )
+      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)
@@ -27,7 +32,12 @@ module ShopifyCLI
       end
 
       def options(&block)
-        @_options = block
+        existing_options = @_options
+        # We prevent new options calls to override existing blocks by nesting them.
+        @_options = ->(parser, flags) {
+          existing_options&.call(parser, flags)
+          block.call(parser, flags)
+        }
       end
 
       def subcommand(const, cmd, path = nil)

data/lib/shopify_cli/command_options/command_serve_options.rb

@@ -0,0 +1,43 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module CommandOptions
+    module CommandServeOptions
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.class_eval do
+          def port
+            return ShopifyCLI::Tunnel::PORT.to_s unless options.flags.key?(:port)
+            port = options.flags[:port].to_i
+            @ctx.abort(@ctx.message("core.app.serve.error.invalid_port", options.flags[:port])) unless port > 0
+            port
+          end
+
+          def host
+            host = options.flags[:host]
+            unless host.nil?
+              @ctx.abort(@ctx.message("core.app.serve.error.host_must_be_https")) if host.match(/^https/i).nil?
+            end
+            host
+          end
+        end
+      end
+
+      module ClassMethods
+        def parse_host_option
+          options do |parser, flags|
+            parser.on("--host=HOST") do |h|
+              flags[:host] = h.gsub('"', "")
+            end
+          end
+        end
+
+        def parse_port_option
+          options do |parser, flags|
+            parser.on("--port=PORT") { |port| flags[:port] = port }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/command_options.rb

@@ -0,0 +1,7 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module CommandOptions
+    autoload :CommandServeOptions, "shopify_cli/command_options/command_serve_options"
+  end
+end

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,38 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Create
+        class Node < ShopifyCLI::Command::AppSubCommand
+          unless ShopifyCLI::Environment.acceptance_test?
+            prerequisite_task :ensure_authenticated
+          end
+
+          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,40 @@
+module ShopifyCLI
+  module Commands
+    class App
+      class Create
+        class Rails < ShopifyCLI::Command::AppSubCommand
+          unless ShopifyCLI::Environment.acceptance_test?
+            prerequisite_task :ensure_authenticated
+          end
+
+          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

data/lib/shopify_cli/commands/login.rb

@@ -15,7 +15,7 @@ module ShopifyCLI
 
       def call(*)
         shop = (options.flags[:shop] || @ctx.getenv("SHOPIFY_SHOP" || nil))
-        ShopifyCLI::DB.set(shop: self.class.validate_shop(shop)) unless shop.nil?
+        ShopifyCLI::DB.set(shop: self.class.validate_shop(shop, context: @ctx)) unless shop.nil?
 
         if shop.nil? && Shopifolk.check
           Shopifolk.reset
@@ -41,9 +41,9 @@ module ShopifyCLI
         ShopifyCLI::Context.message("core.login.help", ShopifyCLI::TOOL_NAME)
       end
 
-      def self.validate_shop(shop)
+      def self.validate_shop(shop, context:)
         permanent_domain = shop_to_permanent_domain(shop)
-        @ctx.abort(@ctx.message("core.login.invalid_shop", shop)) unless permanent_domain
+        context.abort(context.message("core.login.invalid_shop", shop)) unless permanent_domain
         permanent_domain
       end
 

data/lib/shopify_cli/commands/reporting.rb

@@ -0,0 +1,38 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Reporting < ShopifyCLI::Command
+      def call(args, _name)
+        enable_reporting = reporting_enabled?(args)
+        Services::ReportingService.call(enable: enable_reporting)
+
+        message = if enable_reporting
+          @ctx.message("core.reporting.turned_on_message")
+        else
+          @ctx.message("core.reporting.turned_off_message", ShopifyCLI::TOOL_NAME)
+        end
+        @ctx.puts(message)
+      end
+
+      def reporting_enabled?(args)
+        case args.first
+        when nil
+          @ctx.abort(@ctx.message("core.reporting.missing_argument", ShopifyCLI::TOOL_NAME))
+        when "on"
+          true
+        when "off"
+          false
+        else
+          @ctx.abort(
+            @ctx.message("core.reporting.invalid_argument", ShopifyCLI::TOOL_NAME, args.first)
+          )
+        end
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("core.reporting.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end