shopify-cli 2.15.1 → 2.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 141760dcf4bd3da2b9e92a238c72ee4612fc9e72ce4f522db84f190028439175
-  data.tar.gz: f16bc2db60656219f7f1484ce455380822fb7d7da4c65faeceeaf065953076c9
+  metadata.gz: a06f3c09c3e5e000956befefcbb7b8108096236d9b03cd021959881324c7cfe5
+  data.tar.gz: b1daa60127f1b93ceed1f00d151e67f9709bca8ae77a962913f6fd1edfaac0c9
 SHA512:
-  metadata.gz: 1df93436fa11a84a2df90f354a59277fbf29bd2445b097da8c2ddd6d727dc9d2d4792602de476f3479329e58873dfd222ea185fd096271896bd4ee8533f5b242
-  data.tar.gz: ada360c3f4529d52a0315c70b1c4fea63ad69f0da1ca7aab384958adb8bf342003d4c4dced65ddc4984e5732fb5e2604f77ba82702908242b1d1427570362626
+  metadata.gz: 31e29e63fd9f7e569f7d4834549645b1ca206489274709aa7577f57b6888b3bd28d06eb5bd5899721cf9478239fa524b7937c009575a93c0ac096cd56c911fa6
+  data.tar.gz: '09f19940da497bf3fab8d8c78c801fc127c2a8cad8fe49887f86b05de373dc96acb805c8c282ce76c72d7ea89526d65f0ec0ef3732d6854110a50d02de2f240b'

data/CHANGELOG.md

@@ -2,11 +2,17 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## [Unreleased]
 
+## Version 2.15.2
+
+### Fixed
+* [#2121](https://github.com/Shopify/shopify-cli/pull/2121): Fix the hot-reload to work when the section name is not equal to the type
+
 ## Version 2.15.1
 
 ### Added
 * [#1934](https://github.com/Shopify/shopify-cli/pull/1934): Block directories in theme assets
 * [#1880](https://github.com/Shopify/shopify-cli/pull/1880): Recognize attempts to pass a store name and suggest correction
+* [#2174](https://github.com/Shopify/shopify-cli/pull/2174): Add optional 2-way sync between the CLI (`theme serve`) and the Theme Editor
 
 ### Fixed
 * [#1874](https://github.com/Shopify/shopify-cli/pull/1874): Make ngrok errors more robust and helpful

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.15.1)
+    shopify-cli (2.15.2)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.10.1)

data/Rakefile

@@ -154,6 +154,19 @@ namespace :release do
     ShopifyCLI::Release.new(new_version, github_access_token).prepare!
     puts "Completed!"
   end
+
+  task :package do
+    github_access_token = ENV["GITHUB_ACCESS_TOKEN"]
+    unless github_access_token
+      raise <<~NO_GITHUB_ACCESS_TOKEN
+        GitHub access token must be provided, e.g.:
+
+        $ GITHUB_ACCESS_TOKEN=abcdef rake release:package
+      NO_GITHUB_ACCESS_TOKEN
+    end
+    ShopifyCLI::Release.new(ShopifyCLI::VERSION, github_access_token).package!
+    puts "Completed!"
+  end
 end
 
 namespace :extensions do

data/lib/project_types/extension/messages/messages.rb

@@ -41,7 +41,7 @@ module Extension
         invalid_api_key: "The API key %s does not match any of your apps.",
         ask_app: "Which app would you like to register this extension with?",
         no_apps: "{{x}} You don’t have any apps.",
-        learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/concepts/apps>, " \
+        learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/apps>, " \
           "or try creating a new app using {{command:shopify [node|rails] create}}.",
         loading_apps: "Loading your apps…",
         no_available_extensions: "{{x}} There are no available extensions for this app.",

data/lib/project_types/script/layers/infrastructure/errors.rb

@@ -180,6 +180,23 @@ module Script
             @max_size = max_size
           end
         end
+
+        class InvalidInputQueryErrors < ScriptProjectError
+          attr_reader :messages
+
+          def initialize(messages)
+            @messages = messages
+            super()
+          end
+
+          def input_query_path
+            ScriptProjectRepository::INPUT_QUERY_PATH
+          end
+
+          def message
+            messages.join("\n")
+          end
+        end
       end
     end
   end

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -83,6 +83,8 @@ module Script
               valid_types: e["message"],
               filename: script_config.filename,
             )
+          elsif (errors = user_errors.filter { |err| err["tag"] == "input_query_validation_error" }).any?
+            raise Errors::InvalidInputQueryErrors, errors.map { |err| err["message"] }
           elsif user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
             raise Domain::Errors::MetadataValidationError
           else

data/lib/project_types/script/messages/messages.rb

@@ -86,6 +86,9 @@ module Script
                                                      "type(s): %{valid_types}.",
           configuration_schema_field_invalid_value_error_help: "Change the value of the type.",
 
+          input_query_error_cause: "Input query is invalid:\n%{messages}\n\n",
+          input_query_error_help: "Fix the query in the `%{input_query_path}` file.",
+
           script_not_found_cause: "Can't find script %s for Script API %s",
 
           system_call_failure_cause: "Something went wrong while running: {{command:%{cmd}}}.",

data/lib/project_types/script/ui/error_handler.rb

@@ -216,6 +216,17 @@ module Script
               "script.error.configuration_schema_field_invalid_value_error_help"
             ),
           }
