shopify-cli 1.0.2 → 1.1.1

data/lib/shopify-cli/tasks/update_dashboard_urls.rb

@@ -28,16 +28,17 @@ module ShopifyCli
       end
 
       def construct_redirect_urls(urls, new_url, callback_url)
-        urls.map do |url|
+        new_urls = urls.map do |url|
           if (match = url.match(NGROK_REGEX))
             "#{new_url}#{match[2]}"
           else
             url
           end
         end
-        if urls.grep(/#{new_url}#{callback_url}/).empty?
-          urls.push("#{new_url}#{callback_url}")
+        if new_urls.grep(/#{new_url}#{callback_url}/).empty?
+          new_urls.push("#{new_url}#{callback_url}")
         end
+        new_urls.uniq
       end
     end
   end

data/lib/shopify-cli/tunnel.rb

@@ -21,6 +21,7 @@ module ShopifyCli
     DOWNLOAD_URLS = {
       mac: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-amd64.zip',
       linux: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip',
+      windows: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-windows-amd64.zip',
     }
 
     NGROK_TUNNELS_URI = URI.parse('http://localhost:4040/api/tunnels')
@@ -62,14 +63,19 @@ module ShopifyCli
     #
     def start(ctx, port: PORT)
       install(ctx)
-      process = ShopifyCli::ProcessSupervision.start(:ngrok, ngrok_command(port))
-      log = fetch_url(ctx, process.log_path)
-      if log.account
-        ctx.puts(ctx.message('core.tunnel.start_with_account', log.url, log.account))
+      url, account, seconds_remaining = start_ngrok(ctx, port)
+      if account
+        ctx.puts(ctx.message('core.tunnel.start_with_account', url, account))
       else
-        ctx.puts(ctx.message('core.tunnel.start', log.url))
+        if seconds_remaining <= 0
+          ctx.puts(ctx.message('core.tunnel.timed_out'))
+          url, _account, seconds_remaining = restart_ngrok(ctx, port)
+        end
+        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
-      log.url
+      url
     end
 
     ##
@@ -83,7 +89,7 @@ module ShopifyCli
     #
     def auth(ctx, token)
       install(ctx)
-      ctx.system(File.join(ShopifyCli::CACHE_DIR, 'ngrok'), 'authtoken', token)
+      ctx.system(File.join(ShopifyCli.cache_dir, 'ngrok'), 'authtoken', token)
     end
 
     ##
@@ -117,14 +123,21 @@ module ShopifyCli
     private
 
     def install(ctx)
-      return if File.exist?(File.join(ShopifyCli::CACHE_DIR, 'ngrok'))
+      return if File.exist?(File.join(ShopifyCli.cache_dir, ctx.windows? ? 'ngrok.exe' : 'ngrok'))
+      check_prereq_command(ctx, 'curl')
+      check_prereq_command(ctx, ctx.linux? ? 'unzip' : 'tar')
       spinner = CLI::UI::SpinGroup.new
       spinner.add('Installing ngrok...') do
-        zip_dest = File.join(ShopifyCli::CACHE_DIR, 'ngrok.zip')
+        zip_dest = File.join(ShopifyCli.cache_dir, 'ngrok.zip')
         unless File.exist?(zip_dest)
-          ctx.system('curl', '-o', zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli::CACHE_DIR)
+          ctx.system('curl', '-o', zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli.cache_dir)
+        end
+        args = if ctx.linux?
+          %W(unzip -u #{zip_dest})
+        else
+          %W(tar -xf #{zip_dest})
         end
-        ctx.system('unzip', '-u', zip_dest, chdir: ShopifyCli::CACHE_DIR)
+        ctx.system(*args, chdir: ShopifyCli.cache_dir)
         ctx.rm(zip_dest)
       end
       spinner.wait
@@ -138,13 +151,37 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "exec #{File.join(ShopifyCli::CACHE_DIR, 'ngrok')} http -log=stdout -log-level=debug #{port}"
+      "\"#{File.join(ShopifyCli.cache_dir, 'ngrok')}\" http -inspect=false -log=stdout -log-level=debug #{port}"
+    end
+
+    def seconds_to_hm(seconds)
+      format("%d hours %d minutes", seconds / 3600, seconds / 60 % 60)
+    end
+
+    def start_ngrok(ctx, port)
+      process = ShopifyCli::ProcessSupervision.start(:ngrok, ngrok_command(port))
+      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]
+    end
+
+    def restart_ngrok(ctx, port)
+      unless ShopifyCli::ProcessSupervision.stop(:ngrok)
+        ctx.abort(ctx.message('core.tunnel.error.stop'))
+      end
+      start_ngrok(ctx, port)
+    end
+
+    def check_prereq_command(ctx, command)
+      cmd_path = ctx.which(command)
+      ctx.abort(ctx.message('core.tunnel.error.prereq_command_required', command)) if cmd_path.nil?
+      ctx.done(ctx.message('core.tunnel.prereq_command_location', command, cmd_path))
     end
 
     class LogParser # :nodoc:
       TIMEOUT = 10
 
-      attr_reader :url, :account
+      attr_reader :url, :account, :timeout
 
       def initialize(log_path)
         @log_path = log_path
@@ -173,7 +210,9 @@ module ShopifyCli
       end
 
       def parse_account
-        @account, _ = @log.match(/AccountName:([\w\s]+) SessionDuration/)&.captures
+        account, timeout, _ = @log.match(/AccountName:([\w\s\d@._\-]*) SessionDuration:([\d]+) PlanName/)&.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 = '1.0.2'
+  VERSION = '1.1.1'
 end

data/lib/shopify_cli.rb

@@ -44,10 +44,6 @@ module ShopifyCli
   ROOT              = File.expand_path('../..', __FILE__)
   PROJECT_TYPES_DIR = File.join(ROOT, 'lib', 'project_types')
   TEMP_DIR          = File.join(ROOT, '.tmp')
-  CACHE_DIR         = File.join(File.expand_path(ENV.fetch('XDG_CACHE_HOME', '~/.cache')), TOOL_NAME)
-  TOOL_CONFIG_PATH  = File.join(File.expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config')), TOOL_NAME)
-  LOG_FILE          = File.join(TOOL_CONFIG_PATH, 'logs', 'log.log')
-  DEBUG_LOG_FILE    = File.join(TOOL_CONFIG_PATH, 'logs', 'debug.log')
 
   # programmer emoji if default install location, else wrench emoji
   EMOJI    = ROOT == '/opt/shopify' ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
@@ -82,7 +78,7 @@ module ShopifyCli
   # ShopifyCli::Config
   autocall(:Config)   { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
   # ShopifyCli::Logger
-  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: DEBUG_LOG_FILE) }
+  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCli.debug_log_file) }
   # ShopifyCli::Resolver
   autocall(:Resolver) do
     ShopifyCli::Core::HelpResolver.new(
@@ -93,7 +89,7 @@ module ShopifyCli
   # ShopifyCli::ErrorHandler
   autocall(:ErrorHandler) do
     CLI::Kit::ErrorHandler.new(
-      log_file: ShopifyCli::LOG_FILE,
+      log_file: ShopifyCli.log_file,
       exception_reporter: nil,
     )
   end
@@ -105,6 +101,7 @@ module ShopifyCli
   autoload :Context, 'shopify-cli/context'
   autoload :Core, 'shopify-cli/core'
   autoload :DB, 'shopify-cli/db'
+  autoload :Feature, 'shopify-cli/feature'
   autoload :Form, 'shopify-cli/form'
   autoload :Git, 'shopify-cli/git'
   autoload :Helpers, 'shopify-cli/helpers'
@@ -126,7 +123,37 @@ module ShopifyCli
 
   require 'shopify-cli/messages/messages'
   Context.load_messages(ShopifyCli::Messages::MESSAGES)
-end
 
-# Make sure the cache dir always exists
-FileUtils.mkdir_p(ShopifyCli::CACHE_DIR)
+  def self.cache_dir
+    cache_dir = if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+      TEMP_DIR
+    elsif ENV['LOCALAPPDATA'].nil?
+      File.join(File.expand_path(ENV.fetch('XDG_CACHE_HOME', '~/.cache')), TOOL_NAME)
+    else
+      File.join(File.expand_path(ENV['LOCALAPPDATA']), TOOL_NAME)
+    end
+
+    # Make sure the cache dir always exists
+    @cache_dir_exists ||= FileUtils.mkdir_p(cache_dir)
+
+    cache_dir
+  end
+
+  def self.tool_config_path
+    if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+      TEMP_DIR
+    elsif ENV['APPDATA'].nil?
+      File.join(File.expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config')), TOOL_NAME)
+    else
+      File.join(File.expand_path(ENV['APPDATA']), TOOL_NAME)
+    end
+  end
+
+  def self.log_file
+    File.join(tool_config_path, 'logs', 'log.log')
+  end
+
+  def self.debug_log_file
+    File.join(tool_config_path, 'logs', 'debug.log')
+  end
+end

data/shopify-cli.gemspec

@@ -26,7 +26,10 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|packaging)/}) }
+    %x(git ls-files -z).split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|packaging)/}) ||
+      f.match(%r{^bin/(update-deps|shopify.bat)$})
+    end
   end
   spec.bindir = "bin"
   spec.require_paths = ["lib", "vendor"]

