shopify-cli 2.3.0 → 2.4.0

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -9,18 +9,21 @@ module Script
       class ScriptService
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
+        property! :api_key, accepts: String
 
-        def push(
+        def initialize(*args, ctx:, api_key:, **kwargs)
+          super(*args, ctx: ctx, api_key: api_key, **kwargs)
+          @client = ApiClients.default_client(ctx, api_key)
+        end
+
+        def set_app_script(
           uuid:,
           extension_point_type:,
-          script_content:,
-          api_key: nil,
           force: false,
           metadata:,
-          script_json:
+          script_json:,
+          module_upload_url:
         )
-          url = UploadScript.new(ctx).call(api_key, script_content)
-
           query_name = "app_script_set"
           variables = {
             uuid: uuid,
@@ -33,9 +36,9 @@ module Script
             scriptJsonVersion: script_json.version,
             configurationUi: script_json.configuration_ui,
             configurationDefinition: script_json.configuration&.to_json,
-            moduleUploadUrl: url,
+            moduleUploadUrl: module_upload_url,
           }
-          resp_hash = MakeRequest.new(ctx).call(query_name: query_name, api_key: api_key, variables: variables)
+          resp_hash = make_request(query_name: query_name, variables: variables)
           user_errors = resp_hash["data"]["appScriptSet"]["userErrors"]
 
           return resp_hash["data"]["appScriptSet"]["appScript"]["uuid"] if user_errors.empty?
@@ -63,149 +66,31 @@ module Script
           end
         end
 
-        def get_app_scripts(api_key:, extension_point_type:)
+        def get_app_scripts(extension_point_type:)
           query_name = "get_app_scripts"
           variables = { appKey: api_key, extensionPointName: extension_point_type.upcase }
-          response = MakeRequest.new(ctx).call(
-            query_name: query_name,
-            api_key: api_key,
-            variables: variables
-          )
+          response = make_request(query_name: query_name, variables: variables)
           response["data"]["appScripts"]
         end
 
-        class ScriptServiceAPI < ShopifyCli::API
-          property(:api_key, accepts: String)
-
-          LOCAL_INSTANCE_URL = "https://script-service.myshopify.io"
-
-          def self.query(ctx, query_name, api_key: nil, variables: {})
-            api_client(ctx, api_key).query(query_name, variables: variables)
-          end
-
-          def self.api_client(ctx, api_key)
-            instance_url = spin_instance_url || LOCAL_INSTANCE_URL
-            new(
-              ctx: ctx,
-              url: "#{instance_url}/graphql",
-              token: "",
-              api_key: api_key
-            )
-          end
-
-          def self.spin_instance_url
-            workspace = ENV["SPIN_WORKSPACE"]
-            namespace = ENV["SPIN_NAMESPACE"]
-            return if workspace.nil? || namespace.nil?
-
-            "https://script-service.#{workspace}.#{namespace}.us.spin.dev"
-          end
+        def generate_module_upload_url
+          query_name = "module_upload_url_generate"
+          variables = {}
+          response = make_request(query_name: query_name, variables: variables)
+          user_errors = response["data"]["moduleUploadUrlGenerate"]["userErrors"]
 
-          def auth_headers(*)
-            tokens = { "APP_KEY" => api_key }.compact.to_json
-            { "X-Shopify-Authenticated-Tokens" => tokens }
-          end
+          raise Errors::GraphqlError, user_errors if user_errors.any?
+          response["data"]["moduleUploadUrlGenerate"]["url"]
         end
-        private_constant(:ScriptServiceAPI)
-
-        class PartnersProxyAPI < ShopifyCli::PartnersAPI
-          def query(query_name, variables: {})
-            variables[:query] = load_query(query_name)
-            super("script_service_proxy", variables: variables)
-          end
-        end
-        private_constant(:PartnersProxyAPI)
-
-        class MakeRequest
-          attr_reader :ctx
 
-          def initialize(ctx)
-            @ctx = ctx
-          end
+        private
 
-          def self.bypass_partners_proxy
-            !ENV["BYPASS_PARTNERS_PROXY"].nil?
-          end
+        def make_request(query_name:, variables: {})
+          response = @client.query(query_name, variables: variables)
+          raise Errors::EmptyResponseError if response.nil?
+          raise Errors::GraphqlError, response["errors"] if response.key?("errors")
 
-          def call(query_name:, variables: nil, **options)
-            resp = if MakeRequest.bypass_partners_proxy
-              ScriptServiceAPI.query(ctx, query_name, variables: variables, **options)
-            else
-              proxy_through_partners(query_name: query_name, variables: variables, **options)
-            end
-            raise_if_graphql_failed(resp)
-            resp
-          end
-
-          def proxy_through_partners(query_name:, variables: nil, **options)
-            options[:variables] = variables.to_json if variables
-            resp = PartnersProxyAPI.query(ctx, query_name, **options)
-            raise_if_graphql_failed(resp)
-            JSON.parse(resp["data"]["scriptServiceProxy"])
-          end
-
-          def raise_if_graphql_failed(response)
-            raise Errors::EmptyResponseError if response.nil?
-
-            return unless response.key?("errors")
-            case error_code(response["errors"])
-            when "forbidden"
-              raise Errors::ForbiddenError
-            when "forbidden_on_shop"
-              raise Errors::ShopAuthenticationError
-            when "app_not_installed_on_shop"
-              raise Errors::AppNotInstalledError
-            else
-              raise Errors::GraphqlError, response["errors"]
-            end
-          end
-
-          def error_code(errors)
-            errors.map do |e|
-              code = e.dig("extensions", "code")
-              return code if code
-            end
-          end
-        end
-
-        class UploadScript
-          attr_reader :ctx
-
-          def initialize(ctx)
-            @ctx = ctx
-          end
-
-          def call(api_key, script_content)
-            apply_module_upload_url(api_key).tap do |url|
-              upload(url, script_content)
-            end
-          end
-
-          private
-
-          def apply_module_upload_url(api_key)
-            query_name = "module_upload_url_generate"
-            variables = {}
-            resp_hash = MakeRequest.new(ctx).call(query_name: query_name, api_key: api_key, variables: variables)
-            user_errors = resp_hash["data"]["moduleUploadUrlGenerate"]["userErrors"]
-
-            raise Errors::GraphqlError, user_errors if user_errors.any?
-            resp_hash["data"]["moduleUploadUrlGenerate"]["url"]
-          end
-
-          def upload(url, script_content)
-            url = URI(url)
-
-            https = Net::HTTP.new(url.host, url.port)
-            https.use_ssl = true
-
-            request = Net::HTTP::Put.new(url)
-            request["Content-Type"] = "application/wasm"
-            request.body = script_content
-
-            response = https.request(request)
-            raise Errors::ScriptUploadError unless response.code == "200"
-          end
+          response
         end
       end
     end

data/lib/project_types/script/layers/infrastructure/script_uploader.rb

@@ -0,0 +1,27 @@
+module Script
+  module Layers
+    module Infrastructure
+      class ScriptUploader
+        def initialize(script_service)
+          @script_service = script_service
+        end
+
+        def upload(script_content)
+          @script_service.generate_module_upload_url.tap do |url|
+            url = URI(url)
+
+            https = Net::HTTP.new(url.host, url.port)
+            https.use_ssl = true
+
+            request = Net::HTTP::Put.new(url)
+            request["Content-Type"] = "application/wasm"
+            request.body = script_content
+
+            response = https.request(request)
+            raise Errors::ScriptUploadError unless response.code == "200"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/script/tasks/ensure_env.rb

@@ -89,8 +89,8 @@ module Script
       end
 
       def ask_script_uuid(app, extension_point_type)
-        script_service = Layers::Infrastructure::ScriptService.new(ctx: ctx)
-        scripts = script_service.get_app_scripts(api_key: app["apiKey"], extension_point_type: extension_point_type)
+        script_service = Layers::Infrastructure::ScriptService.new(ctx: ctx, api_key: app["apiKey"])
+        scripts = script_service.get_app_scripts(extension_point_type: extension_point_type)
 
         return nil unless scripts.count > 0 &&
           CLI::UI::Prompt.confirm(ctx.message("script.application.ensure_env.ask_connect_to_existing_script"))

data/lib/project_types/script/ui/error_handler.rb

@@ -99,7 +99,7 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_extension_cause", e.type),
             help_suggestion: ShopifyCli::Context.message(
               "script.error.invalid_extension_help",
-              Script::Layers::Application::ExtensionPoints.types.join(", ")
+              Script::Layers::Application::ExtensionPoints.available_types.join(", ")
             ),
           }
         when Layers::Domain::Errors::ScriptNotFoundError

