shopify-cli 2.2.1 → 2.5.0

data/lib/{shopify-cli → shopify_cli}/tasks/select_org_and_shop.rb

@@ -1,8 +1,8 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Tasks
-    class SelectOrgAndShop < ShopifyCli::Task
+    class SelectOrgAndShop < ShopifyCLI::Task
       attr_reader :ctx
 
       def call(ctx, organization_id: nil, shop_domain: nil)
@@ -12,7 +12,7 @@ module ShopifyCli
         unless Shopifolk.acting_as_shopify_organization?
           shop_domain ||= get_shop_domain(org)
         end
-        ShopifyCli::Core::Monorail.metadata[:organization_id] = org["id"].to_i
+        ShopifyCLI::Core::Monorail.metadata[:organization_id] = org["id"].to_i
         response(org["id"].to_i, shop_domain)
       end
 
@@ -25,20 +25,20 @@ module ShopifyCli
       end
 
       def organizations
-        @organizations ||= ShopifyCli::PartnersAPI::Organizations.fetch_all(ctx)
+        @organizations ||= ShopifyCLI::PartnersAPI::Organizations.fetch_all(ctx)
       end
 
       def get_organization(organization_id)
         @organization ||= if !organization_id.nil?
-          org = ShopifyCli::PartnersAPI::Organizations.fetch(ctx, id: organization_id)
+          org = ShopifyCLI::PartnersAPI::Organizations.fetch(ctx, id: organization_id)
           if org.nil?
-            ctx.puts(ctx.message("core.tasks.select_org_and_shop.authentication_issue", ShopifyCli::TOOL_NAME))
+            ctx.puts(ctx.message("core.tasks.select_org_and_shop.authentication_issue", ShopifyCLI::TOOL_NAME))
             ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.organization_not_found"))
           end
           org
         elsif organizations.count == 0
           if Shopifolk.acting_as_shopify_organization?
-            ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.shopifolk_notice", ShopifyCli::TOOL_NAME))
+            ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.shopifolk_notice", ShopifyCLI::TOOL_NAME))
           else
             ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.no_organizations"))
           end
@@ -64,7 +64,7 @@ module ShopifyCli
         if valid_stores.count == 0
           ctx.puts(ctx.message("core.tasks.select_org_and_shop.error.no_development_stores"))
           ctx.puts(ctx.message("core.tasks.select_org_and_shop.create_store", organization["id"]))
-          ctx.puts(ctx.message("core.tasks.select_org_and_shop.authentication_issue", ShopifyCli::TOOL_NAME))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.authentication_issue", ShopifyCLI::TOOL_NAME))
         elsif valid_stores.count == 1
           domain = valid_stores.first["shopDomain"]
           ctx.puts(ctx.message("core.tasks.select_org_and_shop.development_store", domain))

data/lib/{shopify-cli → shopify_cli}/tasks/update_dashboard_urls.rb

@@ -1,24 +1,24 @@
-module ShopifyCli
+module ShopifyCLI
   module Tasks
-    class UpdateDashboardURLS < ShopifyCli::Task
+    class UpdateDashboardURLS < ShopifyCLI::Task
       NGROK_REGEX = /https:\/\/([a-z0-9\-]+\.ngrok\.io)(.*)/
 
       def call(ctx, url:, callback_url:)
         @ctx = ctx
-        project = ShopifyCli::Project.current
+        project = ShopifyCLI::Project.current
         api_key = project.env.api_key
-        result = ShopifyCli::PartnersAPI.query(ctx, "get_app_urls", apiKey: api_key)
+        result = ShopifyCLI::PartnersAPI.query(ctx, "get_app_urls", apiKey: api_key)
         app = result["data"]["app"]
         consent = check_application_url(app["applicationUrl"], url)
         constructed_urls = construct_redirect_urls(app["redirectUrlWhitelist"], url, callback_url)
         return if url == app["applicationUrl"]
