shopify-cli 1.1.1 → 1.4.0

data/lib/shopify-cli/api.rb

@@ -1,5 +1,4 @@
 require 'shopify_cli'
-require 'net/http'
 
 module ShopifyCli
   class API
@@ -32,8 +31,9 @@ module ShopifyCli
       )
       ctx.debug(resp)
       resp
-    rescue API::APIRequestServerError, API::APIRequestUnexpectedError
+    rescue API::APIRequestServerError, API::APIRequestUnexpectedError => e
       ctx.puts(ctx.message('core.api.error.internal_server_error'))
+      ctx.debug(ctx.message('core.api.error.internal_server_error_debug', e.message))
     end
 
     protected
@@ -58,14 +58,10 @@ module ShopifyCli
         unless uri.is_a?(URI::HTTP)
           ctx.abort("Invalid URL: #{graphql_url}")
         end
-        http = ::Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
 
-        req = ::Net::HTTP::Post.new(uri.request_uri)
-        req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
-        req['Content-Type'] = 'application/json'
-        headers.each { |header, value| req[header] = value }
-        response = http.request(req)
+        # we delay this require so as to avoid a performance hit on starting the CLI
+        require 'shopify-cli/http_request'
+        response = HttpRequest.call(uri, body, variables, headers)
 
         case response.code.to_i
         when 200..399

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/system.rb

@@ -23,6 +23,7 @@ module ShopifyCli
         display_cli_ruby(show_all_details)
         display_utility_commands(show_all_details)
         display_project_commands(show_all_details)
+        display_shopify_staff_identity if show_all_details
       end
 
       def self.help
@@ -139,6 +140,14 @@ module ShopifyCli
         end
         @ctx.puts("")
       end
+
+      def display_shopify_staff_identity
+        is_shopifolk = ShopifyCli::Shopifolk.check
+        if is_shopifolk
+          @ctx.puts("\n" + @ctx.message('core.system.identity_header'))
+          @ctx.puts("  " + @ctx.message('core.system.identity_is_shopifolk'))
+        end
+      end
     end
   end
 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
 
@@ -446,6 +453,23 @@ module ShopifyCli
       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)
@@ -456,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))
             )
+          elsif !ctx.testing?
+            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/http_request.rb

@@ -0,0 +1,15 @@
+require 'net/http'
+
+module ShopifyCli
+  class HttpRequest
+    def self.call(uri, body, variables, headers)
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      req = ::Net::HTTP::Post.new(uri.request_uri)
+      req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
+      req['Content-Type'] = 'application/json'
+      headers.each { |header, value| req[header] = value }
+      http.request(req)
+    end
+  end
+end

data/lib/shopify-cli/js_system.rb

@@ -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",
           },
         },
 
@@ -163,6 +177,7 @@ module ShopifyCli
         api: {
           error: {
             internal_server_error: '{{red:{{x}} An unexpected error occurred on Shopify.}}',
+            internal_server_error_debug: "\n{{red:Response details:}}\n%s\n\n",
           },
         },
 
@@ -184,11 +199,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",
           },
         },
 
@@ -234,6 +252,8 @@ module ShopifyCli
           },
           environment_header: "{{bold:Environment}}",
           env: "%-17s = %s",
+          identity_header: "{{bold:Identity}}",
+          identity_is_shopifolk: "{{v}} Checked user settings: you’re Shopify staff!",
         },
 
         tasks: {
@@ -317,7 +337,7 @@ module ShopifyCli
         warning: {
           development_version: <<~DEVELOPMENT,
           {{*}} {{yellow:You are running a development version of the CLI at:}}
-              {{yellow:%s}}
+            {{yellow:%s}}
 
           DEVELOPMENT
 
@@ -328,6 +348,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

data/lib/shopify-cli/project.rb

@@ -166,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
@@ -187,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/shopifolk.rb

@@ -0,0 +1,67 @@
+module ShopifyCli
+  ##
+  # ShopifyCli::Shopifolk contains the logic to determine if the user appears to be a Shopify staff
+  #
+  # The Shopifolk Feature flag will persist between runs so if the flag is enabled or disabled,
+  # it will still be in that same state until the next class invocation.
+  class Shopifolk
+    GCLOUD_CONFIG_FILE = File.expand_path('~/.config/gcloud/configurations/config_default')
+    DEV_PATH = '/opt/dev'
+    SECTION = 'core'
+    FEATURE_NAME = 'shopifolk'
+
+    ##
+    # will return if the user appears to be a Shopify employee, based on several heuristics
+    #
+    # #### Returns
+    #
+    # * `is_shopifolk` - returns true if the user is a Shopify Employee
+    #
+    # #### Example
+    #
+    #     ShopifyCli::Shopifolk.check
+    #
+    def self.check
+      ShopifyCli::Shopifolk.new.shopifolk?
+    end
+
+    ##
+    # will return if the user is a Shopify employee
+    #
+    # #### Returns
+    #
+    # * `is_shopifolk` - returns true if the user has `dev` installed and
+    # a valid google cloud config file with email ending in "@shopify.com"
+    #
+    def shopifolk?
+      return true if Feature.enabled?(FEATURE_NAME)
+      if shopifolk_by_gcloud? && shopifolk_by_dev?
+        ShopifyCli::Feature.enable(FEATURE_NAME)
+        true
+      else
+        ShopifyCli::Feature.disable(FEATURE_NAME)
+        false
+      end
+    end
+
+    private
+
+    def shopifolk_by_gcloud?
+      ini&.dig("[#{SECTION}]", 'account')&.match?(/@shopify.com\z/)
+    end
+
+    def shopifolk_by_dev?
+      File.exist?("#{DEV_PATH}/bin/dev") && File.exist?("#{DEV_PATH}/.shopify-build")
+    end
+
+    def ini
+      @ini ||= begin
+        if File.exist?(GCLOUD_CONFIG_FILE)
+          CLI::Kit::Ini
+            .new(GCLOUD_CONFIG_FILE, default_section: "[#{SECTION}]", convert_types: false)
+            .tap(&:parse).ini
+        end
+      end
+    end
+  end
+end