data/vendor/deps/cli-kit/REVISION

@@ -1 +1 @@
-fc25a17dff9d3130bb705659c002282ef7827932
+1013aa5c5664e7034ca3f02fd2e0513361b07e95 (dirty)

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

@@ -51,7 +51,7 @@ module CLI
     #       1. rescue Abort or Bug
     #       2. Print a contextualized error message
     #       3. Re-raise AbortSilent or BugSilent respectively.
-    GenericAbort = Class.new(Exception)
+    GenericAbort = Class.new(Exception) # rubocop:disable Lint/InheritException
     Abort        = Class.new(GenericAbort)
     Bug          = Class.new(GenericAbort)
     BugSilent    = Class.new(GenericAbort)

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

@@ -11,8 +11,8 @@ module CLI
       def const_missing(const)
         block = begin
           @autocalls.fetch(const)
-        rescue KeyError
-          return super
+                rescue KeyError
+                  return super
         end
         const_set(const, block.call)
       end

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

@@ -22,11 +22,11 @@ module CLI
       end
 
       def handle_exception(error)
-        if notify_with = exception_for_submission(error)
+        if (notify_with = exception_for_submission(error))
           logs = begin
             File.read(@log_file)
-          rescue => e
-            "(#{e.class}: #{e.message})"
+                 rescue => e
+                   "(#{e.class}: #{e.message})"
           end
           exception_reporter.report(notify_with, logs)
         end
