shopify-cli 1.3.1 → 1.7.0

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

@@ -1,10 +1,10 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Commands
     class Version < ShopifyCli::Command
       def self.help
-        ShopifyCli::Context.message('core.version.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("core.version.help", ShopifyCli::TOOL_NAME)
       end
 
       def call(_args, _name)

data/lib/shopify-cli/context.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require 'shopify_cli'
-require 'fileutils'
-require 'rbconfig'
-require 'net/http'
-require 'json'
+require "shopify_cli"
+require "fileutils"
+require "rbconfig"
+require "net/http"
+require "json"
 
 module ShopifyCli
   ##
@@ -13,9 +13,9 @@ 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'
+    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
@@ -40,7 +40,7 @@ module ShopifyCli
       # * `key` - a symbol representing the message
       # * `params` - the parameters to format the string with
       def message(key, *params)
-        key_parts = key.split('.').map(&:to_sym)
+        key_parts = key.split(".").map(&:to_sym)
         str = Context.messages.dig(*key_parts)
         str ? str % params : key
       end
@@ -86,7 +86,7 @@ module ShopifyCli
     # See `#development?` for checking for development environment.
     #
     def system?
-      !Dir.exist?(File.join(ShopifyCli::ROOT, 'test'))
+      !Dir.exist?(File.join(ShopifyCli::ROOT, "test"))
     end
 
     # will return true if the cli is running on your development instance.
@@ -97,13 +97,13 @@ module ShopifyCli
 
     # will return true while tests are running, either locally or on CI
     def testing?
-      ci? || ENV['TEST']
+      ci? || ENV["TEST"]
     end
 
     ##
     # will return true if the cli is being tested on CI
     def ci?
-      ENV['CI']
+      ENV["CI"]
     end
 
     # get a environment variable value by name.
@@ -116,7 +116,7 @@ module ShopifyCli
     #
     def getenv(name)
       v = @env[name]
-      v == '' ? nil : v
+      v == "" ? nil : v
     end
 
     # set a environment variable value by name.
@@ -254,7 +254,7 @@ module ShopifyCli
     # * `uri` - a http URI to open in a browser
     #
     def open_url!(uri)
-      help = message('core.context.open_url', uri)
+      help = message("core.context.open_url", uri)
       puts(help)
     end
 
@@ -303,7 +303,7 @@ module ShopifyCli
     # * `text` - a string message to output
     #
     def debug(text)
-      puts("{{red:DEBUG}} #{text}") if getenv('DEBUG')
+      puts("{{red:DEBUG}} #{text}") if getenv("DEBUG")
     end
 
     # proxy call to Context.message.
@@ -329,14 +329,18 @@ module ShopifyCli
     # - `**kwargs`: additional keyword arguments to pass to Process.spawn
     #
     # #### Returns
-    # - `status`: boolean success status of the command execution
+    # - `status`: The `Process::Status` result of the command execution.
     #
     # #### Usage
     #
     #   stat = @ctx.system('ls', 'a_folder')
     #
     def system(*args, **kwargs)
-      CLI::Kit::System.system(*args, env: @env, **kwargs)
+      process_status = CLI::Kit::System.system(*args, env: @env, **kwargs)
+      unless process_status.success?
+        abort("System call failed: #{args.join(" ")}")
+      end
+      process_status
     end
 
     # Execute a command in the user's environment
@@ -410,13 +414,13 @@ module ShopifyCli
     #
     def on_siginfo
       # Reset any previous SIGINFO handling we had so the only action we take is the given block
-      trap('INFO', 'DEFAULT')
+      trap("INFO", "DEFAULT")
 
       fork do
         begin
           r, w = IO.pipe
           @signal = false
-          trap('SIGINFO') do
+          trap("SIGINFO") do
             @signal = true
             w.write(0)
           end
@@ -442,8 +446,8 @@ module ShopifyCli
     # @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 = 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)
@@ -470,10 +474,27 @@ module ShopifyCli
       end
     end
 
+    # Returns file extension depending on OS
+    # since windows has multiple extensions, the default is .exe unless otherwise specified
+    #
+    # #### Parameters
+    # - ext: optional extension for windows file
+    #
+    # #### Returns
+    # - ext: string for file extension on windows
+    #      : empty string otherwise
+    def executable_file_extension(ext = ".exe")
+      if windows?
+        ext
+      else
+        ""
+      end
+    end
+
     private
 
     def ctx_path(fname)
-      require 'pathname'
+      require "pathname"
       if Pathname.new(fname).absolute?
         fname
       else

data/lib/shopify-cli/core.rb

@@ -1,8 +1,8 @@
 module ShopifyCli
   module Core
-    autoload :EntryPoint, 'shopify-cli/core/entry_point'
-    autoload :Executor, 'shopify-cli/core/executor'
-    autoload :HelpResolver, 'shopify-cli/core/help_resolver'
-    autoload :Monorail, 'shopify-cli/core/monorail'
+    autoload :EntryPoint, "shopify-cli/core/entry_point"
+    autoload :Executor, "shopify-cli/core/executor"
+    autoload :HelpResolver, "shopify-cli/core/help_resolver"
+    autoload :Monorail, "shopify-cli/core/monorail"
   end
 end

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

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Core
@@ -14,23 +14,23 @@ module ShopifyCli
           rescue ArgumentError => e
             # This can happen on RVM, because it can use fd 9 itself and block access to it. That only happens if the fd
             # did not exist beforehand, so that means there was no fd 9 before Ruby started.
-            unless e.message == 'The given fd is not accessible because RubyVM reserves it'
+            unless e.message == "The given fd is not accessible because RubyVM reserves it"
               raise e
             end
           end
 
           if !ctx.testing? && is_shell_shim
-            ctx.puts(ctx.message('core.warning.shell_shim'))
+            ctx.puts(ctx.message("core.warning.shell_shim"))
             return
           end
 
           if ctx.development?
             ctx.puts(
-              ctx.message('core.warning.development_version', File.join(ShopifyCli::ROOT, 'bin', ShopifyCli::TOOL_NAME))
+              ctx.message("core.warning.development_version", File.join(ShopifyCli::ROOT, "bin", ShopifyCli::TOOL_NAME))
             )
-          else
+          elsif !ctx.testing?
             new_version = ctx.new_version
-            ctx.puts(ctx.message('core.warning.new_version', ShopifyCli::VERSION, new_version)) unless new_version.nil?
+            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/core/executor.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Core

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

@@ -1,4 +1,4 @@
-require 'cli/kit'
+require "cli/kit"
 
 module ShopifyCli
   module Core
@@ -6,7 +6,7 @@ module ShopifyCli
       def call(args)
         args = args.dup
         return super(args) unless args.first
-        if args.first.include?('-h') || args.first.include?('--help')
+        if args.first.include?("-h") || args.first.include?("--help")
           help = Commands::Help
           help.ctx = Context.new
           help.call([], nil)

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

@@ -1,13 +1,13 @@
-require 'json'
-require 'net/http'
-require 'time'
-require 'rbconfig'
+require "json"
+require "net/http"
+require "time"
+require "rbconfig"
 
 module ShopifyCli
   module Core
     module Monorail
-      ENDPOINT_URI = URI.parse('https://monorail-edge.shopifycloud.com/v1/produce')
-      INVOCATIONS_SCHEMA = 'app_cli_command/4.0'
+      ENDPOINT_URI = URI.parse("https://monorail-edge.shopifycloud.com/v1/produce")
+      INVOCATIONS_SCHEMA = "app_cli_command/5.0"
 
       # Extra hash of data that will be sent in the payload
       @metadata = {}
@@ -46,25 +46,25 @@ module ShopifyCli
 
         # we only want to send Monorail events in production or when explicitly developing
         def enabled?
-          Context.new.system? || ENV['MONORAIL_REAL_EVENTS'] == '1'
+          Context.new.system? || ENV["MONORAIL_REAL_EVENTS"] == "1"
         end
 
         def consented?
-          ShopifyCli::Config.get_bool('analytics', 'enabled')
+          ShopifyCli::Config.get_bool("analytics", "enabled")
         end
 
         def prompt_for_consent
           return unless enabled?
-          return if ShopifyCli::Config.get_section('analytics').key?('enabled')
-          msg = Context.message('core.monorail.consent_prompt')
+          return if ShopifyCli::Config.get_section("analytics").key?("enabled")
+          msg = Context.message("core.monorail.consent_prompt")
           opt = CLI::UI::Prompt.confirm(msg)
-          ShopifyCli::Config.set('analytics', 'enabled', opt)
+          ShopifyCli::Config.set("analytics", "enabled", opt)
         end
 
         def send_event(start_time, commands, args, err = nil)
           end_time = now_in_milliseconds
           headers = {
-            'Content-Type': 'application/json; charset=utf-8',
+            'Content-Type': "application/json; charset=utf-8",
             'X-Monorail-Edge-Event-Created-At-Ms': start_time.to_s,
             'X-Monorail-Edge-Event-Sent-At-Ms': end_time.to_s,
           }
@@ -74,7 +74,7 @@ module ShopifyCli
               ENDPOINT_URI.port,
               # timeouts for opening a connection, reading, writing (in seconds)
               open_timeout: 0.2, read_timeout: 0.2, write_timeout: 0.2,
-              use_ssl: ENDPOINT_URI.scheme == 'https'
+              use_ssl: ENDPOINT_URI.scheme == "https"
             ) do |http|
               payload = build_payload(start_time, end_time, commands, args, err)
               post = Net::HTTP::Post.new(ENDPOINT_URI.request_uri, headers)
