shopify-cli 2.20.1 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bab2227e665dd4dec8e90ca261705072971a838f85d19bcbb85d18ed1a1d5b0
-  data.tar.gz: 90e22472586a681a26974882b79ac3fd326fdcf696db2aa29201ab5d9a37c2b0
+  metadata.gz: 8971e6497feaa24c2fd34b00c29208f44ffb4cd6405b1b1ec08324b41ade05ad
+  data.tar.gz: 111bbf0f53d8d57812916ee930773887e07163008bd04a1796312378148d70ea
 SHA512:
-  metadata.gz: 24701865a98be1b3062ff7644fff3d35b61532803e96c39d84c7fae636b8205531e57e41641d1222dbd09275288e4dee2f2f94c837d58846212a0f4ed1643b28
-  data.tar.gz: 6e5c53ef75f07879d338692ce9271749002c13f8174a19fe3857b3396ec1512a2368770ec50bd24de2a0c9dc325dddb5b3547564c79cc360a40d1b19b35d2c50
+  metadata.gz: f83037ed5100015bb76f76864af37bff6a735c61d43f1d7870f67441f45d565530e2ebe43537f1f0891a6eda67a2631604916359b678ab8a7d262576a576171d
+  data.tar.gz: 7dd3af12ba1f384d7232c48c5a6f2724a99917eeb598d61d9a01cb86be4d2f114142daf226dc4f58f8083b4f0f8937cbd7f55d9b9283272be4e5c8c6e257ae04

data/CHANGELOG.md

@@ -2,6 +2,17 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## [Unreleased]
 
