shopify-cli 2.3.0 → 2.6.1

data/lib/shopify_cli/exception_reporter.rb

@@ -0,0 +1,55 @@
+module ShopifyCLI
+  module ExceptionReporter
+    autoload :PermissionController, "shopify_cli/exception_reporter/permission_controller"
+
+    def self.report(error, _logs = nil, _api_key = nil, custom_metadata = {})
+      context = ShopifyCLI::Context.new
+      context.puts("\n")
+      context.puts(context.message("core.error_reporting.unhandled_error.message"))
+      context.puts(context.message("core.error_reporting.unhandled_error.issue_message"))
+      unless ShopifyCLI::Environment.print_stacktrace?
+        context.puts(context.message("core.error_reporting.unhandled_error.stacktrace_message",
+          "#{ShopifyCLI::Constants::EnvironmentVariables::STACKTRACE}=1"))
+      end
+      context.puts("\n")
+
+      return unless reportable_error?(error)
+      return unless report?
+
+      ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = "1"
+      require "bugsnag"
+
+      Bugsnag.configure do |config|
+        config.logger.level = ::Logger::ERROR
+        config.api_key = ShopifyCLI::Constants::Bugsnag::API_KEY
+        config.app_type = "shopify"
+        config.project_root = File.expand_path("../../..", __FILE__)
+        config.app_version = ShopifyCLI::VERSION
+        config.auto_capture_sessions = false
+      end
+
+      metadata = {}
+      metadata.merge!(custom_metadata)
+      # Bugsnag.notify(error, metadata)
+    end
+
+    def self.report?
+      # return false if ShopifyCLI::Environment.development?
+      return true if ExceptionReporter::PermissionController.automatic_reporting_prompted? &&
+        ExceptionReporter::PermissionController.can_report_automatically?
+
+      report_error = ExceptionReporter::PermissionController.report_error?
+
+      unless ExceptionReporter::PermissionController.automatic_reporting_prompted?
+        ExceptionReporter::PermissionController.can_report_automatically?
+      end
+
+      report_error
+    end
+
+    def self.reportable_error?(error)
+      is_abort = error.is_a?(ShopifyCLI::Abort) || error.is_a?(ShopifyCLI::AbortSilent)
+      !is_abort
+    end
+  end
+end

data/lib/{shopify-cli → shopify_cli}/feature.rb

@@ -1,6 +1,6 @@
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::Feature contains the logic to hide and show features across the CLI
+  # ShopifyCLI::Feature contains the logic to hide and show features across the CLI
   # These features can be either commands or project types currently.
   #
   # Feature flags will persist between runs so if the flag is enabled or disabled,
@@ -9,7 +9,7 @@ module ShopifyCli
     SECTION = "features"
 
     ##
-    # ShopifyCli::Feature::Set is included on commands and projects to allow you to hide
+    # ShopifyCLI::Feature::Set is included on commands and projects to allow you to hide
     # and enable projects and commands based on feature flags.
     module Set
       ##
@@ -21,9 +21,9 @@ module ShopifyCli
       #
       # #### Example
       #
-      #    module ShopifyCli
+      #    module ShopifyCLI
       #      module Commands
-      #        class Config < ShopifyCli::Command
+      #        class Config < ShopifyCLI::Command
       #          hidden_feature(feature_set: :basic)
       #          ....
       #
@@ -41,7 +41,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #     ShopifyCli::Commands::Config.hidden?
+      #     ShopifyCLI::Commands::Config.hidden?
       #
       def hidden?
         enabled = (@hidden_feature_set || []).any? do |feature|
@@ -84,11 +84,11 @@ module ShopifyCli
       # * `is_enabled` - will be true if the feature has been enabled.
       def enabled?(feature)
         return false if feature.nil?
-        ShopifyCli::Config.get_bool(SECTION, feature.to_s)
+        ShopifyCLI::Config.get_bool(SECTION, feature.to_s)
       end
 
       def set(feature, value)
-        ShopifyCli::Config.set(SECTION, feature.to_s, value)
+        ShopifyCLI::Config.set(SECTION, feature.to_s, value)
       end
     end
   end

data/lib/{shopify-cli → shopify_cli}/form.rb

@@ -1,6 +1,6 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   class Form
     class << self
       def ask(ctx, args, flags)
