@shopify/cli-kit 3.39.0 → 3.40.0

package/assets/cli-ruby/lib/shopify_cli.rb

@@ -0,0 +1,191 @@
+# Make sure we are using UTF 8 encoding
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+Thread.report_on_exception = false
+
+# Contains backports from newer rubies to make our lives easier
+# 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)
+
+# 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 ruby2_keywords 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 "ruby2_keywords"
+require "cli/ui"
+require "cli/kit"
+require "smart_properties"
+require_relative "shopify_cli/version"
+require_relative "shopify_cli/migrator"
+require_relative "shopify_cli/exception_reporter"
+
+# 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/main/lib/cli/ui/stdout_router.rb for more info
+CLI::UI::StdoutRouter.enable
+
+# The main file to load for `shopify-cli`
+# Contains all high level constants, exit management, exception management,
+# autoloads for commands, tasks, helpers, etc
+#
+# It is recommended to read through CLI Kit (https://github.com/shopify/cli-kit) and a CLI Kit example
+# (https://github.com/Shopify/cli-kit-example) to fully understand how shopify-cli functions
+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")
+
+  # programmer emoji if default install location, else wrench emoji
+  EMOJI    = ROOT == "/opt/shopify" ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
+  # shrug or boom emoji
+  FAILMOJI = ROOT == "/opt/shopify" ? "\u{1f937}" : "\u{1f4a5}"
+
+  # Exit management in `shopify-cli` follows the management set out by CLI Kit.
+  # https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit.rb
+  # That is to say, we differentiate between exit success (0), exit failure (1), and exit bug (not 1)
+  #
+  # These should *never* be called outside of the entrypoint and its delegations.
+  EXIT_FAILURE_BUT_NOT_BUG = CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+  EXIT_BUG                 = CLI::Kit::EXIT_BUG
+  EXIT_SUCCESS             = CLI::Kit::EXIT_SUCCESS
+
+  # `shopify-cli` uses CLI Kit's exception management
+  # These are documented here: https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit.rb
+  #
+  # You should never subclass these exceptions, but instead rescue another exception and re-raise.
+  # AbortSilent and BugSilent should never have messages. They are mostly used when we output explanations
+  # and need to exit
+  GenericAbort = CLI::Kit::GenericAbort
+  Abort        = CLI::Kit::Abort
+  Bug          = CLI::Kit::Bug
+  BugSilent    = CLI::Kit::BugSilent
+  AbortSilent  = CLI::Kit::AbortSilent
+
+  # The rest of this file outlines classes and modules required by the shopify-cli
+  # application and CLI kit framework.
+  # To understand how this works, read https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit.rb
+
+  # ShopifyCLI::Config
+  autocall(:Config)   { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
+  # ShopifyCLI::Logger
+  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCLI.debug_log_file) }
+  # ShopifyCLI::Resolver
+  autocall(:Resolver) do
+    ShopifyCLI::Core::HelpResolver.new(
+      tool_name: TOOL_NAME,
+      command_registry: ShopifyCLI::Commands::Registry
+    )
+  end
+  # ShopifyCLI::ErrorHandler
+  autocall(:ErrorHandler) do
+    CLI::Kit::ErrorHandler.new(
+      log_file: ShopifyCLI.log_file,
+      exception_reporter: ->() { ShopifyCLI::ExceptionReporter },
+    )
+  end
+
+  autoload :AdminAPI, "shopify_cli/admin_api"
+  autoload :API, "shopify_cli/api"
+  autoload :AppTypeDetector, "shopify_cli/app_type_detector"
+  autoload :Command, "shopify_cli/command"
+  autoload :CommandOptions, "shopify_cli/command_options"
+  autoload :Commands, "shopify_cli/commands"
+  autoload :Connect, "shopify_cli/connect"
+  autoload :Constants, "shopify_cli/constants"
+  autoload :Context, "shopify_cli/context"
+  autoload :Core, "shopify_cli/core"
+  autoload :DB, "shopify_cli/db"
+  autoload :Environment, "shopify_cli/environment"
+  autoload :Feature, "shopify_cli/feature"
+  autoload :Form, "shopify_cli/form"
+  autoload :Git, "shopify_cli/git"
+  autoload :GitHub, "shopify_cli/github"
+  autoload :Helpers, "shopify_cli/helpers"
+  autoload :Heroku, "shopify_cli/heroku"
+  autoload :IdentityAuth, "shopify_cli/identity_auth"
+  autoload :JsDeps, "shopify_cli/js_deps"
+  autoload :JsSystem, "shopify_cli/js_system"
+  autoload :LazyDelegator, "shopify_cli/lazy_delegator"
+  autoload :MethodObject, "shopify_cli/method_object"
+  autoload :Options, "shopify_cli/options"
+  autoload :PartnersAPI, "shopify_cli/partners_api"
+  autoload :PHPDeps, "shopify_cli/php_deps"
+  autoload :ProcessSupervision, "shopify_cli/process_supervision"
+  autoload :Project, "shopify_cli/project"
+  autoload :ProjectType, "shopify_cli/project_type"
+  autoload :ReportingConfigurationController, "shopify_cli/reporting_configuration_controller"
+  autoload :ResolveConstant, "shopify_cli/resolve_constant"
+  autoload :Resources, "shopify_cli/resources"
+  autoload :Result, "shopify_cli/result"
+  autoload :Services, "shopify_cli/services"
+  autoload :Shopifolk, "shopify_cli/shopifolk"
+  autoload :Task, "shopify_cli/task"
+  autoload :Tasks, "shopify_cli/tasks"
+  autoload :TransformDataStructure, "shopify_cli/transform_data_structure"
+  autoload :Tunnel, "shopify_cli/tunnel"
+  autoload :Utilities, "shopify_cli/utilities"
+
+  require "shopify_cli/messages/messages"
+  Context.load_messages(ShopifyCLI::Messages::MESSAGES)
+
+  # cli-ui utilities for capturing the output close the stream while capturing.
+  # By setting the value here we persist the tty value for the whole lifetime of the process.
+  Environment.interactive = $stdin.tty?
+
+  def self.cache_dir
+    cache_dir = if Environment.test?
+      TEMP_DIR
+    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)
+    end
+
+    # Make sure the cache dir always exists
+    @cache_dir_exists ||= FileUtils.mkdir_p(cache_dir)
+
+    cache_dir
+  end
+
+  def self.tool_config_path
+    if Environment.test?
+      TEMP_DIR
+    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)
+    end
+  end
+
+  def self.log_file
+    File.join(tool_config_path, "logs", "log.log")
+  end
+
+  def self.debug_log_file
+    File.join(tool_config_path, "logs", "debug.log")
+  end
+
+  def self.sha
+    return @sha if defined?(@sha)
+    @sha = Git.sha(dir: ShopifyCLI::ROOT)
+  end
+
+  # Migrate runs migrations that migrate the state of the environment
+  # in which the CLI runs.
+  unless ShopifyCLI::Environment.test? || ShopifyCLI::Environment.development?
+    ShopifyCLI::Migrator.migrate
+  end
+end

