shopify-cli 1.4.1 → 1.8.0

data/lib/shopify-cli/tunnel.rb

@@ -1,7 +1,7 @@
-require 'json'
-require 'fileutils'
-require 'shopify_cli'
-require 'forwardable'
+require "json"
+require "fileutils"
+require "shopify_cli"
+require "forwardable"
 
 module ShopifyCli
   ##
@@ -19,14 +19,14 @@ module ShopifyCli
     PORT = 8081 # port that ngrok will bind to
     # mapping for supported operating systems for where to download ngrok from.
     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',
+      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')
-    TUNNELS_FIELD = 'tunnels'
-    PUBLIC_URL_FIELD = 'public_url'
+    NGROK_TUNNELS_URI = URI.parse("http://localhost:4040/api/tunnels")
+    TUNNELS_FIELD = "tunnels"
+    PUBLIC_URL_FIELD = "public_url"
 
     ##
     # will find and stop a running tunnel process. It will also output if the
@@ -39,12 +39,12 @@ module ShopifyCli
     def stop(ctx)
       if ShopifyCli::ProcessSupervision.running?(:ngrok)
         if ShopifyCli::ProcessSupervision.stop(:ngrok)
-          ctx.puts(ctx.message('core.tunnel.stopped'))
+          ctx.puts(ctx.message("core.tunnel.stopped"))
         else
-          ctx.abort(ctx.message('core.tunnel.error.stop'))
+          ctx.abort(ctx.message("core.tunnel.error.stop"))
         end
       else
-        ctx.puts(ctx.message('core.tunnel.not_running'))
+        ctx.puts(ctx.message("core.tunnel.not_running"))
       end
     end
 
@@ -65,15 +65,15 @@ module ShopifyCli
       install(ctx)
       url, account, seconds_remaining = start_ngrok(ctx, port)
       if account
-        ctx.puts(ctx.message('core.tunnel.start_with_account', url, account))
+        ctx.puts(ctx.message("core.tunnel.start_with_account", url, account))
       else
         if seconds_remaining <= 0
-          ctx.puts(ctx.message('core.tunnel.timed_out'))
+          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))
+        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
     end
@@ -89,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
 
     ##
@@ -123,14 +123,15 @@ module ShopifyCli
     private
 
     def install(ctx)
-      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')
+      ngrok = "ngrok#{ctx.executable_file_extension}"
+      return if File.exist?(File.join(ShopifyCli.cache_dir, 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')
+      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)
+          ctx.system("curl", "-o", zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli.cache_dir)
         end
         args = if ctx.linux?
           %W(unzip -u #{zip_dest})
@@ -141,6 +142,11 @@ module ShopifyCli
         ctx.rm(zip_dest)
       end
       spinner.wait
+
+      # final check to see if ngrok is accessible
+      unless File.exist?(File.join(ShopifyCli.cache_dir, ngrok))
+        ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCli.cache_dir))
+      end
     end
 
     def fetch_url(ctx, log_path)
@@ -151,7 +157,7 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "\"#{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)
@@ -167,15 +173,15 @@ module ShopifyCli
 
     def restart_ngrok(ctx, port)
       unless ShopifyCli::ProcessSupervision.stop(:ngrok)
-        ctx.abort(ctx.message('core.tunnel.error.stop'))
+        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))
+      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:
@@ -193,7 +199,7 @@ module ShopifyCli
           sleep(1)
         end
 
-        raise FetchUrlError, Context.message('core.tunnel.error.url_fetch_failure') unless url
+        raise FetchUrlError, Context.message("core.tunnel.error.url_fetch_failure") unless url
       end
 
       def parse

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '1.4.1'
+  VERSION = "1.8.0"
 end

data/lib/shopify_cli.rb

@@ -8,23 +8,23 @@ Thread.report_on_exception = false
 # require_relative 'support/ruby_backports'
 
 # See bin/load_shopify.rb
-ENV['PATH'] = ENV['PATH'].split(':').select { |p| p.start_with?('/', '~') }.join(':') unless defined?($original_env)
+ENV["PATH"] = ENV["PATH"].split(":").select { |p| p.start_with?("/", "~") }.join(":") unless defined?($original_env)
 
 # Load vendor and CLI UI/Kit.
 # Nothing else should be loaded at this point and nothing else should be added to the load path on boot
 vendor_path = File.expand_path("../../vendor/lib", __FILE__)
 $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
 
