shopify-cli 1.0.5 → 1.3.0

data/lib/project_types/script/ui/error_handler.rb

@@ -96,14 +96,11 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
           }
-        when Layers::Infrastructure::Errors::AppScriptNotPushedError
+        when Layers::Infrastructure::Errors::AppScriptNotPushedError,
+          Layers::Infrastructure::Errors::AppScriptUndefinedError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_script_not_pushed_help'),
           }
-        when Layers::Infrastructure::Errors::AppScriptUndefinedError
-          {
-            help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),
-          }
         when Layers::Infrastructure::Errors::BuildError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.build_error_cause'),
@@ -142,6 +139,17 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.shop_script_undefined_cause'),
           }
+        when Layers::Infrastructure::Errors::PackagesOutdatedError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              'script.error.packages_outdated_cause',
+              e.outdated_packages.join(', ')
+            ),
+            help_suggestion: ShopifyCli::Context.message(
+              'script.error.packages_outdated_help',
+              e.outdated_packages.collect { |package| "#{package}@latest" }.join(' ')
+            ),
+          }
         end
       end
     end

data/lib/rubygems_plugin.rb

@@ -1,17 +1,25 @@
 Gem.post_uninstall do |uninstaller|
   if uninstaller.spec.name == 'shopify-cli'
-    require 'fileutils'
+    if RUBY_PLATFORM.match(/mingw32/)
+      bat_path = File.dirname(RbConfig.ruby)
+      bat = "#{bat_path}\\shopify.bat"
 
-    symlink = '/usr/local/bin/shopify'
+      # delete the auto-generated batch script
+      File.unlink(bat)
+    else
+      require 'fileutils'
 
-    # delete the symbolic link IFF it exists AND it does not point to a file
-    # (i.e., it's been left hanging as a result of the uninstall, as expected)
-    #
-    # if the file still exists, either the uninstall failed (possible but
-    # unlikely) OR
-    # there's another installation of the gem in another ruby folder that has
-    # overwritten it, so leave the symbolic link alone
-    system("sudo rm -f #{symlink}") if File.symlink?(symlink) && !File.exist?(symlink)
+      symlink = '/usr/local/bin/shopify'
+
+      # delete the symbolic link IFF it exists AND it does not point to a file
+      # (i.e., it's been left hanging as a result of the uninstall, as expected)
+      #
+      # if the file still exists, either the uninstall failed (possible but
+      # unlikely) OR
+      # there's another installation of the gem in another ruby folder that has
+      # overwritten it, so leave the symbolic link alone
+      system("sudo rm -f #{symlink}") if File.symlink?(symlink) && !File.exist?(symlink)
+    end
   end
 
   true

data/lib/shopify-cli/admin_api/populate_resource_command.rb

@@ -118,7 +118,7 @@ module ShopifyCli
         kwargs = { input: data }
         kwargs[:shop] = @shop
         resp = AdminAPI.query(
-          @ctx, "create_#{snake_case_resource_type}", kwargs
+          @ctx, "create_#{snake_case_resource_type}", **kwargs
         )
         @ctx.abort(resp['errors']) if resp['errors']
         @ctx.done(message(resp['data'])) unless @silent

data/lib/shopify-cli/commands/config.rb

@@ -6,6 +6,7 @@ module ShopifyCli
       hidden_feature(feature_set: :debug)
 
       subcommand :Feature, 'feature'
+      subcommand :Analytics, 'analytics'
 
       def call(*)
         @ctx.puts(self.class.help)
@@ -16,6 +17,10 @@ module ShopifyCli
       end
 
       class Feature < ShopifyCli::SubCommand
+        def self.help
+          ShopifyCli::Context.message('core.config.feature.help', ShopifyCli::TOOL_NAME)
+        end
+
         options do |parser, flags|
           parser.on('--enable') { flags[:action] = 'enable' }
           parser.on('--disable') { flags[:action] = 'disable' }
@@ -28,7 +33,7 @@ module ShopifyCli
           is_enabled = ShopifyCli::Feature.enabled?(feature_name)
           if options.flags[:action] == 'disable' && is_enabled
             ShopifyCli::Feature.disable(feature_name)
