shopify-cli 2.6.5 → 2.7.2

data/lib/shopify_cli/theme/syncer.rb

@@ -2,24 +2,31 @@
 require "thread"
 require "json"
 require "base64"
+require "forwardable"
+
+require_relative "syncer/error_reporter"
+require_relative "syncer/standard_reporter"
+require_relative "syncer/operation"
 
 module ShopifyCLI
   module Theme
     class Syncer
-      class Operation < Struct.new(:method, :file)
-        def to_s
-          "#{method} #{file&.relative_path}"
-        end
-      end
+      extend Forwardable
+
       API_VERSION = "unstable"
 
       attr_reader :checksums
       attr_accessor :ignore_filter
 
+      def_delegators :@error_reporter, :has_any_error?
+
       def initialize(ctx, theme:, ignore_filter: nil)
         @ctx = ctx
         @theme = theme
         @ignore_filter = ignore_filter
+        @error_reporter = ErrorReporter.new(ctx)
+        @standard_reporter = StandardReporter.new(ctx)
+        @reporters = [@error_reporter, @standard_reporter]
 
         # Queue of `Operation`s waiting to be picked up from a thread for processing.
         @queue = Queue.new
@@ -30,12 +37,19 @@ module ShopifyCLI
         # Mutex used to pause all threads when backing-off when hitting API rate limits
         @backoff_mutex = Mutex.new
 
-        # Allows delaying log of errors, mainly to not break the progress bar.
-        @delay_errors = false
-        @delayed_errors = []
-
         # Latest theme assets checksums. Updated on each upload.
         @checksums = {}
+
+        # Checksums of assets with errors. 
+        @error_checksums = []
+      end
+
+      def lock_io!
+        @reporters.each { |reporter| reporter.disable! }
+      end
+
+      def unlock_io!
+        @reporters.each { |reporter| reporter.enable! }
       end
 
       def enqueue_updates(files)
@@ -103,25 +117,14 @@ module ShopifyCLI
               break if operation.nil? # shutdown was called
               perform(operation)
             rescue Exception => e
-              report_error(
-                "{{red:ERROR}} {{blue:#{operation}}}: #{e}" +
-                (@ctx.debug? ? "\n\t#{e.backtrace.join("\n\t")}" : "")
-              )
+              error_suffix = ": #{e}"
+              error_suffix += + "\n\t#{e.backtrace.join("\n\t")}" if @ctx.debug?
+              report_error(operation, error_suffix)
             end
           end
         end
       end
 
-      def delay_errors!
-        @delay_errors = true
-      end
-
-      def report_errors!
-        @delay_errors = false
-        @delayed_errors.each { |error| report_error(error) }
-        @delayed_errors.clear
-      end
-
       def upload_theme!(delay_low_priority_files: false, delete: true, &block)
         fetch_checksums!
 
@@ -177,21 +180,27 @@ module ShopifyCLI
 
       private
 
+      def report_error(operation, error_suffix = "")
+        @error_checksums << @checksums[operation.file_path]
+        @error_reporter.report("#{operation.as_error_message}#{error_suffix}")
+      end
+
       def enqueue(method, file)
         raise ArgumentError, "file required" unless file
 
-        operation = Operation.new(method, @theme[file])
+        operation = Operation.new(@ctx, method, @theme[file])
 
         # Already enqueued
         return if @pending.include?(operation)
 
-        if @ignore_filter&.ignore?(operation.file.relative_path)
-          @ctx.debug("ignore #{operation.file.relative_path}")
+        if @ignore_filter&.ignore?(operation.file_path)
+          @ctx.debug("ignore #{operation.file_path}")
           return
         end
 
         if [:update, :get].include?(method) && operation.file.exist? && !file_has_changed?(operation.file)
-          @ctx.debug("skip #{operation}")
+          is_fixed = !!@error_checksums.delete(operation.file.checksum)
+          @standard_reporter.report(operation.as_fix_message) if is_fixed
           return
         end
 
@@ -206,16 +215,16 @@ module ShopifyCLI
 
         response = send(operation.method, operation.file)
 
+        @standard_reporter.report(operation.as_synced_message)
+
         # Check if the API told us we're near the rate limit
         if !backingoff? && (limit = response["x-shopify-shop-api-call-limit"])
           used, total = limit.split("/").map(&:to_i)
           backoff_if_near_limit!(used, total)
         end
       rescue ShopifyCLI::API::APIRequestError => e
