shopify-cli 2.6.1 → 2.6.5

data/lib/shopify_cli/constants.rb

@@ -15,10 +15,10 @@ module ShopifyCLI
 
     module Config
       module Sections
-        module ErrorTracking
-          NAME = "error-tracking"
+        module Analytics
+          NAME = "analytics"
           module Fields
-            AUTOMATIC_REPORTING = "automatic-reporting"
+            ENABLED = "enabled"
           end
         end
       end
@@ -39,7 +39,11 @@ module ShopifyCLI
 
       # Environments
       TEST = "SHOPIFY_CLI_TEST"
+      ACCEPTANCE_TEST = "SHOPIFY_CLI_ACCEPTANCE_TEST"
       DEVELOPMENT = "SHOPIFY_CLI_DEVELOPMENT"
+
+      # Monorail
+      MONORAIL_REAL_EVENTS = "MONORAIL_REAL_EVENTS"
     end
 
     module Identity

data/lib/shopify_cli/core/monorail.rb

@@ -16,9 +16,6 @@ module ShopifyCLI
         attr_accessor :metadata
 
         def log(name, args, &block) # rubocop:disable Lint/UnusedMethodArgument
-          prompt_for_consent
-          return yield unless enabled? && consented?
-
           command, command_name = Commands::Registry.lookup_command(name)
           final_command = [command_name]
           if command
@@ -28,13 +25,18 @@ module ShopifyCLI
 
           start_time = now_in_milliseconds
           err = nil
+
           begin
             yield
           rescue Exception => e # rubocop:disable Lint/RescueException
             err = e
             raise
           ensure
-            send_event(start_time, final_command, args - final_command, err&.message)
+            # If there's an error, we don't prompt from here and we let the exception
+            # reporter do that.
+            if report?(prompt: err.nil?)
+              send_event(start_time, final_command, args - final_command, err&.message)
+            end
           end
         end
 
@@ -44,22 +46,9 @@ module ShopifyCLI
           (Time.now.utc.to_f * 1000).to_i
         end
 
-        # we only want to send Monorail events in production or when explicitly developing
-        def enabled?
-          (Context.new.system? || ENV["MONORAIL_REAL_EVENTS"] == "1") && !Context.new.ci?
-        end
-
-        def consented?
-          ShopifyCLI::Config.get_bool("analytics", "enabled")
-        end
-
-        def prompt_for_consent
-          return if Context.new.ci?
-          return unless enabled?
-          return if ShopifyCLI::Config.get_section("analytics").key?("enabled")
-          msg = Context.message("core.monorail.consent_prompt")
-          opt = CLI::UI::Prompt.confirm(msg)
-          ShopifyCLI::Config.set("analytics", "enabled", opt)
+        def report?(prompt:)
+          return true if Environment.send_monorail_events?
+          ReportingConfigurationController.check_or_prompt_report_automatically(source: :usage, prompt: prompt)
         end
 
         def send_event(start_time, commands, args, err = nil)

data/lib/shopify_cli/environment.rb

@@ -26,7 +26,7 @@ module ShopifyCLI
       env_variable_truthy?(
         Constants::EnvironmentVariables::STACKTRACE,
         env_variables: env_variables
-      )
+      ) || development?(env_variables: env_variables)
     end
 
     def self.test?(env_variables: ENV)
@@ -36,6 +36,13 @@ module ShopifyCLI
       )
     end
 
+    def self.acceptance_test?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::ACCEPTANCE_TEST,
+        env_variables: env_variables
+      )
+    end
+
     def self.print_backtrace?(env_variables: ENV)
       env_variable_truthy?(
         Constants::EnvironmentVariables::BACKTRACE,
@@ -72,6 +79,13 @@ module ShopifyCLI
       "#{spin_workspace}.#{spin_namespace}.#{spin_host}"
     end
 
+    def self.send_monorail_events?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::MONORAIL_REAL_EVENTS,
+        env_variables: env_variables
+      )
+    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

@@ -1,20 +1,23 @@
 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.development?
+        context.puts(context.message("core.error_reporting.unhandled_error.message"))
+        context.puts(context.message("core.error_reporting.unhandled_error.issue_message"))
+      end
+
+      # Stack trace hint
       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?
+      return unless report?(context: context)
 
       ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = "1"
       require "bugsnag"
@@ -30,23 +33,31 @@ module ShopifyCLI
 
       metadata = {}
       metadata.merge!(custom_metadata)
-      # Bugsnag.notify(error, 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?
+    def self.report?(context:)
+      return true if ReportingConfigurationController.reporting_prompted? &&
+        ReportingConfigurationController.check_or_prompt_report_automatically(source: :uncaught_error)
 
-      report_error = ExceptionReporter::PermissionController.report_error?
+      report_error = report_error?(context: context)
 