@@ -91,8 +91,8 @@ module ShopifyCli
             schema_id: INVOCATIONS_SCHEMA,
             payload: {
               project_type: Project.current_project_type.to_s,
-              command: commands.join(' '),
-              args: args.join(' '),
+              command: commands.join(" "),
+              args: args.join(" "),
               time_start: start_time,
               time_end: end_time,
               total_time: end_time - start_time,
@@ -101,14 +101,16 @@ module ShopifyCli
               uname: RbConfig::CONFIG["host"],
               cli_version: ShopifyCli::VERSION,
               ruby_version: RUBY_VERSION,
+              is_employee: ShopifyCli::Shopifolk.acting_as_shopify_organization?,
             }.tap do |payload|
-              payload[:metadata] = JSON.dump(metadata) unless metadata.empty?
-
+              payload[:api_key] = metadata.delete(:api_key)
+              payload[:partner_id] = metadata.delete(:organization_id)
               if Project.has_current?
-                project = Project.current
+                project = Project.current(force_reload: true)
                 payload[:api_key] = project.env&.api_key
-                payload[:partner_id] = project.config['organization_id']
+                payload[:partner_id] = project.config["organization_id"]
               end
+              payload[:metadata] = JSON.dump(metadata) unless metadata.empty?
             end,
           }
         end

