shopify-cli 2.12.0 → 2.15.0

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

@@ -21,33 +21,37 @@ module Script
               api: script_project.extension_point_type
             ) if library.nil? && (script_project.language != "wasm")
 
-            library_name = library&.package
-            library_data = {
-              language: script_project.language,
-              version: task_runner.library_version(library_name),
-            } if library_name
-
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
-            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project, library: library_data)
-
-            metadata_file_location = task_runner.metadata_file_location
-            metadata = Infrastructure::MetadataRepository.new(ctx: ctx).get_metadata(metadata_file_location)
+            BuildScript.call(ctx: ctx, task_runner: task_runner)
 
             CLI::UI::Frame.open(ctx.message("script.application.pushing")) do
               UI::PrintingSpinner.spin(ctx, ctx.message("script.application.pushing_script")) do |p_ctx, spinner|
+                library_name = library&.package
+                library_data = {
+                  language: script_project.language,
+                  version: task_runner.library_version(library_name),
+                } if library_name
+
+                metadata_file_location = task_runner.metadata_file_location
+                metadata = Infrastructure::MetadataRepository.new(ctx: ctx).get_metadata(metadata_file_location)
+
                 package = Infrastructure::PushPackageRepository.new(ctx: p_ctx).get_push_package(
                   script_project: script_project,
                   metadata: metadata,
                   library: library_data,
                 )
+
                 script_service = Infrastructure::ServiceLocator.script_service(
                   ctx: p_ctx,
                   api_key: script_project.api_key
                 )
                 module_upload_url = Infrastructure::ScriptUploader.new(script_service).upload(package.script_content)
+
                 uuid = script_service.set_app_script(
                   uuid: package.uuid,
                   extension_point_type: package.extension_point_type,
+                  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/languages/project_creator.rb

@@ -26,7 +26,6 @@ module Script
           )
 
             project_creators = {
-              "assemblyscript" => AssemblyScriptProjectCreator,
               "typescript" => TypeScriptProjectCreator,
               "wasm" => WasmProjectCreator,
             }
@@ -43,15 +42,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 +66,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/task_runner.rb

@@ -9,7 +9,6 @@ module Script
 
           def self.for(ctx, language)
             task_runners = {
-              "assemblyscript" => AssemblyScriptTaskRunner,
               "typescript" => TypeScriptTaskRunner,
               "wasm" => WasmTaskRunner,
             }

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

@@ -5,10 +5,6 @@ module Script
     module Infrastructure
       module Languages
         class TypeScriptProjectCreator < ProjectCreator
-          def self.config_file
-            "package.json"
-          end
-
           def setup_dependencies
             task_runner = Infrastructure::Languages::TypeScriptTaskRunner.new(ctx)
             task_runner.set_npm_config
@@ -22,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

@@ -18,7 +18,8 @@ module Script
 
           def build
             compile
-            bytecode
+          rescue Errors::SystemCallFailureError => e
+            raise Errors::BuildError, e.out
           end
 
           def install_dependencies
@@ -95,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/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.",
@@ -135,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.",
 
@@ -168,7 +168,7 @@ 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. Defaults to wasm. Supported values: %3$s.
           HELP
@@ -235,7 +235,7 @@ module Script
         forms: {
           create: {
             select_extension_point: "Which Script API 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
             ),
           }

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")