shopify-cli 2.5.0 → 2.6.0

data/lib/shopify_cli/constants.rb

@@ -1,26 +1,54 @@
 module ShopifyCLI
   module Constants
+    module Paths
+      ROOT = File.expand_path("../..", __dir__)
+    end
+
+    module StoreKeys
+      LAST_MIGRATION_DATE = :last_migration_date
+      ANALYTICS_ENABLED = :analytics_enabled
+    end
+
+    module Bugsnag
+      API_KEY = "773b0c801eb40c20d8928be5b7c739bd"
+    end
+
+    module Config
+      module Sections
+        module ErrorTracking
+          NAME = "error-tracking"
+          module Fields
+            AUTOMATIC_REPORTING = "automatic-reporting"
+          end
+        end
+      end
+    end
+
     module EnvironmentVariables
+      STACKTRACE = "SHOPIFY_CLI_STACKTRACE"
+
       # When true the CLI points to a local instance of
       # the partners dashboard and identity.
       LOCAL_PARTNERS = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
 
       # When true the CLI points to a spin instance of spin
       SPIN_PARTNERS = "SHOPIFY_APP_CLI_SPIN_PARTNERS"
-
       SPIN_WORKSPACE = "SPIN_WORKSPACE"
-
       SPIN_NAMESPACE = "SPIN_NAMESPACE"
-
       SPIN_HOST = "SPIN_HOST"
 
-      # Set to true when running tests.
-      RUNNING_TESTS = "RUNNING_SHOPIFY_CLI_TESTS"
+      # Environments
+      TEST = "SHOPIFY_CLI_TEST"
+      DEVELOPMENT = "SHOPIFY_CLI_DEVELOPMENT"
     end
 
     module Identity
       CLIENT_ID_DEV = "e5380e02-312a-7408-5718-e07017e9cf52"
       CLIENT_ID = "fbdb2649-e327-4907-8f67-908d24cfd7e3"
     end
+
+    module Links
+      NEW_ISSUE = "https://github.com/Shopify/shopify-cli/issues/new"
+    end
   end
 end

data/lib/shopify_cli/core/executor.rb

@@ -12,7 +12,11 @@ module ShopifyCLI
       def call(command, command_name, args)
         command.task_registry = @task_registry
         command.ctx = @ctx
-        super
+        with_traps do
+          with_logging do |_id|
+            command.call(args, command_name)
+          end
+        end
       end
     end
   end

data/lib/shopify_cli/environment.rb

@@ -3,6 +3,18 @@ module ShopifyCLI
   # the environment in which the CLI runs
   module Environment
     TRUTHY_ENV_VARIABLE_VALUES = ["1", "true", "TRUE", "yes", "YES"]
+
+    def self.development?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::DEVELOPMENT,
+        env_variables: env_variables
+      )
+    end
+
+    def self.interactive?
+      ShopifyCLI::Context.new.tty?
+    end
+
     def self.use_local_partners_instance?(env_variables: ENV)
       env_variable_truthy?(
         Constants::EnvironmentVariables::LOCAL_PARTNERS,
@@ -10,16 +22,30 @@ module ShopifyCLI
       )
     end
 
-    def self.use_spin_partners_instance?(env_variables: ENV)
+    def self.print_stacktrace?(env_variables: ENV)
       env_variable_truthy?(
-        Constants::EnvironmentVariables::SPIN_PARTNERS,
+        Constants::EnvironmentVariables::STACKTRACE,
+        env_variables: env_variables
+      )
+    end
+
+    def self.test?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::TEST,
+        env_variables: env_variables
+      )
+    end
+
+    def self.print_backtrace?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::BACKTRACE,
         env_variables: env_variables
       )
     end
 
-    def self.running_tests?(env_variables: ENV)
+    def self.use_spin_partners_instance?(env_variables: ENV)
       env_variable_truthy?(
-        Constants::EnvironmentVariables::RUNNING_TESTS,
+        Constants::EnvironmentVariables::SPIN_PARTNERS,
         env_variables: env_variables
       )
     end