@@ -12,7 +12,7 @@ module ShopifyCli
         begin
           form.ask
           form
-        rescue ShopifyCli::Abort => err
+        rescue ShopifyCLI::Abort => err
           ctx.puts(err.message)
           nil
         end

data/lib/{shopify-cli → shopify_cli}/git.rb

@@ -1,6 +1,6 @@
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::Git wraps git functionality to make it easier to integrate will
+  # ShopifyCLI::Git wraps git functionality to make it easier to integrate will
   # git.
   class Git
     class << self
@@ -18,7 +18,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   ShopifyCli::Git.sha
+      #   ShopifyCLI::Git.sha
       #
       def sha(dir: Dir.pwd, ctx: Context.new)
         rev_parse("HEAD", dir: dir, ctx: ctx)
@@ -40,7 +40,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   ShopifyCli::Git.clone('git@github.com:shopify/test.git', 'test-app')
+      #   ShopifyCLI::Git.clone('git@github.com:shopify/test.git', 'test-app')
       #
       def clone(repository, dest, ctx: Context.new)
         if Dir.exist?(dest)
@@ -66,7 +66,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   branches = ShopifyCli::Git.branches(@ctx)
+      #   branches = ShopifyCLI::Git.branches(@ctx)
       #
       def branches(ctx)
         output, status = ctx.capture2e("git", "branch", "--list", "--format=%(refname:short)")
@@ -91,7 +91,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   ShopifyCli::Git.init(@ctx)
+      #   ShopifyCLI::Git.init(@ctx)
       #
       def init(ctx)
         output, status = ctx.capture2e("git", "status")
@@ -105,11 +105,41 @@ module ShopifyCli
         end
       end
 
+      def sparse_checkout(repo, set, branch, ctx)
+        _, status = ctx.capture2e("git init")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.repo_not_initiated"))
+        end
+
+        _, status = ctx.capture2e("git remote add -f origin #{repo}")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.remote_not_added"))
+        end
+
+        _, status = ctx.capture2e("git config core.sparsecheckout true")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.sparse_checkout_not_enabled"))
+        end
+
+        _, status = ctx.capture2e("git sparse-checkout set #{set}")
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.sparse_checkout_not_set"))
+        end
+
+        resp, status = ctx.capture2e("git pull origin #{branch}")
+        unless status.success?
+          if resp.include?("fatal: couldn't find remote ref")
+            ctx.abort(ctx.message("core.git.error.pull_failed_bad_branch", branch))
+          end
+          ctx.abort(ctx.message("core.git.error.pull_failed"))
+        end
+      end
+
       private
 
       def exec(*args, dir: Dir.pwd, default: nil, ctx: Context.new)
-        args = %w(git) + args
-        out, _, stat = ctx.capture3(*args, chdir: dir)
+        args = %w(git) + ["--git-dir", File.join(dir, ".git")] + args
+        out, _, stat = ctx.capture3(*args)
         return default unless stat.success?
         out.chomp
       end

data/lib/{shopify-cli → shopify_cli}/helpers/haikunator.rb

@@ -23,7 +23,7 @@
 
 require "securerandom"
 
-module ShopifyCli
+module ShopifyCLI
   module Helpers
     module Haikunator
       class << self

data/lib/shopify_cli/helpers.rb

@@ -0,0 +1,5 @@
+module ShopifyCLI
+  module Helpers
+    autoload :Haikunator, "shopify_cli/helpers/haikunator"
+  end
+end

