shopify-cli 2.5.0 → 2.6.3

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

@@ -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/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/infrastructure/api_clients/partners_proxy_api_client.rb

@@ -12,8 +12,10 @@ module Script
             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
+            response = proxy_response.dig("data", "scriptServiceProxy")
+            raise Errors::InvalidResponseError unless response
+
+            JSON.parse(response)
           end
 
           private

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

@@ -22,7 +22,7 @@ module Script
           private
 
           def script_service_url
-            if ::ShopifyCLI::Environment.use_spin_partners_instance?
+            if ::ShopifyCLI::Environment.use_spin?
               "https://script-service.#{::ShopifyCLI::Environment.spin_url}"
             else
               LOCAL_INSTANCE_URL

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 -s 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

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

@@ -5,20 +5,85 @@ module Script
     module Infrastructure
       module Languages
         class ProjectCreator
-          PROJECT_CREATORS = {
-            "assemblyscript" => AssemblyScriptProjectCreator,
-            "rust" => RustProjectCreator,
-          }
-
-          def self.for(ctx, language, extension_point, script_name, path_to_project)
-            raise Errors::ProjectCreatorNotFoundError unless PROJECT_CREATORS[language]
-            PROJECT_CREATORS[language].new(
+          include SmartProperties
+          property! :ctx, accepts: ShopifyCLI::Context
+          property! :type, accepts: String
+          property! :project_name, accepts: String
+          property! :path_to_project, accepts: String
+          property! :sparse_checkout_repo, accepts: String
+          property! :sparse_checkout_branch, accepts: String
+          property! :sparse_checkout_set_path, accepts: String
+
+          def self.for(
+            ctx:,
+            language:,
+            type:,
+            project_name:,
+            path_to_project:,
+            sparse_checkout_repo:,
+            sparse_checkout_branch:,
+            sparse_checkout_set_path:
+          )
+
+            project_creators = {
+              "assemblyscript" => AssemblyScriptProjectCreator,
+              "typescript" => TypeScriptProjectCreator,
+            }
+
+            raise Errors::ProjectCreatorNotFoundError unless project_creators[language]
+            project_creators[language].new(
               ctx: ctx,
-              extension_point: extension_point,
-              script_name: script_name,
-              path_to_project: path_to_project
+              type: type,
+              project_name: project_name,
+              path_to_project: path_to_project,
+              sparse_checkout_repo: sparse_checkout_repo,
+              sparse_checkout_branch: sparse_checkout_branch,
+              sparse_checkout_set_path: sparse_checkout_set_path
+            )
+          end
+
+          def self.config_file
+            raise NotImplementedError
+          end
+
+          # the sparse checkout process is common to all script types
+          def setup_dependencies
+            setup_sparse_checkout
+            clean
+            update_project_name(File.join(path_to_project, self.class.config_file))
+          end
+
+          private
+
+          def setup_sparse_checkout
+            ShopifyCLI::Git.sparse_checkout(
+              sparse_checkout_repo,
+              sparse_checkout_set_path,
+              sparse_checkout_branch,
+              ctx
             )
           end
+
+          def clean
+            source = File.join(path_to_project, sparse_checkout_set_path, ".")
+            FileUtils.cp_r(source, path_to_project)
+            ctx.rm_rf(sparse_checkout_set_path.split("/")[0])
+            ctx.rm_rf(".git")
+          end
+
+          def update_project_name(config_file)
+            raise Errors::ProjectConfigNotFoundError unless File.exist?(config_file)
+            upstream_name = "#{type.gsub("_", "-")}-default"
+            contents = File.read(config_file)
+
+            raise Errors::InvalidProjectConfigError unless contents.include?(upstream_name)
+            new_contents = contents.gsub(upstream_name, project_name)
+            File.write(config_file, new_contents)
+          end
+
+          def command_runner
+            @command_runner ||= CommandRunner.new(ctx: ctx)
+          end
         end
       end
     end

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

@@ -7,7 +7,7 @@ module Script
         class TaskRunner
           TASK_RUNNERS = {
             "assemblyscript" => AssemblyScriptTaskRunner,
-            "rust" => RustTaskRunner,
+            "typescript" => TypeScriptTaskRunner,
           }
 
           def self.for(ctx, language, script_name)

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class TypeScriptProjectCreator < ProjectCreator
+          MIN_NODE_VERSION = "14.15.0"
+          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"
+
+          def self.config_file
+            "package.json"
+          end
+
+          def setup_dependencies
+            super
+            command_runner.call(NPM_SET_REGISTRY_COMMAND)
+            command_runner.call(NPM_SET_ENGINE_STRICT_COMMAND)
+
+            if ctx.file_exist?("yarn.lock")
+              ctx.rm("yarn.lock")
+            end
+
+            if ctx.file_exist?("package-lock.json")
+              ctx.rm("package-lock.json")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class TypeScriptTaskRunner
+          BYTECODE_FILE = "build/%{name}.wasm"
+          METADATA_FILE = "build/metadata.json"
+          SCRIPT_SDK_BUILD = "npm run build"
+          GEN_METADATA = "npm run gen-metadata"
+
+          attr_reader :ctx, :script_name
+
+          def initialize(ctx, script_name)
+            @ctx = ctx
+            @script_name = script_name
+          end
+
+          def build
+            compile
+            bytecode
+          end
+
+          def compiled_type
+            "wasm"
+          end
+
+          def install_dependencies
+            check_node_version!
+
+            output, status = ctx.capture2e("npm install --no-audit --no-optional --legacy-peer-deps --loglevel error")
+            raise Errors::DependencyInstallError, output unless status.success?
+          end
+
+          def dependencies_installed?
+            # Assuming if node_modules folder exist at root of script folder, all deps are installed
+            ctx.dir_exist?("node_modules")
+          end
+
+          def metadata
+            unless @ctx.file_exist?(METADATA_FILE)
+              msg = @ctx.message("script.error.metadata_not_found_cause", METADATA_FILE)
+              raise Domain::Errors::MetadataNotFoundError, msg
+            end
+
+            raw_contents = File.read(METADATA_FILE)
+            Domain::Metadata.create_from_json(@ctx, raw_contents)
+          end
+
+          private
+
+          def check_node_version!
+            output, status = @ctx.capture2e("node", "--version")
+            raise Errors::DependencyInstallError, output unless status.success?
+
+            require "semantic/semantic"
+            version = ::Semantic::Version.new(output[1..-1])
+            unless version >= ::Semantic::Version.new(TypeScriptProjectCreator::MIN_NODE_VERSION)
+              raise Errors::DependencyInstallError,
+                "Node version must be >= v#{TypeScriptProjectCreator::MIN_NODE_VERSION}. "\
+            "Current version: #{output.strip}."
+            end
+          end
+
+          def compile
+            check_compilation_dependencies!
+            CommandRunner.new(ctx: ctx).call(SCRIPT_SDK_BUILD)
+            CommandRunner.new(ctx: ctx).call(GEN_METADATA)
+          end
+
+          def check_compilation_dependencies!
+            pkg = JSON.parse(File.read("package.json"))
+            build_script = pkg.dig("scripts", "build")
+
+            raise Errors::BuildScriptNotFoundError,
+              "Build script not found" if build_script.nil?
+
+            unless build_script.start_with?("javy")
+              raise Errors::InvalidBuildScriptError, "Invalid build script"
+            end
+          end
+
+          def bytecode
+            legacy_filename = format(BYTECODE_FILE, name: script_name)
+            filename = format(BYTECODE_FILE, name: "index")
+
+            bytecode_file = if ctx.file_exist?(filename)
+              filename
+            elsif ctx.file_exist?(legacy_filename)
+              legacy_filename
+            else
+              raise Errors::WebAssemblyBinaryNotFoundError
+            end
+
+            contents = ctx.binread(bytecode_file)
+            ctx.rm(bytecode_file)
+
+            contents
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -129,7 +129,7 @@ module Script
         end
 
         def default_language
-          Domain::ExtensionPoint::ExtensionPointAssemblyScriptSDK.language
+          "assemblyscript"
         end
 
         def validate_metadata!(extension_point_type, language)

data/lib/project_types/script/messages/messages.rb

@@ -142,6 +142,10 @@ module Script
             "Check that your build npm script outputs the generated binary to the root of the directory." \
             "Generated binary should match the script name: <script_name>.wasm",
 
+          project_config_not_found: "Internal error - Script can't be created because the project's config file is missing from the repository.",
+
+          invalid_project_config: "Internal error - Script can't be created because the project's config file is invalid in the repository.",
+
           script_upload_cause: "Fail to upload script.",
           script_upload_help: "Try again.",
         },

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

