shopify-cli 2.11.2 → 2.14.0

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

@@ -5,21 +5,28 @@ 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
-            bytecode
+          rescue Errors::SystemCallFailureError => e
+            raise Errors::BuildError, e.out
           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 +39,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 +83,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!
@@ -84,15 +96,6 @@ module Script
             raise Errors::BuildScriptNotFoundError,
               "Build script not found" if build_script.nil?
           end
-
-          def bytecode
-            raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(BYTECODE_FILE)
-
-            contents = ctx.binread(BYTECODE_FILE)
-            ctx.rm(BYTECODE_FILE)
-
-            contents
-          end
         end
       end
     end

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

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

@@ -5,7 +5,7 @@ module Script
     module Infrastructure
       module Languages
         class WasmTaskRunner < TaskRunner
-          BYTECODE_FILE = "script.wasm"
+          BYTECODE_FILE = "build/index.wasm"
 
           def dependencies_installed?
             true

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

@@ -7,21 +7,6 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCLI::Context
 
-        def create_push_package(script_project:, script_content:, metadata:, library:)
-          build_file_path = file_path(script_project.id)
-          write_to_path(build_file_path, script_content)
-
-          Domain::PushPackage.new(
-            id: build_file_path,
-            uuid: script_project.uuid,
-            extension_point_type: script_project.extension_point_type,
-            script_content: script_content,
-            metadata: metadata,
-            script_config: script_project.script_config,
-            library: library
-          )
-        end
-
         def get_push_package(script_project:, metadata:, library:)
           build_file_path = file_path(script_project.id)
           raise Domain::Errors::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
@@ -31,6 +16,8 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
+            title: script_project.title,
+            description: script_project.description,
             script_content: script_content,
             metadata: metadata,
             script_config: script_project.script_config,
@@ -40,13 +27,8 @@ module Script
 
         private
 
-        def write_to_path(path, content)
-          ctx.mkdir_p(File.dirname(path))
-          ctx.binwrite(path, content)
-        end
-
         def file_path(path_to_script)
-          "#{path_to_script}/build/script.wasm"
+          "#{path_to_script}/build/index.wasm"
         end
       end
     end

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

@@ -27,7 +27,7 @@ module Script
           change_directory(directory: initial_directory)
         end
 
-        def create(script_name:, extension_point_type:, language:)
+        def create(title:, extension_point_type:, language:)
           validate_metadata!(extension_point_type, language)
 
           ShopifyCLI::Project.write(
@@ -35,7 +35,8 @@ module Script
             project_type: :script,
             organization_id: nil,
             extension_point_type: extension_point_type,
-            script_name: script_name,
+            title: title,
+            description: nil,
             language: language
           )
 
