shopify-cli 2.24.0 → 2.26.0

data/lib/shopify_cli/git.rb

@@ -46,12 +46,77 @@ module ShopifyCLI
       end
 
       ##
-      # will make calls to git to clone a new repo into a supplied destination,
-      # it will also output progress of the cloning process.
+      # returns array with components of git clone command
       #
       # #### Parameters
       #
-      # * `repository` - a git url for git to clone the repo from
+      # * `repo` - repo url without branch name
+      # * `dest` - a filepath to where the repo should be cloned to
+      # * `branch` - branch name when cloning
+      #
+      # #### Returns
+      #
+      # * array of strings
+      #
+      # #### Example
+      #
+      #   ["clone", "--single-branch", "--branch", "test-branch", "test-app"]
+      #
+      def git_clone_command(repo, dest, branch)
+        if branch
+          ["clone", "--single-branch", "--branch", branch, repo, dest]
+        else
+          ["clone", "--single-branch", repo, dest]
+        end
+      end
+
+      ##
+      # calls git to clone a new repo into a supplied destination,
+      # it will also call a supplied block with the percentage of clone completion
+      #
+      # #### Parameters
+      #
+      # * `repo_with_branch` - a git url for git to clone the repo from
+      # * `dest` - a filepath to where the repo should be cloned to
+      # * `ctx` - the current running context of your command, defaults to a new context.
+      #
+      # #### Returns
+      #
+      # * `sha_string` - string of the sha of the most recent commit to the repo
+      #
+      # #### Example
+      #
+      #   ShopifyCLI::Git.raw_clone('git@github.com:shopify/test.git', 'test-app')
+      #
+      def raw_clone(repo_with_branch, dest, ctx: Context.new)
+        if Dir.exist?(dest) && !Dir.empty?(dest)
+          ctx.abort(ctx.message("core.git.error.directory_exists"))
+        else
+          msg = []
+          # require at usage point to not slow down CLI startup
+          # https://github.com/Shopify/shopify-cli/pull/698#discussion_r444342445
+          require "open3"
+
+          repo, branch = repo_with_branch.split("#")
+          git_cmd = git_clone_command(repo, dest, branch)
+
+          success = Open3.popen3("git", *git_cmd, "--progress") do |_stdin, _stdout, stderr, thread|
+            msg = clone_progress(stderr, bar: nil)
+
+            thread.value
+          end.success?
+
+          ctx.abort((msg.join("\n"))) unless success
+        end
+      end
+
+      ##
+      # calls git to clone a new repo into a supplied destination,
+      # it will also output progress of the cloning process into a new progress bar
+      #
+      # #### Parameters
+      #
+      # * `repo_with_branch` - a git url for git to clone the repo from
       # * `dest` - a filepath to where the repo should be cloned to
       # * `ctx` - the current running context of your command, defaults to a new context.
       #
@@ -63,17 +128,30 @@ module ShopifyCLI
       #
       #   ShopifyCLI::Git.clone('git@github.com:shopify/test.git', 'test-app')
       #
-      def clone(repository, dest, ctx: Context.new)
-        if Dir.exist?(dest)
+      def clone(repo_with_branch, dest, ctx: Context.new)
+        if Dir.exist?(dest) && !Dir.empty?(dest)
           ctx.abort(ctx.message("core.git.error.directory_exists"))
         else
-          repo, branch = repository.split("#")
+          msg = []
+          # require at usage point to not slow down CLI startup
+          # https://github.com/Shopify/shopify-cli/pull/698#discussion_r444342445
+          require "open3"
+
+          repo, branch = repo_with_branch.split("#")
+          git_cmd = git_clone_command(repo, dest, branch)
+
           success_message = ctx.message("core.git.cloned", dest)
+
           CLI::UI::Frame.open(ctx.message("core.git.cloning", repo, dest), success_text: success_message) do
-            if branch
-              clone_progress("clone", "--single-branch", "--branch", branch, repo, dest, ctx: ctx)
-            else
-              clone_progress("clone", "--single-branch", repo, dest, ctx: ctx)
+            CLI::UI::Progress.progress do |bar|
+              success = Open3.popen3("git", *git_cmd, "--progress") do |_stdin, _stdout, stderr, thread|
+                msg = clone_progress(stderr, bar: bar)
+
+                thread.value
+              end.success?
+
+              ctx.abort((msg.join("\n"))) unless success
+              bar.tick(set_percent: 1.0)
             end
           end
         end
@@ -197,6 +275,34 @@ module ShopifyCLI
         end
       end
 
