shopify-cli 1.0.5 → 1.3.0

data/lib/shopify-cli/process_supervision.rb

@@ -8,7 +8,7 @@ module ShopifyCli
     # a string or a symbol to identify this process by
     attr_reader :identifier
     # process ID for the running process
-    attr_reader :pid
+    attr_accessor :pid
     # starttime of the process
     attr_reader :time
     # filepath to the pidfile for this process
@@ -58,15 +58,37 @@ module ShopifyCli
       #
       def start(identifier, args)
         return for_ident(identifier) if running?(identifier)
-        fork do
-          pid_file = new(identifier, pid: Process.pid)
+
+        # Windows doesn't support forking process without extra gems, so we resort to spawning a new child process -
+        # that means that it dies along with the original process if it is interrupted. On UNIX, we fork the process so
+        # that it doesn't have to be restarted on every run.
+        if Context.new.windows?
+          pid_file = new(identifier)
+
+          # Make sure the file exists and is empty, otherwise Windows fails
+          File.open(pid_file.log_path, 'w') {}
+          pid = Process.spawn(
+            *args,
+            out: pid_file.log_path,
+            err: pid_file.log_path,
+            in: Context.new.windows? ? "nul" : "/dev/null",
+          )
+          pid_file.pid = pid
           pid_file.write
-          STDOUT.reopen(pid_file.log_path, "w")
-          STDERR.reopen(pid_file.log_path, "w")
-          STDIN.reopen("/dev/null", "r")
-          Process.setsid
-          exec(*args)
+
+          Process.detach(pid)
+        else
+          fork do
+            pid_file = new(identifier, pid: Process.pid)
+            pid_file.write
+            STDOUT.reopen(pid_file.log_path, "w")
+            STDERR.reopen(pid_file.log_path, "w")
+            STDIN.reopen("/dev/null", "r")
+            Process.setsid
+            exec(*args)
+          end
         end
+
         sleep(0.1)
         for_ident(identifier)
       end
@@ -106,10 +128,11 @@ module ShopifyCli
       end
     end
 
-    def initialize(identifier, pid:, time: Time.now.strftime('%s')) # :nodoc:
+    def initialize(identifier, pid: nil, time: Time.now.strftime('%s')) # :nodoc:
       @identifier = identifier
       @pid = pid
       @time = time
+      FileUtils.mkdir_p(ShopifyCli::ProcessSupervision.run_dir)
       @pid_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")
       @log_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.log")
     end
@@ -117,13 +140,17 @@ module ShopifyCli
     ##
     # will attempt to shutdown a running process
     #
+    # #### Parameters
+    #
+    # * `ctx` - the context of this command
+    #
     # #### Returns
     #
     # * `stopped` - [true, false]
     #
     def stop
-      unlink
       kill_proc
+      unlink
       true
     rescue
       false
@@ -159,7 +186,11 @@ module ShopifyCli
     end
 
     def kill_proc
-      kill(-pid) # process group
+      if Context.new.windows?
+        kill(pid)
+      else
+        kill(-pid) # process group
+      end
     rescue Errno::ESRCH
       begin
         kill(pid)
@@ -169,12 +200,18 @@ module ShopifyCli
     end
 
     def kill(id)
-      Process.kill('TERM', id)
-      50.times do
-        sleep 0.1
-        break unless stat(id)
+      ctx = Context.new
+
+      # Windows does not handle SIGTERM, go straight to SIGKILL
+      unless ctx.windows?
+        Process.kill('TERM', id)
+        50.times do
+          sleep 0.1
+          break unless stat(id)
+        end
       end
       Process.kill('KILL', id) if stat(id)
+      sleep(0.1) if ctx.windows? # Give Windows a second to actually close the process
     end
 
     def stat(id)

data/lib/shopify-cli/project.rb

@@ -15,6 +15,10 @@ module ShopifyCli
       # will get an instance of the project that the user is currently operating
       # on. This is used for access to project resources.
       #