-deps = %w(cli-ui cli-kit smart_properties)
+deps = %w(cli-ui cli-kit smart_properties webrick)
 deps.each do |dep|
   vendor_path = File.expand_path("../../vendor/deps/#{dep}/lib", __FILE__)
   $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
 end
 
-require 'cli/ui'
-require 'cli/kit'
-require 'smart_properties'
-require_relative 'shopify-cli/version'
+require "cli/ui"
+require "cli/kit"
+require "smart_properties"
+require_relative "shopify-cli/version"
 
 # 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/master/lib/cli/ui/stdout_router.rb for more info
@@ -39,16 +39,16 @@ CLI::UI::StdoutRouter.enable
 module ShopifyCli
   extend CLI::Kit::Autocall
 
-  TOOL_NAME         = 'shopify'
-  TOOL_FULL_NAME    = 'Shopify CLI'
-  ROOT              = File.expand_path('../..', __FILE__)
-  PROJECT_TYPES_DIR = File.join(ROOT, 'lib', 'project_types')
-  TEMP_DIR          = File.join(ROOT, '.tmp')
+  TOOL_NAME         = "shopify"
+  TOOL_FULL_NAME    = "Shopify CLI"
+  ROOT              = File.expand_path("../..", __FILE__)
+  PROJECT_TYPES_DIR = File.join(ROOT, "lib", "project_types")
+  TEMP_DIR          = File.join(ROOT, ".tmp")
 
   # programmer emoji if default install location, else wrench emoji
-  EMOJI    = ROOT == '/opt/shopify' ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
+  EMOJI    = ROOT == "/opt/shopify" ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
   # shrug or boom emoji
-  FAILMOJI = ROOT == '/opt/shopify' ? "\u{1f937}" : "\u{1f4a5}"
+  FAILMOJI = ROOT == "/opt/shopify" ? "\u{1f937}" : "\u{1f4a5}"
 
   # Exit management in `shopify-app-cli` follows the management set out by CLI Kit.
   # https://github.com/Shopify/cli-kit/blob/master/lib/cli/kit.rb
@@ -94,44 +94,49 @@ module ShopifyCli
     )
   end
 
-  autoload :AdminAPI, 'shopify-cli/admin_api'
-  autoload :API, 'shopify-cli/api'
-  autoload :Command, 'shopify-cli/command'
-  autoload :Commands, 'shopify-cli/commands'
-  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'
-  autoload :Heroku, 'shopify-cli/heroku'
-  autoload :JsDeps, 'shopify-cli/js_deps'
-  autoload :JsSystem, 'shopify-cli/js_system'
-  autoload :Log, 'shopify-cli/log'
-  autoload :OAuth, 'shopify-cli/oauth'
-  autoload :Options, 'shopify-cli/options'
-  autoload :PartnersAPI, 'shopify-cli/partners_api'
-  autoload :ProcessSupervision, 'shopify-cli/process_supervision'
-  autoload :Project, 'shopify-cli/project'
-  autoload :ProjectType, 'shopify-cli/project_type'
-  autoload :Resources, 'shopify-cli/resources'
-  autoload :Shopifolk, 'shopify-cli/shopifolk'
-  autoload :SubCommand, 'shopify-cli/sub_command'
-  autoload :Task, 'shopify-cli/task'
-  autoload :Tasks, 'shopify-cli/tasks'
-  autoload :Tunnel, 'shopify-cli/tunnel'
-
-  require 'shopify-cli/messages/messages'
+  autoload :AdminAPI, "shopify-cli/admin_api"
+  autoload :API, "shopify-cli/api"
+  autoload :Command, "shopify-cli/command"
+  autoload :Commands, "shopify-cli/commands"
+  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"
+  autoload :Heroku, "shopify-cli/heroku"
+  autoload :JsDeps, "shopify-cli/js_deps"
+  autoload :JsSystem, "shopify-cli/js_system"
+  autoload :MethodObject, "shopify-cli/method_object"
+  autoload :LazyDelegator, "shopify-cli/lazy_delegator"
+  autoload :Log, "shopify-cli/log"
+  autoload :OAuth, "shopify-cli/oauth"
+  autoload :Options, "shopify-cli/options"
+  autoload :PartnersAPI, "shopify-cli/partners_api"
+  autoload :ProcessSupervision, "shopify-cli/process_supervision"
+  autoload :Project, "shopify-cli/project"
+  autoload :ProjectType, "shopify-cli/project_type"
+  autoload :ResolveConstant, "shopify-cli/resolve_constant"
+  autoload :Resources, "shopify-cli/resources"
+  autoload :Result, "shopify-cli/result"
+  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"
+  autoload :Tunnel, "shopify-cli/tunnel"
+
+  require "shopify-cli/messages/messages"
   Context.load_messages(ShopifyCli::Messages::MESSAGES)
 
   def self.cache_dir