-        report_error(
-          "{{red:ERROR}} {{blue:#{operation}}}:\n  " +
-          parse_api_errors(e).join("\n  ")
-        )
+        error_suffix = ":\n  " + parse_api_errors(e).join("\n  ")
+        report_error(operation, error_suffix)
       ensure
         @pending.delete(operation)
       end
@@ -295,14 +304,6 @@ module ShopifyCLI
         file.checksum != @checksums[file.relative_path.to_s]
       end
 
-      def report_error(error)
-        if @delay_errors
-          @delayed_errors << error
-        else
-          @ctx.puts(error)
-        end
-      end
-
       def parse_api_errors(exception)
         parsed_body = JSON.parse(exception&.response&.body)
         message = parsed_body.dig("errors", "asset") || parsed_body["message"] || exception.message

data/lib/shopify_cli/theme/theme.rb

@@ -162,26 +162,38 @@ module ShopifyCLI
         }
       end
 
-      def self.all(ctx, root: nil)
-        _status, body = AdminAPI.rest_request(
-          ctx,
-          shop: AdminAPI.get_shop_or_abort(ctx),
-          path: "themes.json",
-          api_version: "unstable",
-        )
+      class << self
+        def all(ctx, root: nil)
+          _status, body = fetch_themes(ctx)
+
+          body["themes"]
+            .sort_by { |theme_attrs| Time.parse(theme_attrs["updated_at"]) }
+            .reverse
+            .map { |theme_attrs| new(ctx, root: root, **allowed_attrs(theme_attrs)) }
+        end
+
+        def live(ctx, root: nil)
+          _status, body = fetch_themes(ctx)
 
-        body["themes"]
-          .sort_by { |attributes| Time.parse(attributes["updated_at"]) }
-          .reverse
-          .map do |attributes|
-            new(
-              ctx,
-              root: root,
-              id: attributes["id"],
-              name: attributes["name"],
-              role: attributes["role"],
-            )
-          end
+          body["themes"]
+            .find { |theme_attrs| theme_attrs["role"] == "main" }
+            .tap { |theme_attrs| break new(ctx, root: root, **allowed_attrs(theme_attrs)) }
+        end
+
+        private
+
+        def allowed_attrs(attrs)
+          attrs.slice("id", "name", "role").transform_keys(&:to_sym)
+        end
+
+        def fetch_themes(ctx)
+          AdminAPI.rest_request(
+            ctx,
+            shop: AdminAPI.get_shop_or_abort(ctx),
+            path: "themes.json",
+            api_version: "unstable",
+          )
+        end
       end
 
       private

data/lib/shopify_cli/tunnel.rb

@@ -12,7 +12,7 @@ module ShopifyCLI
   class Tunnel
     extend SingleForwardable
 
-    def_delegators :new, :start, :stop, :auth, :stats, :urls, :running_on?
+    def_delegators :new, :start, :stop, :auth, :authenticated?, :stats, :urls, :running_on?
 
     class FetchUrlError < RuntimeError; end
     class NgrokError < RuntimeError; end
@@ -65,16 +65,12 @@ module ShopifyCLI
     #
     def start(ctx, port: PORT)
       install(ctx)
-      url, account, seconds_remaining = start_ngrok(ctx, port)
-      if account
+      if authenticated?
+        url, account = start_ngrok(ctx, port)
         ctx.puts(ctx.message("core.tunnel.start_with_account", url, account))
       else
-        if seconds_remaining <= 0
-          ctx.puts(ctx.message("core.tunnel.timed_out"))
-          url, _account, seconds_remaining = restart_ngrok(ctx, port)
-        end
+        url, _ = restart_ngrok(ctx, port)
         ctx.puts(ctx.message("core.tunnel.start", url))
-        ctx.puts(ctx.message("core.tunnel.will_timeout", seconds_to_hm(seconds_remaining)))
         ctx.puts(ctx.message("core.tunnel.signup_suggestion", ShopifyCLI::TOOL_NAME))
       end
       url
@@ -91,7 +87,16 @@ module ShopifyCLI
     #
     def auth(ctx, token)
       install(ctx)
-      ctx.system(File.join(ShopifyCLI.cache_dir, "ngrok"), "authtoken", token)
+      ctx.system(ngrok_path(ctx), "authtoken", token)
+    end
+
+    ##
+    # returns a boolean: if the user has a ngrok token to authenticate
+    #
+    def authenticated?
+      ngrok_config_path = File.join(Dir.home, ".ngrok2/ngrok.yml")
+      return false unless File.exist?(ngrok_config_path)
+      File.read(ngrok_config_path).include?("authtoken")
     end
 
     ##