+      ##
+      # handles showing the progress of the git clone command.
+      # if block given, assumes passing percent to block, otherwise
+      # increments bar for progress bar
+      #
+      # #### Parameters
+      #
+      # * `stderr` - Open3.popen3 output stream
+      # * `bar` - progress bar object to set percent
+      #
+      def clone_progress(stderr, bar: nil)
+        msg = []
+
+        while (line = stderr.gets)
+          msg << line.chomp
+          next unless line.strip.start_with?("Receiving objects:")
+          percent = (line.match(/Receiving objects:\s+(\d+)/)[1].to_f / 100).round(2)
+
+          if block_given?
+            yield percent
+          elsif !bar.nil?
+            bar.tick(set_percent: percent)
+          end
+        end
+
+        msg
+      end
+
       private
 
       def exec(*args, dir: Dir.pwd, default: nil, ctx: Context.new)
@@ -209,29 +315,6 @@ module ShopifyCLI
       def rev_parse(*args, dir: nil, ctx: Context.new)
         exec("rev-parse", *args, dir: dir, ctx: ctx)
       end
-
-      def clone_progress(*git_command, ctx:)
-        CLI::UI::Progress.progress do |bar|
-          msg = []
-          require "open3"
-
-          success = Open3.popen3("git", *git_command, "--progress") do |_stdin, _stdout, stderr, thread|
-            while (line = stderr.gets)
-              msg << line.chomp
-              next unless line.strip.start_with?("Receiving objects:")
-              percent = (line.match(/Receiving objects:\s+(\d+)/)[1].to_f / 100).round(2)
-              bar.tick(set_percent: percent)
-              next
-            end
-
-            thread.value
-          end.success?
-
-          ctx.abort(msg.join("\n")) unless success
-          bar.tick(set_percent: 1.0)
-          success
-        end
-      end
     end
   end
 end

data/lib/shopify_cli/identity_auth.rb

@@ -87,6 +87,7 @@ module ShopifyCLI
 
     def fetch_or_auth_partners_token
       if EnvAuthToken.partners_token_present?
+        return Environment.auth_token if Environment.run_as_subprocess?
         return EnvAuthToken.fetch_exchanged_partners_token do |env_token|
           exchange_partners_auth_token(env_token)
         end

data/lib/shopify_cli/messages/messages.rb