-    cache_dir = if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+    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)
+    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)
+      File.join(File.expand_path(ENV["LOCALAPPDATA"]), TOOL_NAME)
     end
 
     # Make sure the cache dir always exists
@@ -141,20 +146,20 @@ module ShopifyCli
   end
 
   def self.tool_config_path
-    if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+    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)
+    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)
+      File.join(File.expand_path(ENV["APPDATA"]), TOOL_NAME)
     end
   end
 
   def self.log_file
-    File.join(tool_config_path, 'logs', 'log.log')
+    File.join(tool_config_path, "logs", "log.log")
   end
 
   def self.debug_log_file
-    File.join(tool_config_path, 'logs', 'debug.log')
+    File.join(tool_config_path, "logs", "debug.log")
   end
 end

data/shopify-cli.gemspec

@@ -1,11 +1,11 @@
-require_relative 'lib/shopify-cli/version'
+require_relative "lib/shopify-cli/version"
 
 Gem::Specification.new do |spec|
   spec.name = "shopify-cli"
   spec.version = ShopifyCli::VERSION
   spec.authors = ["Shopify"]
   spec.email = ["dev-tools-education@shopify.com"]
-  spec.license = 'MIT'
+  spec.license = "MIT"
 
   spec.summary = "Shopify CLI helps you build Shopify apps faster."
   spec.description = <<~HERE
@@ -25,7 +25,7 @@ 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
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     %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)$})
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "vendor"]
   spec.extensions = ["ext/shopify-cli/extconf.rb"]
 
-  spec.add_development_dependency('bundler', '~> 1.17')
-  spec.add_development_dependency('rake', '~> 12.3', '>= 12.3.3')
-  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency("bundler", "~> 1.17")
+  spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
+  spec.add_development_dependency("minitest", "~> 5.0")
 end

data/shopify.fish

@@ -7,6 +7,6 @@ if [ $status != "0" ]
   echo "This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
 Please visit this page for complete instructions:
-  https://shopify.github.io/shopify-app-cli/migrate/
+  https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version
 "
 end

data/shopify.sh

@@ -6,6 +6,6 @@ if [ "$?" != "0" ]; then
   echo "This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
 Please visit this page for complete instructions:
-  https://shopify.github.io/shopify-app-cli/migrate/
+  https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version
 "
 fi

data/vendor/deps/cli-kit/REVISION

@@ -1 +1 @@
-1013aa5c5664e7034ca3f02fd2e0513361b07e95 (dirty)
+6eadd6c7f7fc9217008c2cfb0bc3101cb6cf3b41

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

@@ -61,7 +61,7 @@ module CLI
       #
       # @param msg [String] the message to log
       def debug(msg)
-        $stdout.puts CLI::UI.fmt(msg) if is_debug?
+        $stdout.puts CLI::UI.fmt(msg) if debug?
         @debug_logger.debug(format_debug(msg))
       end
 
@@ -73,7 +73,7 @@ module CLI
         "[#{CLI::UI::StdoutRouter.current_id[:id]}] #{msg}"
       end
 
-      def is_debug?
+      def debug?
         val = ENV[@env_debug_name]
         val && val != '0' && val != ''
       end

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

@@ -94,11 +94,11 @@ module CLI
           delegate_open3(*a, sudo: sudo, env: env, method: :popen2, **kwargs, &block)
         end
 
-        def popen2e(*a, sudo: false, env: ENV, **kwargs)
+        def popen2e(*a, sudo: false, env: ENV, **kwargs, &block)
           delegate_open3(*a, sudo: sudo, env: env, method: :popen2e, **kwargs, &block)
         end
 