-        ShopifyCli::PartnersAPI.query(@ctx, "update_dashboard_urls", input: {
+        ShopifyCLI::PartnersAPI.query(@ctx, "update_dashboard_urls", input: {
           applicationUrl: consent ? url : app["applicationUrl"],
           redirectUrlWhitelist: constructed_urls, apiKey: api_key
         })
         @ctx.puts(@ctx.message("core.tasks.update_dashboard_urls.updated"))
       rescue
-        @ctx.puts(@ctx.message("core.tasks.update_dashboard_urls.update_error", ShopifyCli::TOOL_NAME))
+        @ctx.puts(@ctx.message("core.tasks.update_dashboard_urls.update_error", ShopifyCLI::TOOL_NAME))
         raise
       end
 

data/lib/{shopify-cli → shopify_cli}/tasks.rb

@@ -1,6 +1,6 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Tasks
     class TaskRegistry
       def initialize
@@ -30,14 +30,14 @@ module ShopifyCli
       Registry.add(-> () { const_get(task) }, name)
     end
 
-    register :ConfirmStore, :confirm_store, "shopify-cli/tasks/confirm_store"
-    register :CreateApiClient, :create_api_client, "shopify-cli/tasks/create_api_client"
-    register :EnsureAuthenticated, :ensure_authenticated, "shopify-cli/tasks/ensure_authenticated"
-    register :EnsureEnv, :ensure_env, "shopify-cli/tasks/ensure_env"
-    register :EnsureLoopbackURL, :ensure_loopback_url, "shopify-cli/tasks/ensure_loopback_url"
-    register :EnsureProjectType, :ensure_project_type, "shopify-cli/tasks/ensure_project_type"
-    register :EnsureDevStore, :ensure_dev_store, "shopify-cli/tasks/ensure_dev_store"
-    register :SelectOrgAndShop, :select_org_and_shop, "shopify-cli/tasks/select_org_and_shop"
-    register :UpdateDashboardURLS, :update_dashboard_urls, "shopify-cli/tasks/update_dashboard_urls"
+    register :ConfirmStore, :confirm_store, "shopify_cli/tasks/confirm_store"
+    register :CreateApiClient, :create_api_client, "shopify_cli/tasks/create_api_client"
+    register :EnsureAuthenticated, :ensure_authenticated, "shopify_cli/tasks/ensure_authenticated"
+    register :EnsureEnv, :ensure_env, "shopify_cli/tasks/ensure_env"
+    register :EnsureLoopbackURL, :ensure_loopback_url, "shopify_cli/tasks/ensure_loopback_url"
+    register :EnsureProjectType, :ensure_project_type, "shopify_cli/tasks/ensure_project_type"
+    register :EnsureDevStore, :ensure_dev_store, "shopify_cli/tasks/ensure_dev_store"
+    register :SelectOrgAndShop, :select_org_and_shop, "shopify_cli/tasks/select_org_and_shop"
+    register :UpdateDashboardURLS, :update_dashboard_urls, "shopify_cli/tasks/update_dashboard_urls"
   end
 end

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/certificate_manager.rb

@@ -2,7 +2,7 @@
 
 require "openssl"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       class CertificateManager
@@ -19,13 +19,13 @@ module ShopifyCli
         end
 
         def find_or_create_certificates!
-          @private_key = if (private_key_pem = ShopifyCli::DB.get(:ssl_private_key))
+          @private_key = if (private_key_pem = ShopifyCLI::DB.get(:ssl_private_key))
             OpenSSL::PKey::RSA.new(private_key_pem)
           else
             OpenSSL::PKey::RSA.new(2048)
           end
 
-          @certificate = if (certificate_pem = ShopifyCli::DB.get(:ssl_certificate))
+          @certificate = if (certificate_pem = ShopifyCLI::DB.get(:ssl_certificate))
             OpenSSL::X509::Certificate.new(certificate_pem)
           else
             x509_certificate = build_x509_certificate
@@ -35,8 +35,8 @@ module ShopifyCli
             x509_certificate
           end
 
-          ShopifyCli::DB.set(ssl_certificate: certificate.to_pem)
-          ShopifyCli::DB.set(ssl_private_key: private_key.to_pem)
+          ShopifyCLI::DB.set(ssl_certificate: certificate.to_pem)
+          ShopifyCLI::DB.set(ssl_private_key: private_key.to_pem)
         end
 
         private

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/header_hash.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # Based on Rack::HeaderHash
@@ -47,6 +47,10 @@ module ShopifyCli
           super(k) || super(@names[k.downcase])
         end
 
+        def fetch(k, default = nil)
+          self[k] || super(@names[k.downcase], default)
+        end
+
         def []=(k, v)
           canonical = k.downcase.freeze
           # .delete is expensive, don't invoke it unless necessary

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/hot_reload.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       class HotReload
@@ -34,11 +34,10 @@ module ShopifyCli
           files = (modified + added).reject { |file| @ignore_filter&.ignore?(file) }
             .map { |file| @theme[file].relative_path }
 
-          @streams.broadcast(JSON.generate(
-            modified: files,
-          ))
-
-          @ctx.debug("[HotReload] Modified #{files.join(", ")}")
+          unless files.empty?
+            @streams.broadcast(JSON.generate(modified: files))
+            @ctx.debug("[HotReload] Modified #{files.join(", ")}")
+          end
         end
 
         private

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/local_assets.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       class LocalAssets

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/proxy.rb

@@ -3,7 +3,7 @@ require "net/http"
 require "stringio"
 require "time"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       HOP_BY_HOP_HEADERS = [
@@ -79,7 +79,7 @@ module ShopifyCli
         end
 
         def bearer_token
-          ShopifyCli::DB.get(:storefront_renderer_production_exchange_token) ||
+          ShopifyCLI::DB.get(:storefront_renderer_production_exchange_token) ||
             raise(KeyError, "storefront_renderer_production_exchange_token missing")
         end
 
@@ -155,11 +155,16 @@ module ShopifyCli
           Time.now - @last_session_cookie_refresh >= SESSION_COOKIE_MAX_AGE
         end
 
+        def extract_secure_session_id_from_response_headers(headers)
+          return unless headers["set-cookie"]
+          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 = response["set-cookie"][SESSION_COOKIE_REGEXP, 1]
+            @secure_session_id = extract_secure_session_id_from_response_headers(response)
             @last_session_cookie_refresh = Time.now
           end
 
@@ -179,6 +184,13 @@ module ShopifyCli
             response_headers["location"].gsub!(%r{(https://#{@theme.shop})}, "http://127.0.0.1:9292")
           end
 
+          new_session_id = extract_secure_session_id_from_response_headers(response_headers)
+          if new_session_id
+            @ctx.debug("New _secure_session_id cookie from response")
+            @secure_session_id = new_session_id
+            @last_session_cookie_refresh = Time.now
+          end
+
           response_headers
         end
 

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/sse.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "thread"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # Server-Sent events implementation for Rack.

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/watcher.rb

@@ -2,7 +2,7 @@
 require "listen"
 require "observer"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # Watches for file changes and publish events to the theme

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/web_server.rb

@@ -3,7 +3,7 @@
 require "webrick"
 require "stringio"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # WEBrick will sometimes cause a fatal deadlock error on shutdown.

data/lib/{shopify-cli → shopify_cli}/theme/dev_server.rb

@@ -14,7 +14,7 @@ require_relative "dev_server/certificate_manager"
 
 require "pathname"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       class << self
@@ -80,8 +80,8 @@ module ShopifyCli
           )
           watcher.stop
 
-        rescue ShopifyCli::API::APIRequestForbiddenError,
-               ShopifyCli::API::APIRequestUnauthorizedError
+        rescue ShopifyCLI::API::APIRequestForbiddenError,
+               ShopifyCLI::API::APIRequestUnauthorizedError
           @ctx.abort("You are not authorized to edit themes on #{theme.shop}.\n" \
                      "Make sure you are a user of that store, and allowed to edit themes.")
         end

data/lib/shopify_cli/theme/development_theme.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require_relative "theme"
+
+require "socket"
+require "securerandom"
+
+module ShopifyCLI
+  module Theme
+    API_NAME_LIMIT = 50
+
+    class DevelopmentTheme < Theme
+      def id
+        ShopifyCLI::DB.get(:development_theme_id)
+      end
+
+      def name
+        existing_name = ShopifyCLI::DB.get(:development_theme_name)
+        # Up to version 2.3.0 (included) generated names stored locally
+        # could have more than 50 characters and the API rejected them.
+        # This code ensures we update the name for those users to ensure
+        # the name stays under the limit.
+        if existing_name.nil? || existing_name.length > API_NAME_LIMIT
+          generate_theme_name
+        else
+          existing_name
+        end
+      end
+
+      def role
+        "development"
+      end
+
+      def ensure_exists!
+        if exists?
+          @ctx.debug("Using temporary development theme: ##{id} #{name}")
+        else
+          create
+          @ctx.debug("Created temporary development theme: #{@id}")
+          ShopifyCLI::DB.set(development_theme_id: @id)
+        end
+      end
+
+      def exists?
+        return false unless id
+
+        ShopifyCLI::AdminAPI.rest_request(
+          @ctx,
+          shop: shop,
+          path: "themes/#{id}.json",
+          api_version: "unstable",
+        )
+      rescue ShopifyCLI::API::APIRequestNotFoundError
+        false
+      end
+
+      def delete
+        super if exists?
+        ShopifyCLI::DB.del(:development_theme_id) if ShopifyCLI::DB.exists?(:development_theme_id)
+        ShopifyCLI::DB.del(:development_theme_name) if ShopifyCLI::DB.exists?(:development_theme_name)
+      end
+
+      def self.delete(ctx)
+        new(ctx).delete
+      end
+
+      private
+
+      def generate_theme_name
+        hostname = Socket.gethostname.split(".").shift
+        hash = SecureRandom.hex(3)
+
+        theme_name = "Development ()"
+        hostname_character_limit = API_NAME_LIMIT - theme_name.length - hash.length - 1
+        identifier = "#{hash}-#{hostname[0, hostname_character_limit]}"
+        theme_name = "Development (#{identifier})"
+
+        ShopifyCLI::DB.set(development_theme_name: theme_name)
+
+        theme_name
+      end
+    end
+  end
+end

data/lib/{shopify-cli → shopify_cli}/theme/file.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require_relative "mime_type"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class File < Struct.new(:path)
       attr_reader :relative_path
@@ -17,12 +17,20 @@ module ShopifyCli
       end
 
       def read
-        path.read
+        if text?
+          path.read
+        else
+          path.read(mode: "rb")
+        end
       end
 
-      def write(*args)
+      def write(content)
         path.parent.mkpath unless path.parent.directory?
-        path.write(*args)
+        if text?
+          path.write(content)
+        else
+          path.write(content, 0, mode: "wb")
+        end
       end
 
       def delete

data/lib/{shopify-cli → shopify_cli}/theme/ignore_filter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class IgnoreFilter
       FILE = ".shopifyignore"
@@ -59,6 +59,13 @@ module ShopifyCli
         @globs = globs
       end
 
+      def add_patterns(patterns)
+        regexes, globs = patterns_to_regexes_and_globs(patterns)
+
+        @regexes += regexes
+        @globs += globs
+      end
+
       def match?(path)
         path = path.to_s
 

data/lib/{shopify-cli → shopify_cli}/theme/mime_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "webrick"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class MimeType < Struct.new(:name)
       MIME_TYPES = WEBrick::HTTPUtils::DefaultMimeTypes.merge(

data/lib/{shopify-cli → shopify_cli}/theme/syncer.rb

@@ -3,7 +3,7 @@ require "thread"
 require "json"
 require "base64"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class Syncer
       class Operation < Struct.new(:method, :file)
@@ -80,7 +80,7 @@ module ShopifyCli
       end
 
       def fetch_checksums!
-        _status, response = ShopifyCli::AdminAPI.rest_request(
+        _status, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",
@@ -211,7 +211,7 @@ module ShopifyCli
           used, total = limit.split("/").map(&:to_i)
           backoff_if_near_limit!(used, total)
         end
-      rescue ShopifyCli::API::APIRequestError => e
+      rescue ShopifyCLI::API::APIRequestError => e
         report_error(
           "{{red:ERROR}} {{blue:#{operation}}}:\n  " +
           parse_api_errors(e).join("\n  ")
@@ -228,7 +228,7 @@ module ShopifyCli
           asset[:attachment] = Base64.encode64(file.read)
         end
 
-        _status, body, response = ShopifyCli::AdminAPI.rest_request(
+        _status, body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",
@@ -243,7 +243,7 @@ module ShopifyCli
       end
 
       def get(file)
-        _status, body, response = ShopifyCli::AdminAPI.rest_request(
+        _status, body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",
@@ -256,7 +256,7 @@ module ShopifyCli
 
         attachment = body.dig("asset", "attachment")
         value = if attachment
-          file.write(Base64.decode64(attachment), 0, mode: "wb")
+          file.write(Base64.decode64(attachment))
         else
           file.write(body.dig("asset", "value"))
         end
@@ -265,7 +265,7 @@ module ShopifyCli
       end
 
       def delete(file)
-        _status, _body, response = ShopifyCli::AdminAPI.rest_request(
+        _status, _body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",

data/lib/{shopify-cli → shopify_cli}/theme/theme.rb

@@ -4,7 +4,7 @@ require_relative "file"
 require "pathname"
 require "time"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class InvalidThemeRole < StandardError; end
 
@@ -101,7 +101,7 @@ module ShopifyCli
       def create
         raise InvalidThemeRole, "Can't create live theme. Use publish." if live?
 
-        _status, body = ShopifyCli::AdminAPI.rest_request(
+        _status, body = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: shop,
           path: "themes.json",
@@ -144,11 +144,11 @@ module ShopifyCli
       end
 
       def current_development?
-        development? && id == ShopifyCli::DB.get(:development_theme_id)
+        development? && id == ShopifyCLI::DB.get(:development_theme_id)
       end
 
       def foreign_development?
-        development? && id != ShopifyCli::DB.get(:development_theme_id)
+        development? && id != ShopifyCLI::DB.get(:development_theme_id)
       end
 
       def to_h

data/lib/{shopify-cli → shopify_cli}/transform_data_structure.rb

@@ -1,5 +1,5 @@
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # `TransformDataStructure` helps to standardize data structure access. It
   # traverses nested data structures and can convert
@@ -22,13 +22,13 @@ module ShopifyCli
   # Since `TransformDataStructure` is a method object, it can easily be chained:
   #
   #    require 'open-uri'
-  #    ShopifyCli::Result
+  #    ShopifyCLI::Result
   #      .call { open("https://jsonplaceholder.typicode.com/todos/1") }
   #      .map(&TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
   #      .value # => { id: 1, user_id: 1, ... }
   #
   class TransformDataStructure
-    include ShopifyCli::MethodObject
+    include ShopifyCLI::MethodObject
 
     class << self
       private
@@ -53,7 +53,7 @@ module ShopifyCli
           result[transform_key(key)] = call(value).value
         end
       else
-        ShopifyCli::Result.success(object)
+        ShopifyCLI::Result.success(object)
       end
     end