shopify-cli 2.24.0 → 2.25.0

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

@@ -2,9 +2,9 @@
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class LocalAssets
-        ASSET_REGEX = %r{//cdn\.shopify\.com/s/.+?/(assets/.+?\.(?:css|js))}
+        THEME_REGEX = %r{//cdn\.shopify\.com/s/.+?/(assets/.+?\.(?:css|js))}
 
         class FileBody
           def initialize(path)
@@ -22,10 +22,10 @@ module ShopifyCLI
           end
         end
 
-        def initialize(ctx, app, theme:)
+        def initialize(ctx, app, target)
           @ctx = ctx
           @app = app
-          @theme = theme
+          @target = target
         end
 
         def call(env)
@@ -42,23 +42,20 @@ module ShopifyCLI
 
         private
 
-        def serve_file(path_info)
-          path = @theme.root.join(path_info[1..-1])
-          if path.file? && path.readable? && @theme.static_asset_file?(path)
-            [
-              200,
-              {
-                "Content-Type" => MimeType.by_filename(path).to_s,
-                "Content-Length" => path.size.to_s,
-              },
-              FileBody.new(path),
-            ]
-          else
-            fail(404, "Not found")
+        def replace_asset_urls(body)
+          replaced_body = body.join.gsub(THEME_REGEX) do |match|
+            path = Regexp.last_match[1]
+            if @target.static_asset_paths.include?(path)
+              "/#{path}"
+            else
+              match
+            end
           end
+
+          [replaced_body]
         end
 
-        def fail(status, body)
+        def serve_fail(status, body)
           [
             status,
             {
@@ -69,17 +66,20 @@ module ShopifyCLI
           ]
         end
 
-        def replace_asset_urls(body)
-          replaced_body = body.join.gsub(ASSET_REGEX) do |match|
-            path = Regexp.last_match[1]
-            if @theme.static_asset_paths.include?(path)
-              "/#{path}"
-            else
-              match
-            end
+        def serve_file(path_info)
+          path = @target.root.join(path_info[1..-1])
+          if path.file? && path.readable? && @target.static_asset_file?(path)
+            [
+              200,
+              {
+                "Content-Type" => MimeType.by_filename(path).to_s,
+                "Content-Length" => path.size.to_s,
+              },
+              FileBody.new(path),
+            ]
+          else
+            serve_fail(404, "Not found")
           end
-
-          [replaced_body]
         end
       end
     end

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

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
-require "net/http"
 require "stringio"
 require "time"
 require "cgi"
-require_relative "proxy/template_param_builder"
+require "net/http"
+
+require_relative "header_hash"
+require_relative "proxy_param_builder"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       HOP_BY_HOP_HEADERS = [
         "connection",
         "keep-alive",
@@ -25,27 +27,27 @@ module ShopifyCLI
         SESSION_COOKIE_REGEXP = /#{SESSION_COOKIE_NAME}=(\h+)/
         SESSION_COOKIE_MAX_AGE = 60 * 60 * 23 # 1 day - leeway of 1h
 
-        def initialize(ctx, theme:, syncer:)
+        def initialize(ctx, theme, param_builder)
           @ctx = ctx
           @theme = theme
-          @syncer = syncer
-          @core_endpoints = Set.new
+          @param_builder = param_builder
 
+          @core_endpoints = Set.new
           @secure_session_id = nil
           @last_session_cookie_refresh = nil
         end
 
         def call(env)
           headers = extract_http_request_headers(env)
-          headers["Host"] = @theme.shop
+          headers["Host"] = shop
           headers["Cookie"] = add_session_cookie(headers["Cookie"])
           headers["Accept-Encoding"] = "none"
           headers["User-Agent"] = "Shopify CLI"
-
           query = URI.decode_www_form(env["QUERY_STRING"])
-          replace_templates = build_replace_templates_param(env)
+          replace_templates = build_replacement_param(env)
           response = if replace_templates.any?
-            # Pass to SFR the recently modified templates in `replace_templates` body param
+            # Pass to SFR the recently modified templates in `replace_templates` or
+            # `replace_extension_templates` body param
             headers["Authorization"] = "Bearer #{bearer_token}"
             form_data = URI.decode_www_form(env["rack.input"].read).to_h
             request(
@@ -63,7 +65,7 @@ module ShopifyCLI
             )
           end
 
-          headers = get_response_headers(response)
+          headers = get_response_headers(response, env)
 
           unless headers["x-storefront-renderer-rendered"]
             @core_endpoints << env["PATH_INFO"]
@@ -79,7 +81,7 @@ module ShopifyCLI
         def patch_body(env, body)
           return [""] unless body
 
-          body.gsub(%r{(data-.+=(["']))(http:|https:)?//#{@theme.shop}(.*)(\2)}) do |_|
+          body.gsub(%r{(data-.+=(["']))(http:|https:)?//#{shop}(.*)(\2)}) do |_|
             match = Regexp.last_match
             "#{match[1]}http://#{host(env)}#{match[4]}#{match[5]}"
           end
@@ -127,15 +129,6 @@ module ShopifyCLI
           name.sub(/^HTTP_/, "").gsub("_", "-")
         end
 
-        def build_replace_templates_param(env)
-          TemplateParamBuilder.new
-            .with_core_endpoints(@core_endpoints)
-            .with_syncer(@syncer)
-            .with_theme(@theme)
-            .with_rack_env(env)
-            .build
-        end
-
         def add_session_cookie(cookie_header)
           cookie_header = if cookie_header
             cookie_header.dup
@@ -170,7 +163,7 @@ module ShopifyCLI
         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]])
+            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
@@ -178,7 +171,7 @@ module ShopifyCLI
           @secure_session_id
         end
 
-        def get_response_headers(response)
+        def get_response_headers(response, env)
           response_headers = normalize_headers(
             response.respond_to?(:headers) ? response.headers : response.to_hash
           )
@@ -188,7 +181,7 @@ module ShopifyCLI
           response_headers.reject! { |k| HOP_BY_HOP_HEADERS.include?(k.downcase) }
 
           if response_headers["location"]&.include?("myshopify.com")
-            response_headers["location"].gsub!(%r{(https://#{@theme.shop})}, "http://127.0.0.1:9292")
+            response_headers["location"].gsub!(%r{(https://#{shop})}, "http://#{host(env)}")
           end
 
           new_session_id = extract_secure_session_id_from_response_headers(response_headers)
@@ -202,7 +195,7 @@ module ShopifyCLI
         end
 
         def request(method, path, headers: nil, query: [], form_data: nil, body_stream: nil)
-          uri = URI.join("https://#{@theme.shop}", path)
+          uri = URI.join("https://#{shop}", path)
           uri.query = URI.encode_www_form(query + [[:_fd, 0], [:pb, 0]])
 
           @ctx.debug("Proxying #{method} #{uri}")
@@ -218,6 +211,21 @@ module ShopifyCLI
             response
           end
         end
+
+        def shop
+          @shop ||= @theme.shop
+        end
+
+        def theme_id
+          @theme_id ||= @theme.id
+        end
+
+        def build_replacement_param(env)
+          @param_builder
+            .with_core_endpoints(@core_endpoints)
+            .with_rack_env(env)
+            .build
+        end
       end
     end
   end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+module ShopifyCLI
+  module Theme
+    class DevServer
+      class ProxyParamBuilder
+        def build
+          # Core doesn't support replace_templates
+          return {} if core?(current_path)
+
+          (syncer_templates + request_templates)
+            .select { |file| file.liquid? || file.json? }
+            .uniq(&:relative_path)
+            .map { |file| as_param(file) }
+            .to_h
+        end
+
+        def with_core_endpoints(core_endpoints)
+          @core_endpoints = core_endpoints
+          self
+        end
+
+        def with_syncer(syncer)
+          @syncer = syncer
+          self
+        end
+
+        def with_rack_env(rack_env)
+          @rack_env = rack_env
+          self
+        end
+
+        def with_theme(theme)
+          @theme = theme
+          self
+        end
+
+        private
+
+        def as_param(file)
+          ["replace_templates[#{file.relative_path}]", file.read]
+        end
+
+        def syncer_templates
+          @syncer&.pending_updates || []
+        end
+
+        def request_templates
+          cookie_sections
+            .map { |section| @theme[section] unless @theme.nil? }
+            .compact
+        end
+
+        def cookie_sections
+          CGI::Cookie.parse(cookie)["hot_reload_files"].join.split(",") || []
+        end
+
+        def core?(path)
+          core_endpoints.include?(path)
+        end
+
+        def current_path
+          rack_env["PATH_INFO"]
+        end
+
+        def cookie
+          rack_env["HTTP_COOKIE"]
+        end
+
+        def core_endpoints
+          @core_endpoints || []
+        end
+
+        def rack_env
+          @rack_env || {}
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class ReloadMode
         MODES = [:"hot-reload", :"full-page", :off]
 

data/lib/shopify_cli/theme/dev_server/remote_watcher/json_files_update_job.rb

@@ -4,7 +4,7 @@ require "shopify_cli/thread_pool/job"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class RemoteWatcher
         class JsonFilesUpdateJob < ShopifyCLI::ThreadPool::Job
           def initialize(theme, syncer, interval)

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

@@ -6,7 +6,7 @@ require_relative "remote_watcher/json_files_update_job"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       class RemoteWatcher
         SYNC_INTERVAL = 3 # seconds
 

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

@@ -3,7 +3,7 @@ require "thread"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       # Server-Sent events implementation for Rack.
       # Based on https://gist.github.com/raggi/ff7971991297e5c8a1ce
       class SSE

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

@@ -1,24 +1,23 @@
 # frozen_string_literal: true
-require "listen"
-require "observer"
+require "shopify_cli/file_system_listener"
+require "forwardable"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       # Watches for file changes and publish events to the theme
       class Watcher
-        include Observable
+        extend Forwardable
+
+        def_delegators :@listener, :add_observer, :changed, :notify_observers
 
         def initialize(ctx, theme:, syncer:, ignore_filter: nil, poll: false)
           @ctx = ctx
           @theme = theme
           @syncer = syncer
           @ignore_filter = ignore_filter
-          @listener = Listen.to(@theme.root, force_polling: poll,
-            ignore: @ignore_filter&.regexes) do |modified, added, removed|
-            changed
-            notify_observers(modified, added, removed)
-          end
+          @listener = FileSystemListener.new(root: @theme.root, force_poll: poll,
+            ignore_regex: @ignore_filter&.regexes)
 
           add_observer(self, :upload_files_when_changed)
         end

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

@@ -5,7 +5,7 @@ require "stringio"
 
 module ShopifyCLI
   module Theme
-    module DevServer
+    class DevServer
       # WEBrick will sometimes cause a fatal deadlock error on shutdown.
       # The error happens because `Thread#join` is called without a timeout argument.
       # We monkey-patch WEBrick to call `Thread#join(timeout)` before the existing