data/lib/shopify-cli/constants.rb

@@ -0,0 +1,26 @@
+module ShopifyCli
+  module Constants
+    module EnvironmentVariables
+      # When true the CLI points to a local instance of
+      # the partners dashboard and identity.
+      LOCAL_PARTNERS = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
+
+      # When true the CLI points to a spin instance of spin
+      SPIN_PARTNERS = "SHOPIFY_APP_CLI_SPIN_PARTNERS"
+
+      SPIN_WORKSPACE = "SPIN_WORKSPACE"
+
+      SPIN_NAMESPACE = "SPIN_NAMESPACE"
+
+      SPIN_HOST = "SPIN_HOST"
+
+      # Set to true when running tests.
+      RUNNING_TESTS = "RUNNING_SHOPIFY_CLI_TESTS"
+    end
+
+    module Identity
+      CLIENT_ID_DEV = "e5380e02-312a-7408-5718-e07017e9cf52"
+      CLIENT_ID = "fbdb2649-e327-4907-8f67-908d24cfd7e3"
+    end
+  end
+end

data/lib/shopify-cli/environment.rb

@@ -0,0 +1,60 @@
+module ShopifyCli
+  # The environment module provides an interface to get information from
+  # the environment in which the CLI runs
+  module Environment
+    TRUTHY_ENV_VARIABLE_VALUES = ["1", "true", "TRUE", "yes", "YES"]
+    def self.use_local_partners_instance?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::LOCAL_PARTNERS,
+        env_variables: env_variables
+      )
+    end
+
+    def self.use_spin_partners_instance?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::SPIN_PARTNERS,
+        env_variables: env_variables
+      )
+    end
+
+    def self.running_tests?(env_variables: ENV)
+      env_variable_truthy?(
+        Constants::EnvironmentVariables::RUNNING_TESTS,
+        env_variables: env_variables
+      )
+    end
+
+    def self.partners_domain(env_variables: ENV)
+      if use_local_partners_instance?(env_variables: env_variables)
+        "partners.myshopify.io"
+      elsif use_spin_partners_instance?(env_variables: env_variables)
+        "partners.#{spin_url(env_variables: env_variables)}"
+      else
+        "partners.shopify.com"
+      end
+    end
+
+    def self.spin_url(env_variables: ENV)
+      spin_workspace = spin_workspace(env_variables: env_variables)
+      spin_namespace = spin_namespace(env_variables: env_variables)
+      spin_host = spin_host(env_variables: env_variables)
+      "#{spin_workspace}.#{spin_namespace}.#{spin_host}"
+    end
+
+    def self.env_variable_truthy?(variable_name, env_variables: ENV)
+      TRUTHY_ENV_VARIABLE_VALUES.include?(env_variables[variable_name.to_s])
+    end
+
+    def self.spin_workspace(env_variables: ENV)
+      env_variables[Constants::EnvironmentVariables::SPIN_WORKSPACE]
+    end
+
+    def self.spin_namespace(env_variables: ENV)
+      env_variables[Constants::EnvironmentVariables::SPIN_NAMESPACE]
+    end
+
+    def self.spin_host(env_variables: ENV)
+      env_variables[Constants::EnvironmentVariables::SPIN_HOST] || "us.spin.dev"
+    end
+  end
+end