@@ -145,7 +150,7 @@ module ShopifyCLI
 
     def install(ctx)
       ngrok = "ngrok#{ctx.executable_file_extension}"
-      return if File.exist?(File.join(ShopifyCLI.cache_dir, ngrok))
+      return if File.exist?(ngrok_path(ctx))
       check_prereq_command(ctx, "curl")
       check_prereq_command(ctx, ctx.linux? ? "unzip" : "tar")
       spinner = CLI::UI::SpinGroup.new
@@ -165,7 +170,7 @@ module ShopifyCLI
       spinner.wait
 
       # final check to see if ngrok is accessible
-      unless File.exist?(File.join(ShopifyCLI.cache_dir, ngrok))
+      unless File.exist?(ngrok_path(ctx))
         ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCLI.cache_dir))
       end
     end
@@ -177,8 +182,9 @@ module ShopifyCLI
       raise e.class, e.message
     end
 
-    def ngrok_command(port)
-      "\"#{File.join(ShopifyCLI.cache_dir, "ngrok")}\" http -inspect=false -log=stdout -log-level=debug #{port}"
+    def ngrok_path(ctx)
+      ngrok = "ngrok#{ctx.executable_file_extension}"
+      File.join(ShopifyCLI.cache_dir, ngrok)
     end
 
     def seconds_to_hm(seconds)
@@ -186,16 +192,14 @@ module ShopifyCLI
     end
 
     def start_ngrok(ctx, port)
-      process = ShopifyCLI::ProcessSupervision.start(:ngrok, ngrok_command(port))
+      ngrok_command = "\"#{ngrok_path(ctx)}\" http -inspect=false -log=stdout -log-level=debug #{port}"
+      process = ShopifyCLI::ProcessSupervision.start(:ngrok, ngrok_command)
       log = fetch_url(ctx, process.log_path)
-      seconds_remaining = (process.time.to_i + log.timeout) - Time.now.to_i
-      [log.url, log.account, seconds_remaining]
+      [log.url, log.account]
     end
 
     def restart_ngrok(ctx, port)
-      unless ShopifyCLI::ProcessSupervision.stop(:ngrok)
-        ctx.abort(ctx.message("core.tunnel.error.stop"))
-      end
+      ShopifyCLI::ProcessSupervision.stop(:ngrok)
       start_ngrok(ctx, port)
     end
 
@@ -208,7 +212,7 @@ module ShopifyCLI
     class LogParser # :nodoc:
       TIMEOUT = 10
 
-      attr_reader :url, :account, :timeout
+      attr_reader :url, :account
 
       def initialize(log_path)
         @log_path = log_path
@@ -237,9 +241,8 @@ module ShopifyCLI
       end
 
       def parse_account
-        account, timeout, _ = @log.match(/AccountName:(.*)\s+SessionDuration:([\d]+) PlanName/)&.captures
+        account, _ = @log.match(/AccountName:(.*)\s+SessionDuration/)&.captures
         @account = account&.empty? ? nil : account
-        @timeout = timeout&.empty? ? 0 : timeout.to_i
       end
 
       def error

data/lib/shopify_cli/version.rb

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

data/lib/shopify_cli.rb

@@ -111,6 +111,7 @@ module ShopifyCLI
   autoload :Feature, "shopify_cli/feature"
   autoload :Form, "shopify_cli/form"
   autoload :Git, "shopify_cli/git"
+  autoload :GitHub, "shopify_cli/github"
   autoload :Helpers, "shopify_cli/helpers"
   autoload :Heroku, "shopify_cli/heroku"
   autoload :IdentityAuth, "shopify_cli/identity_auth"
@@ -123,7 +124,6 @@ module ShopifyCLI
   autoload :PartnersAPI, "shopify_cli/partners_api"
   autoload :ProcessSupervision, "shopify_cli/process_supervision"
   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"
@@ -131,7 +131,6 @@ module ShopifyCLI
   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"
   autoload :Tasks, "shopify_cli/tasks"
   autoload :TransformDataStructure, "shopify_cli/transform_data_structure"

data/shopify-cli.gemspec

@@ -33,11 +33,7 @@ Gem::Specification.new do |spec|
   end
   spec.bindir = "bin"
   spec.require_paths = ["lib", "vendor"]
-  spec.extensions = ["ext/shopify-cli/extconf.rb"]
-  # Do NOT include `shopify` as a listed executable via `spec.executables`.
-  # `ext/shopify-cli/extconf.rb` will dynamically create a script and soft-link
-  # `/usr/local/bin/shopify` to that script, in order to "lock" the Ruby used to
-  # a single Ruby (useful for debugging in multi-Ruby environments)
+  spec.executables << "shopify"
 
   spec.add_development_dependency("bundler", "~> 2.2.2")
   spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