data/lib/{shopify-cli → shopify_cli}/heroku.rb

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   class Heroku
     DOWNLOAD_URLS = {
       linux: "https://cli-assets.heroku.com/heroku-linux-x64.tar.gz",
@@ -36,7 +36,7 @@ module ShopifyCli
     def download
       return if installed?
 
-      result = @ctx.system("curl", "-o", download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli.cache_dir)
+      result = @ctx.system("curl", "-o", download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCLI.cache_dir)
       @ctx.abort(@ctx.message("core.heroku.error.download")) unless result.success?
       @ctx.abort(@ctx.message("core.heroku.error.download")) unless File.exist?(download_path)
     end
@@ -47,7 +47,7 @@ module ShopifyCli
       result = if @ctx.windows?
         @ctx.system("\"#{download_path}\"")
       else
-        @ctx.system("tar", "-xf", download_path, chdir: ShopifyCli.cache_dir)
+        @ctx.system("tar", "-xf", download_path, chdir: ShopifyCLI.cache_dir)
       end
       @ctx.abort(@ctx.message("core.heroku.error.install")) unless result.success?
 
@@ -67,23 +67,33 @@ module ShopifyCli
       nil
     end
 
-    private
-
-    def download_filename
-      URI.parse(DOWNLOAD_URLS[@ctx.os]).path.split("/").last
+    def get_config(config)
+      output, status = @ctx.capture2e(heroku_command, "config:get", config.to_s)
+      return output.strip if status.success?
+      nil
     end
 
-    def download_path
-      File.join(ShopifyCli.cache_dir, download_filename)
+    def set_config(config, value)
+      result = @ctx.system(heroku_command, "config:set", "#{config}=#{value}")
+
+      msg = @ctx.message("core.heroku.error.set_config", config, value)
+      @ctx.abort(msg) unless result.success?
     end
 
-    def git_remote
-      output, status = @ctx.capture2e("git", "remote", "get-url", "heroku")
-      status.success? ? output : nil
+    def add_buildpacks(buildpacks)
+      result = @ctx.system(heroku_command, "buildpacks:clear")
+      msg = @ctx.message("core.heroku.error.add_buildpacks")
+      @ctx.abort(msg) unless result.success?
+
+      buildpacks.each do |buildpack|
+        result = @ctx.system(heroku_command, "buildpacks:add", buildpack)
+        msg = @ctx.message("core.heroku.error.add_buildpacks")
+        @ctx.abort(msg) unless result.success?
+      end
     end
 
     def heroku_command
-      local_path = File.join(ShopifyCli.cache_dir, "heroku", "bin", "heroku").to_s
+      local_path = File.join(ShopifyCLI.cache_dir, "heroku", "bin", "heroku").to_s
       if File.exist?(local_path)
         local_path
       elsif @ctx.windows?
@@ -103,6 +113,21 @@ module ShopifyCli
       end
     end
 
+    private
+
+    def download_filename
+      URI.parse(DOWNLOAD_URLS[@ctx.os]).path.split("/").last
+    end
+
+    def download_path
+      File.join(ShopifyCLI.cache_dir, download_filename)
+    end
+
+    def git_remote
+      output, status = @ctx.capture2e("git", "remote", "get-url", "heroku")
+      status.success? ? output : nil
+    end
+
     def installed?
       _output, status = @ctx.capture2e(heroku_command, "--version")
       status.success?

data/lib/{shopify-cli → shopify_cli}/http_request.rb

@@ -1,7 +1,7 @@
 require "net/http"
 require "openssl"
 
-module ShopifyCli
+module ShopifyCLI
   class HttpRequest
     class << self
       def post(uri, body, headers)

data/lib/{shopify-cli → shopify_cli}/identity_auth/servlet.rb

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   class IdentityAuth
     class Servlet < WEBrick::HTTPServlet::AbstractServlet
       TEMPLATE = %{<!DOCTYPE html>

data/lib/{shopify-cli → shopify_cli}/identity_auth.rb

@@ -8,16 +8,15 @@ require "shopify_cli"
 require "uri"
 require "webrick"
 
-module ShopifyCli
+module ShopifyCLI
   class IdentityAuth
     include SmartProperties
 
-    autoload :Servlet, "shopify-cli/identity_auth/servlet"
+    autoload :Servlet, "shopify_cli/identity_auth/servlet"
 
     class Error < StandardError; end
     class Timeout < StandardError; end
     LocalRequest = Struct.new(:method, :path, :query, :protocol)
-    LOCAL_DEBUG = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
 
     DEFAULT_PORT = 3456
     REDIRECT_HOST = "http://127.0.0.1:#{DEFAULT_PORT}"
@@ -50,7 +49,7 @@ module ShopifyCli
     ]
 
     property! :ctx
-    property :store, default: -> { ShopifyCli::DB.new }
+    property :store, default: -> { ShopifyCLI::DB.new }
     property :state_token, accepts: String, default: SecureRandom.hex(30)
     property :code_verifier, accepts: String, default: SecureRandom.hex(30)
 
@@ -71,7 +70,7 @@ module ShopifyCli
 
     def reauthenticate
       return if refresh_exchange_tokens || refresh_access_tokens
-      ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCli::TOOL_NAME))
+      ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCLI::TOOL_NAME))
     end
 
     def code_challenge
