shopify-cli 1.11.0 → 2.0.0

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

@@ -8,7 +8,8 @@ module Script
           def call(ctx:, force:)
             script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
             script_project = script_project_repo.get
-            task_runner = Infrastructure::TaskRunner.for(ctx, script_project.language, script_project.script_name)
+            task_runner = Infrastructure::Languages::TaskRunner
+              .for(ctx, script_project.language, script_project.script_name)
 
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
             BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project)

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

@@ -14,21 +14,16 @@ module Script
           end
         end
 
-        class InvalidConfigUiDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(filename)
+        class MissingScriptJsonFieldError < ScriptProjectError
+          attr_reader :field
+          def initialize(field)
             super()
-            @filename = filename
+            @field = field
           end
         end
 
-        class MissingSpecifiedConfigUiDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(filename)
-            super()
-            @filename = filename
-          end
-        end
+        class InvalidScriptJsonDefinitionError < ScriptProjectError; end
+        class NoScriptJsonFile < ScriptProjectError; end
 
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type

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

@@ -7,8 +7,7 @@ module Script
         attr_reader :id,
           :uuid,
           :extension_point_type,
-          :script_name,
-          :config_ui,
+          :script_json,
           :script_content,
           :compiled_type,
           :metadata
@@ -17,33 +16,30 @@ module Script
           id:,
           uuid:,
           extension_point_type:,
-          script_name:,
           script_content:,
           compiled_type:,
           metadata:,
-          config_ui:
+          script_json:
         )
           @id = id
           @uuid = uuid
           @extension_point_type = extension_point_type
-          @script_name = script_name
           @script_content = script_content
           @compiled_type = compiled_type
           @metadata = metadata
-          @config_ui = config_ui
+          @script_json = script_json
         end
 
         def push(script_service, api_key, force)
           script_service.push(
             uuid: @uuid,
             extension_point_type: @extension_point_type,
-            script_name: @script_name,
             script_content: @script_content,
             compiled_type: @compiled_type,
             api_key: api_key,
             force: force,
             metadata: @metadata,
-            config_ui: @config_ui,
+            script_json: @script_json,
           )
         end
       end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class ScriptJson
+        attr_reader :content, :version, :title, :description, :configuration_ui, :configuration
+
+        REQUIRED_FIELDS = %w(version title)
+
+        def initialize(content:)
+          validate_content!(content)
+
+          @content = content
+          @version = @content["version"].to_s
+          @title = @content["title"]
+          @description = @content["description"]
+          @configuration_ui = @content["configurationUi"]
+          @configuration = @content["configuration"]
+        end
+
+        private
+
+        def validate_content!(content)
+          REQUIRED_FIELDS.each do |field|
+            raise Errors::MissingScriptJsonFieldError, field if content[field].nil?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module Script
         property! :script_name, accepts: String
         property! :language, accepts: String
 
-        property :config_ui, accepts: ConfigUi
+        property :script_json, accepts: ScriptJson
 
         def initialize(*)
           super

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

@@ -6,40 +6,36 @@ module Script
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
-        class ConfigUiSyntaxError < ScriptProjectError; end
+        class ScriptJsonSyntaxError < ScriptProjectError; end
 
-        class ConfigUiMissingKeysError < ScriptProjectError
-          attr_reader :filename, :missing_keys
-          def initialize(filename, missing_keys)
+        class ScriptJsonMissingKeysError < ScriptProjectError
+          attr_reader :missing_keys
+          def initialize(missing_keys)
             super()
-            @filename = filename
             @missing_keys = missing_keys
           end
         end
 
-        class ConfigUiInvalidInputModeError < ScriptProjectError
-          attr_reader :filename, :valid_input_modes
-          def initialize(filename, valid_input_modes)
+        class ScriptJsonInvalidValueError < ScriptProjectError
+          attr_reader :valid_input_modes
+          def initialize(valid_input_modes)
             super()
-            @filename = filename
             @valid_input_modes = valid_input_modes
           end
         end
 
-        class ConfigUiFieldsMissingKeysError < ScriptProjectError
-          attr_reader :filename, :missing_keys
-          def initialize(filename, missing_keys)
+        class ScriptJsonFieldsMissingKeysError < ScriptProjectError
+          attr_reader :missing_keys
+          def initialize(missing_keys)
             super()
-            @filename = filename
             @missing_keys = missing_keys
           end
         end
 
-        class ConfigUiFieldsInvalidTypeError < ScriptProjectError
-          attr_reader :filename, :valid_types
-          def initialize(filename, valid_types)
+        class ScriptJsonFieldsInvalidValueError < ScriptProjectError
+          attr_reader :valid_types
+          def initialize(valid_types)
             super()
-            @filename = filename
             @valid_types = valid_types
           end
         end
@@ -72,7 +68,7 @@ module Script
         class SystemCallFailureError < ScriptProjectError
           attr_reader :out, :cmd
           def initialize(out:, cmd:)
-            super()
+            super(out)
             @out = out
             @cmd = cmd
           end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class AssemblyScriptProjectCreator