data/lib/shopify-cli/git.rb

@@ -108,8 +108,8 @@ module ShopifyCli
       private
 
       def exec(*args, dir: Dir.pwd, default: nil, ctx: Context.new)
-        args = %w(git) + args
-        out, _, stat = ctx.capture3(*args, chdir: dir)
+        args = %w(git) + ["--git-dir", File.join(dir, ".git")] + args
+        out, _, stat = ctx.capture3(*args)
         return default unless stat.success?
         out.chomp
       end

data/lib/shopify-cli/identity_auth.rb

@@ -17,7 +17,6 @@ module ShopifyCli
     class Error < StandardError; end
     class Timeout < StandardError; end
     LocalRequest = Struct.new(:method, :path, :query, :protocol)
-    LOCAL_DEBUG = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
 
     DEFAULT_PORT = 3456
     REDIRECT_HOST = "http://127.0.0.1:#{DEFAULT_PORT}"
@@ -236,12 +235,17 @@ module ShopifyCli
     end
 
     def auth_url
-      return "https://accounts.shopify.com/oauth" if ENV[LOCAL_DEBUG].nil?
-      "https://identity.myshopify.io/oauth"
+      if Environment.use_local_partners_instance?
+        "https://identity.myshopify.io/oauth"
+      elsif Environment.use_spin_partners_instance?
+        "https://identity.#{Environment.spin_url}/oauth"
+      else
+        "https://accounts.shopify.com/oauth"
+      end
     end
 
     def client_id_for_application(application_name)
