shopify-cli 2.11.1 → 2.13.0

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

@@ -3,12 +3,11 @@
 module Script
   module Forms
     class Create < ShopifyCLI::Form
-      flag_arguments :extension_point, :name, :language
+      flag_arguments :extension_point, :title
 
       def ask
-        self.name = valid_name
+        self.title = valid_name
         self.extension_point ||= ask_extension_point
-        self.language = ask_language
       end
 
       private
@@ -20,26 +19,14 @@ module Script
         )
       end
 
-      def ask_name
-        CLI::UI::Prompt.ask(@ctx.message("script.forms.create.script_name"))
+      def ask_title
+        CLI::UI::Prompt.ask(@ctx.message("script.forms.create.script_title"))
       end
 
       def valid_name
-        n = (name || ask_name).downcase.gsub(" ", "_")
-        return n if n.match?(/^[0-9A-Za-z_-]*$/)
-        raise Errors::InvalidScriptNameError
-      end
-
-      def ask_language
-        return language.downcase if language
-
-        all_languages = Layers::Application::ExtensionPoints.languages(type: extension_point)
-        return all_languages.first if all_languages.count == 1
-
-        CLI::UI::Prompt.ask(
-          ctx.message("script.forms.create.select_language"),
-          options: all_languages
-        )
+        normalized_title = (title || ask_title).downcase.gsub(" ", "_")
+        return normalized_title if normalized_title.match?(/^[0-9A-Za-z_-]*$/)
+        raise Errors::InvalidScriptTitleError
       end
     end
   end

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

@@ -7,32 +7,30 @@ module Script
         class << self
           def call(ctx:, task_runner:, script_project:, library:)
             CLI::UI::Frame.open(ctx.message("script.application.building")) do
-              begin
-                UI::StrictSpinner.spin(ctx.message("script.application.building_script")) do |spinner|
-                  script_content = task_runner.build
-                  metadata_file_location = task_runner.metadata_file_location
-                  metadata = Infrastructure::MetadataRepository.new(ctx: ctx).get_metadata(metadata_file_location)
+              UI::StrictSpinner.spin(ctx.message("script.application.building_script")) do |spinner|
+                script_content = task_runner.build
+                metadata_file_location = task_runner.metadata_file_location
+                metadata = Infrastructure::MetadataRepository.new(ctx: ctx).get_metadata(metadata_file_location)
 
-                  Infrastructure::PushPackageRepository.new(ctx: ctx).create_push_package(
-                    script_project: script_project,
-                    script_content: script_content,
-                    metadata: metadata,
-                    library: library,
-                  )
-                  spinner.update_title(ctx.message("script.application.built"))
-                end
-              rescue StandardError => e
-                CLI::UI::Frame.with_frame_color_override(:red) do
-                  ctx.puts("\n{{red:#{e.message}}}")
-                end
-                errors = [
-                  Infrastructure::Errors::BuildScriptNotFoundError,
-                  Infrastructure::Errors::WebAssemblyBinaryNotFoundError,
-                ]
-
-                raise Infrastructure::Errors::BuildError unless errors.any? { |err| e.is_a?(err) }
-                raise
+                Infrastructure::PushPackageRepository.new(ctx: ctx).create_push_package(
+                  script_project: script_project,
+                  script_content: script_content,
+                  metadata: metadata,
+                  library: library,
+                )
+                spinner.update_title(ctx.message("script.application.built"))
+              end
+            rescue StandardError => e
+              CLI::UI::Frame.with_frame_color_override(:red) do
+                ctx.puts("\n{{red:#{e.message}}}")
               end
+              errors = [
+                Infrastructure::Errors::BuildScriptNotFoundError,
+                Infrastructure::Errors::WebAssemblyBinaryNotFoundError,
+              ]
+
+              raise Infrastructure::Errors::BuildError unless errors.any? { |err| e.is_a?(err) }
+              raise
             end
           end
         end

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