package/assets/cli-ruby/shipit.rubygems.yml

@@ -0,0 +1,3 @@
+deploy:
+  post:
+    - bundle exec rake notify_version_to_bugsnag

package/assets/cli-ruby/shopify-cli.gemspec

@@ -0,0 +1,54 @@
+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.summary = "Shopify CLI helps you build Shopify apps faster."
+  spec.description = <<~HERE
+    Shopify CLI helps you build Shopify apps faster. It quickly scaffolds Node.js
+    and Ruby on Rails embedded apps. It also automates many common tasks in the
+    development process and lets you quickly add popular features, such as billing
+    and webhooks.
+  HERE
+  spec.homepage = "https://shopify.github.io/shopify-cli/"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Shopify/shopify-cli"
+  spec.metadata["changelog_uri"] = "https://github.com/Shopify/shopify-cli/blob/main/CHANGELOG.md"
+
+  # 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
+    %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)$})
+    end
+  end
+  spec.bindir = "bin"
+  spec.require_paths = ["lib", "vendor"]
+  spec.executables << "shopify"
+
+  spec.add_development_dependency("bundler", "~> 2.3.11")
+  spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
+  spec.add_development_dependency("minitest", "~> 5.0")
+
+  spec.add_dependency("bugsnag", "~> 6.22")
+  spec.add_dependency("listen", "~> 3.7.0")
+
+  # We prefer being more strict here with the version range to have a more deterministic build.
+  # The added benefit is that, if the user upgrades the CLI, and we have "~> 1.10.1" version range,
+  # they will get a theme-check update.
+  # Whereas if we were to have "~> 1.9", that version would still be satisfied and thus not upgraded.
+  # Both shopify-cli and theme-check gems are owned and developed by Shopify.
+  # These gems are currently being actively developed and it's easiest to update them together.
+  spec.add_dependency("theme-check", "~> 1.14.0")
+
+  spec.extensions = ["ext/shopify-extensions/extconf.rb"]
+end