-      client_ids = if ENV[LOCAL_DEBUG]
+      client_ids = if Environment.use_local_partners_instance? || Environment.use_spin_partners_instance?
         DEV_APPLICATION_CLIENT_IDS
       else
         APPLICATION_CLIENT_IDS
@@ -257,26 +261,15 @@ module ShopifyCli
     end
 
     def client_id
-      return "fbdb2649-e327-4907-8f67-908d24cfd7e3" if ENV[LOCAL_DEBUG].nil?
-
-      ctx.abort(ctx.message("core.identity_auth.error.local_identity_not_running")) unless local_identity_running?
-
-      # Fetch the client ID from the local Identity Dynamic Registration endpoint
-      response = post_request("/client", {
-        name: "shopify-cli-development",
-        public_type: "native",
-      })
-
-      response["client_id"]
-    end
-
-    def local_identity_running?
-      Net::HTTP.start("identity.myshopify.io", 443, use_ssl: true, open_timeout: 1, read_timeout: 10) do |http|
-        req = Net::HTTP::Get.new(URI.join("https://identity.myshopify.io", "/services/ping"))
-        http.request(req).is_a?(Net::HTTPSuccess)
+      if Environment.use_local_partners_instance? || Environment.use_spin_partners_instance?
+        Constants::Identity::CLIENT_ID_DEV
+      else
+        # In the future we might want to use Identity's dynamic
+        # registration. To migrate to a dynamic client ID we
+        # need to refactor some code that relies on a static
+        # value for the client
+        Constants::Identity::CLIENT_ID
       end
-    rescue Timeout::Error, Errno::EHOSTUNREACH, Errno::EHOSTDOWN, Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED
-      false
     end
   end
 end

data/lib/shopify-cli/partners_api.rb

@@ -8,16 +8,6 @@ module ShopifyCli
   class PartnersAPI < API
     autoload :Organizations, "shopify-cli/partners_api/organizations"
 
-    # Defines the environment variable that this API looks for to operate on local
-    # services. If you set this environment variable in your shell then the partners
-    # API will operate on your local instance
-    #
-    # #### Example
-    #
-    #  SHOPIFY_APP_CLI_LOCAL_PARTNERS=1 shopify create
-    #
-    LOCAL_DEBUG = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
-
     class << self
       ##
       # issues a graphql query or mutation to the Shopify Partners Dashboard CLI Schema.
@@ -59,11 +49,11 @@ module ShopifyCli
         ctx.puts(ctx.message("core.partners_api.error.account_not_found", ShopifyCli::TOOL_NAME))
       end
 
