@shopify/cli-kit 3.39.0 → 3.40.0

package/assets/cli-ruby/Tests.dockerfile

@@ -0,0 +1,35 @@
+# This is a Docker image to test the CLI in UNIX environments other than macOS
+# Build the image: docker build . -t shopify-cli
+# Run tests: docker run -t --rm --volume "$(pwd):/usr/src/app" shopify-cli bundle exec rake test
+FROM cimg/ruby:2.7.5
+
+RUN git config --global user.email "development-lifecycle@shopify.com"
+RUN git config --global user.name "Development Lifecycle"
+
+RUN gem install bundler -v 2.3.11
+
+WORKDIR /usr/src/app
+
+COPY Gemfile Gemfile.lock ./
+COPY shopify-cli.gemspec  shopify-cli.gemspec
+COPY lib/shopify_cli/version.rb  lib/shopify_cli/version.rb
+RUN bundle install
+
+# Update git
+RUN sudo add-apt-repository -y ppa:git-core/ppa
+RUN sudo apt-get update
+RUN sudo apt-get install git -y
+
+# Install the latest version of NodeJS
+RUN sudo apt-get install ca-certificates -y
+RUN curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash -
+RUN sudo apt-get install -y nodejs
+
+# Install the latest version of Yarn
+RUN sudo npm install --global yarn
+
+# Python is necessary to compile NPM packages with native extensions through node-gyp
+RUN sudo apt install python2-minimal -y
+
+# Install sqlite3
+RUN sudo apt-get install libsqlite3-dev -y

package/assets/cli-ruby/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "load_shopify"
+require "irb"
+require "irb/completion"
+require "irb/ext/save-history"
+
+IRB.conf[:SAVE_HISTORY] = 100
+IRB.conf[:HISTORY_FILE] = File.expand_path("../../.console_history", __FILE__)
+IRB.start

package/assets/cli-ruby/bin/load_shopify.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+ENV["SHELLPID"] ||= Process.ppid.to_s
+ENV["USER_PWD"] ||= Dir.pwd
+
+# Prune non-absolute paths from PATH to prevent non-deterministic behavior
+# i.e. If user has "." or "./bin" in their PATH
+# Note that this logic is duplicated in lib/shopify.rb
+ENV["PATH"] = ENV["PATH"].split(File::PATH_SEPARATOR).select do |p|
+  p.start_with?("/", "~", /[A-Z]:\\/)
+end.join(File::PATH_SEPARATOR)
+
+$original_env = ENV.to_hash
+
+require "shopify_cli"
+
+if ENV["PRINT_LOADED_FEATURES"]
+  puts $LOADED_FEATURES
+end

package/assets/cli-ruby/bin/shopify

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+module Kernel
+  # make an alias of the original require
+  alias_method :original_require, :require
+
+  # rewrite require
+  def require(name)
+    original_require(name)
+  rescue LoadError => e
+    # Special case for readline.so, which fails harmlessly on Windows
+    raise if (name == "readline.so") && ShopifyCLI::Context.new.windows?
+    # Special case for psych (yaml), which rescues this itself
+    raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
+    # Special case for ffi, which rescues this itself
+    raise if name == "#{RUBY_VERSION.split(".")[0, 2].join(".")}/ffi_c"
+    # Special case for nokogiri, which might install the wrong architecture
+    if name == "nokogiri/nokogiri"
+      STDERR.puts(<<~MESSAGE)
+        The Nokogiri gem is failing to load, due to an installation or architecture issue.
+
+        To fix this, reinstall Nokogiri.
+
+        • Installation guide: https://nokogiri.org/tutorials/installing_nokogiri.html
+
+      MESSAGE
+      STDERR.puts e.full_message
+      exit(1)
+    end
+    STDERR.puts "[Note] You cannot use gems with Shopify CLI."
+    STDERR.puts "[LoadError] #{e.message}"
+    if ENV["DEBUG"]
+      STDERR.puts e.backtrace
+      STDERR.puts "\n"
+    end
+    STDERR.puts "       They are disabled."
+    STDERR.puts "       Please don't modify the CLI locally."
+    STDERR.puts "       If you would like to contribute to the CLI project, please refer to"
+    STDERR.puts "       https://github.com/Shopify/shopify-cli/blob/main/.github/CONTRIBUTING.md"
+    STDERR.puts "\n"
+    raise
+  end
+end
+
+require_relative "./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/bin/shopify.bat

@@ -0,0 +1,3 @@
+@ECHO OFF
+
+ruby "%~dp0\shopify" %*