-      unless ExceptionReporter::PermissionController.automatic_reporting_prompted?
-        ExceptionReporter::PermissionController.can_report_automatically?
+      unless ReportingConfigurationController.reporting_prompted?
+        ReportingConfigurationController.check_or_prompt_report_automatically(source: :uncaught_error)
       end
 
       report_error
     end
 
+    def self.report_error?(context:)
+      return false if Environment.development?
+
+      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.reportable_error?(error)
       is_abort = error.is_a?(ShopifyCLI::Abort) || error.is_a?(ShopifyCLI::AbortSilent)
       !is_abort

data/lib/shopify_cli/messages/messages.rb

@@ -14,6 +14,18 @@ module ShopifyCLI
         },
       },
       core: {
+        app: {
+          serve: {
+            error: {
+              invalid_port: "%s is not a valid port.",
+              host_must_be_https: "HOST must be a HTTPS url.",
+            },
+          },
+          help: <<~HELP,
+          Create and manage embedded apps
+            Usage: {{command:%s app [ rails | node | php ] }}
+          HELP
+        },
         error_reporting: {
           unhandled_error: {
             message: "{{x}} {{red:An unexpected error occured.}}",
@@ -21,16 +33,25 @@ module ShopifyCLI
               " 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",
+            question: "Send an anonymized error report to Shopify?",
+            yes: "Yes, send",
+            no: "No, don't send",
+          },
+        },
+        analytics: {
+          enable_prompt: {
+            uncaught_error: {
+              question: "Automatically send reports from now on?",
+              yes: "Yes, automatically send anonymized reports to Shopify",
+              no: "No, don't send",
+            },
+            usage: {
+              question: "Automatically send anonymized usage and error reports to Shopify? We use these"\
+                " to make development on Shopify better.",
+              yes: "Yes, automatically send anonymized reports to Shopify",
+              no: "No, don't send",
+            },
           },
         },
         connect: {
@@ -168,15 +189,6 @@ module ShopifyCLI
           disabled_as_shopify_org: "Can't switch development stores logged in as {{green:Shopify partners org}}",
           success: "Switched development store to {{green:%s}}",
         },
-
-        monorail: {
-          consent_prompt: <<~MSG,
-            Would you like to enable anonymous usage reporting?
-            If you select “Yes”, we’ll collect data about which commands you use and which errors you encounter.
-            Sharing this anonymous data helps Shopify improve this tool.
-          MSG
-        },
-
         identity_auth: {
           error: {
             timeout: "Timed out while waiting for response from Shopify",
@@ -493,7 +505,24 @@ module ShopifyCLI
 
           MESSAGE
         },
-
+        reporting: {
+          help: <<~HELP,
+            Turns anonymous reporting on or off.
+              Usage: {{command:%s reporting on}}
+          HELP
+          invalid_argument: <<~MESSAGE,
+            {{command:%s reporting %s}} is not supported. The valid values are {{command:on}} or {{command:off}}
+          MESSAGE
+          missing_argument: <<~MESSAGE,
+            {{command:%s reporting}} expects an argument {{command:on}} or {{command:off}}
+          MESSAGE
+          turned_on_message: <<~MESSAGE,
+            Anonymized reports will be sent to Shopify.
+          MESSAGE
+          turned_off_message: <<~MESSAGE,
+            Turn on automatic reporting later wtih {{command:%s reporting on}}.
+          MESSAGE
+        },
         whoami: {
           help: <<~HELP,
             Identifies which partner organization or store you are currently logged into.

data/lib/shopify_cli/migrator/migration.rb

@@ -14,7 +14,7 @@ module ShopifyCLI
 
       def run
         require(path)
-        ShopifyCli::Migrator::Migrations.const_get(class_name).run
+        ShopifyCLI::Migrator::Migrations.const_get(class_name).run
       rescue StandardError
         # Continue
       end

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

@@ -3,7 +3,7 @@
 module ShopifyCLI
   module Migrator
     module Migrations
-      class Base
+      class Noop
         def self.run
           # This is a noop migration to be used as a reference
         end

data/lib/shopify_cli/migrator/migrations/1633691650_merge_reporting_configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Migrator
+    module Migrations
+      # Before this migration, users configured automatic usage and error
+      # reporting independenty. We changed it to be a single configuration
+      # in the environment's configuration and therefore we need a migration
+      # to merge the configurations.
+      class MergeReportingConfiguration
+        def self.run
+          analytics_enabled = ShopifyCLI::Config.get_bool(
+            Constants::Config::Sections::Analytics::NAME,
+            Constants::Config::Sections::Analytics::Fields::ENABLED,
+            default: false
+          )
+          error_reporting_enabled = ShopifyCLI::Config.get_bool(
+            "error-tracking",
+            "automatic-reporting",
+            default: false
+          )
+          # Because we are merging configuration options, both need
+          # to be true to for the new flag to be true. Otherwise,
+          # we delete them and let the CLI prompt the user again.
+          should_merge_be_true = analytics_enabled && error_reporting_enabled
+
+          unless should_merge_be_true
+            ShopifyCLI::Config.unset(
+              Constants::Config::Sections::Analytics::NAME,
+              Constants::Config::Sections::Analytics::Fields::ENABLED
+            )
+            ShopifyCLI::Config.unset(
+              "error-tracking",
+              "automatic-reporting"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/reporting_configuration_controller.rb

@@ -0,0 +1,64 @@
+module ShopifyCLI
+  module ReportingConfigurationController
+    def self.enable_reporting(enabled)
+      ShopifyCLI::Config.set(
+        Constants::Config::Sections::Analytics::NAME,
+        Constants::Config::Sections::Analytics::Fields::ENABLED,
+        enabled
+      )
+    end
+
+    def self.reporting_prompted?
+      ShopifyCLI::Config.get_section(Constants::Config::Sections::Analytics::NAME).key?(
+        Constants::Config::Sections::Analytics::Fields::ENABLED
+      )
+    end
+
+    def self.reporting_enabled?
+      ShopifyCLI::Config.get_bool(
+        Constants::Config::Sections::Analytics::NAME,
+        Constants::Config::Sections::Analytics::Fields::ENABLED,
+        default: false
+      )
+    end
+
+    def self.check_or_prompt_report_automatically(source: :usage, prompt: true, context: ShopifyCLI::Context.new)
+      return false if ShopifyCLI::Environment.development? || ShopifyCLI::Environment.test?
+
+      # If the terminal is not interactive we can't prompt the user.
+      return false unless ShopifyCLI::Environment.interactive?
+
+      if reporting_prompted?
+        reporting_enabled?
+      elsif prompt
+        prompt_user(context: context, source: source)
+      else
+        false
+      end
+    end
+
+    def self.prompt_user(context:, source:)
+      enable_automatic_tracking = CLI::UI::Prompt.ask(
+        context.message("core.analytics.enable_prompt.#{source}.question")
+      ) do |handler|
+        handler.option(context.message("core.analytics.enable_prompt.#{source}.yes")) { |_| true }
+        handler.option(context.message("core.analytics.enable_prompt.#{source}.no")) { |_| false }
+      end
+
+      ShopifyCLI::Config.set(
+        Constants::Config::Sections::Analytics::NAME,
+        Constants::Config::Sections::Analytics::Fields::ENABLED,
+        enable_automatic_tracking
+      )
+
+      message = if enable_automatic_tracking
+        context.message("core.reporting.turned_on_message")
+      else
+        context.message("core.reporting.turned_off_message", ShopifyCLI::TOOL_NAME)
+      end
+      context.puts(message)
+
+      enable_automatic_tracking
+    end
+  end
+end

data/lib/shopify_cli/services/base_service.rb

@@ -0,0 +1,13 @@
+module ShopifyCLI
+  module Services
+    class BaseService
+      def self.call(*args, **kwargs, &block)
+        new(*args, **kwargs).call(&block)
+      end
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/shopify_cli/services/reporting_service.rb

@@ -0,0 +1,16 @@
+module ShopifyCLI
+  module Services
+    class ReportingService < BaseService
+      attr_reader :enable
+
+      def initialize(enable:)
+        @enable = enable
+        super()
+      end
+
+      def call
+        ReportingConfigurationController.enable_reporting(enable)
+      end
+    end
+  end
+end

data/lib/shopify_cli/services.rb

@@ -0,0 +1,6 @@
+module ShopifyCLI
+  module Services
+    autoload :BaseService, "shopify_cli/services/base_service"
+    autoload :ReportingService, "shopify_cli/services/reporting_service"
+  end
+end

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

@@ -9,12 +9,12 @@ module ShopifyCLI
       class Watcher
         include Observable
 
-        def initialize(ctx, theme:, syncer:, ignore_filter: nil)
+        def initialize(ctx, theme:, syncer:, ignore_filter: nil, poll: false)
           @ctx = ctx
           @theme = theme
           @syncer = syncer
           @ignore_filter = ignore_filter
-          @listener = Listen.to(@theme.root) do |modified, added, removed|
+          @listener = Listen.to(@theme.root, force_polling: poll) do |modified, added, removed|
             changed
             notify_observers(modified, added, removed)
           end

data/lib/shopify_cli/theme/dev_server.rb

@@ -20,12 +20,12 @@ module ShopifyCLI
       class << self
         attr_accessor :ctx
 
-        def start(ctx, root, port: 9292)
+        def start(ctx, root, port: 9292, poll: false)
           @ctx = ctx
           theme = DevelopmentTheme.new(ctx, root: root)
           ignore_filter = IgnoreFilter.from_path(root)
           @syncer = Syncer.new(ctx, theme: theme, ignore_filter: ignore_filter)
-          watcher = Watcher.new(ctx, theme: theme, syncer: @syncer, ignore_filter: ignore_filter)
+          watcher = Watcher.new(ctx, theme: theme, syncer: @syncer, ignore_filter: ignore_filter, poll: poll)
 
           # Setup the middleware stack. Mimics Rack::Builder / config.ru, but in reverse order
           @app = Proxy.new(ctx, theme: theme, syncer: @syncer)

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.6.1"
+  VERSION = "2.6.5"
 end

data/lib/shopify_cli.rb

@@ -96,11 +96,13 @@ module ShopifyCLI
     )
   end
 
+  autoload :AppTypeDetector, "shopify_cli/app_type_detector"
   autoload :Constants, "shopify_cli/constants"
   autoload :Environment, "shopify_cli/environment"
   autoload :AdminAPI, "shopify_cli/admin_api"
   autoload :API, "shopify_cli/api"
   autoload :Command, "shopify_cli/command"
+  autoload :CommandOptions, "shopify_cli/command_options"
   autoload :Commands, "shopify_cli/commands"
   autoload :Connect, "shopify_cli/connect"
   autoload :Context, "shopify_cli/context"
@@ -123,9 +125,11 @@ module ShopifyCLI
   autoload :Project, "shopify_cli/project"
   autoload :ProjectCommands, "shopify_cli/project_commands"
   autoload :ProjectType, "shopify_cli/project_type"
+  autoload :ReportingConfigurationController, "shopify_cli/reporting_configuration_controller"
   autoload :ResolveConstant, "shopify_cli/resolve_constant"
   autoload :Resources, "shopify_cli/resources"
   autoload :Result, "shopify_cli/result"
+  autoload :Services, "shopify_cli/services"
   autoload :Shopifolk, "shopify_cli/shopifolk"
   autoload :SubCommand, "shopify_cli/sub_command"
   autoload :Task, "shopify_cli/task"

data/shopify-cli.gemspec

@@ -45,12 +45,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency("bugsnag", "~> 6.22")
   spec.add_dependency("listen", "~> 3.7.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")
+  spec.add_dependency("theme-check", "~> 1.7.2")
 end

data/utilities/docker/container.rb

@@ -0,0 +1,76 @@
+require "open3"
+
+module Utilities
+  module Docker
+    class Container
+      SHOPIFY_BIN_PATH = "/usr/src/app/bin/shopify"
+
+      Error = Class.new(StandardError)
+
+      attr_reader :id, :env, :cwd, :xdg_config_home, :xdg_cache_home
+
+      def initialize(id:, env:, cwd:)
+        @id = id
+        @cwd = cwd
+        @xdg_config_home = File.join(cwd, ".config")
+        @xdg_cache_home = File.join(cwd, ".cache")
+        @env = env.merge({
+          "XDG_CONFIG_HOME" => @xdg_config_home,
+          "XDG_CACHE_HOME" => @xdg_cache_home,
+        })
+      end
+
+      def remove
+        _, stderr, stat = Open3.capture3(
+          "docker", "rm", "-f", @id
+        )
+        raise Error, stderr unless stat.success?
+      end
+
+      def capture_shopify(*args)
+        capture(*([SHOPIFY_BIN_PATH] + args))
+      end
+
+      def capture(*args, relative_dir: nil)
+        command = ["docker", "exec"]
+        cwd = if relative_dir.nil?
+          @cwd
+        else
+          File.join(@cwd, relative_dir)
+        end
+        command += ["-w", cwd]
+        @env.each do |env_name, env_value|
+          command += ["--env", "#{env_name}=#{env_value}"]
+        end
+        command << @id
+        command += args
+
+        out, err, stat = Open3.capture3(*command)
+        raise Error, err unless stat.success?
+        out
+      end
+
+      def exec_shopify(*args, relative_dir: nil)
+        exec(*([SHOPIFY_BIN_PATH] + args), relative_dir: relative_dir)
+      end
+
+      def exec(*args, relative_dir: nil)
+        command = ["docker", "exec"]
+        cwd = if relative_dir.nil?
+          @cwd
+        else
+          File.join(@cwd, relative_dir)
+        end
+        command += ["-w", cwd]
+        @env.each do |env_name, env_value|
+          command += ["--env", "#{env_name}=#{env_value}"]
+        end
+        command << @id
+        command += args
+
+        out, stat = Open3.capture2e(*command)
+        raise Error, out unless stat.success?
+      end
+    end
+  end
+end