@shopify/cli-kit 3.42.0 → 3.44.0

package/assets/cli-ruby/Gemfile

@@ -1,13 +1,14 @@
 # NOTE: These are development-only dependencies
 source "https://rubygems.org"
 
-gemspec
+gem "bugsnag", "~> 6.22"
+gem "listen", "~> 3.7.0"
+gem "theme-check", "~> 1.14.0"
 
 # None of these can actually be used in a development copy of dev
 # They are all for CI and tests
 # `dev` uses no gems
 group :development, :test do
-  gem "rake"
   gem "pry-byebug"
   gem "byebug"
   gem "rubocop-shopify", require: false
@@ -16,11 +17,13 @@ group :development, :test do
   gem "iniparse", "~> 1.5"
   gem "colorize", "~> 0.8.1"
   gem "octokit", "~> 4.0"
+  gem "bundler", ">= 2.3.11"
+  gem "rake", "~> 12.3", ">= 12.3.3"
+  gem "minitest", "~> 5.0"
 end
 
 group :test do
   gem "mocha", require: false
-  gem "minitest", ">= 5.0.0", require: false
   gem "minitest-reporters", require: false
   gem "minitest-fail-fast", require: false
   gem "fakefs", ">= 1.0", require: false

package/assets/cli-ruby/lib/project_types/extension/commands/serve.rb

@@ -20,6 +20,9 @@ module Extension
         parser.on("-T", "--theme=NAME_OR_ID", "Theme ID or name of the theme app extension host theme.") do |theme|
           flags[:theme] = theme
         end
+        parser.on("--generate-tmp-theme", "Populate host theme, created by CLI 3, with assets") do |generate_tmp_theme|
+          flags[:generate_tmp_theme] = generate_tmp_theme
+        end
         parser.on("--api-key=API_KEY", "Connect your extension and app by inserting your app's API key") do |api_key|
           flags[:api_key] = api_key.gsub('"', "")
         end
@@ -45,6 +48,7 @@ module Extension
         property! :tunnel_requested, accepts: [true, false], reader: :tunnel_requested?, default: true
         property :port, accepts: (1...(2**16))
         property :theme, accepts: String, default: nil
+        property :generate_tmp_theme, accepts: [true, false], reader: :generate_tmp_theme?, default: false
         property :api_key, accepts: String, default: nil
         property :api_secret, accepts: String, default: nil
         property :registration_id, accepts: String, default: nil
@@ -60,6 +64,7 @@ module Extension
           resource_url: options.flags[:resource_url],
           port: options.flags[:port],
           theme: options.flags[:theme],
+          generate_tmp_theme: generate_tmp_theme?,
           api_key: options.flags[:api_key],
           api_secret: options.flags[:api_secret],
           registration_id: options.flags[:registration_id],
@@ -103,6 +108,10 @@ module Extension
         tunnel.nil? || !!tunnel
       end
 
+      def generate_tmp_theme?
+        options.flags[:generate_tmp_theme] == true
+      end
+
       def find_available_port(runtime_configuration)
         return runtime_configuration unless runtime_configuration.port.nil?
         return runtime_configuration unless specification_handler.choose_port?(@ctx)
@@ -137,6 +146,7 @@ module Extension
           tunnel_url: runtime_configuration.tunnel_url,
           port: runtime_configuration.port,
           theme: runtime_configuration.theme,
+          generate_tmp_theme: runtime_configuration.generate_tmp_theme?,
           api_key: runtime_configuration.api_key,
           api_secret: runtime_configuration.api_secret,
           registration_id: runtime_configuration.registration_id,

package/assets/cli-ruby/lib/project_types/extension/models/specification_handlers/theme_app_extension.rb

@@ -78,7 +78,7 @@ module Extension
           root = options[:context]&.root
           project = options[:project]
           properties = options