@@ -237,6 +237,14 @@ module Script
             cause_of_error: ShopifyCLI::Context.message("script.error.web_assembly_binary_not_found"),
             help_suggestion: ShopifyCLI::Context.message("script.error.web_assembly_binary_not_found_suggestion"),
           }
+        when Layers::Infrastructure::Errors::ProjectConfigNotFoundError
+          {
+            cause_of_error: ShopifyCLI::Context.message("script.error.project_config_not_found"),
+          }
+        when Layers::Infrastructure::Errors::InvalidProjectConfigError
+          {
+            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_project_config"),
+          }
         when Layers::Infrastructure::Errors::ScriptUploadError
           {
             cause_of_error: ShopifyCLI::Context.message("script.error.script_upload_cause"),

data/lib/shopify_cli/api.rb

@@ -1,4 +1,5 @@
 require "shopify_cli"
+require "securerandom"
 
 module ShopifyCLI
   class API
@@ -54,6 +55,7 @@ module ShopifyCLI
         # we delay this require so as to avoid a performance hit on starting the CLI
         require "shopify_cli/http_request"
         headers = default_headers.merge(headers)
+        ctx.debug("#{method} #{uri} with X-Request-Id: #{headers["X-Request-Id"]}")
         response = if method == "POST"
           HttpRequest.post(uri, body, headers)
         elsif method == "PUT"
@@ -82,6 +84,7 @@ module ShopifyCLI
           raise APIRequestUnexpectedError.new("#{response.code}\n#{response.body}", response: response)
         end
       rescue Errno::ETIMEDOUT, Timeout::Error
+        ctx.debug("timeout in #{method} #{uri} with X-Request-Id: #{headers["X-Request-Id"]}")
         raise APIRequestTimeoutError.new("Timeout")
       end.retry_after(APIRequestRetriableError, retries: 3) do |e|
         sleep(1) if e.is_a?(APIRequestThrottledError)
@@ -109,6 +112,7 @@ module ShopifyCLI
         "User-Agent" => "Shopify CLI; v=#{ShopifyCLI::VERSION}",
         "Sec-CH-UA" => "Shopify CLI; v=#{ShopifyCLI::VERSION} sha=#{ShopifyCLI.sha}",
         "Sec-CH-UA-PLATFORM" => ctx.os.to_s,
+        "X-Request-Id" => SecureRandom.uuid,
       }.tap do |headers|
         headers["X-Shopify-Cli-Employee"] = "1" if Shopifolk.acting_as_shopify_organization?
       end.merge(auth_headers(token))

data/lib/shopify_cli/command/app_sub_command.rb

@@ -0,0 +1,16 @@
+module ShopifyCLI
+  class Command
+    class AppSubCommand < SubCommand
+      class << self
+        def call_help(*)
+          output = help
+          if respond_to?(:extended_help)
+            output += "\n"
+            output += extended_help
+          end
+          @ctx.puts(output)
+        end
+      end
+    end
+  end
+end