shopify-cli 2.2.2 → 2.6.0

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/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,11 +125,11 @@ module Script
         end
 
         def project
-          @project ||= ShopifyCli::Project.current(force_reload: true)
+          @project ||= ShopifyCLI::Project.current(force_reload: true)
         end
 
         def default_language
-          Domain::ExtensionPoint::ExtensionPointAssemblyScriptSDK.language
+          "assemblyscript"
         end
 
         def validate_metadata!(extension_point_type, 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,20 +7,19 @@ module Script
   module Layers
     module Infrastructure
       class ScriptService
-        include SmartProperties
-        property! :ctx, accepts: ShopifyCli::Context
+        def initialize(client:, api_key:)
+          @client = client
+          @api_key = api_key
+        end
 
-        def push(
+        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 +32,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 +62,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
-          )
+          variables = { appKey: @api_key, extensionPointName: extension_point_type.upcase }
+          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 auth_headers(*)
-            tokens = { "APP_KEY" => api_key }.compact.to_json
-            { "X-Shopify-Authenticated-Tokens" => tokens }
-          end
-        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
-
-          def self.bypass_partners_proxy
-            !ENV["BYPASS_PARTNERS_PROXY"].nil?
-          end
-
-          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 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 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
+          raise Errors::GraphqlError, user_errors if user_errors.any?
+          response["data"]["moduleUploadUrlGenerate"]["url"]
         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"]
+        private
 
-            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
+        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")
 
-            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/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/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/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,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::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 &&
           CLI::UI::Prompt.confirm(ctx.message("script.application.ensure_env.ask_connect_to_existing_script"))