package/assets/cli-ruby/shopify-dev

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require_relative "./bin/load_shopify"
+
+exit(proc do
+  ShopifyCLI::ErrorHandler.call do
+    ShopifyCLI::Core::EntryPoint.call(ARGV.dup)
+  end
+     rescue StandardError => error
+       ShopifyCLI::ErrorHandler.exception = error
+       if ShopifyCLI::Environment.print_stacktrace?
+         raise error
+       else
+         1
+       end
+end.call)

package/assets/cli-ruby/test/minitest_ext.rb

@@ -0,0 +1,115 @@
+module Minitest
+  module Assertions
+    def assert_nothing_raised(*)
+      yield
+    end
+  end
+
+  class Test
+    FIXTURE_DIR = File.expand_path("fixtures", File.dirname(__FILE__))
+    CONFIG_FILE = CLI::Kit::Config.new(tool_name: ShopifyCLI::TOOL_NAME).file
+
+    include TestHelpers::Project
+
+    def setup
+      @minitest_ext_setup_called = true
+      if File.exist?(CONFIG_FILE)
+        @config_sha_before = Digest::SHA256.hexdigest(File.read(CONFIG_FILE))
+      end
+      project_context("project")
+      ::ShopifyCLI::Project.clear
+      super
+    end
+
+    def teardown
+      # Some tests stub the File class, but we need to call the real methods when checking if the config file has
+      # changed.
+      #
+      # We could unstub them individually:
+      #  File.unstub(:read)
+      #  File.unstub(:exist?)
+      #
+      # Or we can use `mocha_teardown` which is documented as "only for use by authors of test libraries" but seems safe
+      # here.
+
+      mocha_teardown
+
+      if File.exist?(CONFIG_FILE)
+        @config_sha_after = Digest::SHA256.hexdigest(File.read(CONFIG_FILE))
+      end
+
+      raise "Local #{CONFIG_FILE} was modified by a test" unless @config_sha_before == @config_sha_after
+
+      unless @minitest_ext_setup_called
+        raise "teardown called without setup - you may have forgotten to call `super`"
+      end
+
+      @minitest_ext_setup_called = nil
+      super
+    end
+
+    def run_cmd(cmd, split_cmd = true)
+      stub_prompt_for_cli_updates
+      stub_new_version_check
+
+      new_cmd = split_cmd ? cmd.split : cmd
+      ShopifyCLI::Core::EntryPoint.call(new_cmd, @context)
+    end
+
+    def capture_io(strip_ansi: false, &block)
+      cap = CLI::UI::StdoutRouter::Capture.new(with_frame_inset: true, &block)
+      @context.output_captured = true if @context
+      cap.run
+      @context.output_captured = false if @context
+      [cap.stdout, cap.stderr].map do |s|
+        strip_ansi ? CLI::UI::ANSI.strip_codes(s) : s
+      end
+    end
+
+    def capture_io_and_assert_raises(exception_class)
+      io = []
+      io << capture_io do
+        exception = assert_raises(exception_class) { yield }
+        io << CLI::UI.fmt(exception.message.gsub("{{x}} ", ""))
+      end
+    end
+
+    def assert_message_output(io:, expected_content:)
+      all_output = io.join
+
+      Array(expected_content).each do |expected|
+        assert_includes all_output, CLI::UI.fmt(expected)
+      end
+    end
+
+    def to_s # :nodoc:
+      if passed? && !skipped?
+        return location
+      end
+      failures.flat_map do |failure|
+        [
+          "#{failure.result_label}:",
+          "#{location}:",
+          failure.message.force_encoding(Encoding::UTF_8),
+        ]
+      end.join("\n")
+    end
+
+    private
+
+    def stub_prompt_for_cli_updates
+      ShopifyCLI::Config.stubs(:get_section).with("autoupdate").returns("enabled" => "true")
+    end
+
+    def stub_new_version_check
+      stub_request(:get, ShopifyCLI::Context::GEM_LATEST_URI)
+        .with(headers: {
+          "Accept" => "*/*",
+          "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+          "Host" => "rubygems.org",
+          "User-Agent" => "Ruby",
+        })
+        .to_return(status: 200, body: "{\"version\":\"#{ShopifyCLI::VERSION}\"}", headers: {})
+    end
+  end
+end