@@ -48,7 +49,8 @@ module Script
           Domain::ScriptProject.new(
             id: project.directory,
             env: project.env,
-            script_name: script_name,
+            title: title,
+            description: description,
             extension_point_type: extension_point_type,
             language: language,
             script_config: script_config_repository.get!,
@@ -79,11 +81,6 @@ module Script
           build_script_project
         end
 
-        def update_script_config(title:)
-          script_config = script_config_repository.update!(title: title)
-          build_script_project(script_config: script_config)
-        end
-
         private
 
         def build_script_project(
@@ -92,7 +89,8 @@ module Script
           Domain::ScriptProject.new(
             id: ctx.root,
             env: project.env,
-            script_name: script_name,
+            title: title,
+            description: description,
             extension_point_type: extension_point_type,
             language: language,
             script_config: script_config,
@@ -111,8 +109,12 @@ module Script
           project_config_value!("extension_point_type")
         end
 
-        def script_name
-          project_config_value!("script_name")
+        def title
+          project_config_value!("title")
+        end
+
+        def description
+          project_config_value("description")
         end
 
         def language
@@ -134,7 +136,7 @@ module Script
         end
 
         def default_language
-          "assemblyscript"
+          "wasm"
         end
 
         def validate_metadata!(extension_point_type, language)
@@ -181,26 +183,12 @@ module Script
             from_h(hash)
           end
 
-          def update!(title:)
-            hash = get!.content
-            update_hash(hash: hash, title: title)
-
-            ctx.write(filename, hash_to_file_content(hash))
-
-            from_h(hash)
-          end
-
           def filename
             raise NotImplementedError
           end
 
           private
 
-          def update_hash(hash:, title:)
-            hash["version"] ||= "2"
-            hash["title"] = title
-          end
-
           def from_h(hash)
             Domain::ScriptConfig.new(content: hash, filename: filename)
           end

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

@@ -15,6 +15,8 @@ module Script
         def set_app_script(
           uuid:,
           extension_point_type:,
+          title:,
+          description:,
           force: false,
           metadata:,
           script_config:,
@@ -26,8 +28,8 @@ module Script
           variables = {
             uuid: uuid,
             extensionPointName: extension_point_type.upcase,
-            title: script_config.title,
-            description: script_config.description,
+            title: title,
+            description: description,
             force: force,
             schemaMajorVersion: metadata.schema_major_version.to_s, # API expects string value
             schemaMinorVersion: metadata.schema_minor_version.to_s, # API expects string value

data/lib/project_types/script/loaders/project.rb

@@ -20,21 +20,22 @@ module Script
         project.env = env
         project
       rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
-        handle_error(error, context: context, env_file_present: env_file_present)
+        handle_error(error, context: context)
       end
 
-      def self.handle_error(error, context:, env_file_present:)
-        if env_file_present
+      def self.handle_error(error, context:)
+        if ShopifyCLI::Environment.interactive?
           properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
           missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          raise ShopifyCLI::Abort,
-            context.message("script.error.missing_env_file_variables", missing_env_variables, ShopifyCLI::TOOL_NAME)
+          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)
         else
           properties_hash = { api_key: "--api-key", secret: "--api-secret" }
           missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          raise ShopifyCLI::Abort, context.message("script.error.missing_push_options", missing_options,
-            ShopifyCli::TOOL_NAME)
+          message = context.message("script.error.missing_push_options_ci", missing_options)
+          message += context.message("script.error.missing_push_options_ci_solution", ShopifyCLI::TOOL_NAME)
         end
+        raise ShopifyCLI::Abort, message
       end
 
       def self.env_file_exists?(directory)

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

@@ -24,11 +24,11 @@ module Script
           oauth_help: "Wait a few minutes and try again.",
 
           invalid_context_cause: "Your .shopify-cli.yml is formatted incorrectly. It's missing values for "\
-                                 "extension_point_type or script_name.",
+                                 "extension_point_type or title.",
           invalid_context_help: "Add these values.",
 
-          invalid_script_name_cause: "Script name contains unsupported characters.",
-          invalid_script_name_help: "Use only numbers, letters, hyphens, or underscores.",
+          invalid_script_title_cause: "Script title contains unsupported characters.",
+          invalid_script_title_help: "Use only numbers, letters, hyphens, or underscores.",
 
           no_existing_apps_cause: "Your script can't be pushed to an app because your Partner account "\
                                   "doesn't have any apps.",
@@ -37,8 +37,8 @@ module Script
           no_existing_orgs_cause: "Your account doesn't belong to a Partner Organization.",
           no_existing_orgs_help: "Visit https://partners.shopify.com/ to create an account.",
 
-          project_exists_cause: "A directory with this same name already exists.",
-          project_exists_help: "Choose a different name for your script.",
+          project_exists_cause: "A directory with this same title already exists.",
+          project_exists_help: "Choose a different title for your script.",
 
           invalid_extension_cause: "The name of the Script API is incorrect: %s.",
           invalid_extension_help: "Choose a supported API: %s.",
@@ -113,6 +113,10 @@ module Script
           dependency_install_cause: "Something went wrong while installing the needed dependencies.",
           dependency_install_help: "Correct the errors.",
 
+          invalid_environment_cause: "Your environment %{tool} version, %{env_version}, "\
+                                     "is too low. It must be at least %{minimum_version}.",
+          invalid_environment_help: "Update %{tool}.",
+
           failed_api_request_cause: "Something went wrong while communicating with Shopify.",
           failed_api_request_help: "Try again.",
 
@@ -131,8 +135,8 @@ module Script
             "\nbuild: npx shopify-scripts-toolchain-as build --src src/shopify_main.ts --binary build/<script_name>.wasm --metadata build/metadata.json -- --lib node_modules --optimize --use Date=",
 
           web_assembly_binary_not_found: "Wasm binary not found.",
-          web_assembly_binary_not_found_suggestion: "Check that there is a valid Wasm binary in the root directory" \
-          "Your Wasm binary should match the script name: <script_name>.wasm",
+          web_assembly_binary_not_found_suggestion: "Check that a valid Wasm binary is present. " \
+          "The Wasm binary's filepath must be 'build/index.wasm'.",
 
           project_config_not_found: "Internal error - Script can't be created because the project's config file is missing from the repository.",
 
@@ -150,11 +154,13 @@ module Script
           language_library_for_api_not_found_cause: "Script can’t be pushed because the %{language} library for API %{api} is missing.",
           language_library_for_api_not_found_help: "Make sure extension_point.yml contains the correct API library.",
           no_scripts_found_in_app: "The selected apps have no scripts. Please, create them first on the partners' dashboard.",
-          missing_env_file_variables: "The following are missing in the .env file: %s."\
-            " To add it, run {{command:%s script connect}}",
-          missing_push_options: "The following are missing: %s. "\
-            "To add them to a CI environment:\n\t1. Run a connect command {{command:%s script connect}}\n\t2. Navigate to the .env file at the root of your project\n\t"\
-            "3. Copy the missing values, then pass them through as arguments.",
+          missing_push_options_ci: "The following are missing: %s. ",
+          missing_push_options_ci_solution: "To add them to a CI environment:\n\t1. Run a connect command " \
+          "({{command:%1$s script connect}})\n\t2. Navigate to the .env file at the root of your project\n\t" \
+          "3. Copy the missing values and pass them through as arguments in {{command:%1$s script push}}",
+          missing_env_file_variables: "The following are missing in the .env file: %s. ",
+          missing_env_file_variables_solution: "To add it, connect your script with " \
+          "{{command:%1$s script connect}} ",
         },
 
         create: {
@@ -162,9 +168,9 @@ module Script
             {{command:%1$s script create}}: Creates a script project.
               Usage: {{command:%1$s script create}}
               Options:
-                {{command:--name=NAME}} Script project name.
+                {{command:--title=TITLE}} Script project title.
                 {{command:--api=TYPE}} Script API name. Supported values: %2$s.
-                {{command:--language=LANGUAGE}} Programming language. Supported values: %3$s.
+                {{command:--language=LANGUAGE}} Programming language. Defaults to wasm. Supported values: %3$s.
           HELP
 
           error: {
@@ -191,9 +197,7 @@ module Script
           HELP
 
           error: {
-            operation_failed_no_uuid: "UUID is required to push in a CI environment.",
-            operation_failed_with_api_key: "Couldn't push script to app (API key: %{api_key}).",
-            operation_failed_no_api_key: "Couldn't push script to app.",
+            operation_failed: "Couldn't push script to app.",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
@@ -206,8 +210,6 @@ module Script
           HELP
           error: {
             operation_failed: "Couldn't connect script to app.",
-            missing_env_file_variables: "The following variables are missing in the .env file: %s."\
-            " To connect the script to an app, enter the value into the .env file or delete the .env file, and then run {{command:%s script connect}}",
           },
         },
         javy: {
@@ -233,8 +235,7 @@ module Script
         forms: {
           create: {
             select_extension_point: "Which Script API do you want to use?",
-            select_language: "Which language do you want to use?",
-            script_name: "What do you want to name your script?",
+            script_title: "What do you want to title your script?",
           },
         },
 

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

@@ -59,10 +59,10 @@ module Script
               Script::Layers::Application::ExtensionPoints.languages(type: e.extension_point_type).join(", ")
             ),
           }
-        when Errors::InvalidScriptNameError
+        when Errors::InvalidScriptTitleError
           {
-            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_script_name_cause"),
-            help_suggestion: ShopifyCLI::Context.message("script.error.invalid_script_name_help"),
+            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_script_title_cause"),
+            help_suggestion: ShopifyCLI::Context.message("script.error.invalid_script_title_help"),
           }
         when Errors::NoExistingAppsError
           {
@@ -96,7 +96,7 @@ module Script
           {
             cause_of_error: ShopifyCLI::Context.message(
               "script.error.script_not_found_cause",
-              e.script_name,
+              e.title,
               e.extension_point_type
             ),
           }
@@ -237,6 +237,19 @@ module Script
             ),
             help_suggestion: ShopifyCLI::Context.message("script.error.graphql_error_help"),
           }
+        when Layers::Infrastructure::Errors::InvalidEnvironmentError
+          {
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.invalid_environment_cause",
+              tool: e.tool,
+              env_version: e.env_version,
+              minimum_version: e.minimum_version,
+            ),
+            help_suggestion: ShopifyCLI::Context.message(
+              "script.error.invalid_environment_help",
+              tool: e.tool,
+            ),
+          }
         when Layers::Infrastructure::Errors::SystemCallFailureError
           {
             cause_of_error: ShopifyCLI::Context

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

@@ -8,12 +8,10 @@ module Script
       def self.spin(title, auto_debrief: false)
         exception = nil
         CLI::UI::Spinner.spin(title, auto_debrief: auto_debrief) do |*args|
-          begin
-            yield(*args)
-          rescue StandardError => e
-            exception = e
-            CLI::UI::Spinner::TASK_FAILED
-          end
+          yield(*args)
+        rescue StandardError => e
+          exception = e
+          CLI::UI::Spinner::TASK_FAILED
         end
         raise exception if exception
       end

data/lib/project_types/theme/cli.rb

@@ -14,6 +14,8 @@ module Theme
     subcommand :Check, "check", Project.project_filepath("commands/check")
     subcommand :Publish, "publish", Project.project_filepath("commands/publish")
     subcommand :Package, "package", Project.project_filepath("commands/package")
+    subcommand :Open, "open", Project.project_filepath("commands/open")
+    subcommand :List, "list", Project.project_filepath("commands/list")
     subcommand :LanguageServer, "language-server", Project.project_filepath("commands/language_server")
   end
   ShopifyCLI::Commands.register("Theme::Command", "theme")

data/lib/project_types/theme/commands/common/root_helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Theme
+  class Command
+    module Common
+      module RootHelper
+        def root_value(options, name)
+          argv = default_argv(options)
+          command_index = argv.index(name.to_s)
+
+          return "." if command_index.nil?
+
+          next_index = command_index + 1
+          option_by_key = options_map(options)
+
+          while next_index < argv.size
+            element = argv[next_index]
+            key, value = key_value_tuple(element)
+            option = option_by_key[key]
+
+            return element if option.nil?
+
+            # Skip the option argument
+            next_index += 1 if !option.arg.nil? && !value
+
+            # PATTERN arguments take precedence over the `root`
+            if option.arg =~ /PATTERN/ && !value
+              next_index += 1 while option_argument?(argv, next_index, option_by_key)
+              next
+            end
+
+            next_index += 1
+          end
+
+          "."
+        end
+
+        private
+
+        def default_argv(options)
+          options.parser.default_argv.compact
+        end
+
+        def options_map(options)
+          map = {}
+          options_list(options).each do |option|
+            map[option.short.first] = option
+            map[option.long.first] = option
+          end
+          map
+        end
+
+        def options_list(options)
+          options.parser.top.list
+        end
+
+        def option_argument?(argv, next_index, option_by_key)
+          return false unless next_index < argv.size
+
+          element = argv[next_index]
+          key, _value = key_value_tuple(element)
+          option_by_key[key].nil?
+        end
+
+        def key_value_tuple(element)
+          element.split("=")
+        end
+      end
+    end
+  end
+end

data/lib/project_types/theme/commands/init.rb

@@ -9,6 +9,8 @@ module Theme
         parser.on("-u", "--clone-url URL") { |url| flags[:clone_url] = url }
       end
 
+      prerequisite_task :ensure_git_dependency
+
       DEFAULT_CLONE_URL = "https://github.com/Shopify/dawn.git"
 
       def call(args, _name)

data/lib/project_types/theme/commands/list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "project_types/theme/presenters/themes_presenter"
+
+module Theme
+  class Command
+    class List < ShopifyCLI::Command::SubCommand
+      recommend_default_ruby_range
+
+      def call(_args, _name)
+        @ctx.puts(@ctx.message("theme.list.title", shop))
+
+        themes_presenter.all.each do |theme|
+          @ctx.puts("  #{theme}")
+        end
+      end
+
+      def self.help
+        @ctx.message("theme.list.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def themes_presenter
+        Theme::Presenters::ThemesPresenter.new(@ctx, nil)
+      end
+
+      def shop
+        ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+      end
+    end
+  end
+end