@@ -55,9 +55,10 @@ module Script
           def handle_error(error, context:)
             properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
             missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+            message = context.message("script.error.missing_env_file_variables", missing_env_variables)
+            message += context.message("script.error.missing_env_file_variables_solution", ShopifyCLI::TOOL_NAME)
             raise ShopifyCLI::Abort,
-              context.message("script.connect.error.missing_env_file_variables", missing_env_variables,
-                ShopifyCLI::TOOL_NAME)
+              message
           end
 
           private

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

@@ -7,17 +7,17 @@ module Script
     module Application
       class CreateScript
         class << self
-          def call(ctx:, language:, sparse_checkout_branch:, script_name:, extension_point_type:)
+          def call(ctx:, language:, sparse_checkout_branch:, title:, extension_point_type:)
             script_project_repo = Infrastructure::ScriptProjectRepository.new(
               ctx: ctx,
-              directory: script_name,
+              directory: title,
               initial_directory: ctx.root
             )
 
             in_new_directory_context(script_project_repo) do
               extension_point = ExtensionPoints.get(type: extension_point_type)
               project = script_project_repo.create(
-                script_name: script_name,
+                title: title,
                 extension_point_type: extension_point_type,
                 language: language
               )
@@ -31,35 +31,34 @@ module Script
                 ctx: ctx,
                 language: language,
                 type: type,
-                project_name: script_name,
+                project_name: title,
                 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)
-              script_project_repo.update_script_config(title: script_name)
+              install_dependencies(ctx, language, title, project_creator)
               project
             end
           end
 
           private
 
-          def install_dependencies(ctx, language, script_name, project_creator)
+          def install_dependencies(ctx, language, title, project_creator)
             task_runner = Infrastructure::Languages::TaskRunner.for(ctx, language)
             CLI::UI::Frame.open(ctx.message(
               "core.git.pulling_from_to",
               project_creator.sparse_checkout_repo,
-              script_name,
+              title,
             )) do
               UI::StrictSpinner.spin(ctx.message(
                 "core.git.pulling",
                 project_creator.sparse_checkout_repo,
-                script_name,
+                title,
               )) do |spinner|
                 project_creator.setup_dependencies
-                spinner.update_title(ctx.message("core.git.pulled", script_name))
+                spinner.update_title(ctx.message("core.git.pulled", title))
               end
             end
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)

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

@@ -4,22 +4,20 @@ module Script
       class ProjectDependencies
         def self.install(ctx:, task_runner:)
           CLI::UI::Frame.open(ctx.message("script.project_deps.checking")) do
-            begin
-              if task_runner.dependencies_installed?
-                ctx.puts(ctx.message("script.project_deps.none_required"))
-              else
-                UI::StrictSpinner.spin(ctx.message("script.project_deps.installing")) do |spinner|
-                  task_runner.install_dependencies
-                  spinner.update_title(ctx.message("script.project_deps.installed"))
-                end
+            if task_runner.dependencies_installed?
+              ctx.puts(ctx.message("script.project_deps.none_required"))
+            else
+              UI::StrictSpinner.spin(ctx.message("script.project_deps.installing")) do |spinner|
+                task_runner.install_dependencies
+                spinner.update_title(ctx.message("script.project_deps.installed"))
               end
-              true
-            rescue Infrastructure::Errors::DependencyInstallError => e
-              CLI::UI::Frame.with_frame_color_override(:red) do
-                ctx.puts("\n#{e.message}")
-              end
-              raise e
             end
+            true
+          rescue Infrastructure::Errors::DependencyInstallError => e
+            CLI::UI::Frame.with_frame_color_override(:red) do
+              ctx.puts("\n#{e.message}")
+            end
+            raise e
           end
         end
       end

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