-        def popen3(*a, sudo: false, env: ENV, **kwargs)
+        def popen3(*a, sudo: false, env: ENV, **kwargs, &block)
           delegate_open3(*a, sudo: sudo, env: env, method: :popen3, **kwargs, &block)
         end
 
@@ -112,7 +112,7 @@ module CLI
         # - `**kwargs`: additional keyword arguments to pass to Process.spawn
         #
         # #### Returns
-        # - `status`: boolean success status of the command execution
+        # - `status`: The `Process:Status` result for the command execution
         #
         # #### Usage
         # `stat = CLI::Kit::System.system('ls', 'a_folder')`

data/vendor/deps/cli-ui/REVISION

@@ -1 +1 @@
-5ea578d3110af35c73837a8008147ce53a4b56ed (dirty)
+168ce68b31d8436b2b222d6f063e5c7225785bd4

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

@@ -1,18 +1,19 @@
 module CLI
   module UI
-    autoload :ANSI,               'cli/ui/ansi'
-    autoload :Glyph,              'cli/ui/glyph'
-    autoload :Color,              'cli/ui/color'
-    autoload :Frame,              'cli/ui/frame'
-    autoload :OS,                 'cli/ui/os'
-    autoload :Printer,            'cli/ui/printer'
-    autoload :Progress,           'cli/ui/progress'
-    autoload :Prompt,             'cli/ui/prompt'
-    autoload :Terminal,           'cli/ui/terminal'
-    autoload :Truncater,          'cli/ui/truncater'
-    autoload :Formatter,          'cli/ui/formatter'
-    autoload :Spinner,            'cli/ui/spinner'
-    autoload :Widgets,            'cli/ui/widgets'
+    autoload :ANSI,      'cli/ui/ansi'
+    autoload :Glyph,     'cli/ui/glyph'
+    autoload :Color,     'cli/ui/color'
+    autoload :Frame,     'cli/ui/frame'
+    autoload :OS,        'cli/ui/os'
+    autoload :Printer,   'cli/ui/printer'
+    autoload :Progress,  'cli/ui/progress'
+    autoload :Prompt,    'cli/ui/prompt'
+    autoload :Terminal,  'cli/ui/terminal'
+    autoload :Truncater, 'cli/ui/truncater'
+    autoload :Formatter, 'cli/ui/formatter'
+    autoload :Spinner,   'cli/ui/spinner'
+    autoload :Widgets,   'cli/ui/widgets'
+    autoload :Wrap,      'cli/ui/wrap'
 
     # Convenience accessor to +CLI::UI::Spinner::SpinGroup+
     SpinGroup = Spinner::SpinGroup
@@ -29,7 +30,7 @@ module CLI
     end
 
     # Color resolution using +CLI::UI::Color.lookup+
-    # Will lookup using +Color.lookup+ if a symbol, otherwise we assume it is a valid color and return it
+    # Will lookup using +Color.lookup+ unless it's already a CLI::UI::Color (or nil)
     #
     # ==== Attributes
     #
@@ -37,26 +38,25 @@ module CLI
     #
     def self.resolve_color(input)
       case input
-      when Symbol
-        CLI::UI::Color.lookup(input)
-      else
+      when CLI::UI::Color, nil
         input
+      else
+        CLI::UI::Color.lookup(input)
       end
     end
 
     # Frame style resolution using +CLI::UI::Frame::FrameStyle.lookup+.
-    # Will lookup using +FrameStyle.lookup+ if the input is a symbol.  Otherwise,
-    # we assume it's a valid FrameStyle
+    # Will lookup using +FrameStyle.lookup+ unless it's already a CLI::UI::Frame::FrameStyle(or nil)
     #
     # ==== Attributes
     #
     # * +input+ - frame style to resolve
     def self.resolve_style(input)
       case input
-      when Symbol
-        CLI::UI::Frame::FrameStyle.lookup(input)
-      else
+      when CLI::UI::Frame::FrameStyle, nil
         input
+      else
+        CLI::UI::Frame::FrameStyle.lookup(input)
       end
     end
 
@@ -114,6 +114,10 @@ module CLI
       CLI::UI::Formatter.new(input).format(enable_color: enable_color)
     end
 
+    def self.wrap(input)
+      CLI::UI::Wrap.new(input).wrap
+    end
+
     # Convenience Method for +CLI::UI::Printer.puts+
     #
     # ==== Attributes