@@ -94,8 +93,8 @@ module ShopifyCli
     end
 
     def self.delete_tokens_and_keys
-      ShopifyCli::DB.del(*IDENTITY_ACCESS_TOKENS)
-      ShopifyCli::DB.del(*EXCHANGE_TOKENS)
+      ShopifyCLI::DB.del(*IDENTITY_ACCESS_TOKENS)
+      ShopifyCLI::DB.del(*EXCHANGE_TOKENS)
     end
 
     private
@@ -213,7 +212,7 @@ module ShopifyCli
       https = Net::HTTP.new(uri.host, uri.port)
       https.use_ssl = true
       request = Net::HTTP::Post.new(uri.path)
-      request["User-Agent"] = "Shopify CLI #{::ShopifyCli::VERSION}"
+      request["User-Agent"] = "Shopify CLI #{::ShopifyCLI::VERSION}"
       request.body = URI.encode_www_form(params)
       res = https.request(request)
       unless res.is_a?(Net::HTTPSuccess)
@@ -236,12 +235,17 @@ module ShopifyCli
     end
 
     def auth_url
-      return "https://accounts.shopify.com/oauth" if ENV[LOCAL_DEBUG].nil?
-      "https://identity.myshopify.io/oauth"
+      if Environment.use_local_partners_instance?
+        "https://identity.myshopify.io/oauth"
+      elsif Environment.use_spin_partners_instance?
+        "https://identity.#{Environment.spin_url}/oauth"
+      else
+        "https://accounts.shopify.com/oauth"
+      end
     end
 
     def client_id_for_application(application_name)
-      client_ids = if ENV[LOCAL_DEBUG]
+      client_ids = if Environment.use_local_partners_instance? || Environment.use_spin_partners_instance?
         DEV_APPLICATION_CLIENT_IDS
       else
         APPLICATION_CLIENT_IDS
@@ -252,31 +256,20 @@ module ShopifyCli
 
     def scopes(additional_scopes = [])
       (["openid"] + additional_scopes).tap do |result|
-        result << "employee" if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        result << "employee" if ShopifyCLI::Shopifolk.acting_as_shopify_organization?
       end.join(" ")
     end
 
     def client_id
-      return "fbdb2649-e327-4907-8f67-908d24cfd7e3" if ENV[LOCAL_DEBUG].nil?
-
-      ctx.abort(ctx.message("core.identity_auth.error.local_identity_not_running")) unless local_identity_running?
-
-      # Fetch the client ID from the local Identity Dynamic Registration endpoint
-      response = post_request("/client", {
-        name: "shopify-cli-development",
-        public_type: "native",
-      })
-
-      response["client_id"]
-    end
-
-    def local_identity_running?
-      Net::HTTP.start("identity.myshopify.io", 443, use_ssl: true, open_timeout: 1, read_timeout: 10) do |http|
-        req = Net::HTTP::Get.new(URI.join("https://identity.myshopify.io", "/services/ping"))
-        http.request(req).is_a?(Net::HTTPSuccess)
+      if Environment.use_local_partners_instance? || Environment.use_spin_partners_instance?
+        Constants::Identity::CLIENT_ID_DEV
+      else
+        # In the future we might want to use Identity's dynamic
+        # registration. To migrate to a dynamic client ID we
+        # need to refactor some code that relies on a static
+        # value for the client
+        Constants::Identity::CLIENT_ID
       end
-    rescue Timeout::Error, Errno::EHOSTUNREACH, Errno::EHOSTDOWN, Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED
-      false
     end
   end
 end

data/lib/{shopify-cli → shopify_cli}/js_deps.rb

@@ -1,17 +1,17 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::JsDeps ensures that all JavaScript dependencies are installed for projects.
+  # ShopifyCLI::JsDeps ensures that all JavaScript dependencies are installed for projects.
   #
   class JsDeps
     include SmartProperties
 
-    property! :ctx, accepts: ShopifyCli::Context
+    property! :ctx, accepts: ShopifyCLI::Context
     property! :system, accepts: JsSystem, default: -> { JsSystem.new(ctx: ctx) }
 
     ##