@@ -56,7 +56,7 @@ module CLI
             # if it was `exit 30`, translate the exit code to 1, and submit nothing.
             # 30 is used to signal normal failures that are not indicative of bugs.
             # However, users should see it presented as 1.
-            exit 1
+            exit(1)
           else
             # A weird termination status happened. `error.exception "message"` will maintain backtrace
             # but allow us to set a message
@@ -83,7 +83,7 @@ module CLI
 
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Interrupt
-        $stderr.puts(format_error_message("Interrupt"))
+        stderr_puts_message('Interrupt')
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Errno::ENOSPC
         message = if @tool_name
@@ -91,10 +91,16 @@ module CLI
         else
           "Your disk is full - free space is required to operate"
         end
-        $stderr.puts(format_error_message(message))
+        stderr_puts_message(message)
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       end
 
+      def stderr_puts_message(message)
+        $stderr.puts(format_error_message(message))
+      rescue Errno::EPIPE
+        nil
+      end
+
       def exception_reporter
         if @exception_reporter_or_proc.respond_to?(:report)
           @exception_reporter_or_proc

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

@@ -13,19 +13,17 @@ module CLI
       def call(command, command_name, args)
         with_traps do
           with_logging do |id|
+            command.call(args, command_name)
+          rescue => e
             begin