data/lib/shopify-cli/db.rb

@@ -1,5 +1,5 @@
-require 'pstore'
-require 'forwardable'
+require "pstore"
+require "forwardable"
 
 module ShopifyCli
   # Persists transient data like access tokens that may be cleared

data/lib/shopify-cli/feature.rb

@@ -6,7 +6,7 @@ module ShopifyCli
   # Feature flags will persist between runs so if the flag is enabled or disabled,
   # it will still be in that same state on the next cli invocation.
   class Feature
-    SECTION = 'features'
+    SECTION = "features"
 
     ##
     # ShopifyCli::Feature::Set is included on commands and projects to allow you to hide
@@ -87,8 +87,6 @@ module ShopifyCli
         ShopifyCli::Config.get_bool(SECTION, feature.to_s)
       end
 
-      private
-
       def set(feature, value)
         ShopifyCli::Config.set(SECTION, feature.to_s, value)
       end

data/lib/shopify-cli/form.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   class Form

data/lib/shopify-cli/git.rb

@@ -21,7 +21,7 @@ module ShopifyCli
       #   ShopifyCli::Git.sha
       #
       def sha(dir: Dir.pwd, ctx: Context.new)
-        rev_parse('HEAD', dir: dir, ctx: ctx)
+        rev_parse("HEAD", dir: dir, ctx: ctx)
       end
 
       ##
@@ -44,11 +44,11 @@ module ShopifyCli
       #
       def clone(repository, dest, ctx: Context.new)
         if Dir.exist?(dest)
-          ctx.abort(ctx.message('core.git.error.directory_exists'))
+          ctx.abort(ctx.message("core.git.error.directory_exists"))
         else
-          success_message = ctx.message('core.git.cloned', dest)
-          CLI::UI::Frame.open(ctx.message('core.git.cloning', repository, dest), success_text: success_message) do
-            clone_progress('clone', '--single-branch', repository, dest, ctx: ctx)
+          success_message = ctx.message("core.git.cloned", dest)
+          CLI::UI::Frame.open(ctx.message("core.git.cloning", repository, dest), success_text: success_message) do
+            clone_progress("clone", "--single-branch", repository, dest, ctx: ctx)
           end
         end
       end
@@ -69,11 +69,11 @@ module ShopifyCli
       #   branches = ShopifyCli::Git.branches(@ctx)
       #
       def branches(ctx)
-        output, status = ctx.capture2e('git', 'branch', '--list', '--format=%(refname:short)')
-        ctx.abort(ctx.message('core.git.error.no_branches_found')) unless status.success?
+        output, status = ctx.capture2e("git", "branch", "--list", "--format=%(refname:short)")
+        ctx.abort(ctx.message("core.git.error.no_branches_found")) unless status.success?
 
-        branches = if output == ''
-          ['master']
+        branches = if output == ""
+          ["master"]
         else
           output.split("\n")
         end
@@ -94,14 +94,14 @@ module ShopifyCli
       #   ShopifyCli::Git.init(@ctx)
       #
       def init(ctx)
-        output, status = ctx.capture2e('git', 'status')
+        output, status = ctx.capture2e("git", "status")
 
         unless status.success?
-          ctx.abort(ctx.message('core.git.error.repo_not_initiated'))
+          ctx.abort(ctx.message("core.git.error.repo_not_initiated"))
         end
 
-        if output.include?('No commits yet')
-          ctx.abort(ctx.message('core.git.error.no_commits_made'))
+        if output.include?("No commits yet")
+          ctx.abort(ctx.message("core.git.error.no_commits_made"))
         end
       end
 
@@ -115,18 +115,18 @@ module ShopifyCli
       end
 
       def rev_parse(*args, dir: nil, ctx: Context.new)
-        exec('rev-parse', *args, dir: dir, ctx: ctx)
+        exec("rev-parse", *args, dir: dir, ctx: ctx)
       end
 
       def clone_progress(*git_command, ctx:)
         CLI::UI::Progress.progress do |bar|
           msg = []
-          require 'open3'
+          require "open3"
 
-          success = Open3.popen3('git', *git_command, '--progress') do |_stdin, _stdout, stderr, thread|
+          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:')
+              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