@@ -788,7 +788,7 @@ module ShopifyCLI
             {{*}} {{yellow:A new version of Shopify CLI is available! You have version %s and the latest version is %s.
 
               To upgrade, follow the instructions for the package manager you’re using:
-              {{underline:https://shopify.dev/tools/cli/troubleshooting#upgrade-shopify-cli}}}}
+              {{underline:https://shopify.dev/themes/tools/cli/upgrade-uninstall}}}}
 
           MESSAGE
 

data/lib/shopify_cli/packager.rb

@@ -70,9 +70,10 @@ module ShopifyCLI
       root_dir = File.join(PACKAGING_DIR, "homebrew")
 
       build_path = File.join(BUILDS_DIR, "shopify-cli.rb")
-      puts "\nBuilding Homebrew package"
+      build_path_2 = File.join(BUILDS_DIR, "shopify-cli@2.rb")
+      puts "\nBuilding Homebrew packages"
 
-      puts "Generating formula…"
+      puts "Generating formulae…"
       File.delete(build_path) if File.exist?(build_path)
 
       spec_contents = File.read(File.join(root_dir, "shopify-cli.base.rb"))
@@ -89,7 +90,15 @@ module ShopifyCLI
       spec_contents = spec_contents.gsub("SHOPIFY_CLI_GEM_CHECKSUM", gem_checksum)
 
       puts "Writing generated formula\n  To: #{build_path}\n\n"
-      File.write(build_path, spec_contents)
+      File.write(build_path, spec_contents.gsub("SHOPIFY_CLI_BINSTUB_SUFFIX", ""))
+
+      puts "Writing generated formula\n  To: #{build_path_2}\n\n"
+      File.write(
+        build_path_2,
+        spec_contents
+          .sub("class ShopifyCli < Formula", "class ShopifyCliAT2 < Formula")
+          .sub("SHOPIFY_CLI_BINSTUB_SUFFIX", "2")
+      )
     end
 
     private

data/lib/shopify_cli/project.rb

@@ -109,7 +109,7 @@ module ShopifyCLI
 
       def at(dir)
         proj_dir = directory(dir)
-        unless proj_dir
+        if !proj_dir && !ShopifyCLI::Environment.run_as_subprocess?
           raise(ShopifyCLI::Abort, Context.message("core.project.error.not_in_project"))
         end
         @at ||= Hash.new { |h, k| h[k] = new(directory: k) }

data/lib/shopify_cli/release.rb

@@ -120,8 +120,10 @@ module ShopifyCLI
     end
 
     def update_homebrew_repo
-      source_file = File.join(package_dir, "shopify-cli.rb")
-      FileUtils.copy(source_file, homebrew_path)
+      %w(shopify-cli.rb shopify-cli@2.rb).each do |source_filename|
+        source_file = File.join(package_dir, source_filename)
+        FileUtils.copy(source_file, homebrew_path)
+      end
       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")

data/lib/shopify_cli/tasks/ensure_project_type.rb

@@ -4,7 +4,9 @@ module ShopifyCLI
   module Tasks
     class EnsureProjectType < ShopifyCLI::Task
       def call(ctx, project_type)
-        return true if project_type.to_sym == ShopifyCLI::Project.current_project_type
+        if project_type.to_sym == ShopifyCLI::Project.current_project_type || Environment.run_as_subprocess?
+          return true
+        end
         ctx.abort(ctx.message("core.tasks.ensure_project_type.wrong_project_type", project_type))
       end
     end

data/lib/shopify_cli/theme/dev_server/cdn_fonts.rb

@@ -2,7 +2,7 @@
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class CdnFonts
         FONTS_PATH = "/fonts"
         FONTS_CDN = "https://fonts.shopifycdn.com"

data/lib/shopify_cli/theme/dev_server/certificate_manager.rb

@@ -4,7 +4,7 @@ require "openssl"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class CertificateManager
         attr_reader :ctx, :domain_name, :certificate, :private_key
 

data/lib/shopify_cli/theme/dev_server/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module ShopifyCLI
+  module Theme
+    class DevServer
+      # Errors
+      class Error < StandardError; end
+    end
+  end
+end

data/lib/shopify_cli/theme/dev_server/header_hash.rb

@@ -2,7 +2,7 @@
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       # Based on Rack::HeaderHash
       class HeaderHash < Hash
         def self.[](headers)

data/lib/shopify_cli/theme/dev_server/hooks/file_change_hook.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require_relative "../hot_reload/remote_file_reloader"
+require_relative "../hot_reload/remote_file_deleter"
+require "shopify_cli/theme/ignore_helper"
+
+module ShopifyCLI
+  module Theme
+    class DevServer
+      module Hooks
+        class FileChangeHook
+          include ShopifyCLI::Theme::IgnoreHelper
+
+          attr_reader :include_filter, :ignore_filter
+
+          def initialize(ctx, theme:, include_filter: nil, ignore_filter: nil)
+            @ctx = ctx
+            @theme = theme
+            @include_filter = include_filter
+            @ignore_filter = ignore_filter
+          end
+
+          def call(modified, added, removed, streams: nil)
+            @streams = streams
+            files = (modified + added)
+              .map { |f| @theme[f] }
+              .reject { |f| ignore_file?(f) }
+            files -= liquid_css_files = files.select(&:liquid_css?)
+            deleted_files = removed
+              .map { |f| @theme[f] }
+              .reject { |f| ignore_file?(f) }
+
+            remote_delete(deleted_files) unless deleted_files.empty?
+            reload_page(removed) unless deleted_files.empty?
+
+            hot_reload(files) unless files.empty?
+            remote_reload(liquid_css_files)
+          end
+
+          private
+
+          def hot_reload(files)
+            paths = files.map(&:relative_path)
+            @streams.broadcast(JSON.generate(modified: paths))
+            @ctx.debug("[HotReload] Modified #{paths.join(", ")}")
+          end
+
+          def reload_page(removed)
+            @streams.broadcast(JSON.generate(reload_page: true))
+            @ctx.debug("[ReloadPage] Deleted #{removed.join(", ")}")
+          end
+
+          def remote_reload(files)
+            files.each do |file|
+              @ctx.debug("reload file each -> file.relative_path #{file.relative_path}")
+              remote_file_reloader.reload(file)
+            end
+          end
+
+          def remote_delete(files)
+            files.each do |file|
+              @ctx.debug("delete file each -> file.relative_path #{file.relative_path}")
+              remote_file_deleter.delete(file)
+            end
+          end
+
+          def remote_file_deleter
+            @remote_file_deleter ||= HotReload::RemoteFileDeleter.new(@ctx, theme: @theme, streams: @streams)
+          end
+
+          def remote_file_reloader
+            @remote_file_reloader ||= HotReload::RemoteFileReloader.new(@ctx, theme: @theme, streams: @streams)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class HotReload
         class RemoteFileDeleter
           def initialize(ctx, theme:, streams:)

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

@@ -2,7 +2,7 @@
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class HotReload
         class RemoteFileReloader
           def initialize(ctx, theme:, streams:)

data/lib/shopify_cli/theme/dev_server/hot_reload/resources/hot_reload.js

@@ -0,0 +1,48 @@
+class HotReload {
+  static reloadMode = () => {
+    const namespace = window.__SHOPIFY_CLI_ENV__;
+    return namespace.mode;
+  };
+  static isFullPageReloadMode = () => {
+    return HotReload.reloadMode() === "full-page";
+  };
+  static isReloadModeActive = () => {
+    return HotReload.reloadMode() !== "off";
+  };
+  static setHotReloadCookie = (files) => {
+    const date = new Date();
+
+    // Hot reload cookie expires in 3 seconds
+    date.setSeconds(date.getSeconds() + 3);
+
+    const sections = files.join(",");
+    const expires = date.toUTCString();
+
+    document.cookie = `hot_reload_files=${sections}; expires=${expires}; path=/`;
+  };
+  static refreshPage = (files) => {
+    HotReload.setHotReloadCookie(files);
+    console.log("[HotReload] Refreshing entire page");
+    window.location.reload();
+  };
+  static isCSSFile = (filename) => {
+    return filename.endsWith(".css");
+  };
+  static reloadCssFile = (filename) => {
+    // Find a stylesheet link starting with /assets (locally-served only) containing the filename
+    let links = document.querySelectorAll(
+      `link[href^="/assets"][href*="${filename}"][rel="stylesheet"]`
+    );
+
+    Array.from(links).forEach((link) => {
+      if (!link) {
+        console.log(
+          `[HotReload] Could not find link for stylesheet ${filename}`
+        );
+      } else {
+        link.href = new URL(link.href).pathname + `?v=${Date.now()}`;
+        console.log(`[HotReload] Reloaded stylesheet ${filename}`);
+      }
+    });
+  };
+}

data/lib/shopify_cli/theme/dev_server/hot_reload/resources/sse_client.js

@@ -0,0 +1,43 @@
+class SSEClient {
+  constructor(eventsUrl, eventHandler) {
+    SSEClient.verifySSE();
+    this.eventsUrl = eventsUrl;
+    this.eventHandler = eventHandler;
+  }
+  static verifySSE() {
+    if (typeof EventSource === "undefined") {
+      console.error(
+        "[HotReload] Error: SSE features are not supported. Try a different browser."
+      );
+    }
+
+    console.log("[HotReload] Initializing...");
+  }
+  connect() {
+    const eventSource = new EventSource(this.eventsUrl);
+    eventSource.onmessage = (msg) => {
+      this.handleMessage(msg);
+    };
+
+    eventSource.onopen = () => console.log("[HotReload] SSE connected.");
+
+    eventSource.onclose = () => {
+      console.log("[HotReload] SSE closed. Attempting to reconnect...");
+
+      setTimeout(this.connect, 5000);
+    };
+
+    eventSource.onerror = () => {
+      console.log("[HotReload] SSE closed.");
+      eventSource.close();
+    };
+  }
+  handleMessage(message) {
+    const data = JSON.parse(message.data);
+    if (data.reload_page) {
+      HotReload.refreshPage([]);
+      return;
+    }
+    this.eventHandler(data);
+  }
+}

data/lib/shopify_cli/theme/dev_server/hot_reload/resources/theme.js

@@ -0,0 +1,114 @@
+(() => {
+  function sectionNamesByType(type) {
+    const namespace = window.__SHOPIFY_CLI_ENV__;
+    return namespace.section_names_by_type[type] || [];
+  }
+
+  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 isRefreshRequired(files) {
+    if (HotReload.isFullPageReloadMode()) {
+      return true;
+    }
+    return files.some(
+      (file) => !HotReload.isCSSFile(file) && !isSectionFile(file)
+    );
+  }
+
+  function refreshFile(file) {
+    if (HotReload.isCSSFile(file)) {
+      HotReload.reloadCssFile(file);
+      return;
+    }
+
+    if (isSectionFile(file)) {
+      reloadSection(file);
+    }
+  }
+
+  function handleUpdate(data) {
+    const modifiedFiles = data.modified;
+
+    if (modifiedFiles === undefined) {
+      return;
+    }
+
+    if (isRefreshRequired(modifiedFiles)) {
+      HotReload.refreshPage(modifiedFiles);
+    } else {
+      modifiedFiles.forEach(refreshFile);
+    }
+  }
+
+  function isSectionFile(filename) {
+    return new Section(filename).valid();
+  }
+
+  function reloadSection(filename) {
+    new Section(filename).refresh();
+  }
+
+  class Section {
+    constructor(filename) {
+      this.filename = filename;
+      this.name = filename.split("/").pop().replace(".liquid", "");
+      this.elements = fetchDOMSections(this.name);
+    }
+
+    valid() {
+      return this.filename.startsWith("sections/") && this.elements.length > 0;
+    }
+
+    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 {
+        if (response.headers.get("x-templates-from-params") === "1") {
+          element.outerHTML = await response.text();
+        } else {
+          window.location.reload();
+
+          console.log(
+            `[HotReload] Hot-reloading not supported, fully reloading ${this.name} section`
+          );
+        }
+      } catch (e) {
+        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 (HotReload.isReloadModeActive()) {
+    let client = new SSEClient("/hot-reload", handleUpdate);
+    client.connect();
+  }
+})();