-            @ctx.puts(@ctx.message('core.config.feature.disabled', is_enabled))
+            @ctx.puts(@ctx.message('core.config.feature.disabled', feature_name))
           elsif options.flags[:action] == 'enable' && !is_enabled
             ShopifyCli::Feature.enable(feature_name)
             @ctx.puts(@ctx.message('core.config.feature.enabled', feature_name))
@@ -39,6 +44,33 @@ module ShopifyCli
           end
         end
       end
+
+      class Analytics < ShopifyCli::SubCommand
+        def self.help
+          ShopifyCli::Context.message('core.config.analytics.help', ShopifyCli::TOOL_NAME)
+        end
+
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(_args, _name)
+          is_enabled = ShopifyCli::Config.get_bool('analytics', 'enabled')
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Config.set('analytics', 'enabled', false)
+            @ctx.puts(@ctx.message('core.config.analytics.disabled'))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Config.set('analytics', 'enabled', true)
+            @ctx.puts(@ctx.message('core.config.analytics.enabled'))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.analytics.is_enabled'))
+          else
+            @ctx.puts(@ctx.message('core.config.analytics.is_disabled'))
+          end
+        end
+      end
     end
   end
 end

data/lib/shopify-cli/commands/connect.rb

@@ -13,8 +13,8 @@ module ShopifyCli
         end
 
         org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
-        api_key = Project.current.env['api_key']
         write_cli_yml(project_type, org['id']) unless Project.has_current?
+        api_key = Project.current(force_reload: true).env['api_key']
         @ctx.puts(@ctx.message('core.connect.connected', get_app(org['apps'], api_key).first["title"]))
       end
 

data/lib/shopify-cli/commands/system.rb

@@ -68,13 +68,14 @@ module ShopifyCli
       end
 
       def display_utility_commands(_show_all_details)
-        commands = %w(git curl tar unzip)
+        commands = %w(git curl tar)
 
         @ctx.puts("\n" + @ctx.message('core.system.command_header'))
         commands.each do |s|
-          output, status = @ctx.capture2e('which', s)
-          if status.success?
-            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, output))
+          cmd_path = @ctx.which(s)
+
+          if !cmd_path.nil?
+            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, cmd_path))
           else
             @ctx.puts("  " + @ctx.message('core.system.command_not_found', s))
           end
@@ -82,7 +83,7 @@ module ShopifyCli
       end
 
       def display_ngrok
-        ngrok_location = File.join(ShopifyCli.cache_dir, 'ngrok')
+        ngrok_location = File.join(ShopifyCli.cache_dir, @ctx.windows? ? 'ngrok.exe' : 'ngrok')
         if File.exist?(ngrok_location)
           @ctx.puts("  " + @ctx.message('core.system.ngrok_available', ngrok_location))
         else
@@ -102,11 +103,11 @@ module ShopifyCli
       def display_project(project_type, commands)
         @ctx.puts("\n" + @ctx.message('core.system.project.header', project_type))
         commands.each do |s|
-          output, status = @ctx.capture2e('which', s)
-          if status.success?
+          cmd_path = @ctx.which(s)
+          if !cmd_path.nil?
             version_output, _ = @ctx.capture2e(s, '--version')
             version = version_output.match(/(\d+\.[^\s]+)/)[0]
-            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, output.strip, version.strip))
+            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, cmd_path.strip, version.strip))
           else
             @ctx.puts("  " + @ctx.message('core.system.project.command_not_found', s))
           end

data/lib/shopify-cli/context.rb

@@ -2,6 +2,8 @@
 require 'shopify_cli'
 require 'fileutils'
 require 'rbconfig'
+require 'net/http'
+require 'json'
 
 module ShopifyCli
   ##
@@ -11,6 +13,11 @@ module ShopifyCli
   # resoures.
   #
   class Context
+    GEM_LATEST_URI = URI.parse('https://rubygems.org/api/v1/versions/shopify-cli/latest.json')
+    VERSION_CHECK_SECTION = 'versioncheck'
+    LAST_CHECKED_AT_FIELD = 'last_checked_at'
+    VERSION_CHECK_INTERVAL = 86400
+
     class << self
       attr_reader :messages
 