-      def partners_url_for(organization_id, api_client_id, local_debug)
+      def partners_url_for(organization_id, api_client_id)
         if ShopifyCli::Shopifolk.acting_as_shopify_organization?
           organization_id = "internal"
         end
-        "#{partners_endpoint(local_debug)}/#{organization_id}/apps/#{api_client_id}"
+        "https://#{Environment.partners_domain}/#{organization_id}/apps/#{api_client_id}"
       end
 
       private
@@ -72,7 +62,7 @@ module ShopifyCli
         new(
           ctx: ctx,
           token: access_token(ctx),
-          url: "#{endpoint}/api/cli/graphql",
+          url: "https://#{Environment.partners_domain}/api/cli/graphql",
         )
       end
 
@@ -83,20 +73,6 @@ module ShopifyCli
         end
       end
 
-      def endpoint
-        return "https://partners.shopify.com" if ENV[LOCAL_DEBUG].nil?
-        "https://partners.myshopify.io/"
-      end
-
-      def partners_endpoint(local_debug)
-        domain = if local_debug
-          "partners.myshopify.io"
-        else
-          "partners.shopify.com"
-        end
-        "https://#{domain}"
-      end
-
       def auth_failure_info(ctx, error)
         if error.response
           headers = %w(www-authenticate x-request-id)

data/lib/shopify-cli/theme/dev_server/hot_reload.rb

@@ -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/theme/development_theme.rb

@@ -6,13 +6,24 @@ require "securerandom"
 
 module ShopifyCli
   module Theme
+    API_NAME_LIMIT = 50
+
     class DevelopmentTheme < Theme
       def id
         ShopifyCli::DB.get(:development_theme_id)
       end
 
       def name
-        ShopifyCli::DB.get(:development_theme_name) || generate_theme_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
@@ -58,7 +69,10 @@ module ShopifyCli
         hostname = Socket.gethostname.split(".").shift
         hash = SecureRandom.hex(3)
 
-        theme_name = "Development (#{hash}-#{hostname})"
+        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)
 

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/lib/shopify_cli.rb

@@ -94,6 +94,8 @@ module ShopifyCli
     )
   end
 
+  autoload :Constants, "shopify-cli/constants"
+  autoload :Environment, "shopify-cli/environment"
   autoload :AdminAPI, "shopify-cli/admin_api"
   autoload :API, "shopify-cli/api"
   autoload :Command, "shopify-cli/command"
@@ -132,7 +134,7 @@ module ShopifyCli
   Context.load_messages(ShopifyCli::Messages::MESSAGES)
 
   def self.cache_dir
-    cache_dir = if ENV.key?("RUNNING_SHOPIFY_CLI_TESTS")
+    cache_dir = if Environment.running_tests?
       TEMP_DIR
     elsif ENV["LOCALAPPDATA"].nil?
       File.join(File.expand_path(ENV.fetch("XDG_CACHE_HOME", "~/.cache")), TOOL_NAME)
@@ -147,7 +149,7 @@ module ShopifyCli
   end
 
   def self.tool_config_path
-    if ENV.key?("RUNNING_SHOPIFY_CLI_TESTS")
+    if Environment.running_tests?
       TEMP_DIR
     elsif ENV["APPDATA"].nil?
       File.join(File.expand_path(ENV.fetch("XDG_CONFIG_HOME", "~/.config")), TOOL_NAME)

data/shopify-cli.gemspec

@@ -39,10 +39,10 @@ Gem::Specification.new do |spec|
   # `/usr/local/bin/shopify` to that script, in order to "lock" the Ruby used to
   # a single Ruby (useful for debugging in multi-Ruby environments)
 
-  spec.add_development_dependency("bundler", "~> 2.1.4")
+  spec.add_development_dependency("bundler", "~> 2.2.2")
   spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
   spec.add_development_dependency("minitest", "~> 5.0")
 
-  spec.add_dependency("listen", "~> 3.5")
-  spec.add_dependency("theme-check", "~> 1.2")
+  spec.add_dependency("listen", "~> 3.7.0")
+  spec.add_dependency("theme-check", "~> 1.4.0")
 end