-    # Proxy to instance method ShopifyCli::JsDeps.new.install.
+    # Proxy to instance method ShopifyCLI::JsDeps.new.install.
     #
     # #### Parameters
     # - `ctx`: running context from your command
@@ -19,7 +19,7 @@ module ShopifyCli
     #
     # #### Example
     #
-    #   ShopifyCli::JsDeps.install(ctx)
+    #   ShopifyCLI::JsDeps.install(ctx)
     #
     def self.install(ctx, verbose = false)
       new(ctx: ctx).install(verbose)
@@ -34,7 +34,7 @@ module ShopifyCli
     # #### Example
     #
     #   # context is the running context for the command
-    #   ShopifyCli::JsDeps.new(context).install(true)
+    #   ShopifyCLI::JsDeps.new(context).install(true)
     #
     def install(verbose = false)
       title = ctx.message("core.js_deps.installing", @system.package_manager)
@@ -104,7 +104,7 @@ module ShopifyCli
         ctx.message("core.js_deps.error.invalid_package", File.read(File.join(path, "package.json"))),
         error: true
       )
-      raise ShopifyCli::AbortSilent
+      raise ShopifyCLI::AbortSilent
     end
   end
 end

data/lib/{shopify-cli → shopify_cli}/js_system.rb

@@ -1,8 +1,8 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::JsSystem allows conditional system calls of npm or yarn commands.
+  # ShopifyCLI::JsSystem allows conditional system calls of npm or yarn commands.
   #
   class JsSystem
     include SmartProperties
@@ -12,21 +12,21 @@ module ShopifyCli
 
     class << self
       ##
-      # Proxy to instance method `ShopifyCli::JsSystem.new.yarn?`
+      # Proxy to instance method `ShopifyCLI::JsSystem.new.yarn?`
       #
       # #### Parameters
       # - `ctx`: running context from your command
       #
       # #### Example
       #
-      #   ShopifyCli::JsSystem.yarn?(ctx)
+      #   ShopifyCLI::JsSystem.yarn?(ctx)
       #
       def yarn?(ctx)
         JsSystem.new(ctx: ctx).yarn?
       end
 
       ##
-      # Proxy to instance method `ShopifyCli::JsSystem.new.call`
+      # Proxy to instance method `ShopifyCLI::JsSystem.new.call`
       #
       # #### Parameters
       # - `ctx`: running context from your command
@@ -35,21 +35,21 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   ShopifyCli::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+      #   ShopifyCLI::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
       #
       def call(ctx, yarn:, npm:, capture_response: false)
         JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm, capture_response: capture_response)
       end
     end
 
-    property :ctx, accepts: ShopifyCli::Context
+    property :ctx, accepts: ShopifyCLI::Context
 
     ##
     # Returns the name of the JS package manager being used
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).package_manager
+    #   ShopifyCLI::JsSystem.new(ctx: ctx).package_manager
     #
     def package_manager
       yarn? ? YARN_CORE_COMMAND : NPM_CORE_COMMAND
@@ -60,7 +60,7 @@ module ShopifyCli
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).yarn?
+    #   ShopifyCLI::JsSystem.new(ctx: ctx).yarn?
     #
     def yarn?
       @has_yarn ||= begin
@@ -80,7 +80,7 @@ module ShopifyCli
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).call(
+    #   ShopifyCLI::JsSystem.new(ctx: ctx).call(
     #     yarn: ['install', '--silent'],
     #     npm: ['install', '--no-audit'],
     #     capture_response: false

data/lib/{shopify-cli → shopify_cli}/lazy_delegator.rb

@@ -1,6 +1,6 @@
 require "delegate"
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # `LazyDelegator` defers initialization of its underlying delegatee until the
   # latter is accessed for the first time due to a method call that the
@@ -16,7 +16,7 @@ module ShopifyCli
   # LazyDelegator lends itself to being subclassed in scenarios where some
   # facts are known and others are costly to compute:
   #
-  #   class LazySpecificationHandler < ShopifyCli::LazyDelegator
+  #   class LazySpecificationHandler < ShopifyCLI::LazyDelegator
   #     attr_reader :identifier
   #
   #     def initialize(identifier, &initializer)