@@ -56,6 +63,7 @@ module ShopifyCli
       host = uname
       return :mac if /darwin/.match(host)
       return :linux if /linux/.match(host)
+      return :windows if /mingw32/.match(host)
     end
 
     # will return true if the cli is running on an apple computer.
@@ -68,6 +76,11 @@ module ShopifyCli
       os == :linux
     end
 
+    # will return true if the cli is running on Windows
+    def windows?
+      os == :windows
+    end
+
     # will return true if the cli is being run from an installation, and not a
     # development instance. The gem installation will not have a 'test' directory.
     # See `#development?` for checking for development environment.
@@ -418,6 +431,45 @@ module ShopifyCli
       end
     end
 
+    # Checks if the given command exists in the system
+    #
+    # #### Parameters
+    # - `cmd`: The command to test
+    #
+    # #### Returns
+    # The path of the executable if it is found
+    #
+    # @todo This is currently a duplicate of CLI::Kit::System.which() - we should make that method public when we make
+    #       Kit changes and make this a wrapper instead.
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(File.expand_path(path), "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+
+      nil
+    end
+
+    # Checks if there's a newer version of the CLI available and returns version string if
+    # this should be conveyed to the user (i.e., if it's been over 24 hours since last check)
+    #
+    # #### Parameters
+    #
+    # #### Returns
+    # - `version`: string of newer version available, IFF new version is available AND it's time to inform user,
+    #            : nil otherwise
+    #
+    def new_version
+      if (time_of_last_check + VERSION_CHECK_INTERVAL) < (now = Time.now.to_i)
+        update_time_of_last_check(now)
+        latest_version = retrieve_latest_gem_version
+        latest_version unless latest_version == ShopifyCli::VERSION
+      end
+    end
+
     private
 
     def ctx_path(fname)
@@ -428,5 +480,21 @@ module ShopifyCli
         File.join(root, fname)
       end
     end
+
+    def retrieve_latest_gem_version
+      response = Net::HTTP.get_response(GEM_LATEST_URI)
+      latest = JSON.parse(response.body)
+      latest["version"]
+    rescue
+      nil
+    end
+
+    def time_of_last_check
+      (val = ShopifyCli::Config.get(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD)) ? val.to_i : 0
+    end
+
+    def update_time_of_last_check(time)
+      ShopifyCli::Config.set(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD, time)
+    end
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -28,6 +28,9 @@ module ShopifyCli
             ctx.puts(
               ctx.message('core.warning.development_version', File.join(ShopifyCli::ROOT, 'bin', ShopifyCli::TOOL_NAME))
             )
+          else
+            new_version = ctx.new_version
+            ctx.puts(ctx.message('core.warning.new_version', ShopifyCli::VERSION, new_version)) unless new_version.nil?
           end
 
           ProjectType.load_type(Project.current_project_type)

data/lib/shopify-cli/git.rb

@@ -125,13 +125,13 @@ module ShopifyCli
 
           success = Open3.popen3('git', *git_command, '--progress') do |_stdin, _stdout, stderr, thread|
             while (line = stderr.gets)
+              msg << line.chomp
               next unless line.strip.start_with?('Receiving objects:')
               percent = (line.match(/Receiving objects:\s+(\d+)/)[1].to_f / 100).round(2)
               bar.tick(set_percent: percent)
               next
             end
 
-            msg << stderr
             thread.value
           end.success?
 

data/lib/shopify-cli/heroku.rb

@@ -3,7 +3,7 @@ module ShopifyCli
     DOWNLOAD_URLS = {
       linux: 'https://cli-assets.heroku.com/heroku-linux-x64.tar.gz',
       mac: 'https://cli-assets.heroku.com/heroku-darwin-x64.tar.gz',
-      windows: 'https://cli-assets.heroku.com/heroku-win32-x64.tar.gz',
+      windows: 'https://cli-assets.heroku.com/heroku-x64.exe',
     }
 
     def initialize(ctx)
@@ -44,7 +44,11 @@ module ShopifyCli
     def install
       return if installed?
 
-      result = @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli.cache_dir)
+      result = if @ctx.windows?
+        @ctx.system("\"#{download_path}\"")
+      else
+        @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli.cache_dir)
+      end
       @ctx.abort(@ctx.message('core.heroku.error.install')) unless result.success?
 
       @ctx.rm(download_path)