package/assets/cli-ruby/dev.yml

@@ -0,0 +1,29 @@
+name: dev
+type:
+  - ruby
+
+env:
+  SHOPIFY_CLI_DEVELOPMENT: "1"
+
+up:
+  - ruby: 3.1.0
+  - homebrew:
+      - dpkg:
+          version: 1.21.1
+      - rpm:
+          version: 4.17.0
+  - bundler
+
+test:
+  desc: "Run tests."
+  run: |
+    if [ "$#" -eq 1 ] && [[ -f $1 ]];
+    then
+      bundle exec rake test TEST=$1
+    else
+      bundle exec rake test $@
+    fi
+
+commands:
+  style:
+    run: bundle exec rubocop .

package/assets/cli-ruby/docs/README.md

@@ -0,0 +1,13 @@
+# Documentation
+
+This directory contains documentation for **contributors** of the Shopify CLI.
+It also contains documentation that is relevant to **users** like migration guidelines.
+
+## Contributors
+
+- [**Testing**](contributors/testing.md): Read about testing strategies and how they are used across the codebase.
+
+## Users
+
+- [**Installation**](users/installation.md): Learn how to install the Shopify CLI in different OSs.
+- [**Migrate from theme-kit**](users/migrate-from-themekit.md): If you were previously using theme-kit, check out this documentation to learn how to migrate to the Shopify CLI theme commands.

package/assets/cli-ruby/docs/contributors/testing.md