@@ -48,6 +48,8 @@ module Script
                 uuid = script_service.set_app_script(
                   uuid: package.uuid,
                   extension_point_type: package.extension_point_type,
+                  title: package.title,
+                  description: package.description,
                   force: force,
                   metadata: package.metadata,
                   script_config: package.script_config,

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

@@ -24,10 +24,10 @@ module Script
         end
 
         class ScriptNotFoundError < ScriptProjectError
-          attr_reader :script_name, :extension_point_type
-          def initialize(extension_point_type, script_name)
+          attr_reader :title, :extension_point_type
+          def initialize(extension_point_type, title)
             super()
-            @script_name = script_name
+            @title = title
             @extension_point_type = extension_point_type
           end
         end

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

@@ -7,6 +7,8 @@ module Script
         attr_reader :id,
           :uuid,
           :extension_point_type,
+          :title,
+          :description,
           :script_config,
           :script_content,
           :metadata,
@@ -16,6 +18,8 @@ module Script
           id:,
           uuid:,
           extension_point_type:,
+          title:,
+          description:,
           script_content:,
           metadata:,
           script_config:,
@@ -24,6 +28,8 @@ module Script
           @id = id
           @uuid = uuid
           @extension_point_type = extension_point_type
+          @title = title
+          @description = description
           @script_content = script_content
           @metadata = metadata
           @script_config = script_config

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

@@ -4,17 +4,15 @@ module Script
   module Layers
     module Domain
       class ScriptConfig
-        attr_reader :content, :version, :title, :description, :configuration_ui, :configuration, :filename
+        attr_reader :content, :version, :configuration_ui, :configuration, :filename
 
-        REQUIRED_FIELDS = %w(version title)
+        REQUIRED_FIELDS = %w(version)
 
         def initialize(content:, filename:)
           @filename = filename
           validate_content!(content)
           @content = content
           @version = @content["version"].to_s
-          @title = @content["title"]
-          @description = @content["description"]
           @configuration_ui = @content.fetch("configurationUi", true)
           @configuration = @content["configuration"]
         end

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

@@ -12,7 +12,8 @@ module Script
         property :env, accepts: ShopifyCLI::Resources::EnvFile
 
         property! :extension_point_type, accepts: String
-        property! :script_name, accepts: String
+        property! :title, accepts: String
+        property  :description, accepts: String
         property! :language, accepts: String
 
         property :script_config, accepts: ScriptConfig
@@ -22,7 +23,7 @@ module Script
           super
 
           ShopifyCLI::Core::Monorail.metadata = {
-            "script_name" => script_name,
+            "script_name" => title,
             "extension_point_type" => extension_point_type,
             "language" => language,
           }

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

@@ -105,6 +105,17 @@ module Script
 
         class DependencyInstallError < ScriptProjectError; end
         class EmptyResponseError < ScriptProjectError; end
+
+        class InvalidEnvironmentError < ScriptProjectError
+          attr_reader :tool, :env_version, :minimum_version
+          def initialize(tool, env_version, minimum_version)
+            super()
+            @tool = tool
+            @env_version = env_version
+            @minimum_version = minimum_version
+          end
+        end
+
         class InvalidResponseError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
         class InvalidContextError < ScriptProjectError; end

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

@@ -5,18 +5,29 @@ module Script
     module Infrastructure
       module Languages
         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"
+          def setup_dependencies
+            task_runner = Infrastructure::Languages::AssemblyScriptTaskRunner.new(ctx)
+            task_runner.set_npm_config
+            super
 
-          def self.config_file
-            "package.json"
+            update_package_json_name
           end
 
-          def setup_dependencies
-            super
-            command_runner.call(NPM_SET_REGISTRY_COMMAND)
-            command_runner.call(NPM_SET_ENGINE_STRICT_COMMAND)
+          private
+
+          def update_package_json_name
+            file_content = ctx.read("package.json")
+            hash = file_content_to_hash(file_content)
+            hash["name"] = project_name
+            ctx.write("package.json", hash_to_file_content(hash))
+          end
+
+          def file_content_to_hash(content)
+            JSON.parse(content)
+          end
+
+          def hash_to_file_content(hash)
+            JSON.pretty_generate(hash)
           end
         end
       end

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

@@ -5,9 +5,15 @@ module Script
     module Infrastructure
       module Languages
         class AssemblyScriptTaskRunner < TaskRunner
+          NODE_MIN_VERSION = "14.15.0"
+          NPM_MIN_VERSION = "5.2.0"
+
           BYTECODE_FILE = "build/script.wasm"
           METADATA_FILE = "build/metadata.json"
           SCRIPT_SDK_BUILD = "npm run build"
+          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"
+          NPM_INSTALL_COMMAND = "npm install --no-audit --no-optional --legacy-peer-deps --loglevel error"
 
           def build
             compile
@@ -15,10 +21,10 @@ module Script
           end
 
           def install_dependencies
-            check_node_version!
+            run_cmd_with_env_check(NPM_INSTALL_COMMAND)
 
-            output, status = ctx.capture2e("npm install --no-audit --no-optional --legacy-peer-deps --loglevel error")
-            raise Errors::DependencyInstallError, output unless status.success?
+          rescue Errors::SystemCallFailureError => e
+            raise Errors::DependencyInstallError, e.out
           end
 
           def dependencies_installed?
@@ -31,14 +37,32 @@ module Script
           end
 
           def library_version(library_name)
-            output = JSON.parse(CommandRunner.new(ctx: ctx).call("npm -s list --json"))
+            output = JSON.parse(run_cmd_with_env_check("npm -s list --json"))
             library_version_from_npm_list(output, library_name)
           rescue Errors::SystemCallFailureError => error
             library_version_from_npm_list_error_output(error, library_name)
           end
 
+          def set_npm_config
+            run_cmd_with_env_check(NPM_SET_REGISTRY_COMMAND)
+            run_cmd_with_env_check(NPM_SET_ENGINE_STRICT_COMMAND)
+          end
+
           private
 
+          def ensure_environment
+            return if defined?(@environment_checked)
+            @environment_checked = true
+
+            ToolVersionChecker.check_node(minimum_version: NODE_MIN_VERSION)
+            ToolVersionChecker.check_npm(minimum_version: NPM_MIN_VERSION)
+          end
+
+          def run_cmd_with_env_check(cmd)
+            ensure_environment
+            CommandRunner.new(ctx: ctx).call(cmd)
+          end
+
           def library_version_from_npm_list_error_output(error, library_name)
             # npm list can return a failure status code, even when returning the correct data.
             # This causes the CommandRunner to throw a SystemCallFailure error that contains the data.
@@ -57,22 +81,9 @@ module Script
             end
           end
 
-          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(AssemblyScriptProjectCreator::MIN_NODE_VERSION)
-              raise Errors::DependencyInstallError,
-                "Node version must be >= v#{AssemblyScriptProjectCreator::MIN_NODE_VERSION}. "\
-                "Current version: #{output.strip}."
-            end
-          end
-
           def compile
             check_compilation_dependencies!
-            CommandRunner.new(ctx: ctx).call(SCRIPT_SDK_BUILD)
+            run_cmd_with_env_check(SCRIPT_SDK_BUILD)
           end
 
           def check_compilation_dependencies!

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

@@ -43,15 +43,10 @@ module Script
             )
           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