@@ -82,6 +86,18 @@ module ShopifyCli
       local_path = File.join(ShopifyCli.cache_dir, 'heroku', 'bin', 'heroku').to_s
       if File.exist?(local_path)
         local_path
+      elsif @ctx.windows?
+        # Check if Heroku exists in the Windows registry and run it from there
+        require 'win32/registry'
+        begin
+          windows_path = Win32::Registry::HKEY_CURRENT_USER.open('SOFTWARE\heroku') do |reg|
+            reg[''] # This reads the 'Default' registry key
+          end
+
+          File.join(windows_path, 'bin', 'heroku').to_s
+        rescue
+          'heroku'
+        end
       else
         'heroku'
       end

data/lib/shopify-cli/js_deps.rb

@@ -69,7 +69,7 @@ module ShopifyCli
       deps = parse_dependencies
       errors = nil
 
-      spinner_title = ctx.message('core.js_deps.installing_deps', deps.size)
+      spinner_title = ctx.message('core.js_deps.installing', @system.package_manager)
       success = CLI::UI::Spinner.spin(spinner_title, auto_debrief: false) do |spinner|
         _, errors, status = CLI::Kit::System.capture3(*cmd, env: @ctx.env, chdir: ctx.root)
         update_spinner_title_and_status(spinner, status, deps)
@@ -81,7 +81,7 @@ module ShopifyCli
 
     def update_spinner_title_and_status(spinner, status, deps)
       if status.success?
-        spinner.update_title(ctx.message('core.js_deps.installed_deps', deps.size))
+        spinner.update_title(ctx.message('core.js_deps.installed', deps.size))
       else
         spinner.update_title(ctx.message('core.js_deps.error.install_spinner_error', deps.size))
         CLI::UI::Spinner::TASK_FAILED

data/lib/shopify-cli/js_system.rb

@@ -64,8 +64,8 @@ module ShopifyCli
     #
     def yarn?
       @has_yarn ||= begin
-        _, status = CLI::Kit::System.capture2('which', 'yarn')
-        File.exist?(File.join(ctx.root, 'yarn.lock')) && status.success?
+        cmd_path = @ctx.which('yarn')
+        File.exist?(File.join(ctx.root, 'yarn.lock')) && !cmd_path.nil?
       end
     end
 
@@ -76,23 +76,40 @@ module ShopifyCli
     # - `ctx`: running context from your command
     # - `yarn`: The proc, array, or string command to run if yarn is available
     # - `npm`: The proc, array, or string command to run if npm is available