+## Version 2.21.0 - 2022-08-03
+
+### Fixed
+* [#2453](https://github.com/Shopify/shopify-cli/pull/2453): Fix [#2382](https://github.com/Shopify/shopify-cli/issues/2382): Ensure we wait 24 hours to show update message again
+* [#2463](https://github.com/Shopify/shopify-cli/pull/2463): Fix for "Keep the remote version" deletes files on new development theme
+* [#2405](https://github.com/Shopify/shopify-cli/pull/2405): Fix `theme serve` to trigger page refresh when a file is deleted
+* [#2489](https://github.com/Shopify/shopify-cli/pull/2489): Fix `theme serve` to hot reload many occurrences of a stylesheet
+
+### Added
+* [#2496](https://github.com/Shopify/shopify-cli/pull/2496): Accept storefront renderer token from ENV variable
+
 ## Version 2.20.1 - 2022-07-18
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.20.1)
+    shopify-cli (2.21.0)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.10.3)

data/lib/shopify_cli/constants.rb

@@ -54,6 +54,7 @@ module ShopifyCLI
       # Authentication
       AUTH_TOKEN = "SHOPIFY_CLI_AUTH_TOKEN"
       ADMIN_AUTH_TOKEN = "SHOPIFY_CLI_ADMIN_AUTH_TOKEN"
+      STOREFRONT_RENDERER_AUTH_TOKEN = "SHOPIFY_CLI_STOREFRONT_RENDERER_AUTH_TOKEN"
 
       # Monorail
       MONORAIL_REAL_EVENTS = "MONORAIL_REAL_EVENTS"

data/lib/shopify_cli/context.rb

@@ -628,9 +628,10 @@ module ShopifyCLI
           thread = Thread.new { retrieve_latest_gem_version }
           at_exit { thread.join }
         end
+        latest_version =
+          ShopifyCLI::Config.get(VERSION_CHECK_SECTION, LATEST_VERSION_FIELD, default: ShopifyCLI::VERSION)
+        latest_version if ::Semantic::Version.new(latest_version) > ::Semantic::Version.new(ShopifyCLI::VERSION)
       end
-      latest_version = ShopifyCLI::Config.get(VERSION_CHECK_SECTION, LATEST_VERSION_FIELD, default: ShopifyCLI::VERSION)
-      latest_version if ::Semantic::Version.new(latest_version) > ::Semantic::Version.new(ShopifyCLI::VERSION)
     end
 
     # Returns file extension depending on OS

data/lib/shopify_cli/environment.rb

@@ -170,6 +170,10 @@ module ShopifyCLI
       env_variables[Constants::EnvironmentVariables::ADMIN_AUTH_TOKEN]
     end
 
+    def self.storefront_renderer_auth_token(env_variables: ENV)
+      env_variables[Constants::EnvironmentVariables::STOREFRONT_RENDERER_AUTH_TOKEN]
+    end
+
     def self.store(env_variables: ENV)
       env_variables[Constants::EnvironmentVariables::STORE]
     end

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

@@ -14,7 +14,7 @@
   function connect() {
     const eventSource = new EventSource('/hot-reload');
 
-    eventSource.onmessage = handleUpdate;
+    eventSource.onmessage = onMessage;
 
     eventSource.onopen = () => console.log('[HotReload] SSE connected.');
 
@@ -97,10 +97,23 @@
     window.location.reload();
   }
 
-  function handleUpdate(message) {
-    var data = JSON.parse(message.data);
+  function onMessage(message) {
+    const data = JSON.parse(message.data);
+    if (data.reload_page) {
+      refreshPage([]);
+      return;
+    }
+
+    handleUpdate(data);
+  }
+
+  function handleUpdate(data) {
     var modifiedFiles = data.modified;
 
+    if (modifiedFiles === undefined) {
+      return;
+    }
+
     if (isRefreshRequired(modifiedFiles)) {
       refreshPage(modifiedFiles);
     } else {
@@ -114,13 +127,15 @@
 
   function reloadCssFile(filename) {
     // Find a stylesheet link starting with /assets (locally-served only) containing the filename
-    let link = document.querySelector(`link[href^="/assets"][href*="${filename}"][rel="stylesheet"]`);
+    let links = document.querySelectorAll(`link[href^="/assets"][href*="${filename}"][rel="stylesheet"]`);
 
-    if (!link) {
+    if (!links.length) {
       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}`);
+      links.forEach(link => {
+        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/remote_file_deleter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    module DevServer
+      class HotReload
+        class RemoteFileDeleter
+          def initialize(ctx, theme:, streams:)
+            @ctx = ctx
+            @theme = theme
+            @streams = streams
+          end
+
+          def delete(file)
+            retries = 6
+
+            until retries.zero?
+              retries -= 1
+
+              _status, body = fetch_asset(file)
+              retries = 0 if deleted_file?(body)
+
+              wait
+            end
+
+            notify(file)
+          end
+
+          private
+
+          def api_client
+            @api_client ||= ThemeAdminAPI.new(@ctx, @theme.shop)
+          end
+
+          def deleted_file?(body)
+            remote_checksum = body.dig("asset", "checksum")
+
+            remote_checksum.nil?
+          end
+
+          def notify(file)
+            @streams.broadcast(JSON.generate(deleted: [file]))
+            @ctx.debug("[RemoteFileDeleter] Deleted #{file}")
+          end
+
+          def wait
+            sleep(1)
+          end
+
+          def fetch_asset(file)
+            api_client.get(
+              path: "themes/#{@theme.id}/assets.json",
+              query: URI.encode_www_form("asset[key]" => file.relative_path),
+            )
+          rescue ShopifyCLI::API::APIRequestNotFoundError
+            [404, {}]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "hot_reload/remote_file_reloader"
+require_relative "hot_reload/remote_file_deleter"
 require_relative "hot_reload/sections_index"
 
 module ShopifyCLI
@@ -14,6 +15,7 @@ module ShopifyCLI
           @mode = mode
           @streams = SSE::Streams.new
           @remote_file_reloader = RemoteFileReloader.new(ctx, theme: @theme, streams: @streams)
+          @remote_file_deleter = RemoteFileDeleter.new(ctx, theme: @theme, streams: @streams)
           @sections_index = SectionsIndex.new(@theme)
           @watcher = watcher
           @watcher.add_observer(self, :notify_streams_of_file_change)
@@ -36,13 +38,20 @@ module ShopifyCLI
           @streams.close
         end
 
-        def notify_streams_of_file_change(modified, added, _removed)
+        def notify_streams_of_file_change(modified, added, removed)
           files = (modified + added)
             .reject { |file| @ignore_filter&.ignore?(file) }
             .map { |file| @theme[file] }
 
           files -= liquid_css_files = files.select(&:liquid_css?)
 
+          deleted_files = removed
+            .reject { |file| @ignore_filter&.ignore?(file) }
+            .map { |file| @theme[file] }
+
+          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
@@ -55,8 +64,21 @@ module ShopifyCLI
           @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_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_reload(files)
           files.each do |file|
+            @ctx.debug("reload file each -> file.relative_path #{file.relative_path}")
             @remote_file_reloader.reload(file)
           end
         end

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

@@ -94,6 +94,7 @@ module ShopifyCLI
         end
 
         def bearer_token
+          Environment.storefront_renderer_auth_token ||
           ShopifyCLI::DB.get(:storefront_renderer_production_exchange_token) ||
             raise(KeyError, "storefront_renderer_production_exchange_token missing")
         end

data/lib/shopify_cli/theme/syncer.rb

@@ -393,7 +393,11 @@ module ShopifyCLI
       end
 
       def overwrite_json?
-        @overwrite_json
+        theme_created_at_runtime? || @overwrite_json
+      end
+
+      def theme_created_at_runtime?
+        @theme.created_at_runtime?
       end
 
       def backingoff?

data/lib/shopify_cli/theme/theme.rb

@@ -120,6 +120,7 @@ module ShopifyCLI
         )
 
         @id = body["theme"]["id"]
+        @created_at_runtime = true
       end
 
       def delete
@@ -147,6 +148,10 @@ module ShopifyCLI
         development? && id != ShopifyCLI::DB.get(:development_theme_id)
       end
 
+      def created_at_runtime?
+        @created_at_runtime ||= false
+      end
+
       def to_h
         {
           id: id,

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.20.1"
+  VERSION = "2.21.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 2.20.1
+  version: 2.21.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -507,6 +507,7 @@ files:
 - lib/shopify_cli/theme/dev_server/hot-reload-no-script.html
 - lib/shopify_cli/theme/dev_server/hot-reload.js
 - lib/shopify_cli/theme/dev_server/hot_reload.rb
+- lib/shopify_cli/theme/dev_server/hot_reload/remote_file_deleter.rb
 - lib/shopify_cli/theme/dev_server/hot_reload/remote_file_reloader.rb
 - lib/shopify_cli/theme/dev_server/hot_reload/sections_index.rb
 - lib/shopify_cli/theme/dev_server/local_assets.rb