-              command.call(args, command_name)
-            rescue => e
-              begin
-                $stderr.puts "This command ran with ID: #{id}"
-                $stderr.puts "Please include this information in any issues/report along with relevant logs"
-              rescue SystemCallError
-                # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
-                # we can detect and log the original error, which may even be the source of this error.
-                nil
-              end
-              raise e
+              $stderr.puts "This command ran with ID: #{id}"
+              $stderr.puts "Please include this information in any issues/report along with relevant logs"
+            rescue SystemCallError
+              # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
+              # we can detect and log the original error, which may even be the source of this error.
+              nil
             end
+            raise e
           end
         end
       end

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

@@ -10,9 +10,10 @@ module CLI
       # Constructor for CLI::Kit::Logger
       #
       # @param debug_log_file [String] path to the file where debug logs should be stored
-      def initialize(debug_log_file:)
+      def initialize(debug_log_file:, env_debug_name: 'DEBUG')
         FileUtils.mkpath(File.dirname(debug_log_file))
         @debug_logger = ::Logger.new(debug_log_file, MAX_NUM_LOGS, MAX_LOG_SIZE)
+        @env_debug_name = env_debug_name
       end
 
       # Functionally equivalent to Logger#info
@@ -60,7 +61,7 @@ module CLI
       #
       # @param msg [String] the message to log
       def debug(msg)
-        $stdout.puts CLI::UI.fmt(msg) if ENV['DEBUG']
+        $stdout.puts CLI::UI.fmt(msg) if is_debug?
         @debug_logger.debug(format_debug(msg))
       end
 
@@ -71,6 +72,11 @@ module CLI
         return msg unless CLI::UI::StdoutRouter.current_id
         "[#{CLI::UI::StdoutRouter.current_id[:id]}] #{msg}"
       end
+
+      def is_debug?
+        val = ENV[@env_debug_name]
+        val && val != '0' && val != ''
+      end
     end
   end
 end

data/vendor/deps/cli-kit/lib/cli/kit/support/test_helper.rb

@@ -10,7 +10,7 @@ module CLI
         def assert_all_commands_run(should_raise: true)
           errors = CLI::Kit::System.error_message
           CLI::Kit::System.reset!
-          assert false, errors if should_raise && !errors.nil?
+          assert(false, errors) if should_raise && !errors.nil?
           errors
         end
 
@@ -196,22 +196,22 @@ module CLI
 
                   unless errors[:unexpected].empty?
                     final_error << CLI::UI.fmt(<<~EOF)
