shopify-cli 2.14.0 → 2.15.2

data/lib/shopify_cli/changelog.rb

@@ -0,0 +1,76 @@
+require "shopify_cli/sed"
+
+module ShopifyCLI
+  class Changelog
+    CHANGELOG_FILE = File.join(ShopifyCLI::ROOT, "CHANGELOG.md")
+
+    def initialize
+      load(File.read(CHANGELOG_FILE))
+    end
+
+    def update_version!(new_version)
+      Sed.new.replace_inline(
+        CHANGELOG_FILE,
+        "## \\[Unreleased\\]",
+        "## [Unreleased]\\n\\n## Version #{new_version}"
+      )
+    end
+
+    def release_notes(version)
+      changes[version].map do |change_category, changes|
+        <<~CHANGES
+          ### #{change_category}
+          #{changes.map { |change| entry(**change) }.join("\n")}
+        CHANGES
+      end.join("\n")
+    end
+
+    def entry(pr_id:, desc:)
+      "* [##{pr_id}](https://github.com/Shopify/shopify-cli/pull/#{pr_id}): #{desc}"
+    end
+
+    private
+
+    def changes
+      @changes ||= Hash.new do |h, k|
+        h[k] = Hash.new do |h2, k2|
+          h2[k2] = []
+        end
+      end
+    end
+
+    def load(log)
+      state = :initial
+      change_category = nil
+      current_version = nil
+      @remainder = ""
+      log.each_line do |line|
+        case state
+        when :initial
+          next unless line.chomp == "\#\# [Unreleased]"
+          state = :unreleased
+          current_version = "Unreleased"
+        when :unreleased, :last_version
+          if /\A\#\#\# (?<category>\w+)/ =~ line
+            change_category = category
+          elsif %r{\A\* \[\#(?<pr_id>\d+)\]\(https://github.com/Shopify/shopify-cli/pull/\d+\): (?<desc>.+)\n} =~ line
+            changes[current_version][change_category] << { pr_id: pr_id, desc: desc }
+          elsif /\A\#\# Version (?<version>\d+\.\d+\.\d+)/ =~ line
+            current_version = version
+            state =
+              case state
+              when :unreleased
+                :last_version
+              else
+                :finished
+              end
+          elsif !line.match?(/\s*\n/)
+            raise "Unrecognized line: #{line.inspect}"
+          end
+        when :finished
+          @remainder << line
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/command.rb

@@ -36,6 +36,13 @@ module ShopifyCLI
         end
       rescue OptionParser::InvalidOption => error
         arg = error.args.first
+        store_name = arg.match(/\A--(?<store_name>.*\.myshopify\.com)\z/)&.[](:store_name)
+        if store_name && !arg.match?(/\A--(store|shop)=/)
+          # Sometimes it may look like --invalidoption=https://storename.myshopify.com
+          store_name = store_name.sub(%r{\A(.*=)?(https?://)?}, "")
+          raise ShopifyCLI::Abort,
+            @ctx.message("core.errors.option_parser.invalid_option_store_equals", arg, store_name)
+        end
         raise ShopifyCLI::Abort, @ctx.message("core.errors.option_parser.invalid_option", arg)
       rescue OptionParser::MissingArgument => error
         arg = error.args.first
@@ -102,16 +109,10 @@ module ShopifyCLI
       def check_node_version
         return unless @compatible_node_range
 
-        context = Context.new
-        if context.which("node").nil?
-          raise ShopifyCLI::Abort, context.message("core.errors.missing_node")
-        end
-
         check_version(
           Environment.node_version,
           range: @compatible_node_range,
-          runtime: "Node",
-          context: context
+          runtime: "Node"
         )
       end
 

data/lib/shopify_cli/environment.rb

@@ -12,23 +12,31 @@ module ShopifyCLI
     ]
 
     def self.ruby_version(context: Context.new)
-      out, err, stat = context.capture3('ruby -e "puts RUBY_VERSION"')
-      raise ShopifyCLI::Abort, err unless stat.success?
-      out = out.gsub('"', "")
-      ::Semantic::Version.new(out.chomp)
+      output, status = context.capture2e("ruby", "--version")
+      raise ShopifyCLI::Abort, context.message("core.errors.missing_ruby") unless status.success?
+      version = output.match(/ruby (\d+\.\d+\.\d+)/)[1]
+      ::Semantic::Version.new(version)
     end
 
     def self.node_version(context: Context.new)
-      out, err, stat = context.capture3("node", "--version")
-      raise ShopifyCLI::Abort, err unless stat.success?
-      out = out.gsub("v", "")
-      ::Semantic::Version.new(out.chomp)
+      output, status = context.capture2e("node", "--version")
+      raise ShopifyCLI::Abort, context.message("core.errors.missing_node") unless status.success?
+      version = output.match(/v(\d+\.\d+\.\d+)/)[1]
+      ::Semantic::Version.new(version)
     end
 
     def self.npm_version(context: Context.new)
-      out, err, stat = context.capture3("npm", "--version")
-      raise ShopifyCLI::Abort, err unless stat.success?
-      ::Semantic::Version.new(out.chomp)
+      output, status = context.capture2e("npm", "--version")
+      raise ShopifyCLI::Abort, context.message("core.errors.missing_npm") unless status.success?
+      version = output.match(/(\d+\.\d+\.\d+)/)[1]
+      ::Semantic::Version.new(version)
+    end
+
+    def self.rails_version(context: Context.new)
+      output, status = context.capture2e("rails", "--version")
+      context.abort(context.message("core.app.create.rails.error.install_failure", "rails")) unless status.success?
+      version = output.match(/Rails (\d+\.\d+\.\d+)/)[1]
+      ::Semantic::Version.new(version)
     end
 
     def self.interactive=(interactive)

data/lib/shopify_cli/git.rb

@@ -102,6 +102,42 @@ module ShopifyCLI
         branches
       end
 
+      ##
+      # Run git three-way file merge (it doesn't require an initialized git repository)
+      #
+      # #### Parameters
+      #
+      # * `current_file  - string path of the current file
+      # * `base_file`    - string path of the base file
+      # * `other_file`   - string path of the other file
+      # * `opts`         - list of "git merge-file" options. Valid values:
+      #                    - "-q"       - do not warn about conflicts
+      #                    - "--diff3"  - show conflicts
+      #                    - "--ours"   - resolve conflicts favoring lines from `current_file`
+      #                    - "--theirs" - resolve conflicts favoring lines from `other_file`
+      #                    - "--union"  - resolve conflicts favoring lines from both files
+      #                    - "-p"       - send results to standard output instead of
+      #                                 overwriting the `current_file`
+      # * `ctx`          - the current running context of your command, defaults to a new context
+      #
+      # #### Returns
+      #
+      # * standard output from git
+      #
+      # #### Example
+      #
+      #   output = ShopifyCLI::Git.merge_file(current_file, base_file, other_file, opts, ctx: ctx)
+      #
+      def merge_file(current_file, base_file, other_file, opts = [], ctx: Context.new)
+        output, status = ctx.capture2e("git", "merge-file", current_file, base_file, other_file, *opts)
+
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.merge_failed"))
+        end
+
+        output
+      end
+
       ##
       # will initialize a new repo in the current directory. This will output
       # if it was successful or not.

data/lib/shopify_cli/messages/messages.rb

@@ -15,9 +15,17 @@ module ShopifyCLI
       },
       core: {
         errors: {
-          missing_node: "Node is required to continue. Install node here: https://nodejs.org/en/download.",
+          missing_node: "Node.js is required to continue. Install Node.js here: https://nodejs.org/en/download.",
+          missing_npm: "npm is required to continue. Install npm here: https://www.npmjs.com/get-npm.",
+          missing_ruby: "Ruby is required to continue. Install Ruby here: https://www.ruby-lang.org/en/downloads.",
           option_parser: {
             invalid_option: "The option {{command:%s}} is not supported.",
+            invalid_option_store_equals: <<~MESSAGE,
+            The option {{command:%s}} isn't recognized.
+
+            Try this:
+            {{command:--store=%s}}.
+            MESSAGE
             missing_argument: "The required argument {{command:%s}} is missing.",
           },
         },
@@ -95,8 +103,6 @@ module ShopifyCLI
               HELP
               error: {
                 node_required: "node is required to create an app project. Download at https://nodejs.org/en/download.",
-                node_version_failure: "Failed to get the current node version. Please make sure it is installed as " \
-                  "per the instructions at https://nodejs.org/en.",
                 npm_required: "npm is required to create an app project. Download at https://www.npmjs.com/get-npm.",
                 npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
                   "the instructions at https://www.npmjs.com/get-npm.",
@@ -131,8 +137,6 @@ module ShopifyCLI
                     {{underline:https://getcomposer.org/download/}}
                   COMPOSER
                 npm_required: "npm is required to create an app project. Download at https://www.npmjs.com/get-npm.",
-                npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
-                  "the instructions at https://www.npmjs.com/get-npm.",
                 app_setup: "Failed to set up the app",
               },
 
@@ -283,6 +287,8 @@ module ShopifyCLI
               localization: {
                 error: {
                   bundle_too_large: "Total size of all locale files must be less than %s.",
+                  duplicate_locale_code: "Duplicate locale found: `%s`; locale codes"\
+                    " should be unique and are case insensitive.",
                   file_empty: "Locale file `%s` is empty.",
                   file_too_large: "Locale file `%s` too large; size must be less than %s.",
                   invalid_file_extension: "Invalid locale filename: `%s`; only .json files are allowed.",
@@ -382,6 +388,7 @@ module ShopifyCLI
             sparse_checkout_not_set: "Sparse checkout set command failed.",
             pull_failed: "Pull failed.",
             pull_failed_bad_branch: "Pull failed. Branch %s cannot be found. Check the branch name and try again.",
+            merge_failed: "The file %s merge failed.",
           },
 
           cloning: "Cloning %s into %s…",
@@ -432,7 +439,7 @@ module ShopifyCLI
         login: {
           help: <<~HELP,
             Log in to the Shopify CLI by authenticating with a store or partner organization
-              Usage: {{command:%s login [--store=STORE]}}
+              Usage: {{command:%s login [--store STORE]}}
           HELP
           invalid_shop: <<~MESSAGE,
             Invalid store provided (%s). Please provide the store in the following format: my-store.myshopify.com
@@ -454,7 +461,7 @@ module ShopifyCLI
         switch: {
           help: <<~HELP,
             Switch between development stores in your partner organization
-              Usage: {{command:%s switch [--store=STORE]}}
+              Usage: {{command:%s switch [--store STORE]}}
           HELP
           disabled_as_shopify_org: "Can't switch development stores logged in as {{green:Shopify partners org}}",
           success: "Switched development store to {{green:%s}}",
@@ -567,7 +574,7 @@ module ShopifyCLI
           HELP
 
           error: {
-            no_shop: "No store found. Please run {{command:%s login --store=STORE}} to login to a specific store",
+            no_shop: "No store found. Please run {{command:%s login --store STORE}} to login to a specific store",
           },
 
           customer: {
@@ -803,7 +810,7 @@ module ShopifyCLI
           not_logged_in: <<~MESSAGE,
             It doesn't appear that you're logged in. You must log into a partner organization or a store staff account.
 
-            If trying to log into a store staff account, please use {{command:%s login --store=STORE}} to log in.
+            If trying to log into a store staff account, please use {{command:%s login --store STORE}} to log in.
           MESSAGE
           logged_in_shop_only: <<~MESSAGE,
             Logged into store {{green:%s}} as staff (no partner organizations available for this login)

data/lib/shopify_cli/release.rb

@@ -0,0 +1,194 @@
+require "net/http"
+require "fileutils"
+require "shopify_cli/sed"
+require "shopify_cli/changelog"
+require "octokit"
+
+module ShopifyCLI
+  class Release
+    def initialize(new_version, github_access_token)
+      @new_version = new_version
+      @changelog = ShopifyCLI::Changelog.new
+      @github = Octokit::Client.new(access_token: github_access_token)
+    end
+
+    def prepare!
+      ensure_updated_main
+      create_release_branch
+      update_changelog
+      update_versions_in_files
+      commit_packaging
+      pr = create_pr
+      system("open #{pr["html_url"]}")
+    end
+
+    def package!
+      ensure_updated_main
+      ensure_correct_gem_version
+      Rake::Task["package"].invoke
+      update_homebrew
+      create_github_release
+    end
+
+    private
+
+    attr_reader :new_version, :changelog, :github
+
+    def ensure_updated_main
+      # We can't be sure what is the correct action to take if changes have been
+      # made but not committed. Ensure the user handles the situation before
+      # moving on.
+      unless %x(git status --porcelain).empty?
+        raise <<~MESSAGE
+          Uncommitted changes have been made to the repository.
+          Please make sure `git status` does not show any changes before continuing.
+        MESSAGE
+      end
+      system_or_fail("git checkout main", "check out main branch")
+      unless system("git pull")
+        raise "git pull failed, cannot be sure there aren't new commits!"
+      end
+    end
+
+    def create_release_branch
+      puts "Checking out release branch"
+      system_or_fail("git checkout -b #{release_branch_name}", "check out release branch")
+    end
+
+    def update_changelog
+      if release_notes("Unreleased").empty?
+        puts "No unreleased CHANGELOG updates found!"
+      else
+        puts "Updating CHANGELOG"
+        changelog.update_version!(new_version)
+      end
+    end
+
+    def update_versions_in_files
+      version_file = File.join(ShopifyCLI::ROOT, "lib/shopify_cli/version.rb")
+      puts "Updating version.rb"
+      ShopifyCLI::Sed.new.replace_inline(version_file, ShopifyCLI::VERSION, new_version)
+      gemfile_lock = File.join(ShopifyCLI::ROOT, "Gemfile.lock")
+      puts "Updating Gemfile.lock"
+      ShopifyCLI::Sed.new.replace_inline(
+        gemfile_lock,
+        "shopify-cli (#{ShopifyCLI::VERSION})",
+        "shopify-cli (#{new_version})",
+      )
+    end
+
+    def commit_packaging
+      puts "Committing"
+      system_or_fail("git commit -am 'Packaging for release v#{new_version}'", "commit")
+      system_or_fail("git push -u origin #{release_branch_name}", "push branch")
+    end
+
+    def create_pr
+      repo = "Shopify/shopify-cli"
+      github.create_pull_request(
+        repo,
+        "main",
+        release_branch_name,
+        "Packaging for release v#{new_version}",
+        release_notes("Unreleased")
+      ).tap { |results| puts "Created #{repo} PR ##{results["number"]}" }
+    end
+
+    def ensure_correct_gem_version
+      response = Net::HTTP.get(URI("https://rubygems.org/api/v1/versions/shopify-cli/latest.json"))
+      latest_version = JSON.parse(response)["version"]
+      unless latest_version == new_version
+        raise "Attempted to update to #{new_version}, but latest on RubyGems is #{latest_version}"
+      end
+    end
+
+    def update_homebrew
+      ensure_updated_homebrew_repo
+      update_homebrew_repo
+      pr = create_homebrew_pr
+      system("open #{pr["html_url"]}")
+    end
+
+    def ensure_updated_homebrew_repo
+      unless File.exist?(homebrew_path)
+        system_or_fail("/opt/dev/bin/dev clone homebrew-shopify", "clone homebrew-shopify repo")
+      end
+
+      Dir.chdir(homebrew_path) do
+        system_or_fail("git checkout master && git pull", "pull latest homebrew-shopify")
+        system_or_fail("git checkout -b #{homebrew_release_branch}", "check out homebrew branch")
+      end
+    end
+
+    def update_homebrew_repo
+      source_file = File.join(package_dir, "shopify-cli.rb")
+      FileUtils.copy(source_file, homebrew_path)
+      Dir.chdir(homebrew_path) do
+        system_or_fail("git commit -am '#{homebrew_update_message}'", "commit homebrew update")
+        system_or_fail("git push -u origin #{homebrew_release_branch}", "push homebrew branch")
+      end
+    end
+
+    def create_homebrew_pr
+      repo = "Shopify/homebrew-shopify"
+      github.create_pull_request(
+        repo,
+        "master",
+        homebrew_release_branch,
+        homebrew_update_message,
+        homebrew_release_notes
+      ).tap { |results| puts "Created #{repo} PR ##{results["number"]}" }
+    end
+
+    def create_github_release
+      release = github.create_release(
+        "Shopify/shopify-cli",
+        "v#{new_version}",
+        {
+          name: "Version #{new_version}",
+          body: release_notes(new_version),
+        }
+      )
+      %w(.deb -1.noarch.rpm).each do |suffix|
+        github.upload_asset(
+          release["url"],
+          File.join(package_dir, "shopify-cli-#{new_version}#{suffix}")
+        )
+      end
+      system("open #{release["html_url"]}")
+    end
+
+    def homebrew_path
+      @homebrew_path ||= %x(/opt/dev/bin/dev project-path homebrew-shopify).chomp
+    end
+
+    def homebrew_update_message
+      @homebrew_update_message ||= "Update Shopify CLI to #{new_version}"
+    end
+
+    def package_dir
+      @package_dir ||= File.join(ShopifyCLI::ROOT, "packaging", "builds", new_version)
+    end
+
+    def homebrew_release_branch
+      "release_#{new_version.split(".").join("_")}_of_shopify-cli"
+    end
+
+    def homebrew_release_notes
+      "I'm releasing a new version of the Shopify CLI, " \
+        "[#{new_version}](https://github.com/Shopify/shopify-cli/releases/tag/v#{new_version})"
+    end
+
+    def release_branch_name
+      @release_branch_name ||= "release_#{new_version.split(".").join("_")}"
+    end
+
+    def release_notes(version)
+      changelog.release_notes(version)
+    end
+
+    def system_or_fail(command, action)
+      raise "Failed to #{action}!" unless system(command)
+    end
+  end
+end

data/lib/shopify_cli/sed.rb

@@ -0,0 +1,19 @@
+module ShopifyCLI
+  class Sed
+    class SedError < StandardError; end
+
+    def replace_inline(filename, pattern, output)
+      command =
+        case CLI::Kit::System.os
+        when :mac
+          "sed -i ''"
+        when :linux
+          "sed -i"
+        else
+          raise "Unrecognized system!"
+        end
+      success = system("#{command} 's/#{pattern}/#{output}/' #{filename}")
+      raise SedError unless success
+    end
+  end
+end

data/lib/shopify_cli/services/app/create/node_service.rb

@@ -88,24 +88,12 @@ module ShopifyCLI
           end
 
           def check_node
-            cmd_path = context.which("node")
-            context.abort(context.message("core.app.create.node.error.node_required")) if cmd_path.nil?
-
-            version, stat = context.capture2e("node", "-v")
-            unless stat.success?
-              context.abort(context.message("core.app.create.node.error.node_version_failure"))
-            end
-
+            version = ShopifyCLI::Environment.node_version(context: context)
             context.done(context.message("core.app.create.node.node_version", version))
           end
 
           def check_npm
-            cmd_path = context.which("npm")
-            context.abort(context.message("core.app.create.node.error.npm_required")) if cmd_path.nil?
-
-            version, stat = context.capture2e("npm", "-v")
-            context.abort(context.message("core.app.create.node.error.npm_version_failure")) unless stat.success?
-
+            version = ShopifyCLI::Environment.npm_version(context: context)
             context.done(context.message("core.app.create.node.npm_version", version))
           end
 

data/lib/shopify_cli/services/app/create/php_service.rb

@@ -69,12 +69,7 @@ module ShopifyCLI
           end
 
           def check_npm
-            cmd_path = context.which("npm")
-            context.abort(context.message("core.app.create.php.error.npm_required")) if cmd_path.nil?
-
-            version, stat = context.capture2e("npm", "-v")
-            context.abort(context.message("core.app.create.php.error.npm_version_failure")) unless stat.success?
-
+            version = ShopifyCLI::Environment.npm_version(context: context)
             context.done(context.message("core.app.create.php.npm_version", version))
           end
 

data/lib/shopify_cli/services/app/create/rails_service.rb

@@ -108,7 +108,7 @@ module ShopifyCLI
           end
 
           def check_ruby
-            ruby_version = Rails::Ruby.version(context)
+            ruby_version = Environment.ruby_version(context: context)
             return if ruby_version.satisfies?("~>2.5") || ruby_version.satisfies?("~>3.1.0")
             context.abort(context.message("core.app.create.rails.error.invalid_ruby_version"))
           end
@@ -219,18 +219,10 @@ module ShopifyCLI
           end
 
           def install_webpacker?
-            rails_version < ::Semantic::Version.new("7.0.0") &&
-              !File.exist?(File.join(context.root, "config/webpacker.yml"))
-          end
-
-          def rails_version
-            output, status = context.capture2e("rails", "--version")
-            unless status.success?
-              context.abort(context.message("core.app.create.rails.error.install_failure", "rails"))
-            end
+            rails_version = Environment.rails_version(context: context)
+            webpacker_config = File.exist?(File.join(context.root, "config/webpacker.yml"))
 
-            version = output.scan(/Rails \d+\.\d+\.\d+/).first.split(" ").last
-            ::Semantic::Version.new(version)
+            rails_version < ::Semantic::Version.new("7.0.0") && !webpacker_config
           end
         end
       end

data/lib/shopify_cli/theme/dev_server/hot-reload.js

@@ -15,17 +15,37 @@
     eventSource.onerror = () => eventSource.close();
   }
 
+  function sectionNamesByType(type) {
+    const namespace = window.__SHOPIFY_CLI_ENV__;
+    return namespace.section_names_by_type[type] || [];
+  }
+
   function reloadMode() {
-    var namespace = window.__SHOPIFY_CLI_ENV__;
+    const namespace = window.__SHOPIFY_CLI_ENV__;
     return namespace.mode;
   }
 
+  function querySelectDOMSections(idSuffix) {
+    const elements = document.querySelectorAll(`[id^='shopify-section'][id$='${idSuffix}']`);
+    return Array.from(elements);
+  }
+
+  function fetchDOMSections(name) {
+    const domSections = sectionNamesByType(name).flatMap((n) => querySelectDOMSections(n));
+    
+    if (domSections.length > 0) {
+      return domSections;
+    }
+
+    return querySelectDOMSections(name);
+  }
+
   function isFullPageReloadMode(){
-    return reloadMode() === "full-page";
+    return reloadMode() === 'full-page';
   }
 
   function isReloadModeActive(){
-    return reloadMode() !== "off";
+    return reloadMode() !== 'off';
   }
 
   function isRefreshRequired(files) {
@@ -104,26 +124,28 @@
     constructor(filename) {
       this.filename = filename;
       this.name = filename.split('/').pop().replace('.liquid', '');
-      this.element = document.querySelector(`[id^='shopify-section'][id$='${this.name}']`);
+      this.elements = fetchDOMSections(this.name);
     }
 
     valid() {
-      return this.filename.startsWith('sections/') && this.element;
+      return this.filename.startsWith('sections/') && this.elements.length > 0;
     }
 
-    async refresh() {
-      var url = new URL(window.location.href);
-      url.searchParams.append('section_id', this.name);
+    async refreshElement(element) {
+
+      const sectionId = element.id.replace(/^shopify-section-/, '');
+      const url = new URL(window.location.href);
+
+      url.searchParams.append('section_id', sectionId);
+
+      const response = await fetch(url);
 
       try {
-        const response = await fetch(url);
         if (response.headers.get('x-templates-from-params') == '1') {
           const html = await response.text();
-          this.element.outerHTML = html;
-
-          console.log(`[HotReload] Reloaded ${this.name} section`);
+          element.outerHTML = html;
         } else {
-          window.location.reload()
+          window.location.reload();
 
           console.log(`[HotReload] Hot-reloading not supported, fully reloading ${this.name} section`);
         }
@@ -132,6 +154,11 @@
         console.log(`[HotReload] Failed to reload ${this.name} section: ${e.message}`);
       }
     }
+
+    async refresh() {
+      console.log(`[HotReload] Reloaded ${this.name} sections`);
+      this.elements.forEach(this.refreshElement);
+    }
   }
 
   if (isReloadModeActive()) {

data/lib/shopify_cli/theme/dev_server/hot_reload/remote_file_reloader.rb

@@ -51,7 +51,7 @@ module ShopifyCLI
           def fetch_asset(file)
             api_client.get(
               path: "themes/#{@theme.id}/assets.json",
-              query: URI.encode_www_form("asset[key]" => file.relative_path.to_s),
+              query: URI.encode_www_form("asset[key]" => file.relative_path),
             )
           rescue ShopifyCLI::API::APIRequestNotFoundError
             [404, {}]