+        when Layers::Infrastructure::Errors::InvalidInputQueryErrors
+          {
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.input_query_error_cause",
+              messages: e.messages.map { |message| "  {{x}} #{message}." }.join("\n"),
+            ),
+            help_suggestion: ShopifyCLI::Context.message(
+              "script.error.input_query_error_help",
+              input_query_path: e.input_query_path,
+            ),
+          }
         when Layers::Infrastructure::Errors::DependencyInstallError
           {
             cause_of_error: ShopifyCLI::Context.message("script.error.dependency_install_cause"),

data/lib/project_types/theme/commands/serve.rb

@@ -16,6 +16,7 @@ module Theme
         parser.on("--port=PORT") { |port| flags[:port] = port.to_i }
         parser.on("--poll") { flags[:poll] = true }
         parser.on("--live-reload=MODE") { |mode| flags[:mode] = as_reload_mode(mode) }
+        parser.on("--theme-editor-sync") { flags[:editor_sync] = true }
       end
 
       def call(_args, name)

data/lib/project_types/theme/messages/messages.rb

@@ -101,13 +101,14 @@ module Theme
             Usage: {{command:%s theme serve [ ROOT ]}}
 
             Options:
-              {{command:--port=PORT}}        Local port to serve theme preview from.
-              {{command:--poll}}             Force polling to detect file changes.
-              {{command:--host=HOST}}        Set which network interface the web server listens on. The default value is 127.0.0.1.
-              {{command:--live-reload=MODE}} The live reload mode switches the server behavior when a file is modified:
-                                 - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
-                                 - {{command:full-page}}  Always refreshes the entire page
-                                 - {{command:off}}        Deactivate live reload
+              {{command:--port=PORT}}         Local port to serve theme preview from.
+              {{command:--poll}}              Force polling to detect file changes.
+              {{command:--host=HOST}}         Set which network interface the web server listens on. The default value is 127.0.0.1.
+              {{command:--theme-editor-sync}} Synchronize Theme Editor updates in the local theme files.
+              {{command:--live-reload=MODE}}  The live reload mode switches the server behavior when a file is modified:
+                                  - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
+                                  - {{command:full-page}}  Always refreshes the entire page
+                                  - {{command:off}}        Deactivate live reload
           HELP
           reload_mode_is_not_valid: "The live reload mode `%s` is not valid.",
           try_a_valid_reload_mode: "Try a valid live reload mode: %s.",
@@ -121,6 +122,36 @@ module Theme
               fixed: "Fixed",
             },
           },