-                    {{bold:Unexpected command invocations:}}
-                    {{command:#{errors[:unexpected].join("\n")}}}
+                      {{bold:Unexpected command invocations:}}
+                      {{command:#{errors[:unexpected].join("\n")}}}
                     EOF
                   end
 
                   unless errors[:not_run].empty?
                     final_error << CLI::UI.fmt(<<~EOF)
-                    {{bold:Expected commands were not run:}}
-                    {{command:#{errors[:not_run].join("\n")}}}
+                      {{bold:Expected commands were not run:}}
+                      {{command:#{errors[:not_run].join("\n")}}}
                     EOF
                   end
 
                   unless errors[:other].empty?
                     final_error << CLI::UI.fmt(<<~EOF)
-                    {{bold:Commands were not run as expected:}}
-                    #{errors[:other].map { |cmd, msg| "{{command:#{cmd}}}\n#{msg}" }.join("\n\n")}
+                      {{bold:Commands were not run as expected:}}
+                      #{errors[:other].map { |cmd, msg| "{{command:#{cmd}}}\n#{msg}" }.join("\n\n")}
                     EOF
                   end
 

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

@@ -19,7 +19,7 @@ module CLI
         #
         def sudo_reason(msg)
           # See if sudo has a cached password
-          `env SUDO_ASKPASS=/usr/bin/false sudo -A true`
+          %x(env SUDO_ASKPASS=/usr/bin/false sudo -A true)
           return if $CHILD_STATUS.success?
           CLI::UI.with_frame_color(:blue) do
             puts(CLI::UI.fmt("{{i}} #{msg}"))
@@ -90,6 +90,18 @@ module CLI
           delegate_open3(*a, sudo: sudo, env: env, method: :capture3, **kwargs)
         end
 
+        def popen2(*a, sudo: false, env: ENV, **kwargs, &block)
+          delegate_open3(*a, sudo: sudo, env: env, method: :popen2, **kwargs, &block)
+        end
+
+        def popen2e(*a, sudo: false, env: ENV, **kwargs)
+          delegate_open3(*a, sudo: sudo, env: env, method: :popen2e, **kwargs, &block)
+        end
+
+        def popen3(*a, sudo: false, env: ENV, **kwargs)
+          delegate_open3(*a, sudo: sudo, env: env, method: :popen3, **kwargs, &block)
+        end
+
         # Execute a command in the user's environment
         # Outputs result of the command without capturing it
         #
@@ -130,13 +142,11 @@ module CLI
 
             readers, = IO.select(ios)
             readers.each do |io|
-              begin
-                data, trailing = split_partial_characters(io.readpartial(4096))
-                handlers[io].call(previous_trailing[io] + data)
-                previous_trailing[io] = trailing
-              rescue IOError
-                io.close
-              end
+              data, trailing = split_partial_characters(io.readpartial(4096))
+              handlers[io].call(previous_trailing[io] + data)
+              previous_trailing[io] = trailing
+            rescue IOError
+              io.close
             end
           end
 
@@ -163,6 +173,14 @@ module CLI
           [data.byteslice(0...partial_character_index), data.byteslice(partial_character_index..-1)]
         end
 
+        def os
+          return :mac if /darwin/.match(RUBY_PLATFORM)
+          return :linux if /linux/.match(RUBY_PLATFORM)
+          return :windows if /mingw32/.match(RUBY_PLATFORM)
+
+          raise "Could not determine OS from platform #{RUBY_PLATFORM}"
+        end
+
         private
 
         def apply_sudo(*a, sudo)
@@ -171,9 +189,9 @@ module CLI
           a
         end
 
-        def delegate_open3(*a, sudo: raise, env: raise, method: raise, **kwargs)
+        def delegate_open3(*a, sudo: raise, env: raise, method: raise, **kwargs, &block)
           a = apply_sudo(*a, sudo)
-          Open3.send(method, env, *resolve_path(a, env), **kwargs)
+          Open3.send(method, env, *resolve_path(a, env), **kwargs, &block)
         rescue Errno::EINTR
           raise(Errno::EINTR, "command interrupted: #{a.join(' ')}")
         end
@@ -189,17 +207,30 @@ module CLI
         # See https://github.com/Shopify/dev/pull/625 for more details.
         def resolve_path(a, env)
           # If only one argument was provided, make sure it's interpreted by a shell.
-          return ["true ; " + a[0]] if a.size == 1
+          if a.size == 1
+            if os == :windows
+              return ["break && " + a[0]]
+            else
+              return ["true ; " + a[0]]
+            end
+          end
           return a if a.first.include?('/')
 
-          paths = env.fetch('PATH', '').split(':')
-          item = paths.detect do |f|
-            command_path = "#{f}/#{a.first}"
-            File.executable?(command_path) && File.file?(command_path)
+          item = which(a.first, env)
+          a[0] = item if item
+          a
+        end
+
+        def which(cmd, env)
+          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}")
+              return exe if File.executable?(exe) && !File.directory?(exe)
+            end
           end
 
-          a[0] = "#{item}/#{a.first}" if item
-          a
+          nil
         end
       end
     end