@@ -34,6 +60,11 @@ module ShopifyCLI
       end
     end
 
+    def self.use_spin?(env_variables: ENV)
+      !env_variables[Constants::EnvironmentVariables::SPIN_WORKSPACE].nil? &&
+        !env_variables[Constants::EnvironmentVariables::SPIN_NAMESPACE].nil?
+    end
+
     def self.spin_url(env_variables: ENV)
       spin_workspace = spin_workspace(env_variables: env_variables)
       spin_namespace = spin_namespace(env_variables: env_variables)

data/lib/shopify_cli/exception_reporter/permission_controller.rb

@@ -0,0 +1,54 @@
+module ShopifyCLI
+  module ExceptionReporter
+    module PermissionController
+      def self.report_error?(context: ShopifyCLI::Context.new)
+        CLI::UI::Prompt.ask(context.message("core.error_reporting.report_error.question")) do |handler|
+          handler.option(context.message("core.error_reporting.report_error.yes")) { |_| true }
+          handler.option(context.message("core.error_reporting.report_error.no")) { |_| false }
+        end
+      end
+
+      def self.automatic_reporting_prompted?
+        ShopifyCLI::Config.get_section(Constants::Config::Sections::ErrorTracking::NAME).key?(
+          Constants::Config::Sections::ErrorTracking::Fields::AUTOMATIC_REPORTING
+        )
+      end
+
+      def self.can_report_automatically?(context: ShopifyCLI::Context.new)
+        # If the terminal is not interactive we can't prompt the user.
+        return false unless ShopifyCLI::Environment.interactive?
+
+        if automatic_reporting_prompted?
+          automatic_reporting_enabled?
+        else
+          prompt_user(context: context)
+        end
+      end
+
+      def self.prompt_user(context:)
+        enable_automatic_tracking = CLI::UI::Prompt.ask(
+          context.message("core.error_reporting.enable_automatic_reporting_prompt.question")
+        ) do |handler|
+          handler.option(context.message("core.error_reporting.enable_automatic_reporting_prompt.yes")) { |_| true }
+          handler.option(context.message("core.error_reporting.enable_automatic_reporting_prompt.no")) { |_| false }
+        end
+
+        ShopifyCLI::Config.set(
+          Constants::Config::Sections::ErrorTracking::NAME,
+          Constants::Config::Sections::ErrorTracking::Fields::AUTOMATIC_REPORTING,
+          enable_automatic_tracking
+        )
+
+        enable_automatic_tracking
+      end
+
+      def self.automatic_reporting_enabled?
+        ShopifyCLI::Config.get_bool(
+          Constants::Config::Sections::ErrorTracking::NAME,
+          Constants::Config::Sections::ErrorTracking::Fields::AUTOMATIC_REPORTING,
+          default: false
+        )
+      end
+    end
+  end
+end

data/lib/shopify_cli/exception_reporter.rb