@@ -72,16 +67,6 @@ module Script
             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

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

@@ -0,0 +1,26 @@
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class ToolVersionChecker
+          class << self
+            def check_node(minimum_version:)
+              check_version("node", ShopifyCLI::Environment.node_version, minimum_version)
+            end
+
+            def check_npm(minimum_version:)
+              check_version("npm", ShopifyCLI::Environment.npm_version, minimum_version)
+            end
+
+            private
+
+            def check_version(tool, env_version, minimum_version)
+              return if env_version >= ::Semantic::Version.new(minimum_version)
+              raise Errors::InvalidEnvironmentError.new(tool, env_version, minimum_version)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,18 +5,11 @@ module Script
     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
+            task_runner = Infrastructure::Languages::TypeScriptTaskRunner.new(ctx)
+            task_runner.set_npm_config
+
             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")
@@ -25,6 +18,25 @@ module Script
             if ctx.file_exist?("package-lock.json")
               ctx.rm("package-lock.json")
             end
+
+            update_package_json_name
+          end
+
+          private
+
+          def update_package_json_name
+            file_content = ctx.read("package.json")
+            hash = file_content_to_hash(file_content)
+            hash["name"] = project_name
+            ctx.write("package.json", hash_to_file_content(hash))
+          end
+
+          def file_content_to_hash(content)
+            JSON.parse(content)
+          end
+
+          def hash_to_file_content(hash)
+            JSON.pretty_generate(hash)
           end
         end
       end

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

