shopify-cli 2.4.0 → 2.5.0

data/lib/project_types/rails/commands/serve.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Rails
   class Command
-    class Serve < ShopifyCli::SubCommand
+    class Serve < ShopifyCLI::SubCommand
       prerequisite_task ensure_project_type: :rails
       prerequisite_task :ensure_env, :ensure_dev_store
 
@@ -12,11 +12,11 @@ module Rails
       end
 
       def call(*)
-        project = ShopifyCli::Project.current
-        url = options.flags[:host] || ShopifyCli::Tunnel.start(@ctx)
+        project = ShopifyCLI::Project.current
+        url = options.flags[:host] || ShopifyCLI::Tunnel.start(@ctx)
         @ctx.abort(@ctx.message("rails.serve.error.host_must_be_https")) if url.match(/^https/i).nil?
         project.env.update(@ctx, :host, url)
-        ShopifyCli::Tasks::UpdateDashboardURLS.call(
+        ShopifyCLI::Tasks::UpdateDashboardURLS.call(
           @ctx,
           url: url,
           callback_url: "/auth/shopify/callback",
@@ -28,9 +28,9 @@ module Rails
         end
 
         CLI::UI::Frame.open(@ctx.message("rails.serve.running_server")) do
-          env = ShopifyCli::Project.current.env.to_h
+          env = ShopifyCLI::Project.current.env.to_h
           env.delete("HOST")
-          env["PORT"] = ShopifyCli::Tunnel::PORT.to_s
+          env["PORT"] = ShopifyCLI::Tunnel::PORT.to_s
           env["GEM_PATH"] = Gem.gem_path(@ctx)
           if @ctx.windows?
             @ctx.system("ruby bin\\rails server", env: env)
@@ -41,11 +41,11 @@ module Rails
       end
 
       def self.help
-        ShopifyCli::Context.message("rails.serve.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("rails.serve.help", ShopifyCLI::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message("rails.serve.extended_help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("rails.serve.extended_help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/project_types/rails/commands/tunnel.rb

@@ -4,7 +4,7 @@ require "shopify_cli"
 
 module Rails
   class Command
-    class Tunnel < ShopifyCli::SubCommand
+    class Tunnel < ShopifyCLI::SubCommand
       # subcommands :auth, :start, :stop
 
       prerequisite_task ensure_project_type: :rails
@@ -18,23 +18,23 @@ module Rails
             @ctx.puts(@ctx.message("rails.tunnel.error.token_argument_missing"))
             @ctx.puts("#{self.class.help}\n#{self.class.extended_help}")
           else
-            ShopifyCli::Tunnel.auth(@ctx, token)
+            ShopifyCLI::Tunnel.auth(@ctx, token)
           end
         when "start"
-          ShopifyCli::Tunnel.start(@ctx)
+          ShopifyCLI::Tunnel.start(@ctx)
         when "stop"
-          ShopifyCli::Tunnel.stop(@ctx)
+          ShopifyCLI::Tunnel.stop(@ctx)
         else
           @ctx.puts(self.class.help)
         end
       end
 
       def self.help
-        ShopifyCli::Context.message("rails.tunnel.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("rails.tunnel.help", ShopifyCLI::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message("rails.tunnel.extended_help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("rails.tunnel.extended_help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/project_types/rails/forms/create.rb

@@ -2,7 +2,7 @@ require "uri"
 
 module Rails
   module Forms
-    class Create < ShopifyCli::Form
+    class Create < ShopifyCLI::Form
       attr_accessor :name
       flag_arguments :title, :organization_id, :shop_domain, :type, :db
       VALID_DB_TYPES = ["sqlite3",
@@ -22,7 +22,7 @@ module Rails
         self.title ||= CLI::UI::Prompt.ask(ctx.message("rails.forms.create.app_name"))
         self.name = format_name
         self.type = ask_type
-        res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
+        res = ShopifyCLI::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
         self.organization_id = res[:organization_id]
         self.shop_domain = res[:shop_domain]
         self.db = ask_db
@@ -48,7 +48,7 @@ module Rails
           end
         end
 
-        unless ShopifyCli::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
+        unless ShopifyCLI::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
           ctx.abort(ctx.message("rails.forms.create.error.invalid_app_type", type))
         end
         ctx.puts(ctx.message("rails.forms.create.app_type.selected", type))

data/lib/project_types/rails/gem.rb

@@ -5,7 +5,7 @@ module Rails
   class Gem
     include SmartProperties
 
-    property :ctx, accepts: ShopifyCli::Context, required: true
+    property :ctx, accepts: ShopifyCLI::Context, required: true
     property :name, converts: :to_s, required: true
     property :version, converts: :to_s
 

data/lib/project_types/rails/ruby.rb

@@ -4,7 +4,7 @@ module Rails
 
     VERSION_STRING = /ruby ([\d\.]+)/
 
-    property :ctx, accepts: ShopifyCli::Context, required: true
+    property :ctx, accepts: ShopifyCLI::Context, required: true
 
     class << self
       def version(ctx)

data/lib/project_types/script/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Script
-  class Project < ShopifyCli::ProjectType
+  class Project < ShopifyCLI::ProjectType
     hidden_feature(feature_set: :script_project)
 
     require Project.project_filepath("messages/messages")
@@ -9,12 +9,12 @@ module Script
   end
 
   # define/autoload project specific Commands
-  class Command < ShopifyCli::ProjectCommands
+  class Command < ShopifyCLI::ProjectCommands
     hidden_feature(feature_set: :script_project)
     subcommand :Create, "create", Project.project_filepath("commands/create")
     subcommand :Push, "push", Project.project_filepath("commands/push")
   end
-  ShopifyCli::Commands.register("Script::Command", "script")
+  ShopifyCLI::Commands.register("Script::Command", "script")
 
   # define/autoload project specific Forms
   module Forms
@@ -45,7 +45,6 @@ module Script
     end
 
     module Infrastructure
-      autoload :ApiClients, Project.project_filepath("layers/infrastructure/api_clients")
       autoload :Errors, Project.project_filepath("layers/infrastructure/errors")
       autoload :CommandRunner, Project.project_filepath("layers/infrastructure/command_runner")
       autoload :PushPackageRepository, Project.project_filepath("layers/infrastructure/push_package_repository")
@@ -53,6 +52,7 @@ module Script
       autoload :ScriptProjectRepository, Project.project_filepath("layers/infrastructure/script_project_repository")
       autoload :ScriptService, Project.project_filepath("layers/infrastructure/script_service")
       autoload :ScriptUploader, Project.project_filepath("layers/infrastructure/script_uploader")
+      autoload :ServiceLocator, Project.project_filepath("layers/infrastructure/service_locator")
 
       module Languages
         autoload :AssemblyScriptProjectCreator,
@@ -65,6 +65,13 @@ module Script
         autoload :RustTaskRunner, Project.project_filepath("layers/infrastructure/languages/rust_task_runner")
         autoload :TaskRunner, Project.project_filepath("layers/infrastructure/languages/task_runner")
       end
+
+      module ApiClients
+        autoload :PartnersProxyApiClient,
+          Project.project_filepath("layers/infrastructure/api_clients/partners_proxy_api_client")
+        autoload :ScriptServiceApiClient,
+          Project.project_filepath("layers/infrastructure/api_clients/script_service_api_client")
+      end
     end
   end
 

data/lib/project_types/script/commands/create.rb

@@ -2,7 +2,7 @@
 
 module Script
   class Command
-    class Create < ShopifyCli::SubCommand
+    class Create < ShopifyCLI::SubCommand
       prerequisite_task :ensure_authenticated
 
       options do |parser, flags|
@@ -35,7 +35,7 @@ module Script
 
       def self.help
         allowed_values = Script::Layers::Application::ExtensionPoints.available_types.map { |type| "{{cyan:#{type}}}" }
-        ShopifyCli::Context.message("script.create.help", ShopifyCli::TOOL_NAME, allowed_values.join(", "))
+        ShopifyCLI::Context.message("script.create.help", ShopifyCLI::TOOL_NAME, allowed_values.join(", "))
       end
     end
   end

data/lib/project_types/script/commands/push.rb

@@ -2,7 +2,7 @@
 
 module Script
   class Command
-    class Push < ShopifyCli::SubCommand
+    class Push < ShopifyCLI::SubCommand
       prerequisite_task ensure_project_type: :script
 
       options do |parser, flags|
@@ -28,7 +28,7 @@ module Script
       end
 
       def self.help
-        ShopifyCli::Context.message("script.push.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("script.push.help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/project_types/script/forms/create.rb

@@ -2,7 +2,7 @@
 
 module Script
   module Forms
-    class Create < ShopifyCli::Form
+    class Create < ShopifyCLI::Form
       flag_arguments :extension_point, :name, :language
 
       def ask

data/lib/project_types/script/layers/application/extension_points.rb

@@ -15,7 +15,7 @@ module Script
         def self.available_types
           Infrastructure::ExtensionPointRepository.new.extension_points.select do |ep|
             next false if ep.deprecated?
-            !ep.beta? || ShopifyCli::Feature.enabled?(:scripts_beta_extension_points)
+            !ep.beta? || ShopifyCLI::Feature.enabled?(:scripts_beta_extension_points)
           end.map(&:type)
         end
 
@@ -28,7 +28,7 @@ module Script
 
         def self.languages(type:)
           get(type: type).sdks.all.map do |sdk|
-            next nil if sdk.beta? && !ShopifyCli::Feature.enabled?(:scripts_beta_languages)
+            next nil if sdk.beta? && !ShopifyCLI::Feature.enabled?(:scripts_beta_languages)
             sdk.class.language
           end.compact
         end

data/lib/project_types/script/layers/application/push_script.rb

@@ -20,7 +20,10 @@ module Script
                 compiled_type: task_runner.compiled_type,
                 metadata: task_runner.metadata,
               )
-              script_service = Infrastructure::ScriptService.new(ctx: p_ctx, api_key: script_project.api_key)
+              script_service = Infrastructure::ServiceLocator.script_service(
+                ctx: p_ctx,
+                api_key: script_project.api_key
+              )
               module_upload_url = Infrastructure::ScriptUploader.new(script_service).upload(package.script_content)
               uuid = script_service.set_app_script(
                 uuid: package.uuid,

data/lib/project_types/script/layers/domain/script_project.rb

@@ -9,7 +9,7 @@ module Script
         UUID_ENV_KEY = "UUID"
 
         property! :id, accepts: String
-        property :env, accepts: ShopifyCli::Resources::EnvFile
+        property :env, accepts: ShopifyCLI::Resources::EnvFile
 
         property! :extension_point_type, accepts: String
         property! :script_name, accepts: String
@@ -20,7 +20,7 @@ module Script
         def initialize(*)
           super
 
-          ShopifyCli::Core::Monorail.metadata = {
+          ShopifyCLI::Core::Monorail.metadata = {
             "script_name" => script_name,
             "extension_point_type" => extension_point_type,
             "language" => language,

data/lib/project_types/script/layers/infrastructure/api_clients/partners_proxy_api_client.rb

@@ -0,0 +1,55 @@
+module Script
+  module Layers
+    module Infrastructure
+      module ApiClients
+        class PartnersProxyApiClient
+          def initialize(ctx, api_key)
+            @ctx = ctx
+            @api_key = api_key
+          end
+
+          def query(query_name, variables: {})
+            proxy_response = ShimAPI.query(@ctx, query_name, api_key: @api_key, variables: variables.to_json)
+            raise_if_graphql_failed(proxy_response)
+
+            response = proxy_response["data"]["scriptServiceProxy"]
+            JSON.parse(response) if response
+          end
+
+          private
+
+          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
+
+          class ShimAPI < ShopifyCLI::PartnersAPI
+            def query(query_name, variables: {})
+              variables[:query] = load_query(query_name)
+              super("script_service_proxy", variables: variables)
+            end
+          end
+          private_constant(:ShimAPI)
+        end
+      end
+    end
+  end
+end

data/lib/project_types/script/layers/infrastructure/api_clients/script_service_api_client.rb

@@ -0,0 +1,35 @@
+module Script
+  module Layers
+    module Infrastructure
+      module ApiClients
+        class ScriptServiceApiClient
+          LOCAL_INSTANCE_URL = "https://script-service.myshopify.io"
+
+          def initialize(ctx, api_key)
+            instance_url = script_service_url
+            @api = ShopifyCLI::API.new(
+              ctx: ctx,
+              url: "#{instance_url}/graphql",
+              token: { "APP_KEY" => api_key }.compact.to_json,
+              auth_header: "X-Shopify-Authenticated-Tokens"
+            )
+          end
+
+          def query(query_name, variables: {})
+            @api.query(query_name, variables: variables)
+          end
+
+          private
+
+          def script_service_url
+            if ::ShopifyCLI::Environment.use_spin_partners_instance?
+              "https://script-service.#{::ShopifyCLI::Environment.spin_url}"
+            else
+              LOCAL_INSTANCE_URL
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Script
       class CommandRunner
         include SmartProperties
 
-        property! :ctx, accepts: ShopifyCli::Context
+        property! :ctx, accepts: ShopifyCLI::Context
 
         def call(cmd)
           out, status = ctx.capture2e(cmd)

data/lib/project_types/script/layers/infrastructure/languages/assemblyscript_project_creator.rb

@@ -6,7 +6,7 @@ module Script
       module Languages
         class AssemblyScriptProjectCreator
           include SmartProperties
-          property! :ctx, accepts: ShopifyCli::Context
+          property! :ctx, accepts: ShopifyCLI::Context
           property! :extension_point, accepts: Domain::ExtensionPoint
           property! :script_name, accepts: String
           property! :path_to_project, accepts: String

data/lib/project_types/script/layers/infrastructure/languages/rust_project_creator.rb

@@ -6,7 +6,7 @@ module Script
       module Languages
         class RustProjectCreator
           include SmartProperties
-          property! :ctx, accepts: ShopifyCli::Context
+          property! :ctx, accepts: ShopifyCLI::Context
           property! :extension_point, accepts: Domain::ExtensionPoint
           property! :script_name, accepts: String
           property! :path_to_project, accepts: String

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

@@ -5,7 +5,7 @@ module Script
     module Infrastructure
       class PushPackageRepository
         include SmartProperties
-        property! :ctx, accepts: ShopifyCli::Context
+        property! :ctx, accepts: ShopifyCLI::Context
 
         def create_push_package(script_project:, script_content:, compiled_type:, metadata:)
           build_file_path = file_path(script_project.id, compiled_type)

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

@@ -5,7 +5,7 @@ module Script
     module Infrastructure
       class ScriptProjectRepository
         include SmartProperties
-        property! :ctx, accepts: ShopifyCli::Context
+        property! :ctx, accepts: ShopifyCLI::Context
 
         SCRIPT_JSON_FILENAME = "script.json"
         MUTABLE_ENV_VALUES = %i(uuid)
@@ -13,7 +13,7 @@ module Script
         def create(script_name:, extension_point_type:, language:)
           validate_metadata!(extension_point_type, language)
 
-          ShopifyCli::Project.write(
+          ShopifyCLI::Project.write(
             ctx,
             project_type: :script,
             organization_id: nil,
@@ -63,7 +63,7 @@ module Script
         end
 
         def create_env(api_key:, secret:, uuid:)
-          ShopifyCli::Resources::EnvFile.new(
+          ShopifyCLI::Resources::EnvFile.new(
             api_key: api_key,
             secret: secret,
             extra: {
@@ -125,7 +125,7 @@ module Script
         end
 
         def project
-          @project ||= ShopifyCli::Project.current(force_reload: true)
+          @project ||= ShopifyCLI::Project.current(force_reload: true)
         end
 
         def default_language
@@ -142,7 +142,7 @@ module Script
 
         class ScriptJsonRepository
           include SmartProperties
-          property! :ctx, accepts: ShopifyCli::Context
+          property! :ctx, accepts: ShopifyCLI::Context
 
           def get
             current_script_json || raise(Domain::Errors::NoScriptJsonFile)

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

@@ -7,13 +7,9 @@ module Script
   module Layers
     module Infrastructure
       class ScriptService
-        include SmartProperties
-        property! :ctx, accepts: ShopifyCli::Context
-        property! :api_key, accepts: String
-
-        def initialize(*args, ctx:, api_key:, **kwargs)
-          super(*args, ctx: ctx, api_key: api_key, **kwargs)
-          @client = ApiClients.default_client(ctx, api_key)
+        def initialize(client:, api_key:)
+          @client = client
+          @api_key = api_key
         end
 
         def set_app_script(
@@ -68,7 +64,7 @@ module Script
 
         def get_app_scripts(extension_point_type:)
           query_name = "get_app_scripts"
-          variables = { appKey: api_key, extensionPointName: extension_point_type.upcase }
+          variables = { appKey: @api_key, extensionPointName: extension_point_type.upcase }
           response = make_request(query_name: query_name, variables: variables)
           response["data"]["appScripts"]
         end

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

@@ -0,0 +1,20 @@
+module Script
+  module Layers
+    module Infrastructure
+      class ServiceLocator
+        def self.api_client(ctx:, api_key:)
+          if ENV["BYPASS_PARTNERS_PROXY"]
+            ApiClients::ScriptServiceApiClient.new(ctx, api_key)
+          else
+            ApiClients::PartnersProxyApiClient.new(ctx, api_key)
+          end
+        end
+
+        def self.script_service(ctx:, api_key:)
+          client = api_client(ctx: ctx, api_key: api_key)
+          ScriptService.new(client: client, api_key: api_key)
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ require "shopify_cli"
 
 module Script
   module Tasks
-    class EnsureEnv < ShopifyCli::Task
+    class EnsureEnv < ShopifyCLI::Task
       attr_accessor :ctx
 
       def call(ctx)
@@ -31,11 +31,11 @@ module Script
       def ask_org
         return stubbed_org if partner_proxy_bypass
 
-        if ShopifyCli::Shopifolk.check && wants_to_run_against_shopify_org?
-          ShopifyCli::Shopifolk.act_as_shopify_organization
+        if ShopifyCLI::Shopifolk.check && wants_to_run_against_shopify_org?
+          ShopifyCLI::Shopifolk.act_as_shopify_organization
         end
 
-        orgs = ShopifyCli::PartnersAPI::Organizations.fetch_with_app(ctx)
+        orgs = ShopifyCLI::PartnersAPI::Organizations.fetch_with_app(ctx)
         if orgs.count == 1
           default = orgs.first
           ctx.puts(ctx.message("script.application.ensure_env.organization", default["businessName"], default["id"]))
@@ -69,7 +69,7 @@ module Script
       end
 
       def ask_app(apps)
-        unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        unless ShopifyCLI::Shopifolk.acting_as_shopify_organization?
           apps = apps.select { |app| app["appType"] == "custom" }
         end
 
@@ -89,7 +89,7 @@ module Script
       end
 
       def ask_script_uuid(app, extension_point_type)
-        script_service = Layers::Infrastructure::ScriptService.new(ctx: ctx, api_key: app["apiKey"])
+        script_service = Layers::Infrastructure::ServiceLocator.script_service(ctx: ctx, api_key: app["apiKey"])
         scripts = script_service.get_app_scripts(extension_point_type: extension_point_type)
 
         return nil unless scripts.count > 0 &&