@@ -0,0 +1,55 @@
+module ShopifyCLI
+  module ExceptionReporter
+    autoload :PermissionController, "shopify_cli/exception_reporter/permission_controller"
+
+    def self.report(error, _logs = nil, _api_key = nil, custom_metadata = {})
+      context = ShopifyCLI::Context.new
+      context.puts("\n")
+      context.puts(context.message("core.error_reporting.unhandled_error.message"))
+      context.puts(context.message("core.error_reporting.unhandled_error.issue_message"))
+      unless ShopifyCLI::Environment.print_stacktrace?
+        context.puts(context.message("core.error_reporting.unhandled_error.stacktrace_message",
+          "#{ShopifyCLI::Constants::EnvironmentVariables::STACKTRACE}=1"))
+      end
+      context.puts("\n")
+
+      return unless reportable_error?(error)
+      return unless report?
+
+      ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = "1"
+      require "bugsnag"
+
+      Bugsnag.configure do |config|
+        config.logger.level = ::Logger::ERROR
+        config.api_key = ShopifyCLI::Constants::Bugsnag::API_KEY
+        config.app_type = "shopify"
+        config.project_root = File.expand_path("../../..", __FILE__)
+        config.app_version = ShopifyCLI::VERSION
+        config.auto_capture_sessions = false
+      end
+
+      metadata = {}
+      metadata.merge!(custom_metadata)
+      # Bugsnag.notify(error, metadata)
+    end
+
+    def self.report?
+      # return false if ShopifyCLI::Environment.development?
+      return true if ExceptionReporter::PermissionController.automatic_reporting_prompted? &&
+        ExceptionReporter::PermissionController.can_report_automatically?
+
+      report_error = ExceptionReporter::PermissionController.report_error?
+
+      unless ExceptionReporter::PermissionController.automatic_reporting_prompted?
+        ExceptionReporter::PermissionController.can_report_automatically?
+      end
+
+      report_error
+    end
+
+    def self.reportable_error?(error)
+      is_abort = error.is_a?(ShopifyCLI::Abort) || error.is_a?(ShopifyCLI::AbortSilent)
+      !is_abort
+    end
+  end
+end

data/lib/shopify_cli/git.rb

@@ -105,6 +105,36 @@ module ShopifyCLI
         end
       end
 
+      def sparse_checkout(repo, set, branch, ctx)
+        _, status = ctx.capture2e("git init")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.repo_not_initiated"))
+        end
+
+        _, status = ctx.capture2e("git remote add -f origin #{repo}")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.remote_not_added"))
+        end
+
+        _, status = ctx.capture2e("git config core.sparsecheckout true")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.sparse_checkout_not_enabled"))
+        end
+
+        _, status = ctx.capture2e("git sparse-checkout set #{set}")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.sparse_checkout_not_set"))
+        end
+
+        resp, status = ctx.capture2e("git pull origin #{branch}")
+        unless status.success?
+          if resp.include?("fatal: couldn't find remote ref")
+            ctx.abort(ctx.message("core.git.error.pull_failed_bad_branch", branch))
+          end
+          ctx.abort(ctx.message("core.git.error.pull_failed"))
+        end
+      end
+
       private
 
       def exec(*args, dir: Dir.pwd, default: nil, ctx: Context.new)

data/lib/shopify_cli/messages/messages.rb

@@ -14,6 +14,25 @@ module ShopifyCLI
         },
       },
       core: {
+        error_reporting: {
+          unhandled_error: {
+            message: "{{x}} {{red:An unexpected error occured.}}",
+            issue_message: "{{red:\tTo \e]8;;#{ShopifyCLI::Constants::Links::NEW_ISSUE}\e\\submit an issue\e]8;;\e\\"\
+              " include the stack trace.}}",
+            stacktrace_message: "{{red:\tTo print the stack trace, add the environment variable %s.}}",
+          },
+          enable_automatic_reporting_prompt: {
+            question: "Automatically send error reports moving forward?",
+            yes: "Automatically send error reports to the Shopify team",
+            no: "Don't send error reports",
+            enabled: "Anonymized error reports will be sent to Shopify.",
+          },
+          report_error: {
+            question: "Send an error report to Shopify?",
+            yes: "Send report",
+            no: "Don't send",
+          },
+        },
         connect: {
           already_connected_warning: "{{yellow:! This app appears to be already connected}}",
           project_type_select: "What type of project would you like to connect?",
@@ -67,10 +86,18 @@ module ShopifyCLI
             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.",
+            remote_not_added: "Remote could not be added.",
+            sparse_checkout_not_enabled: "Sparse checkout could not be enabled.",
+            sparse_checkout_not_set: "Sparse checkout set command failed.",
+            pull_failed: "Pull failed.",
+            pull_failed_bad_branch: "Pull failed. Branch %s cannot be found. Check the branch name and try again.",
           },
 
           cloning: "Cloning %s into %s…",
           cloned: "{{v}} Cloned into %s",
+          pulling_from_to: "Pulling %s into %s…",
+          pulling: "Pulling…",
+          pulled: "Pulled into %s",
         },
 
         help: {
@@ -429,7 +456,6 @@ module ShopifyCLI
             ngrok: "Something went wrong with ngrok installation,"\
               "please make sure %s exists within %s before trying again",
           },