@@ -45,5 +41,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency("bugsnag", "~> 6.22")
   spec.add_dependency("listen", "~> 3.7.0")
-  spec.add_dependency("theme-check", "~> 1.7.2")
+  spec.add_dependency("theme-check", "~> 1.8.0")
 end

data/shopify-dev

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require_relative "./bin/load_shopify"
+
+exit(proc do
+  begin
+    ShopifyCLI::ErrorHandler.call do
+      ShopifyCLI::Core::EntryPoint.call(ARGV.dup)
+    end
+  rescue StandardError => error
+    ShopifyCLI::ErrorHandler.exception = error
+    if ShopifyCLI::Environment.print_stacktrace?
+      raise error
+    else
+      1
+    end
+  end
+end.call)

data/utilities/constants.rb

@@ -0,0 +1,7 @@
+module Utilities
+  module Constants
+    module Paths
+      ROOT = File.expand_path("..", __dir__)
+    end
+  end
+end

data/utilities/docker/container.rb

@@ -1,8 +1,10 @@
 require "open3"
+require "colorize"
 
 module Utilities
   module Docker
     class Container
+      SHOPIFY_PATH = "/usr/src/app"
       SHOPIFY_BIN_PATH = "/usr/src/app/bin/shopify"
 
       Error = Class.new(StandardError)
@@ -55,6 +57,10 @@ module Utilities
       end
 
       def exec(*args, relative_dir: nil)
+        if ARGV.include?("--verbose")
+          running_prefix = "Running command: #{args.join(" ")}"
+          STDOUT.puts(running_prefix.colorize(:yellow).bold)
+        end
         command = ["docker", "exec"]
         cwd = if relative_dir.nil?
           @cwd
@@ -68,8 +74,30 @@ module Utilities
         command << @id
         command += args
 
-        out, stat = Open3.capture2e(*command)
-        raise Error, out unless stat.success?
+        docker_prefix = "Docker (#{args.first}):"
+
+        if ARGV.include?("--verbose")
+          stat = Open3.popen3(*command) do |stdin, stdout, stderr, wait_thread|
+            Thread.new do
+              stdout.each { |l| STDOUT.puts("#{docker_prefix.colorize(:cyan).bold} #{l}") } unless stdout&.nil?
+            end
+            Thread.new do
+              stderr.each { |l| STDERR.puts("#{docker_prefix.colorize(:red).bold} #{l}") } unless stderr&.nil?
+            end
+            stdin.close
+
+            status = wait_thread.value
+
+            stdout.close
+            stderr.close
+
+            status
+          end
+          raise StandardError, "The command #{args.first} failed" unless stat.success?
+        else
+          out, stat = Open3.capture2e(*command)
+          raise Error, out unless stat.success?
+        end
       end
     end
   end

data/utilities/docker.rb

@@ -57,8 +57,9 @@ module Utilities
 
       def build_image_if_needed
         unless image_exists?(image_tag)
+          puts "Rebuilding the Docker image..."
           _, err, stat = Open3.capture3(
-            "docker", "build", root_dir, "-t", image_tag
+            "docker", "build", "-t", image_tag, "-f", File.join(root_dir, "Tests.dockerfile"), root_dir
           )
           raise Error, err unless stat.success?
         end
@@ -66,7 +67,7 @@ module Utilities
 
       def image_tag
         gemfile_lock_path = File.expand_path("./Gemfile.lock", root_dir)
-        dockerfile_path = File.expand_path("./Dockerfile", root_dir)
+        dockerfile_path = File.expand_path("./Tests.dockerfile", root_dir)
         fingerprintable_strings = [
           File.read(gemfile_lock_path),
           File.read(dockerfile_path),

data/utilities/utilities.rb

@@ -2,4 +2,5 @@ $LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
 module Utilities
   autoload :Docker, "docker"
+  autoload :Constants, "constants"
 end

data/vendor/deps/cli-kit/lib/cli/kit/system.rb

@@ -222,7 +222,7 @@ module CLI
         end
 
         def which(cmd, env)
-          exts = os == :windows ? env.fetch('PATHEXT').split(';') : ['']
+          exts = os == :windows ? env.fetch('PATHEXT', ['']).split(';') : ['']
           env.fetch('PATH', '').split(File::PATH_SEPARATOR).each do |path|
             exts.each do |ext|
               exe = File.join(path, "#{cmd}#{ext}")