shopify-cli 2.3.0 → 2.6.1

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|
@@ -10,6 +10,7 @@ module Script
         parser.on("--extension_point=EP_NAME") { |ep_name| flags[:extension_point] = ep_name }
         parser.on("--extension-point=EP_NAME") { |ep_name| flags[:extension_point] = ep_name }
         parser.on("--language=LANGUAGE") { |language| flags[:language] = language }
+        parser.on("--branch=BRANCH") { |branch| flags[:branch] = branch }
         parser.on("--no-config-ui") { |no_config_ui| flags[:no_config_ui] = no_config_ui }
       end
 
@@ -24,6 +25,7 @@ module Script
         project = Layers::Application::CreateScript.call(
           ctx: @ctx,
           language: form.language,
+          sparse_checkout_branch: options.flags[:branch] || "master",
           script_name: form.name,
           extension_point_type: form.extension_point,
           no_config_ui: options.flags.key?(:no_config_ui)
@@ -35,7 +37,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/config/extension_points.yml

@@ -1,43 +1,44 @@
 discount:
   deprecated: true
-  assemblyscript:
-    package: "@shopify/extension-point-as-discount"
-    sdk-version: "^9.0.0"
-    toolchain-version: "^5.0.0"
+  libraries:
+    assemblyscript:
+      package: "@shopify/extension-point-as-discount"
 unit_limit_per_order:
   beta: true
-  assemblyscript:
-    package: "@shopify/extension-point-as-unit-limit-per-order"
-    sdk-version: "^9.0.0"
-    toolchain-version: "^5.0.0"
+  libraries:
+    assemblyscript:
+      package: "@shopify/extension-point-as-unit-limit-per-order"
 payment_filter:
   deprecated: true
-  assemblyscript:
-    package: "@shopify/extension-point-as-payment-filter"
-    sdk-version: "^9.0.0"
-    toolchain-version: "^5.0.0"
-  rust:
-    beta: true
-    package: "https://github.com/Shopify/scripts-apis-rs"
+  libraries:
+    assemblyscript:
+      package: "@shopify/extension-point-as-payment-filter"
 shipping_filter:
   deprecated: true
-  assemblyscript:
-    package: "@shopify/extension-point-as-shipping-filter"
-    sdk-version: "^9.0.0"
-    toolchain-version: "^5.0.0"
+  libraries:
+    assemblyscript:
+      package: "@shopify/extension-point-as-shipping-filter"
 tax_filter:
   beta: true
-  assemblyscript:
-    package: "@shopify/extension-point-as-tax-filter"
-    sdk-version: "^9.0.0"
-    toolchain-version: "^5.0.0"
+  libraries:
+    assemblyscript:
+      repo: "https://github.com/Shopify/extension-points.git"
+      package: "@shopify/extension-point-as-tax-filter"
 payment_methods:
   domain: 'checkout'
-  assemblyscript:
-    package: "@shopify/scripts-checkout-apis"
-    toolchain-version: "^5.0.0"
+  libraries:
+    assemblyscript:
+      repo: "https://github.com/Shopify/scripts-apis-examples"
+      package: "@shopify/scripts-checkout-apis"
+    typescript:
+      beta: true
+      repo: "https://github.com/Shopify/scripts-apis-examples"
 shipping_methods:
   domain: 'checkout'
-  assemblyscript:
-    package: "@shopify/scripts-checkout-apis"
-    toolchain-version: "^5.0.0"
+  libraries:
+    assemblyscript:
+      repo: "https://github.com/Shopify/scripts-apis-examples"
+      package: "@shopify/scripts-checkout-apis"
+    typescript:
+      beta: true
+      repo: "https://github.com/Shopify/scripts-apis-examples"

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/create_script.rb

@@ -7,7 +7,7 @@ module Script
     module Application
       class CreateScript
         class << self
-          def call(ctx:, language:, script_name:, extension_point_type:, no_config_ui:)
+          def call(ctx:, language:, sparse_checkout_branch:, script_name:, extension_point_type:, no_config_ui:)
             raise Infrastructure::Errors::ScriptProjectAlreadyExistsError, script_name if ctx.dir_exist?(script_name)
 
             in_new_directory_context(ctx, script_name) do
@@ -18,10 +18,24 @@ module Script
                 extension_point_type: extension_point_type,
                 language: language
               )
-              project_creator = Infrastructure::Languages::ProjectCreator
-                .for(ctx, language, extension_point, script_name, project.id)
+
+              # remove the need to pass the whole extension-point object to the infra layer
+              sparse_checkout_repo = extension_point.libraries.for(language).repo
+              type = extension_point.dasherize_type
+              domain = extension_point.domain
+
+              project_creator = Infrastructure::Languages::ProjectCreator.for(
+                ctx: ctx,
+                language: language,
+                type: type,
+                project_name: script_name,
+                path_to_project: project.id,
+                sparse_checkout_repo: sparse_checkout_repo,
+                sparse_checkout_branch: sparse_checkout_branch,
+                sparse_checkout_set_path: "#{domain}/#{language}/#{type}/default"
+              )
+
               install_dependencies(ctx, language, script_name, project_creator)
