shopify-cli 2.6.5 → 2.7.2

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

data/lib/shopify_cli/commands.rb

@@ -29,6 +29,7 @@ module ShopifyCLI
     register :System, "system", "shopify_cli/commands/system", true
     register :Version, "version", "shopify_cli/commands/version", true
     register :Whoami, "whoami", "shopify_cli/commands/whoami", true
+    register :App, "app", "shopify_cli/commands/app", true
 
     autoload :Connect, "shopify_cli/commands/connect"
   end

data/lib/shopify_cli/constants.rb

@@ -4,6 +4,10 @@ module ShopifyCLI
       ROOT = File.expand_path("../..", __dir__)
     end
 
+    module Files
+      SHOPIFY_CLI_YML = ".shopify-cli.yml"
+    end
+
     module StoreKeys
       LAST_MIGRATION_DATE = :last_migration_date
       ANALYTICS_ENABLED = :analytics_enabled
@@ -42,6 +46,9 @@ module ShopifyCLI
       ACCEPTANCE_TEST = "SHOPIFY_CLI_ACCEPTANCE_TEST"
       DEVELOPMENT = "SHOPIFY_CLI_DEVELOPMENT"
 
+      # Authentication
+      AUTH_TOKEN = "SHOPIFY_CLI_AUTH_TOKEN"
+
       # Monorail
       MONORAIL_REAL_EVENTS = "MONORAIL_REAL_EVENTS"
     end

data/lib/shopify_cli/context.rb

@@ -357,6 +357,15 @@ module ShopifyCLI
       Kernel.puts(CLI::UI.fmt(*args))
     end
 
+    # a wrapper around $stderr.puts to allow for easy formatting
+    #
+    # #### Parameters
+    # * `text` - a string message to output
+    #
+    def error(text)
+      $stderr.puts(CLI::UI.fmt(text))
+    end
+
     # a wrapper around Kernel.warn to allow for easy formatting
     #
     # #### Parameters

data/lib/shopify_cli/environment.rb

@@ -86,6 +86,10 @@ module ShopifyCLI
       )
     end
 
+    def self.auth_token(env_variables: ENV)
+      env_variables[Constants::EnvironmentVariables::AUTH_TOKEN]
+    end
+
     def self.env_variable_truthy?(variable_name, env_variables: ENV)
       TRUTHY_ENV_VARIABLE_VALUES.include?(env_variables[variable_name.to_s])
     end

data/lib/shopify_cli/exception_reporter.rb

@@ -2,10 +2,10 @@ module ShopifyCLI
   module ExceptionReporter
     def self.report(error, _logs = nil, _api_key = nil, custom_metadata = {})
       context = ShopifyCLI::Context.new
-
       unless ShopifyCLI::Environment.development?
         context.puts(context.message("core.error_reporting.unhandled_error.message"))
-        context.puts(context.message("core.error_reporting.unhandled_error.issue_message"))
+        context.puts(context.message("core.error_reporting.unhandled_error.issue_message",
+          ShopifyCLI::GitHub::IssueURLGenerator.error_url(error)))
       end
 
       # Stack trace hint
@@ -17,8 +17,8 @@ module ShopifyCLI
       context.puts("\n")
 
       return unless reportable_error?(error)
-      return unless report?(context: context)
 
+      return unless report?(context: context)
       ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = "1"
       require "bugsnag"
 
@@ -31,9 +31,12 @@ module ShopifyCLI
         config.auto_capture_sessions = false
       end
 
-      metadata = {}
+      metadata = { rubyPlatform: RUBY_PLATFORM }
       metadata.merge!(custom_metadata)
-      Bugsnag.notify(error, metadata)
+
+      Bugsnag.notify(error) do |event|
+        event.add_metadata(:device, metadata)
+      end
     end
 
     def self.report?(context:)
@@ -45,7 +48,6 @@ module ShopifyCLI
       unless ReportingConfigurationController.reporting_prompted?
         ReportingConfigurationController.check_or_prompt_report_automatically(source: :uncaught_error)
       end
-
       report_error
     end
 

data/lib/shopify_cli/git.rb

@@ -4,6 +4,12 @@ module ShopifyCLI
   # git.
   class Git
     class << self
+      # Check if Git is available in the environment
+      def available?(ctx)
+        _output, status = ctx.capture2e("git", "status")
+        status.success?
+      end
+
       ##
       # will return the current sha of the cli repo
       #
@@ -20,8 +26,13 @@ module ShopifyCLI
       #
       #   ShopifyCLI::Git.sha
       #
+      # Some environments don't have git in PATH and this prevents
+      # the execution from raising an error
+      # https://app.bugsnag.com/shopify/shopify-cli/errors/615dd36365ce57000889d4c5
       def sha(dir: Dir.pwd, ctx: Context.new)
-        rev_parse("HEAD", dir: dir, ctx: ctx)
+        if available?(ctx)
+          rev_parse("HEAD", dir: dir, ctx: ctx)
+        end
       end
 
       ##

data/lib/shopify_cli/github/issue_url_generator.rb

@@ -0,0 +1,19 @@
+module ShopifyCLI
+  module GitHub
+    module IssueURLGenerator
+      def self.error_url(error)
+        title = "#{error.class}: #{error.message}"
+        labels = "type:bug"
+        content = File.read(File.join(ShopifyCLI::ROOT, ".github/ISSUE_TEMPLATE.md"))
+
+        # take at most 5 lines from backtrace
+        stacktrace = error.backtrace.length < 5 ? error.backtrace : error.backtrace[0..4]
+        body = stacktrace.join("\n").to_s
+        output = content.gsub(/<!--Stacktrace(.|\n)*-->/, body)
+        query = URI.encode_www_form({ title: title, body: output, labels: labels })
+        url = "#{ShopifyCLI::Constants::Links::NEW_ISSUE}?#{query}"
+        url
+      end
+    end
+  end
+end

data/lib/shopify_cli/github.rb

@@ -0,0 +1,5 @@
+module ShopifyCLI
+  module GitHub
+    autoload :IssueURLGenerator, "shopify_cli/github/issue_url_generator"
+  end
+end

data/lib/shopify_cli/identity_auth.rb

@@ -68,6 +68,24 @@ module ShopifyCLI
       request_exchange_tokens
     end
 
+    def self.fetch_or_auth_partners_token(ctx:)
+      env_var_auth_token = Environment.auth_token
+      return env_var_auth_token if env_var_auth_token
+
+      ShopifyCLI::DB.get(:partners_exchange_token) do
+        IdentityAuth.new(ctx: ctx).authenticate
+        ShopifyCLI::DB.get(:partners_exchange_token)
+      end
+    end
+
+    def self.environment_auth_token?
+      !!Environment.auth_token
+    end
+
+    def self.authenticated?
+      environment_auth_token? || IDENTITY_ACCESS_TOKENS.all? { |key| ShopifyCLI::DB.exists?(key) }
+    end
+
     def reauthenticate
       return if refresh_exchange_tokens || refresh_access_tokens
       ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCLI::TOOL_NAME))