+    # - `capture_response`: The boolean flag to capture the output of the running command if it is set to true
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).call(yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+    #   ShopifyCli::JsSystem.new(ctx: ctx).call(
+    #     yarn: ['install', '--silent'],
+    #     npm: ['install', '--no-audit'],
+    #     capture_response: false
+    #   )
     #
-    def call(yarn:, npm:)
-      yarn? ? call_command(yarn, YARN_CORE_COMMAND) : call_command(npm, NPM_CORE_COMMAND)
+    def call(yarn:, npm:, capture_response: false)
+      if yarn?
+        call_command(yarn, YARN_CORE_COMMAND, capture_response)
+      else
+        call_command(npm, NPM_CORE_COMMAND, capture_response)
+      end
     end
 
     private
 
-    def call_command(command, core_command)
+    def call_command(command, core_command, capture_response)
       if command.is_a?(String) || command.is_a?(Array)
-        CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+        capture_response ? call_with_capture(command, core_command) : call_without_capture(command, core_command)
       else
         command.call
       end
     end
+
+    def call_with_capture(command, core_command)
+      CLI::Kit::System.capture3(core_command, *command, chdir: ctx.root)
+    end
+
+    def call_without_capture(command, core_command)
+      CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+    end
   end
 end

data/lib/shopify-cli/messages/messages.rb

@@ -48,13 +48,27 @@ module ShopifyCli
         config: {
           help: <<~HELP,
           Change configuration of how the CLI operates
-            Usage: {{command:%s config [ feature ] [ feature_name ] }}
+            Usage: {{command:%s config [ feature | analytics ] }}
           HELP
           feature: {
-            enabled: "{{v}} feature {{green:%s}} was enabled",
-            disabled: "{{v}} feature {{green:%s}} was disabled",
-            is_enabled: "{{v}} feature {{green:%s}} is enabled",
-            is_disabled: "{{v}} feature {{green:%s}} is disabled",
+            help: <<~HELP,
+            Change configuration of various features
+              Usage: {{command:%s config [ feature ] [ feature_name ] }}
+            HELP
+            enabled: "{{v}} feature {{green:%s}} has been enabled",
+            disabled: "{{v}} feature {{green:%s}} has been disabled",
+            is_enabled: "{{v}} feature {{green:%s}} is currently enabled",
+            is_disabled: "{{v}} feature {{green:%s}} is currently disabled",
+          },
+          analytics: {
+            help: <<~HELP,
+            Opt in/out of anonymous usage reporting
+              Usage: {{command:%s config [ analytics ] }}
+            HELP
+            enabled: "{{v}} analytics have been enabled",
+            disabled: "{{v}} analytics have been disabled",
+            is_enabled: "{{v}} analytics are currently enabled",
+            is_disabled: "{{v}} analytics are currently disabled",
           },
         },
 
@@ -184,11 +198,14 @@ module ShopifyCli
             {{x}} You are not in a Shopify app project
             {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify create}}{{reset: to create your app}}
             MESSAGE
-            cli_yaml: {
-              not_hash: "{{x}} .shopify-cli.yml was not a proper YAML file. Expecting a hash.",
-              invalid: "{{x}} %s contains invalid YAML: %s",
-              not_found: "{{x}} %s not found",
-            },
+          },
+        },
+
+        yaml: {
+          error: {
+            not_hash: "{{x}} %s was not a proper YAML file. Expecting a hash.",
+            invalid: "{{x}} %s contains invalid YAML: %s",
+            not_found: "{{x}} %s not found",
           },
         },
 
@@ -289,6 +306,8 @@ module ShopifyCli
           error: {
             stop: "ngrok tunnel could not be stopped. Try running {{command:killall -9 ngrok}}",
             url_fetch_failure: "Unable to fetch external url",
+            prereq_command_required: "%1$s is required for installing ngrok. Please install %1$s using the appropriate"\
+              " package manager for your system.",
           },
 
           not_running: "{{green:x}} ngrok tunnel not running",
@@ -302,6 +321,7 @@ module ShopifyCli
           stopped: "{{green:x}} ngrok tunnel stopped",
           timed_out: "{{x}} ngrok tunnel has timed out, restarting ...",
           will_timeout: "{{*}} This tunnel will timeout in {{red:%s}}",
+          prereq_command_location: "%s @ %s",
         },
 
         version: {
@@ -314,7 +334,7 @@ module ShopifyCli
         warning: {
           development_version: <<~DEVELOPMENT,
           {{*}} {{yellow:You are running a development version of the CLI at:}}
-              {{yellow:%s}}
+            {{yellow:%s}}
 
           DEVELOPMENT
 
@@ -325,6 +345,14 @@ module ShopifyCli
             {{underline:https://shopify.github.io/shopify-app-cli/migrate/}}
 
           MESSAGE
+
+          new_version: <<~MESSAGE,
+          {{*}} {{yellow:A new version of the Shopify App CLI is available! You have version %s and the latest version is %s.
+
+            To upgrade, follow the instructions for the package manager you’re using:
+            {{underline:https://shopify.github.io/shopify-app-cli/getting-started/upgrade/}}}}
+
+          MESSAGE
         },
       },
     }.freeze