-              bootstrap(ctx, project_creator)
               script_project_repo.update_or_create_script_json(title: script_name, configuration_ui: !no_config_ui)
               project
             end
@@ -31,15 +45,21 @@ module Script
 
           def install_dependencies(ctx, language, script_name, project_creator)
             task_runner = Infrastructure::Languages::TaskRunner.for(ctx, language, script_name)
-            project_creator.setup_dependencies
-            ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
-          end
-
-          def bootstrap(ctx, project_creator)
-            UI::StrictSpinner.spin(ctx.message("script.create.creating")) do |spinner|
-              project_creator.bootstrap
-              spinner.update_title(ctx.message("script.create.created"))
+            CLI::UI::Frame.open(ctx.message(
+              "core.git.pulling_from_to",
+              project_creator.sparse_checkout_repo,
+              script_name,
+            )) do
+              UI::StrictSpinner.spin(ctx.message(
+                "core.git.pulling",
+                project_creator.sparse_checkout_repo,
+                script_name,
+              )) do |spinner|
+                project_creator.setup_dependencies
+                spinner.update_title(ctx.message("core.git.pulled", script_name))
+              end
             end
+            ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
           end
 
           def in_new_directory_context(ctx, directory)

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
 
@@ -27,9 +27,9 @@ module Script
         end
 
         def self.languages(type:)
-          get(type: type).sdks.all.map do |sdk|
-            next nil if sdk.beta? && !ShopifyCli::Feature.enabled?(:scripts_beta_languages)
-            sdk.class.language
+          get(type: type).libraries.all.map do |library|
+            next nil if library.beta? && !ShopifyCLI::Feature.enabled?(:scripts_beta_languages)
+            library.language
           end.compact
         end
 

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

@@ -20,7 +20,19 @@ module Script
                 compiled_type: task_runner.compiled_type,
                 metadata: task_runner.metadata,
               )
-              uuid = package.push(Infrastructure::ScriptService.new(ctx: p_ctx), script_project.api_key, force)
+              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,
+                extension_point_type: package.extension_point_type,
+                force: force,
+                metadata: package.metadata,
+                script_json: package.script_json,
+                module_upload_url: module_upload_url,
+              )
               script_project_repo.update_env(uuid: uuid)
               spinner.update_title(p_ctx.message("script.application.pushed"))
             end

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

@@ -4,14 +4,14 @@ module Script
   module Layers
     module Domain
       class ExtensionPoint
-        attr_reader :type, :beta, :deprecated, :sdks, :domain
+        attr_reader :type, :beta, :deprecated, :libraries, :domain
 
         def initialize(type, config)
           @type = type
           @beta = config["beta"] || false
           @deprecated = config["deprecated"] || false
           @domain = config["domain"] || nil
-          @sdks = ExtensionPointSDKs.new(config)
+          @libraries = ExtensionPointLibraries.new(config["libraries"])
         end
 
         def beta?
@@ -26,39 +26,31 @@ module Script
           @type.gsub("_", "-")
         end
 
-        class ExtensionPointSDKs
+        class ExtensionPointLibraries
           def initialize(config)
             @config = config
           end
 
           def all
-            [assemblyscript, rust].compact
+            @all ||= @config.map do |language, libray_config|
+              ExtensionPointLibrary.new(language, libray_config)
+            end
           end
 
-          def assemblyscript
-            @assemblyscript ||= new_sdk(ExtensionPointAssemblyScriptSDK)
-          end
-
-          def rust
-            @rust ||= new_sdk(ExtensionPointRustSDK)
-          end
-
-          private
-
-          def new_sdk(klass)
-            config = @config[klass.language]
-            return nil if config.nil?
-            klass.new(config)
+          def for(language)
+            all.find { |ep| ep.language == language }
           end
         end
 
-        class ExtensionPointSDK
-          attr_reader :version, :beta, :package
+        class ExtensionPointLibrary
+          attr_reader :language, :version, :beta, :package, :repo
 
-          def initialize(config)
+          def initialize(language, config)
+            @language = language
             @beta = config["beta"] || false
             @package = config["package"]
             @version = config["package-version"]
+            @repo = config["repo"]
           end
 
           def beta?
@@ -68,30 +60,6 @@ module Script
           def versioned?
             @version
           end
-
-          def self.language
-            raise NotImplementedError
-          end
-        end
-
-        class ExtensionPointAssemblyScriptSDK < ExtensionPointSDK
-          attr_reader :sdk_version, :toolchain_version
-
-          def initialize(config)
-            super
-            @sdk_version = config["sdk-version"]
-            @toolchain_version = config["toolchain-version"]
-          end
-
-          def self.language
-            "assemblyscript"
-          end
-        end
-
-        class ExtensionPointRustSDK < ExtensionPointSDK
-          def self.language
-            "rust"
-          end
         end
       end
     end

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