-            .slice(:port, :theme)
+            .slice(:port, :theme, :generate_tmp_theme)
             .compact
             .merge({
               project: project,

package/assets/cli-ruby/lib/project_types/theme/cli.rb

@@ -19,6 +19,7 @@ module Theme
     subcommand :List, "list", Project.project_filepath("commands/list")
     subcommand :Share, "share", Project.project_filepath("commands/share")
     subcommand :LanguageServer, "language-server", Project.project_filepath("commands/language_server")
+    subcommand :Console, "console", Project.project_filepath("commands/console")
   end
   ShopifyCLI::Commands.register("Theme::Command", "theme")
 

package/assets/cli-ruby/lib/project_types/theme/commands/common/root_helper.rb

@@ -49,13 +49,14 @@ module Theme
         private
 
         def current_directory_confirmed?
-          raise "Current theme directory can't be confirmed during tests" if @ctx.testing?
+          return true if options.flags[:force]
 
+          @ctx.warn(@ctx.message("theme.current_directory_is_not_theme_directory"))
           Forms::ConfirmStore.ask(
             @ctx,
             [],
             title: @ctx.message("theme.confirm_current_directory"),
-            force: options.flags[:force],
+            force: !ShopifyCLI::Environment.interactive?,
           ).confirmed?
         end
 

package/assets/cli-ruby/lib/project_types/theme/commands/console.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/repl"
+
+module Theme
+  class Command
+    class Console < ShopifyCLI::Command::SubCommand
+      recommend_default_ruby_range
+
+      def call(_args, *)
+        ShopifyCLI::Theme::Repl.new(@ctx).run
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/commands/push.rb

@@ -67,6 +67,7 @@ module Theme
         begin
           syncer.start_threads
           if options.flags[:json]
+            syncer.standard_reporter.disable!
             syncer.upload_theme!(delete: delete)
           else
             CLI::UI::Frame.open(@ctx.message("theme.push.info.pushing", theme.name, theme.id, theme.shop)) do

package/assets/cli-ruby/lib/project_types/theme/messages/messages.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Theme
   module Messages
     MESSAGES = {
@@ -18,8 +19,9 @@ module Theme
         ENSURE_USER
         stable_flag_suggestion: "If the current command isn't working as expected," \
           " we suggest re-running the command with the {{command: --stable}} flag",
-        confirm_current_directory: "It doesn’t seem like you’re running this command in a theme directory. " \
-          "Are you sure you want to proceed?",
+        current_directory_is_not_theme_directory: "It doesn’t seem like you’re running this command" \
+          " in a theme directory.",
+        confirm_current_directory: "Are you sure you want to proceed?",
         init: {
           help: <<~HELP,
             {{command:%s theme init}}: Clones a Git repository to use as a starting point for building a new theme.

package/assets/cli-ruby/lib/shopify_cli/theme/dev_server/hot_reload/script_injector.rb

@@ -25,7 +25,7 @@ module ShopifyCLI
               "</script>",
             ].join("\n")
 
-            body = body.join.gsub("</body>", "#{hot_reload_script}\n</body>")
+            body = body.join.sub("</body>", "#{hot_reload_script}\n</body>")
 
             [body]
           end

package/assets/cli-ruby/lib/shopify_cli/theme/dev_server/hot_reload.rb

@@ -16,12 +16,15 @@ module ShopifyCLI
         end
 
         def call(env)
-          if env["PATH_INFO"] == "/hot-reload"
+          path = env["PATH_INFO"]
+          if path == "/hot-reload"
             create_stream
           else
             status, headers, body = @app.call(env)
 
-            body = inject_hot_reload_javascript(body) if request_is_html?(headers)
+            if request_is_html?(headers) && leads_to_injectable_body?(path)
+              body = inject_hot_reload_javascript(body)
+            end
 
             [status, headers, body]
           end
@@ -43,6 +46,10 @@ module ShopifyCLI
           headers["content-type"]&.start_with?("text/html")
         end
 
+        def leads_to_injectable_body?(path)
+          path !~ /web-pixels-manager.+sandbox/
+        end
+
         def inject_hot_reload_javascript(body)
           @script_injector&.inject(body: body, dir: __dir__, mode: @mode)
         end

package/assets/cli-ruby/lib/shopify_cli/theme/dev_server/proxy.rb

@@ -78,6 +78,17 @@ module ShopifyCLI
           [response.code, headers, body]
         end
 
+        def secure_session_id
+          if secure_session_id_expired?
+            @ctx.debug("Refreshing preview _secure_session_id cookie")
+            response = request("HEAD", "/", query: [[:preview_theme_id, theme_id]])
+            @secure_session_id = extract_secure_session_id_from_response_headers(response)
+            @last_session_cookie_refresh = Time.now
+          end
+
+          @secure_session_id
+        end
+
         private
 
         def patch_body(env, body)
@@ -164,17 +175,6 @@ module ShopifyCLI
           headers["set-cookie"][SESSION_COOKIE_REGEXP, 1]
         end
 
-        def secure_session_id
-          if secure_session_id_expired?
-            @ctx.debug("Refreshing preview _secure_session_id cookie")
-            response = request("HEAD", "/", query: [[:preview_theme_id, theme_id]])
-            @secure_session_id = extract_secure_session_id_from_response_headers(response)
-            @last_session_cookie_refresh = Time.now
-          end
-
-          @secure_session_id
-        end
-
         def get_response_headers(response, env)
           response_headers = normalize_headers(
             response.respond_to?(:headers) ? response.headers : response.to_hash,
@@ -184,7 +184,8 @@ module ShopifyCLI
           # (Taken from Rack::Proxy)
           response_headers.reject! { |k| HOP_BY_HOP_HEADERS.include?(k.downcase) }
 
-          if response_headers["location"]&.include?("myshopify.com")
+          if response_headers["location"]&.include?("myshopify.com") ||
+            response_headers["location"]&.include?("spin.dev")
             response_headers["location"].gsub!(%r{(https://#{shop})}, "http://#{host(env)}")
           end
 

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

@@ -139,8 +139,8 @@ module ShopifyCLI
       private
 
       def setup_server
-        watcher.start
-        remote_watcher.start if editor_sync
+        watcher&.start
+        remote_watcher&.start if editor_sync
       end
 
       def teardown_server

package/assets/cli-ruby/lib/shopify_cli/theme/extension/dev_server.rb

@@ -26,12 +26,13 @@ module ShopifyCLI
         # Extensions
         ScriptInjector = ShopifyCLI::Theme::Extension::DevServer::HotReload::ScriptInjector
 
-        attr_accessor :project, :specification_handler
+        attr_accessor :project, :specification_handler, :generate_tmp_theme
 
         class << self
-          def start(ctx, root, port: 9292, theme: nil, project:, specification_handler:)
+          def start(ctx, root, port: 9292, theme: nil, generate_tmp_theme: false, project:, specification_handler:)
             instance.project = project
             instance.specification_handler = specification_handler
+            instance.generate_tmp_theme = generate_tmp_theme
 
             super(ctx, root, port: port, theme: theme)
           end
@@ -66,8 +67,10 @@ module ShopifyCLI
 
         def theme
           @theme ||= if theme_identifier
-            theme = ShopifyCLI::Theme::Theme.find_by_identifier(ctx, identifier: theme_identifier)
-            theme || ctx.abort(not_found_error_message)
+            theme = HostTheme.find_by_identifier(ctx, identifier: theme_identifier)
+            ctx.abort(not_found_error_message) unless theme
+            theme.generate_tmp_theme if generate_tmp_theme
+            theme
           else
             HostTheme.find_or_create!(ctx)
           end

package/assets/cli-ruby/lib/shopify_cli/theme/extension/host_theme.rb

@@ -61,20 +61,9 @@ module ShopifyCLI
           new(ctx, root: nil).ensure_exists!
         end
 
-        private
-
-        def generate_host_theme_name
-          hostname = Socket.gethostname.split(".").shift
-          hash = SecureRandom.hex(3)
-
-          theme_name = "App Ext. Host ()"
-          hostname_character_limit = API_NAME_LIMIT - theme_name.length - hash.length - 1
-          identifier = encode_identifier("#{hash}-#{hostname[0, hostname_character_limit]}")
-          theme_name = "App Ext. Host (#{identifier})"
-
-          ShopifyCLI::DB.set(host_theme_name: theme_name)
-
-          theme_name
+        def self.find_by_identifier(ctx, root: nil, identifier:)
+          ShopifyCLI::DB.set(host_theme_id: identifier)
+          find(ctx, root: root)
         end
 
         def generate_tmp_theme
@@ -98,6 +87,22 @@ module ShopifyCLI
             end
           end
         end
+
+        private
+
+        def generate_host_theme_name
+          hostname = Socket.gethostname.split(".").shift
+          hash = SecureRandom.hex(3)
+
+          theme_name = "App Ext. Host ()"
+          hostname_character_limit = API_NAME_LIMIT - theme_name.length - hash.length - 1
+          identifier = encode_identifier("#{hash}-#{hostname[0, hostname_character_limit]}")
+          theme_name = "App Ext. Host (#{identifier})"
+
+          ShopifyCLI::DB.set(host_theme_name: theme_name)
+
+          theme_name
+        end
       end
     end
   end

package/assets/cli-ruby/lib/shopify_cli/theme/repl/api.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Repl
+      class Api
+        attr_reader :ctx, :repl
+
+        def initialize(ctx, repl)
+          @ctx = ctx
+          @repl = repl
+        end
+
+        def request(liquid_snippet)
+          Net::HTTP.start(uri.host, 443, use_ssl: true) do |http|
+            req = Net::HTTP::Post.new(uri)
+
+            req.initialize_http_header(headers)
+            req.set_form_data(form_data(liquid_snippet))
+            res = http.request(req)
+
+            debug(res)
+
+            res
+          end
+        end
+
+        private
+
+        def debug(response)
+          return response unless debug?
+
+          ctx.debug(<<~DEBUG)
+            URI: #{uri}
+            ---
+            HTTP status: #{response.code}
+            ---
+            Response body:
+            #{response.body}
+          DEBUG
+
+          response
+        end
+
+        def debug?
+          @is_debug ||= ctx.debug?
+        end
+
+        def form_data(liquid_snippet)
+          template = ["", "", liquid_snippet, "", liquid_template].join("\n")
+
+          {
+            "replace_templates[sections/announcement-bar.liquid]" => template,
+            :_method => "GET",
+          }
+        end
+
+        def liquid_template
+          @liquid_template ||= ::File.read("#{__dir__}/resources/template.liquid")
+        end
+
+        def cookie
+          @cookie ||= "storefront_digest=#{repl.storefront_digest}; _secure_session_id=#{repl.secure_session_id}"
+        end
+
+        def shop
+          @shop ||= ShopifyCLI::Theme::ThemeAdminAPI.new(ctx).get_shop_or_abort
+        end
+
+        def storefront_renderer_token
+          @storefront_renderer_token ||= ShopifyCLI::Environment.storefront_renderer_auth_token ||
+            ShopifyCLI::DB.get(:storefront_renderer_production_exchange_token)
+        end
+
+        def headers
+          @headers ||= if Environment.theme_access_password?
+            {
+              "Cookie" => cookie,
+              "X-Shopify-Access-Token" => Environment.admin_auth_token,
+              "X-Shopify-Shop" => shop,
+            }
+          else
+            {
+              "Cookie" => cookie,
+              "Authorization" => "Bearer #{storefront_renderer_token}",
+              "User-Agent" => "Shopify CLI",
+            }
+          end
+        end
+
+        def uri
+          return @api_uri if @api_uri
+
+          uri_address = if Environment.theme_access_password?
+            "https://#{ThemeAccessAPI::BASE_URL}/cli/sfr"
+          else
+            "https://#{shop}"
+          end
+
+          @api_uri = URI(uri_address)
+          @api_uri.query = URI.encode_www_form([["section_id", "announcement-bar"], [:_fd, 0], [:pb, 0]])
+          @api_uri
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/theme/repl/auth_dev_server.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Repl
+      class AuthDevServer < ShopifyCLI::Theme::DevServer
+        attr_accessor :app, :repl
+
+        REPL_THEME = "liquid-console-repl"
+
+        class << self
+          def start(ctx, repl, port)
+            instance.repl = repl
+
+            super(ctx, nil, port: port, theme: REPL_THEME)
+          end
+        end
+
+        private
+
+        def theme
+          @theme ||= find_repl_theme || create_repl_theme
+        end
+
+        def find_repl_theme
+          Theme.find(ctx, nil) do |theme_hash|
+            theme_hash["name"] == theme_identifier && theme_hash["role"] == "development"
+          end
+        end
+
+        def create_repl_theme
+          repl_theme = Theme.new(ctx, name: theme_identifier, role: "development")
+          repl_theme.create
+
+          api_client = ThemeAdminAPI.new(ctx, repl_theme.shop)
+          status, _body, _response = api_client.put(
+            path: "themes/#{repl_theme.id}/assets/bulk.json",
+            method: "PUT",
+            body: JSON.generate({
+              assets: [
+                { key: "sections/announcement-bar.liquid", value: "" },
+                { key: "config/settings_schema.json", value: "[]" },
+                { key: "config/settings_data.json", value: "{}" },
+                { key: "layout/theme.liquid", value: "{{ content_for_header }}{{ content_for_layout }}" },
+                { key: "layout/password.liquid", value: "{{ content_for_header }}{{ content_for_layout }}" },
+              ],
+            }),
+          )
+
+          if status != 207
+            ctx.puts("{{red:Shopify Liquid console could not be initiatilize (HTTP status: #{status})}}")
+            raise ShopifyCLI::AbortSilent
+          end
+
+          repl_theme
+        end
+
+        def middleware_stack
+          @app = proxy
+          @app = CdnFonts.new(app, theme: theme)
+          @app = AuthMiddleware.new(app, proxy, repl) { WebServer.shutdown }
+        end
+
+        def param_builder
+          @param_builder ||= ProxyParamBuilder.new
+        end
+
+        def proxy
+          @proxy ||= Proxy.new(ctx, theme, param_builder)
+        end
+
+        def frame_title; end
+        def preview_message; end
+        def setup_server; end
+        def stop(_signal); end
+        def sync_theme; end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/theme/repl/auth_middleware.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    class Repl
+      class AuthMiddleware
+        def initialize(app, proxy, repl, &stop_dev_server)
+          @app = app
+          @proxy = proxy
+          @repl = repl
+          @stop_dev_server = stop_dev_server
+        end
+
+        def call(env)
+          @env = env
+
+          return @app.call(env) unless authenticated?
+
+          authenticate!
+          shutdown
+
+          [
+            200,
+            {
+              "Content-Type" => "text/html",
+              "Content-Length" => success_body.size.to_s,
+            },
+            [success_body],
+          ]
+        end
+
+        def close
+          @app.close
+        end
+
+        private
+
+        def storefront_session
+          cookie["storefront_digest"]&.first
+        end
+
+        def secure_session
+          @proxy.secure_session_id
+        end
+
+        def authenticated?
+          storefront_session && secure_session
+        end
+
+        def authenticate!
+          @repl.authenticate(storefront_session, secure_session)
+        end
+
+        def shutdown
+          Thread.new do
+            # Web server answers the request and shutdown itself
+            sleep(1)
+
+            @stop_dev_server.call
+          end
+        end
+
+        def success_body
+          @success_body ||= ::File.read("#{__dir__}/resources/success.html")
+        end
+
+        def cookie
+          CGI::Cookie.parse(@env["HTTP_COOKIE"])
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/theme/repl/resources/success.html

@@ -0,0 +1,79 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Shopify CLI</title>
+    <style type="text/css">
+      html {
+        font-family: -apple-system, BlinkMacSystemFont, San Francisco, Segoe UI, Roboto, Helvetica Neue, sans-serif;
+        text-size-adjust: 100%;
+        text-rendering: optimizeLegibility;
+        -webkit-font-smoothing: antialiased;
+        -moz-osx-font-smoothing: grayscale;
+      }
+
+      body {
+        font-size: 26px;
+        line-height: normal;
+        margin: 0;
+        padding: 0;
+      }
+
+      button, input, optgroup, select, textarea {
+        font-family: inherit;
+      }
+
+      h1 {
+        font-weight: 600;
+        font-size: 1em;
+      }
+
+      p {
+        font-weight: 400;
+      }
+
+      .body-success {
+        color: #F6F6F7;
+      }
+
+      .body-error {
+        color: #202223;
+      }
+
+      .app-success {
+        width: 100vw;
+        height: 100vh;
+        background-color: #054A49;
+        display: flex;
+      }
+
+      .app-error {
+        width: 100vw;
+        height: 100vh;
+        background-color: #F6F6F7;
+        display: flex;
+      }
+
+      .container {
+        display: flex;
+        flex-direction: column;
+        justify-content: center;
+        width: 100%;
+        height: 100%;
+        padding-left: 7.5em;
+      }
+    </style>
+    <link rel="icon" href="favicon.svg" sizes="any" type="image/svg+xml">
+</head>
+
+<body class="body-success">
+    <div class="app-success">
+        <div class="container">
+            <h1>You've successfully activated the Shopify Liquid session!</h1>
+            <p>You can close this tab and return to your terminal.</p>
+        </div>
+    </div>
+</body>
+</html>