+          include SmartProperties
+          property! :ctx, accepts: ShopifyCli::Context
+          property! :extension_point, accepts: Domain::ExtensionPoint
+          property! :script_name, accepts: String
+          property! :path_to_project, accepts: String
+
+          BOOTSTRAP = "npx --no-install shopify-scripts-toolchain-as bootstrap --from %{extension_point} --dest %{base}"
+          BUILD = "shopify-scripts-toolchain-as build --src src/shopify_main.ts " \
+          "--binary build/script.wasm --metadata build/metadata.json"
+          MIN_NODE_VERSION = "14.5.0"
+          ASC_ARGS = "-- --lib node_modules --optimize --use Date="
+
+          def setup_dependencies
+            write_npmrc
+            write_package_json
+          end
+
+          def bootstrap
+            command_runner.call(bootstap_command)
+          end
+
+          private
+
+          def command_runner
+            @command_runner ||= CommandRunner.new(ctx: ctx)
+          end
+
+          def write_npmrc
+            command_runner.call("npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com")
+            command_runner.call("npm --userconfig ./.npmrc config set engine-strict true")
+          end
+
+          def extension_point_version
+            return extension_point.sdks.assemblyscript.version if extension_point.sdks.assemblyscript.versioned?
+
+            out = command_runner.call("npm show #{extension_point.sdks.assemblyscript.package} version --json")
+            "^#{JSON.parse(out)}"
+          end
+
+          def write_package_json
+            package_json = {
+              name: script_name,
+              version: "1.0.0",
+              devDependencies: dev_dependencies,
+              scripts: {
+                test: "asp --summary --verbose",
+                build: build_command,
+              },
+              engines: {
+                node: ">=#{MIN_NODE_VERSION}",
+              },
+            }
+
+            ctx.write("package.json", JSON.pretty_generate(package_json))
+          end
+
+          def bootstap_command
+            type = extension_point.dasherize_type
+            base_command = format(BOOTSTRAP, extension_point: type, base: path_to_project)
+            domain = extension_point.domain
+
+            if domain.nil?
+              base_command
+            else
+              "#{base_command} --domain #{domain}"
+            end
+          end
+
+          def build_command
+            type = extension_point.dasherize_type
+            domain = extension_point.domain
+
+            if domain.nil?
+              "#{BUILD} #{ASC_ARGS}"
+            else
+              "#{BUILD} --domain #{domain} --ep #{type} #{ASC_ARGS}"
+            end
+          end
+
+          def dev_dependencies
+            dependencies = {
+              "@as-pect/cli": "^6.0.0",
+              "assemblyscript": "^0.18.13",
+              "@shopify/scripts-toolchain-as": extension_point.sdks.assemblyscript.toolchain_version,
+              "#{extension_point.sdks.assemblyscript.package}": extension_point_version,
+            }
+
+            if extension_point.sdks.assemblyscript.sdk_version
+              dependencies["@shopify/scripts-sdk-as"] = extension_point.sdks.assemblyscript.sdk_version
+            end
+
+            dependencies
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class AssemblyScriptTaskRunner
+          BYTECODE_FILE = "build/%{name}.wasm"
+          METADATA_FILE = "build/metadata.json"
+          SCRIPT_SDK_BUILD = "npm run build"
+
+          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(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)
+          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?("shopify-scripts")
+              raise Errors::InvalidBuildScriptError, "Invalid build script"
+            end
+          end
+
+          def bytecode
+            legacy_filename = format(BYTECODE_FILE, name: script_name)
+            filename = format(BYTECODE_FILE, name: "script")
+
+            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/languages/project_creator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    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(
+              ctx: ctx,
+              extension_point: extension_point,
+              script_name: script_name,
+              path_to_project: path_to_project
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class RustProjectCreator
+          include SmartProperties
+          property! :ctx, accepts: ShopifyCli::Context
+          property! :extension_point, accepts: Domain::ExtensionPoint
+          property! :script_name, accepts: String
+          property! :path_to_project, accepts: String
+
+          ORIGIN_BRANCH = "main"
+          SAMPLE_PATH = "default"
+
+          def setup_dependencies
+            git_init
+            setup_remote
+            setup_sparse_checkout
+            pull
+            clean
+            set_script_name
+          end
+
+          def bootstrap
+          end
+
+          private
+
+          def command_runner
+            @command_runner ||= CommandRunner.new(ctx: ctx)
+          end
+
+          def git_init
+            command_runner.call("git init")
+          end
+
+          def setup_remote
+            repo = extension_point.sdks.rust.package
+            command_runner.call("git remote add -f origin #{repo}")
+          end
+
+          def setup_sparse_checkout
+            type = extension_point.type
+            command_runner.call("git config core.sparsecheckout true")
+            command_runner.call("echo #{type}/#{SAMPLE_PATH} >> .git/info/sparse-checkout")
+          end
+
+          def pull
+            command_runner.call("git pull origin #{ORIGIN_BRANCH}")
+          end
+
+          def clean
+            type = extension_point.type
+            ctx.rm_rf(".git")
+            source = File.join(path_to_project, File.join(type, SAMPLE_PATH))
+            FileUtils.copy_entry(source, path_to_project)
+            ctx.rm_rf(type)
+          end
+
+          def set_script_name
+            config_file = "Cargo.toml"
+            upstream_name = "#{extension_point.type.gsub("_", "-")}-default"
+            contents = File.read(config_file)
+            new_contents = contents.sub(upstream_name, script_name)
+            File.write(config_file, new_contents)
+          end
+        end
+      end
+    end
+  end
+end