@@ -29,18 +29,6 @@ module Script
           @metadata = metadata
           @script_json = script_json
         end
-
-        def push(script_service, api_key, force)
-          script_service.push(
-            uuid: @uuid,
-            extension_point_type: @extension_point_type,
-            script_content: @script_content,
-            api_key: api_key,
-            force: force,
-            metadata: @metadata,
-            script_json: @script_json,
-          )
-        end
       end
     end
   end

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,57 @@
+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.dig("data", "scriptServiceProxy")
+            raise Errors::InvalidResponseError unless response
+
+            JSON.parse(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?
+              "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/errors.rb

@@ -43,6 +43,7 @@ module Script
         class DependencyInstallError < ScriptProjectError; end
         class DeprecatedEPError < ScriptProjectError; end
         class EmptyResponseError < ScriptProjectError; end
+        class InvalidResponseError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
         class InvalidContextError < ScriptProjectError; end
 
@@ -94,7 +95,11 @@ module Script
           end
         end
 
+        class InvalidProjectError < ScriptProjectError; end
+
         class ScriptUploadError < ScriptProjectError; end
+        class ProjectConfigNotFoundError < ScriptProjectError; end
+        class InvalidProjectConfigError < ScriptProjectError; end
       end
     end
   end

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

@@ -4,99 +4,19 @@ module Script
   module Layers
     module Infrastructure
       module Languages
-        class AssemblyScriptProjectCreator
-          include SmartProperties
-          property! :ctx, accepts: ShopifyCli::Context
-          property! :extension_point, accepts: Domain::ExtensionPoint
-          property! :script_name, accepts: String
-          property! :path_to_project, accepts: String
+        class AssemblyScriptProjectCreator < ProjectCreator
+          MIN_NODE_VERSION = "14.5.0" # kept because task_runner uses this
+          NPM_SET_REGISTRY_COMMAND = "npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com"
+          NPM_SET_ENGINE_STRICT_COMMAND = "npm --userconfig ./.npmrc config set engine-strict true"
 
-          BOOTSTRAP = "npx --no-install shopify-scripts-toolchain-as bootstrap --from %{extension_point} --dest %{base}"
-          BUILD = "shopify-scripts-toolchain-as build --src src/shopify_main.ts " \
-          "--binary build/script.wasm --metadata build/metadata.json"
-          MIN_NODE_VERSION = "14.5.0"
-          ASC_ARGS = "-- --lib node_modules --optimize --use Date="
-
-          def setup_dependencies
-            write_npmrc
-            write_package_json
-          end
-
-          def bootstrap
-            command_runner.call(bootstap_command)
-          end
-
-          private
-
-          def command_runner
-            @command_runner ||= CommandRunner.new(ctx: ctx)
-          end
-
-          def write_npmrc
-            command_runner.call("npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com")
-            command_runner.call("npm --userconfig ./.npmrc config set engine-strict true")
-          end
-
-          def extension_point_version
-            return extension_point.sdks.assemblyscript.version if extension_point.sdks.assemblyscript.versioned?
-
-            out = command_runner.call("npm show #{extension_point.sdks.assemblyscript.package} version --json")
-            "^#{JSON.parse(out)}"
+          def self.config_file
+            "package.json"
           end
 
-          def write_package_json
-            package_json = {
-              name: script_name,
-              version: "1.0.0",
-              devDependencies: dev_dependencies,
-              scripts: {
-                test: "asp --summary --verbose",
-                build: build_command,
-              },
-              engines: {
-                node: ">=#{MIN_NODE_VERSION}",
-              },
-            }
-
-            ctx.write("package.json", JSON.pretty_generate(package_json))
-          end
-
-          def bootstap_command
-            type = extension_point.dasherize_type
-            base_command = format(BOOTSTRAP, extension_point: type, base: path_to_project)
-            domain = extension_point.domain
-
-            if domain.nil?
-              base_command
-            else
-              "#{base_command} --domain #{domain}"
-            end
-          end
-
-          def build_command
-            type = extension_point.dasherize_type
-            domain = extension_point.domain
-
-            if domain.nil?
-              "#{BUILD} #{ASC_ARGS}"
-            else
-              "#{BUILD} --domain #{domain} --ep #{type} #{ASC_ARGS}"
-            end
-          end
-
-          def dev_dependencies
-            dependencies = {
-              "@as-pect/cli": "^6.0.0",
-              "assemblyscript": "^0.18.13",
-              "@shopify/scripts-toolchain-as": extension_point.sdks.assemblyscript.toolchain_version,
-              "#{extension_point.sdks.assemblyscript.package}": extension_point_version,
-            }
-
-            if extension_point.sdks.assemblyscript.sdk_version
-              dependencies["@shopify/scripts-sdk-as"] = extension_point.sdks.assemblyscript.sdk_version
-            end
-
-            dependencies
+          def setup_dependencies
+            super
+            command_runner.call(NPM_SET_REGISTRY_COMMAND)
+            command_runner.call(NPM_SET_ENGINE_STRICT_COMMAND)
           end
         end
       end