-
           installing: "Installing ngrok…",
           not_running: "{{green:x}} ngrok tunnel not running",
           prereq_command_location: "%s @ %s",

data/lib/shopify_cli/method_object.rb

@@ -48,12 +48,14 @@ module ShopifyCLI
   #
   module MethodObject
     module AutoCreateResultObject
+      def self.ruby2_keywords(*); end unless respond_to?(:ruby2_keywords, true)
+
       ##
       # invokes the original `call` implementation and wraps its return value
       # into a result object.
       #
-      def call(*args, **kwargs, &block)
-        Result.wrap { kwargs.any? ? super(*args, **kwargs, &block) : super(*args, &block) }.call
+      ruby2_keywords def call(*args, &block)
+        Result.wrap { super(*args, &block) }.call
       end
     end
 
@@ -66,8 +68,13 @@ module ShopifyCLI
       #
       def call(*args, **kwargs, &block)
         properties.keys.yield_self do |properties|
-          new(**kwargs.slice(*properties))
-            .call(*args, **kwargs.slice(*(kwargs.keys - properties)), &block)
+          instance = new(**kwargs.slice(*properties))
+          kwargs = kwargs.slice(*(kwargs.keys - properties))
+          if kwargs.any?
+            instance.call(*args, **kwargs, &block)
+          else
+            instance.call(*args, &block)
+          end
         end
       end
 