+      # #### Parameters
+      #
+      # * `force_reload` - whether to force a reload of the project files
+      #
       # #### Returns
       #
       # * `project` - a Project instance if the user is currently in the project.
@@ -29,8 +33,8 @@ module ShopifyCli
       #
       #   project = ShopifyCli::Project.current
       #
-      def current
-        at(Dir.pwd)
+      def current(force_reload: false)
+        at(Dir.pwd, force_reload: force_reload)
       end
 
       ##
@@ -93,13 +97,17 @@ module ShopifyCli
 
       private
 
-      def directory(dir)
+      def directory(dir, force_reload: false)
+        @dir = nil if force_reload
+
         @dir ||= Hash.new { |h, k| h[k] = __directory(k) }
         @dir[dir]
       end
 
-      def at(dir)
-        proj_dir = directory(dir)
+      def at(dir, force_reload: false)
+        @at = nil if force_reload
+
+        proj_dir = directory(dir, force_reload: force_reload)
         unless proj_dir
           raise(ShopifyCli::Abort, Context.message('core.project.error.not_in_project'))
         end
@@ -109,7 +117,7 @@ module ShopifyCli
 
       def __directory(curr)
         loop do
-          return nil if curr == '/'
+          return nil if curr == '/' || /^[A-Z]:\/$/.match?(curr)
           file = File.join(curr, '.shopify-cli.yml')
           return curr if File.exist?(file)
           curr = File.dirname(curr)
@@ -158,7 +166,7 @@ module ShopifyCli
       @config ||= begin
         config = load_yaml_file('.shopify-cli.yml')
         unless config.is_a?(Hash)
-          raise ShopifyCli::Abort, Context.message('core.project.error.cli_yaml.not_hash')
+          raise ShopifyCli::Abort, Context.message('core.yaml.error.not_hash', '.shopify-cli.yml')
         end
 
         # The app_type key was deprecated in favour of project_type, so replace it
@@ -179,12 +187,12 @@ module ShopifyCli
       begin
         YAML.load_file(f)
       rescue Psych::SyntaxError => e
-        raise(ShopifyCli::Abort, Context.message('core.project.error.cli_yaml.invalid', relative_path, e.message))
+        raise(ShopifyCli::Abort, Context.message('core.yaml.error.invalid', relative_path, e.message))
       # rescue Errno::EACCES => e
       # TODO
       #   Dev::Helpers::EaccesHandler.diagnose_and_raise(f, e, mode: :read)
       rescue Errno::ENOENT
-        raise ShopifyCli::Abort, Context.message('core.project.error.cli_yaml.not_found', f)
+        raise ShopifyCli::Abort, Context.message('core.yaml.error.not_found', f)
       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')
@@ -122,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')
         unless File.exist?(zip_dest)
           ctx.system('curl', '-o', zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli.cache_dir)
         end
-        ctx.system('unzip', '-u', zip_dest, chdir: ShopifyCli.cache_dir)
+        args = if ctx.linux?
+          %W(unzip -u #{zip_dest})
+        else
+          %W(tar -xf #{zip_dest})
+        end
+        ctx.system(*args, chdir: ShopifyCli.cache_dir)
         ctx.rm(zip_dest)
       end
       spinner.wait
@@ -143,7 +151,7 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "exec #{File.join(ShopifyCli.cache_dir, 'ngrok')} http -inspect=false -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)
@@ -163,6 +171,13 @@ module ShopifyCli
       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
 
@@ -195,7 +210,7 @@ module ShopifyCli
       end
 
       def parse_account
-        account, timeout, _ = @log.match(/AccountName:([\w\s]*) SessionDuration:([\d]+) PlanName/)&.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

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '1.0.5'
+  VERSION = '1.3.0'
 end

data/lib/shopify_cli.rb

@@ -127,8 +127,10 @@ module ShopifyCli
   def self.cache_dir
     cache_dir = if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
       TEMP_DIR
-    else
+    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
@@ -140,8 +142,10 @@ module ShopifyCli
   def self.tool_config_path
     if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
       TEMP_DIR
-    else
+    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
 

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