package/assets/cli-ruby/test/project_types/extension/extension_test_helpers.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Extension
+  module ExtensionTestHelpers
+    autoload :FakeExtensionProject, "project_types/extension/extension_test_helpers/fake_extension_project"
+    autoload :TestExtension, "project_types/extension/extension_test_helpers/test_extension"
+    autoload :TestExtensionSetup, "project_types/extension/extension_test_helpers/test_extension_setup"
+    autoload :TempProjectSetup, "project_types/extension/extension_test_helpers/temp_project_setup"
+    autoload :DummyArgo, "project_types/extension/extension_test_helpers/dummy_argo"
+    autoload :DummySpecifications, "project_types/extension/extension_test_helpers/dummy_specifications"
+
+    module Stubs
+      autoload :GetOrganizations, "project_types/extension/extension_test_helpers/stubs/get_organizations"
+      autoload :GetApp, "project_types/extension/extension_test_helpers/stubs/get_app"
+      autoload :CreateExtension, "project_types/extension/extension_test_helpers/stubs/create_extension"
+      autoload :UpdateDraft, "project_types/extension/extension_test_helpers/stubs/update_draft"
+      autoload :ArgoScript, "project_types/extension/extension_test_helpers/stubs/argo_script"
+      autoload :FetchSpecifications, "project_types/extension/extension_test_helpers/stubs/fetch_specifications"
+    end
+
+    def self.test_specifications(type_identifier: "TEST_EXTENSION")
+      DummySpecifications.build(
+        identifier: type_identifier.downcase,
+        custom_handler_root: File.expand_path("../", __FILE__),
+        custom_handler_namespace: ::Extension::ExtensionTestHelpers,
+      )
+    end
+
+    def self.test_specification_handler(type_identifier: "TEST_EXTENSION")
+      specification_handler = test_specifications[type_identifier]
+      if specification_handler.nil?
+        raise "Unable to retrieve specification handler due to broken test setup"
+      end
+
+      specification_handler
+    end
+
+    def self.fake_extension_project(
+      with_mocks: false,
+      api_key: "TEST_KEY",
+      api_secret: "TEST_SECRET",
+      directory: "fake/dir",
+      title: "Test",
+      type_identifier: "TEST_EXTENSION",
+      registration_id: 55,
+      registration_uuid: "db946ca8-a925-11eb-bcbc-0242ac130002"
+    )
+      project = FakeExtensionProject.new(
+        directory: directory,
+        api_key: api_key,
+        api_secret: api_secret,
+        title: title,
+        type: type_identifier,
+        registration_id: registration_id,
+        registration_uuid: registration_uuid
+      )
+
+      if with_mocks
+        ShopifyCLI::Project.stubs(:current).returns(project)
+        ShopifyCLI::Project.stubs(:has_current?).returns(true)
+        ExtensionProject.stubs(:current).returns(project)
+        Extension::Loaders::Project.stubs(:load).returns(project)
+        specifications = test_specifications(type_identifier: type_identifier)
+        Models::Specifications.stubs(:new).returns(specifications)
+      end
+
+      project
+    end
+  end
+end