+          syncer: {
+            forms: {
+              apply_to_all: {
+                title: "Would like apply this to all the other %s files?",
+                yes: "Yes",
+                no: "No",
+              },
+              update_strategy: {
+                title_context: <<~TITLE,
+
+                  The local file {{command:%s}} is different from the remote version in the development theme."
+                TITLE
+                title_question: "What would you like to do?",
+                keep_remote: "Keep the remote version",
+                keep_local: "Keep the local version",
+                union_merge: "Merge files (it may break the local file)",
+                exit: "Exit",
+              },
+              delete_strategy: {
+                title_context: <<~TITLE,
+
+                  The local file {{command:%s}} has been recently removed, but it's present on your remote development theme.",
+                TITLE
+                title_question: "What would you like to do?",
+                delete: "Delete permanently",
+                restore: "Restore with the remote version",
+                exit: "Exit",
+              },
+            },
+          },
           error: {
             address_binding_error: "Couldn't bind to localhost."\
               " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
@@ -137,9 +168,10 @@ module Theme
             Serving %s
 
           SERVING
+          download_changes: ", and use 'theme pull' to get the changes",
           customize_or_preview: <<~CUSTOMIZE_OR_PREVIEW,
 
-            Customize this theme in the Theme Editor:
+            Customize this theme in the Theme Editor%s:
             {{green:%s}}
 
             Share this theme preview:

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

@@ -388,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…",
@@ -438,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
@@ -460,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}}",
@@ -573,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: {
@@ -809,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

@@ -1,3 +1,5 @@
+require "net/http"
+require "fileutils"
 require "shopify_cli/sed"
 require "shopify_cli/changelog"
 require "octokit"
@@ -15,20 +17,34 @@ module ShopifyCLI
       create_release_branch
       update_changelog
       update_versions_in_files
-      commit
+      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
-      current_branch = %x(git branch --show-current)
-      unless current_branch == "main"
-        raise "Must be on the main branch to package a release!"
+      # 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
@@ -36,13 +52,11 @@ module ShopifyCLI
 
     def create_release_branch
       puts "Checking out release branch"
-      unless system("git checkout -b #{release_branch_name}")
-        puts "Cannot check out release branch!"
-      end
+      system_or_fail("git checkout -b #{release_branch_name}", "check out release branch")
     end
 
     def update_changelog
-      if release_notes.empty?
+      if release_notes("Unreleased").empty?
         puts "No unreleased CHANGELOG updates found!"
       else
         puts "Updating CHANGELOG"
@@ -63,32 +77,118 @@ module ShopifyCLI
       )
     end
 
-    def commit
+    def commit_packaging
       puts "Committing"
-      unless system("git commit -am 'Packaging for release v#{new_version}'")
-        puts "Commit failed!"
-      end
-      unless system("git push -u origin #{release_branch_name}")
-        puts "Failed to push branch!"
-      end
+      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(
-        "Shopify/shopify-cli",
+        repo,
         "main",
         release_branch_name,
         "Packaging for release v#{new_version}",
-        release_notes
-      ).tap { |results| puts "Created PR ##{results["number"]}" }
+        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
-      @release_notes ||= changelog.release_notes("Unreleased")
+    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/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, {}]

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    module DevServer
+      class HotReload
+        class SectionsIndex
+          def initialize(theme)
+            @theme = theme
+          end
+
+          def section_names_by_type
+            index = {}
+
+            files.each do |file|
+              section_hash(file).each do |key, value|
+                name = key
+                type = value&.dig("type")
+
+                next if !name || !type
+
+                index[type] = [] unless index[type]
+                index[type] << name
+              end
+            end
+
+            index
+          end
+
+          private
+
+          def section_hash(file)
+            content = JSON.parse(file.read)
+            return [] unless content.is_a?(Hash)
+
+            sections = content["sections"]
+            return [] if sections.nil?
+
+            sections
+          rescue JSON::JSONError
+            []
+          end
+
+          def files
+            @theme.json_files
+          end
+        end
+      end
+    end
+  end
+end