@@ -5,10 +5,16 @@ module Script
     module Infrastructure
       module Languages
         class TypeScriptTaskRunner < TaskRunner
+          NODE_MIN_VERSION = "14.15.0"
+          NPM_MIN_VERSION = "5.2.0"
+
           BYTECODE_FILE = "build/index.wasm"
           METADATA_FILE = "build/metadata.json"
           SCRIPT_SDK_BUILD = "npm run build"
           GEN_METADATA = "npm run gen-metadata"
+          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"
+          NPM_INSTALL_COMMAND = "npm install --no-audit --no-optional --legacy-peer-deps --loglevel error"
 
           def build
             compile
@@ -16,10 +22,10 @@ module Script
           end
 
           def install_dependencies
-            check_node_version!
+            run_cmd_with_env_check(NPM_INSTALL_COMMAND)
 
-            output, status = ctx.capture2e("npm install --no-audit --no-optional --legacy-peer-deps --loglevel error")
-            raise Errors::DependencyInstallError, output unless status.success?
+          rescue Errors::SystemCallFailureError => e
+            raise Errors::DependencyInstallError, e.out
           end
 
           def dependencies_installed?
@@ -32,14 +38,32 @@ module Script
           end
 
           def library_version(library_name)
-            output = JSON.parse(CommandRunner.new(ctx: ctx).call("npm -s list --json"))
+            output = JSON.parse(run_cmd_with_env_check("npm -s list --json"))
             library_version_from_npm_list(output, library_name)
           rescue Errors::SystemCallFailureError => error
             library_version_from_npm_list_error_output(error, library_name)
           end
 
+          def set_npm_config
+            run_cmd_with_env_check(NPM_SET_REGISTRY_COMMAND)
+            run_cmd_with_env_check(NPM_SET_ENGINE_STRICT_COMMAND)
+          end
+
           private
 
+          def ensure_environment
+            return if defined?(@environment_checked)
+            @environment_checked = true
+
+            ToolVersionChecker.check_node(minimum_version: NODE_MIN_VERSION)
+            ToolVersionChecker.check_npm(minimum_version: NPM_MIN_VERSION)
+          end
+
+          def run_cmd_with_env_check(cmd)
+            ensure_environment
+            CommandRunner.new(ctx: ctx).call(cmd)
+          end
+
           def library_version_from_npm_list_error_output(error, library_name)
             # npm list can return a failure status code, even when returning the correct data.
             # This causes the CommandRunner to throw a SystemCallFailure error that contains the data.
@@ -58,23 +82,10 @@ module Script
             end
           end
 
-          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)
+            run_cmd_with_env_check(SCRIPT_SDK_BUILD)
+            run_cmd_with_env_check(GEN_METADATA)
           end
 
           def check_compilation_dependencies!

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

@@ -5,9 +5,6 @@ module Script
     module Infrastructure
       module Languages
         class WasmProjectCreator < ProjectCreator
-          def self.config_file
-            "script.config.yml"
-          end
         end
       end
     end