package/assets/cli-ruby/test/shopify-cli/migrator/migrations/migration_helper.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+
+module ShopifyCLI
+  module Migrator
+    module Migrations
+      module MigrationHelper
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def require_migration(path)
+            migration_name = File.basename(path).gsub("_test.rb", "")
+            require("shopify_cli/migrator/migrations/#{migration_name}")
+          end
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/test/test_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module TestHelpers
+  autoload :Command, "test_helpers/command"
+  autoload :Constants, "test_helpers/constants"
+  autoload :FakeTask, "test_helpers/fake_task"
+  autoload :FakeContext, "test_helpers/fake_context"
+  autoload :FakeDB, "test_helpers/fake_db"
+  autoload :FakeFS, "test_helpers/fake_fs"
+  autoload :FakeProject, "test_helpers/fake_project"
+  autoload :FakeUI, "test_helpers/fake_ui"
+  autoload :Heroku, "test_helpers/heroku"
+  autoload :Partners, "test_helpers/partners"
+  autoload :Project, "test_helpers/project"
+  autoload :Schema, "test_helpers/schema"
+  autoload :Shopifolk, "test_helpers/shopifolk"
+  autoload :Singleton, "test_helpers/singleton"
+  autoload :TemporaryDirectory, "test_helpers/temporary_directory"
+end

package/assets/cli-ruby/utilities/constants.rb

@@ -0,0 +1,7 @@
+module Utilities
+  module Constants
+    module Paths
+      ROOT = File.expand_path("..", __dir__)
+    end
+  end
+end

package/assets/cli-ruby/utilities/docker/container.rb

@@ -0,0 +1,104 @@
+require "open3"
+require "colorize"
+
+module Utilities
+  module Docker
+    class Container
+      SHOPIFY_PATH = "/usr/src/app"
+      SHOPIFY_BIN_PATH = "/usr/src/app/bin/shopify"
+
+      Error = Class.new(StandardError)
+
+      attr_reader :id, :env, :cwd, :xdg_config_home, :xdg_cache_home
+
+      def initialize(id:, env:, cwd:)
+        @id = id
+        @cwd = cwd
+        @xdg_config_home = File.join(cwd, ".config")
+        @xdg_cache_home = File.join(cwd, ".cache")
+        @env = env.merge({
+          "XDG_CONFIG_HOME" => @xdg_config_home,
+          "XDG_CACHE_HOME" => @xdg_cache_home,
+        })
+      end
+
+      def remove
+        _, stderr, stat = Open3.capture3(
+          "docker", "rm", "-f", @id
+        )
+        raise Error, stderr unless stat.success?
+      end
+
+      def capture_shopify(*args)
+        capture(*([SHOPIFY_BIN_PATH] + args))
+      end
+
+      def capture(*args, relative_dir: nil)
+        command = ["docker", "exec"]
+        cwd = if relative_dir.nil?
+          @cwd
+        else
+          File.join(@cwd, relative_dir)
+        end
+        command += ["-w", cwd]
+        @env.each do |env_name, env_value|
+          command += ["--env", "#{env_name}=#{env_value}"]
+        end
+        command << @id
+        command += args
+
+        out, err, stat = Open3.capture3(*command)
+        raise Error, err unless stat.success?
+        out
+      end
+
+      def exec_shopify(*args, relative_dir: nil)
+        exec(*([SHOPIFY_BIN_PATH] + args), relative_dir: relative_dir)
+      end
+
+      def exec(*args, relative_dir: nil)
+        if ARGV.include?("--verbose")
+          running_prefix = "Running command: #{args.join(" ")}"
+          STDOUT.puts(running_prefix.colorize(:yellow).bold)
+        end
+        command = ["docker", "exec"]
+        cwd = if relative_dir.nil?
+          @cwd
+        else
+          File.join(@cwd, relative_dir)
+        end
+        command += ["-w", cwd]
+        @env.each do |env_name, env_value|
+          command += ["--env", "#{env_name}=#{env_value}"]
+        end
+        command << @id
+        command += args
+
+        docker_prefix = "Docker (#{args.first}):"
+
+        if ARGV.include?("--verbose")
+          stat = Open3.popen3(*command) do |stdin, stdout, stderr, wait_thread|
+            Thread.new do
+              stdout.each { |l| STDOUT.puts("#{docker_prefix.colorize(:cyan).bold} #{l}") } unless stdout&.nil?
+            end
+            Thread.new do
+              stderr.each { |l| STDERR.puts("#{docker_prefix.colorize(:red).bold} #{l}") } unless stderr&.nil?
+            end
+            stdin.close
+
+            status = wait_thread.value
+
+            stdout.close
+            stderr.close
+
+            status
+          end
+          raise StandardError, "The command #{args.first} failed" unless stat.success?
+        else
+          out, stat = Open3.capture2e(*command)
+          raise Error, out unless stat.success?
+        end
+      end
+    end
+  end
+end