data/lib/shopify_cli/migrator/migration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "date"
+
+module ShopifyCLI
+  module Migrator
+    class Migration
+      attr_reader :name, :path, :date
+
+      def initialize(name:, path:, date:)
+        @name = name
+        @path = path
+        @date = date
+      end
+
+      def run
+        require(path)
+        ShopifyCli::Migrator::Migrations.const_get(class_name).run
+      rescue StandardError
+        # Continue
+      end
+
+      def class_name
+        name.split("_").collect(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/shopify_cli/migrator/migrations/1631709766_noop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Migrator
+    module Migrations
+      class Base
+        def self.run
+          # This is a noop migration to be used as a reference
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/migrator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require "date"
+
+module ShopifyCLI
+  module Migrator
+    autoload :Migration, "shopify_cli/migrator/migration"
+
+    def self.migrate(
+      migrations_directory: File.expand_path("migrator/migrations", __dir__)
+    )
+      baseline_date = last_migration_date
+      unless baseline_date.nil?        
+        migrations = migrations(migrations_directory: migrations_directory)
+          .select { |m| 
+            m.date > baseline_date.to_i 
+          }
+          .each { |m| m.run }
+      end
+
+      store_last_migration_date
+    end
+
+    private
+
+    def self.store_last_migration_date
+      ShopifyCLI::DB.set(ShopifyCLI::Constants::StoreKeys::LAST_MIGRATION_DATE => Time.now.to_i)
+    end
+    
+    def self.last_migration_date
+      ShopifyCLI::DB.get(ShopifyCLI::Constants::StoreKeys::LAST_MIGRATION_DATE)
+    end
+
+    def self.migrations(migrations_directory:)
+      Dir.glob(File.join(migrations_directory, "*.rb")).map do |file_path|
+        file_name = File.basename(file_path).gsub(".rb", "")
+        file_name_components = file_name.split("_")
+        date_timestamp = file_name_components[0].to_i
+        migration_name = file_name_components[1...].join("_")
+
+        Migrator::Migration.new(
+          name: migration_name,
+          date: Time.at(date_timestamp).to_i,
+          path: file_path
+        )
+      end
+    end
+  end
+end

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

data/lib/shopify_cli.rb

@@ -25,6 +25,8 @@ require "cli/ui"
 require "cli/kit"
 require "smart_properties"
 require_relative "shopify_cli/version"
+require_relative "shopify_cli/migrator"
+require_relative "shopify_cli/exception_reporter"
 
 # Enable stdout routing. At this point all calls to STDOUT (and STDERR) will go through this class.
 # See https://github.com/Shopify/cli-ui/blob/main/lib/cli/ui/stdout_router.rb for more info
@@ -90,7 +92,7 @@ module ShopifyCLI
   autocall(:ErrorHandler) do
     CLI::Kit::ErrorHandler.new(
       log_file: ShopifyCLI.log_file,
-      exception_reporter: nil,
+      exception_reporter: ->() { ShopifyCLI::ExceptionReporter },
     )
   end
 
@@ -135,7 +137,7 @@ module ShopifyCLI
   Context.load_messages(ShopifyCLI::Messages::MESSAGES)
 
   def self.cache_dir
-    cache_dir = if Environment.running_tests?
+    cache_dir = if Environment.test?
       TEMP_DIR
     elsif ENV["LOCALAPPDATA"].nil?
       File.join(File.expand_path(ENV.fetch("XDG_CACHE_HOME", "~/.cache")), TOOL_NAME)
@@ -150,7 +152,7 @@ module ShopifyCLI
   end
 
   def self.tool_config_path
-    if Environment.running_tests?
+    if Environment.test?
       TEMP_DIR
     elsif ENV["APPDATA"].nil?
       File.join(File.expand_path(ENV.fetch("XDG_CONFIG_HOME", "~/.config")), TOOL_NAME)
@@ -171,4 +173,10 @@ module ShopifyCLI
     return @sha if defined?(@sha)
     @sha = Git.sha(dir: ShopifyCLI::ROOT)
   end
+
+  # Migrate runs migrations that migrate the state of the environment
+  # in which the CLI runs.
+  unless ShopifyCLI::Environment.test? || ShopifyCLI::Environment.development?
+    ShopifyCLI::Migrator.migrate
+  end
 end

data/shopify-cli.gemspec

@@ -43,6 +43,14 @@ Gem::Specification.new do |spec|
   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.4.0")
+
+  # Note: theme-check is _intentionally_ not specifying the third
+  # digit. We _want_ new features to make their way into new installs
+  # of the Shopify CLI. Otherwise updates need to be released twice.
+  #
+  # That is, DO USE ~> 1.X, DO NOT USE ~> 1.X.Y, this would unnecessarily
+  # fix the feature version.
+  spec.add_dependency("theme-check", "~> 1.7")
 end

data/utilities/docker.rb

@@ -0,0 +1,47 @@
+require "open3"
+
+module Utilities
+  module Docker
+    Error = Class.new(StandardError)
+
+    class << self
+      def run_and_rm_container(*args)
+        build_image_if_needed
+        system(
+          "docker", "run",
+          "-t", "--rm",
+          "--volume", "#{Shellwords.escape(root_dir)}:/usr/src/app",
+          image_tag,
+          *args
+        ) || abort
+      end
+
+      private
+
+      def root_dir
+        File.expand_path("..", __dir__)
+      end
+
+      def build_image_if_needed
+        unless image_exists?(image_tag)
+          system("docker", "build", root_dir, "-t", image_tag) || abort
+        end
+      end
+
+      def image_tag
+        gemfile_lock_path = File.expand_path("./Gemfile.lock", root_dir)
+        image_sha = Digest::SHA256.hexdigest(File.read(gemfile_lock_path))
+        "shopify-cli-#{image_sha}"
+      end
+
+      def image_exists?(tag)
+        _, stat = Open3.capture2(
+          "docker", "inspect",
+          "--type=image",
+          tag
+        )
+        stat.success?
+      end
+    end
+  end
+end

data/utilities/utilities.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
+
+module Utilities
+  autoload :Docker, "docker"
+end