@@ -0,0 +1,27 @@
+## Testing
+
+The project employs a diverse suite tests that help ensure it works as intended and prevents regressions as it continues to grow and evolve.
+
+### Unit Tests
+Most of the internal components the project uses have unit tests to thoroughly test them. Here dependencies of components are mocked or stubbed appropriately to ensure tests are reliable, test only one component and are fast!
+
+### Acceptance Tests
+
+Acceptance tests run the built `shopify` command line against a wide range of fixtures and verify its output and results. They are the slowest to run however provide the most coverage. The idea is to test a few complete scenarios for each major feature.
+
+Those are written in [Cucumber](https://cucumber.io/) and Ruby and can be found in the [`features/`](/features) directory. They can be executed by running:
+
+```bash
+bundle exec cucumber
+bundle exec cucumber features/theme.feature:3 # A specific test
+```
+
+> **Note** that we currently don't have an approach for stubbing the interactions with the GraphQL APIs and that therefore we can't write acceptance tests for commands that interact with APIs.
+
+#### Debugging acceptance tests
+When developing acceptance tests, it can be helpful to see the outputs of running commands.
+To see outputs, append `--verbose` when running an acceptance test. Example:
+
+```sh
+bundle exec cucumber features/theme.feature --verbose
+```

package/assets/cli-ruby/docs/users/installation.md

@@ -0,0 +1,3 @@
+# Installation
+
+The installation guide can be found here: https://shopify.dev/apps/tools/cli/cli-2#installing-shopify-cli-2-x

package/assets/cli-ruby/docs/users/migrate-from-themekit.md

@@ -0,0 +1,18 @@
+# Migrate from Theme Kit
+
+Shopify CLI is the recommended and officially supported tool for developing Themes and creating CI/CD workflows.
+
+This guide shows how to achieve equivalent flows with the new version of the CLI.
+
+## Equivalent commands
+
+| Theme Kit Command | Shopify CLI Equivalent | Objective |
+|---|---|---|
+|`theme deploy`|`shopify theme push`| Deploy a local (to the CLI) version of the Theme in the current working directory to a remote store.|
+|`theme new`|`shopify theme init`| Scaffold a new theme. In the case of the CLI it clones Dawn to be used as a reference Theme. Alternatively, it's possible to simply clone Dawn `git clone git@github.com:Shopify/dawn.git` and use it with the CLI.
+|`theme download`|`shopify theme pull`| Download your remote theme files.|
+|`theme watch` & `theme open` | `shopify theme serve` | Start a theme server to locally preview changes with CSS & Section hot reload enabled|
+|-| `shopify theme check`| Run the Theme Check linter on your theme codebase.|
+|-|`shopify theme publish`| Set a remote theme as the live theme.|
+|-|`shopify theme package`|Pack your Theme as a zip file ready for distribution and submission to the Theme Store.|
+|`theme remove`| `shopify theme delete`| Theme kit removes files from the Theme whereas Shopify CLI will remotely destroy the specified theme.|

package/assets/cli-ruby/ext/javy/hashes/javy-arm-macos-v0.1.0.gz.sha256

@@ -0,0 +1 @@
+16e1a74c06eff6e5be79253a8ee96a08a404e95be3479a6e384c8926bb736e43

package/assets/cli-ruby/ext/javy/hashes/javy-arm-macos-v0.2.0.gz.sha256

@@ -0,0 +1 @@
+69ac26fd99a41aa1839cdf8fc8a734874370947ef79e88b90f661c2e58485ae0

package/assets/cli-ruby/ext/javy/hashes/javy-arm-macos-v0.2.1.gz.sha256

@@ -0,0 +1 @@
+80576fe617d6e093a72bc826f041207ddc57605381f0db6451ba27310e57e830

package/assets/cli-ruby/ext/javy/hashes/javy-arm-macos-v0.3.0.gz.sha256

@@ -0,0 +1 @@
+c7e97d166e46d96fa43a70046c80607035101b4a96e40edcf4643a6c92913692

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-linux-v0.1.0.gz.sha256

@@ -0,0 +1 @@
+53cb9d0e8a345d68f91512a28a7d2eab93463dc8650c7a044f03cbee1f7cac05

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-linux-v0.2.0.gz.sha256

@@ -0,0 +1 @@
+9d2686f5caccc34e30baff614ccfc487e90c5d1220e515ca4e47337a0b6a2daf

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-linux-v0.2.1.gz.sha256

@@ -0,0 +1 @@
+6b7b6f6745594c2e8efcaf948c0ef367911446101d2b8a7c8138ce2aca868cbd

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-linux-v0.3.0.gz.sha256

@@ -0,0 +1 @@
+877e6383b921de2b93ecaf5d1d902c7305d65bdab52758b9d5c02d9c5cea45ab

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-macos-v0.1.0.gz.sha256

@@ -0,0 +1 @@
+5e1ca88385206a653980139ab969efd80de11fd9b298dafe450d3ac27d6d0173

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-macos-v0.2.0.gz.sha256

@@ -0,0 +1 @@
+a68b5cbfce2b4b6c1a7e89e50d41dfc63f083e73f846547232897e06345e9ca3

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-macos-v0.2.1.gz.sha256

@@ -0,0 +1 @@
+4010c2d154f1ef7ebf1f8c49621a0742ab75c60fd77746a5fa175878d07f16ef

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-macos-v0.3.0.gz.sha256

@@ -0,0 +1 @@
+c8a40adf83cacae33f819fa78501355eee9077dce3818ab4a483b2473952941e

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-windows-v0.1.0.gz.sha256

@@ -0,0 +1 @@
+37f9b3f75b4ffca68b06656d6f90abfbac57597ee45fffb59b3a559b6b5de44e

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-windows-v0.2.0.gz.sha256

@@ -0,0 +1 @@
+786e417716969fcac4e97d9c0c701966c54a49152f9f57fa164f916cf14ae5f3

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-windows-v0.2.1.gz.sha256

@@ -0,0 +1 @@
+c12418f7b3e4edead87ade1f44bd7280626a92d8d1238d7f8eb91b1122f20f20

package/assets/cli-ruby/ext/javy/hashes/javy-x86_64-windows-v0.3.0.gz.sha256

@@ -0,0 +1 @@
+9ca1e65b0f7a2645f408cb65e683d243069f03828d4b3eeaf59f3012e5d41e73

package/assets/cli-ruby/ext/javy/javy.rb

@@ -0,0 +1,204 @@
+require "open-uri"
+require "zlib"
+require "open3"
+require "digest/sha2"
+
+module Javy
+  ROOT = __dir__
+  BIN_FOLDER = File.join(ShopifyCLI.cache_dir, "javy", "bin")
+  HASH_FOLDER = File.join(ROOT, "hashes")
+  VERSION = File.read(File.join(ROOT, "version")).strip
+  TARGET = File.join(BIN_FOLDER, "javy-#{VERSION}")
+
+  class << self
+    def install
+      ShopifyCLI::Result
+        .wrap { Installer.call(target: target, platform: platform, version: VERSION) }
+        .call
+    end
+
+    def build(source:, dest: nil)
+      optional_args = []
+      optional_args += ["-o", dest] unless dest.nil?
+
+      ShopifyCLI::Result
+        .wrap { ensure_installed }
+        .call
+        .then { exec(source, *optional_args) }
+    end
+
+    private
+
+    def exec(*args, **kwargs)
+      out_and_err, stat = CLI::Kit::System.capture2e(target, *args, **kwargs)
+      raise ExecutionError, out_and_err unless stat.success?
+      true
+    end
+
+    def platform
+      Platform.new
+    end
+
+    def target
+      platform.format_executable_path(TARGET)
+    end
+
+    def ensure_installed
+      delete_outdated_installations
+      install.unwrap { |e| raise e } unless Installer.installed?(target: target)
+      true
+    end
+
+    def delete_outdated_installations
+      installed_binaries
+        .reject { |v| v == target }
+        .each { |file| File.delete(file) }
+    end
+
+    def installed_binaries
+      Dir[File.join(BIN_FOLDER, "javy-*")]
+    end
+
+    module Installer
+      def self.call(target:, platform:, version:)
+        asset = Asset.new(
+          platform: platform,
+          version: version,
+          owner: "Shopify",
+          repository: "javy",
+          basename: "javy"
+        )
+
+        downloaded = asset.download(target: target)
+        raise InstallationError.asset_not_found(platform: platform, version: version, url: asset.url) unless downloaded
+
+        true
+      end
+
+      def self.installed?(target:)
+        File.executable?(target)
+      end
+    end
+  end
+
+  class Error < RuntimeError; end
+  class ExecutionError < Error; end
+
+  class InstallationError < Error
+    def self.cpu_unsupported
+      new("Javy is not supported on this CPU")
+    end
+
+    def self.asset_not_found(platform:, version:, url:)
+      new(format(
+        "Unable to download javy %{version} for %{os} (%{cpu}) at %{url}",
+        version: version,
+        os: platform.os,
+        cpu: platform.cpu,
+        url: url
+      ))
+    end
+
+    def self.invalid_binary
+      new("Invalid Javy binary downloaded.")
+    end
+  end
+
+  Asset = Struct.new(:platform, :version, :owner, :repository, :basename, keyword_init: true) do
+    def download(target:)
+      FileUtils.mkdir_p(BIN_FOLDER)
+
+      source_file = url.open
+      validate_sha!(source_file)
+      source_file.seek(0)
+
+      Dir.chdir(File.dirname(target)) do
+        File.open(File.basename(target), "wb") do |target_file|
+          decompress(source_file, target_file)
+        end
+
+        File.chmod(0755, target)
+      end
+
+      true
+    rescue OpenURI::HTTPError
+      false
+    end
+
+    def url
+      URI.parse(format(
+        "https://github.com/%{owner}/%{repository}/releases/download/%{version}/%{filename}",
+        owner: owner,
+        repository: repository,
+        version: version,
+        filename: filename
+      ))
+    end
+
+    def filename
+      format(
+        "%{basename}-%{cpu}-%{os}-%{version}.gz",
+        basename: basename,
+        cpu: platform.cpu,
+        os: platform.os,
+        version: version
+      )
+    end
+
+    private
+
+    def decompress(source, target)
+      zlib = Zlib::GzipReader.new(source)
+      target << zlib.read
+    ensure
+      zlib.close
+    end
+
+    def validate_sha!(source)
+      generated_hash = Digest::SHA256.hexdigest(source.read).strip
+      expected_hash = File.read(File.join(HASH_FOLDER, "#{filename}.sha256")).strip
+      raise InstallationError.invalid_binary unless generated_hash == expected_hash
+    end
+  end
+
+  Platform = Struct.new(:ruby_platform) do
+    def initialize(ruby_platform = RUBY_PLATFORM)
+      super(ruby_platform)
+    end
+
+    def to_s
+      format("%{cpu}-%{os}", cpu: cpu, os: os)
+    end
+
+    def os
+      case ruby_platform
+      when /linux/
+        "linux"
+      when /darwin/
+        "macos"
+      else
+        "windows"
+      end
+    end
+
+    def cpu
+      case ruby_platform
+      when /x64/, /x86_64/
+        "x86_64"
+      when /arm/
+        "arm"
+      else
+        raise InstallationError.cpu_unsupported
+      end
+    end
+
+    def format_executable_path(path)
+      case os
+      when "windows"
+        File.extname(path) != ".exe" ? path + ".exe" : path
+      else
+        path
+      end
+    end
+  end
+end

package/assets/cli-ruby/ext/javy/version

@@ -0,0 +1 @@
+v0.3.0

package/assets/cli-ruby/ext/shopify-extensions/extconf.rb

@@ -0,0 +1,21 @@
+require_relative "./shopify_extensions"
+
+installation_dir = ENV.fetch("SHOPIFY_CLI_EXTENSIONS_INSTALLATION_DIR", __dir__)
+
+File.write(File.expand_path("Makefile", installation_dir), <<~MAKEFILE)
+  .PHONY: clean
+
+  clean: ;
+
+  install: ;
+MAKEFILE
+
+begin
+  ShopifyExtensions.install(
+    target: File.expand_path("shopify-extensions", installation_dir)
+  )
+rescue ShopifyExtensions::InstallationError => error
+  STDERR.puts(error.message)
+rescue => error
+  STDERR.puts("Unable to install shopify-extensions: #{error}")
+end

package/assets/cli-ruby/ext/shopify-extensions/shopify_extensions.rb

@@ -0,0 +1,152 @@
+require "rbconfig"
+require "open-uri"
+require "zlib"
+require "open3"
+
+module ShopifyExtensions
+  def self.install(**args)
+    Install.call(**args)
+  end
+
+  class Install
+    def self.call(platform: Platform.new, **args)
+      new.call(platform: platform, **args)
+    end
+
+    def self.version
+      File.read(File.expand_path("../version", __FILE__)).strip
+    end
+
+    def call(platform:, version: self.class.version, target:)
+      target = platform.format_path(target.to_s)
+
+      asset = Asset.new(
+        platform: platform,
+        version: version,
+        owner: "Shopify",
+        repository: "shopify-cli-extensions",
+        basename: "shopify-extensions"
+      )
+      downloaded = asset.download(target: target)
+      raise InstallationError.asset_not_found(platform: platform, version: version) unless downloaded
+
+      raise InstallationError.installation_failed unless verify(target, version: version)
+    end
+
+    private
+
+    def fetch_release_details_for(version:)
+      JSON.parse(URI.parse(release_url_for(version: version)).open.read).yield_self(&Release)
+    rescue OpenURI::HTTPError
+      nil
+    end
+
+    def verify(target, version:)
+      return false unless File.executable?(target)
+      installed_server_version, exit_code = Open3.capture2(target, "version")
+      return false unless exit_code == 0
+      return false unless installed_server_version.strip == version.strip
+      true
+    end
+  end
+
+  class InstallationError < RuntimeError
+    def self.installation_failed
+      new("Failed to install shopify-extensions properly")
+    end
+
+    def self.asset_not_found(platform:, version:)
+      new(format(
+        "Unable to download shopify-extensions %{version} for %{os} (%{cpu})",
+        version: version,
+        os: platform.os,
+        cpu: platform.cpu
+      ))
+    end
+  end
+
+  Asset = Struct.new(:platform, :version, :owner, :repository, :basename, keyword_init: true) do
+    def download(target:)
+      Dir.chdir(File.dirname(target)) do
+        File.open(File.basename(target), "wb") do |target_file|
+          decompress(url.open, target_file)
+        end
+        File.chmod(0755, target)
+      end
+
+      true
+    rescue OpenURI::HTTPError
+      false
+    end
+
+    def url
+      URI.parse(format(
+        "https://github.com/%{owner}/%{repository}/releases/download/%{version}/%{filename}",
+        owner: owner,
+        repository: repository,
+        version: version,
+        filename: filename
+      ))
+    end
+
+    def filename
+      format(
+        "%{basename}-%{os}-%{cpu}.%{extension}",
+        basename: basename,
+        os: platform.os,
+        cpu: platform.cpu,
+        extension: platform.os == "windows" ? "exe.gz" : "gz"
+      )
+    end
+
+    private
+
+    def decompress(source, target)
+      zlib = Zlib::GzipReader.new(source)
+      target << zlib.read
+    ensure
+      zlib.close
+    end
+  end
+
+  Platform = Struct.new(:ruby_config) do
+    def initialize(ruby_config = RbConfig::CONFIG)
+      super(ruby_config)
+    end
+
+    def format_path(path)
+      case os
+      when "windows"
+        File.extname(path) != ".exe" ? path + ".exe" : path
+      else
+        path
+      end
+    end
+
+    def to_s
+      format("%{os}-%{cpu}", os: os, cpu: cpu)
+    end
+
+    def os
+      case ruby_config.fetch("host_os")
+      when /linux/
+        "linux"
+      when /darwin/
+        "darwin"
+      else
+        "windows"
+      end
+    end
+
+    def cpu
+      case ruby_config.fetch("host_cpu")
+      when /arm.*64/
+        "arm64"
+      when /64/
+        "amd64"
+      else
+        "386"
+      end
+    end
+  end
+end

package/assets/cli-ruby/ext/shopify-extensions/version

@@ -0,0 +1 @@
+v0.12.0