shopify-cli 1.5.0 → 1.6.0

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

@@ -11,6 +11,30 @@ module Script
         def self.types
           Infrastructure::ExtensionPointRepository.new.extension_point_types
         end
+
+        def self.non_deprecated_types
+          Infrastructure::ExtensionPointRepository.new.extension_points.select do |ep|
+            !ep.deprecated?
+          end.map(&:type)
+        end
+
+        def self.deprecated_types
+          Infrastructure::ExtensionPointRepository.new
+            .extension_points
+            .select(&:deprecated?)
+            .map(&:type)
+        end
+
+        def self.languages(type:)
+          get(type: type).sdks.all.map do |sdk|
+            next nil if sdk.beta? && !ShopifyCli::Feature.enabled?(:scripts_beta_languages)
+            sdk.class.language
+          end.compact
+        end
+
+        def self.supported_language?(type:, language:)
+          languages(type: type).include?(language.downcase)
+        end
       end
     end
   end

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

@@ -5,25 +5,27 @@ module Script
     module Application
       class PushScript
         class << self
-          def call(ctx:, language:, extension_point_type:, script_name:, source_file:, api_key:, force:)
-            script = Infrastructure::ScriptRepository.new(ctx: ctx).get_script(
-              language,
-              extension_point_type,
-              script_name
-            )
-            task_runner = Infrastructure::TaskRunner.for(ctx, language, script_name, source_file)
+          def call(ctx:, force:)
+            script_project = ScriptProject.current
+            task_runner = Infrastructure::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: script)
-            push_script(ctx, task_runner, script, api_key, force)
-          end
-
-          private
+            BuildScript.call(
+              ctx: ctx,
+              task_runner: task_runner,
+              extension_point_type: script_project.extension_point_type,
+              script_name: script_project.script_name,
+              description: script_project.description
+            )
 
-          def push_script(ctx, task_runner, script, api_key, force)
             UI::PrintingSpinner.spin(ctx, ctx.message('script.application.pushing')) do |p_ctx, spinner|
-              Infrastructure::PushPackageRepository.new(ctx: p_ctx)
-                .get_push_package(script, task_runner.compiled_type)
-                .push(Infrastructure::ScriptService.new(ctx: p_ctx), api_key, force)
+              package = Infrastructure::PushPackageRepository.new(ctx: p_ctx).get_push_package(
+                extension_point_type: script_project.extension_point_type,
+                script_name: script_project.script_name,
+                description: script_project.description,
+                compiled_type: task_runner.compiled_type,
+                metadata: task_runner.metadata
+              )
+              package.push(Infrastructure::ScriptService.new(ctx: p_ctx), script_project.api_key, force)
               spinner.update_title(p_ctx.message('script.application.pushed'))
             end
           end

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

@@ -24,6 +24,10 @@ module Script
         end
 
         class ServiceFailureError < ScriptProjectError; end
+
+        class MetadataNotFoundError < ScriptProjectError; end
+
+        class MetadataValidationError < ScriptProjectError; end
       end
     end
   end

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

@@ -4,24 +4,80 @@ module Script
   module Layers
     module Domain
       class ExtensionPoint
-        attr_reader :type, :sdks
+        attr_reader :type, :deprecated, :sdks
 
         def initialize(type, config)
           @type = type
-          @sdks = {
-            ts: ExtensionPointAssemblyScriptSDK.new(config["assemblyscript"]),
-          }
+          @deprecated = config["deprecated"] || false
+          @sdks = ExtensionPointSDKs.new(config)
+        end
+
+        def deprecated?
+          @deprecated
+        end
+      end
+
+      class ExtensionPointSDKs
+        def initialize(config)
+          @config = config
+        end
+
+        def all
+          [assemblyscript, rust].compact
+        end
+
+        def assemblyscript
+          @assemblyscript ||= new_sdk(ExtensionPointAssemblyScriptSDK)
+        end
+
+        def rust
+          @rust ||= new_sdk(ExtensionPointRustSDK)
+        end
+
+        private
+
+        def new_sdk(klass)
+          config = @config[klass.language]
+          return nil if config.nil?
+          klass.new(config)
         end
       end
 
-      class ExtensionPointAssemblyScriptSDK
-        attr_reader :package, :version, :sdk_version, :toolchain_version
+      class ExtensionPointSDK
+        attr_reader :beta, :package
 
         def initialize(config)
+          @beta = config["beta"] || false
           @package = config["package"]
+        end
+
+        def beta?
+          @beta
+        end
+
+        def self.language
+          raise NotImplementedError
+        end
+      end
+
+      class ExtensionPointAssemblyScriptSDK < ExtensionPointSDK
+        attr_reader :sdk_version, :toolchain_version
+
+        def initialize(config)
+          super
           @sdk_version = config["sdk-version"]
           @toolchain_version = config["toolchain-version"]
         end
+
+        def self.language
+          "assemblyscript"
+        end
+      end
+
+      class ExtensionPointRustSDK < ExtensionPointSDK
+        def self.language
+          "rust"
+        end
       end
     end
   end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class Metadata
+        attr_reader :schema_major_version, :schema_minor_version, :use_msgpack
+
+        def initialize(schema_major_version, schema_minor_version, use_msgpack)
+          @schema_major_version = schema_major_version
+          @schema_minor_version = schema_minor_version
+          @use_msgpack = use_msgpack
+        end
+
+        class << self
+          def create_from_json(ctx, metadata_json)
+            metadata_hash = JSON.parse(metadata_json)
+            schema_versions = metadata_hash["schemaVersions"]
+            if schema_versions.nil?
+              err_msg = "script.error.metadata_schema_versions_missing"
+              raise ::Script::Layers::Domain::Errors::MetadataValidationError, ctx.message(err_msg)
+            end
+            # Scripts may be attached to more than one EP in the future but not right now
+            unless schema_versions.count == 1
+              err_msg = "script.error.metadata_schema_versions_single_key"
+              raise ::Script::Layers::Domain::Errors::MetadataValidationError, ctx.message(err_msg)
+            end
+
+            _, version = schema_versions.first
+            schema_major_version = version["major"]
+            schema_minor_version = version["minor"]
+            if schema_major_version.nil?
+              err_msg = "script.error.metadata_schema_versions_missing_major"
+              raise ::Script::Layers::Domain::Errors::MetadataValidationError, ctx.message(err_msg)
+            end
+
+            if schema_minor_version.nil?
+              err_msg = "script.error.metadata_schema_versions_missing_minor"
+              raise ::Script::Layers::Domain::Errors::MetadataValidationError, ctx.message(err_msg)
+            end
+
+            use_msgpack = !!metadata_hash.dig("flags", "use_msgpack")
+
+            Metadata.new(schema_major_version, schema_minor_version, use_msgpack)
+          rescue ::Script::Layers::Domain::Errors::MetadataValidationError
+            raise
+          rescue
+            err_msg = "script.error.metadata_validation_cause"
+            raise ::Script::Layers::Domain::Errors::MetadataValidationError, ctx.message(err_msg)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,23 +4,42 @@ module Script
   module Layers
     module Domain
       class PushPackage
-        attr_reader :id, :script, :script_content, :compiled_type
+        attr_reader :id,
+          :extension_point_type,
+          :script_name,
+          :description,
+          :script_content,
+          :compiled_type,
+          :metadata
 
-        def initialize(id, script, script_content, compiled_type)
+        def initialize(
+          id:,
+          extension_point_type:,
+          script_name:,
+          description:,
+          script_content:,
+          compiled_type:,
+          metadata:
+        )
           @id = id
-          @script = script
+          @extension_point_type = extension_point_type
+          @script_name = script_name
+          @description = description
           @script_content = script_content
           @compiled_type = compiled_type
+          @metadata = metadata
         end
 
         def push(script_service, api_key, force)
           script_service.push(
-            extension_point_type: @script.extension_point_type,
-            script_name: @script.name,
+            extension_point_type: @extension_point_type,
+            script_name: @script_name,
+            description: @description,
             script_content: @script_content,
             compiled_type: @compiled_type,
             api_key: api_key,
-            force: force
+            force: force,
+            metadata: @metadata,
           )
         end
       end

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

@@ -36,7 +36,7 @@ module Script
         end
 
         def extension_point_version
-          out, status = ctx.capture2e("npm show #{extension_point.sdks[:ts].package} version --json")
+          out, status = ctx.capture2e("npm show #{extension_point.sdks.assemblyscript.package} version --json")
           raise Domain::Errors::ServiceFailureError, out unless status.success?
           JSON.parse(out)
         end
@@ -47,16 +47,16 @@ module Script
               "name": "#{script_name}",
               "version": "1.0.0",
               "devDependencies": {
-                "@shopify/scripts-sdk-as": "#{extension_point.sdks[:ts].sdk_version}",
-                "@shopify/scripts-toolchain-as": "#{extension_point.sdks[:ts].toolchain_version}",
-                "#{extension_point.sdks[:ts].package}": "^#{extension_point_version}",
+                "@shopify/scripts-sdk-as": "#{extension_point.sdks.assemblyscript.sdk_version}",
+                "@shopify/scripts-toolchain-as": "#{extension_point.sdks.assemblyscript.toolchain_version}",
+                "#{extension_point.sdks.assemblyscript.package}": "^#{extension_point_version}",
                 "@as-pect/cli": "4.0.0",
                 "as-wasi": "^0.2.1",
-                "assemblyscript": "^0.14.0"
+                "assemblyscript": "^0.16.1"
               },
               "scripts": {
                 "test": "asp --summary --verbose",
-                "build": "shopify-scripts-toolchain-as build --src src/script.ts --binary build/#{script_name}.wasm -- --lib node_modules --optimize --use Date="
+                "build": "shopify-scripts-toolchain-as build --src src/script.ts --binary build/#{script_name}.wasm --metadata build/metadata.json -- --lib node_modules --optimize --use Date="
               },
               "engines": {
                 "node": ">=#{MIN_NODE_VERSION}"

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

@@ -5,14 +5,14 @@ module Script
     module Infrastructure
       class AssemblyScriptTaskRunner
         BYTECODE_FILE = "build/%{name}.wasm"
+        METADATA_FILE = "build/metadata.json"
         SCRIPT_SDK_BUILD = "npm run build"
 
-        attr_reader :ctx, :script_name, :script_source_file
+        attr_reader :ctx, :script_name
 
-        def initialize(ctx, script_name, script_source_file)
+        def initialize(ctx, script_name)
           @ctx = ctx
           @script_name = script_name
-          @script_source_file = script_source_file
         end
 
         def build
@@ -27,7 +27,7 @@ module Script
         def install_dependencies
           check_node_version!
 
-          output, status = ctx.capture2e("npm", "install", "--no-audit", "--no-optional", "--loglevel error")
+          output, status = ctx.capture2e("npm install --no-audit --no-optional --legacy-peer-deps --loglevel error")
           raise Errors::DependencyInstallError, output unless status.success?
         end
 
@@ -38,6 +38,16 @@ module Script
           true
         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!
@@ -48,8 +58,8 @@ module Script
           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}."
+              "Node version must be >= v#{AssemblyScriptProjectCreator::MIN_NODE_VERSION}. "\
+              "Current version: #{output.strip}."
           end
         end
 

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

@@ -8,18 +8,24 @@ module Script
           Domain::ExtensionPoint.new(type, fetch_extension_point(type))
         end
 
+        def extension_points
+          extension_point_configs.map do |type, extension_point_config|
+            Domain::ExtensionPoint.new(type, extension_point_config)
+          end
+        end
+
         def extension_point_types
-          extension_points.keys
+          extension_point_configs.keys
         end
 
         private
 
         def fetch_extension_point(type)
-          raise Domain::Errors::InvalidExtensionPointError, type unless extension_points[type]
-          extension_points[type]
+          raise Domain::Errors::InvalidExtensionPointError, type unless extension_point_configs[type]
+          extension_point_configs[type]
         end
 
-        def extension_points
+        def extension_point_configs
           @extension_points ||= begin
             require 'yaml'
             YAML.load_file(Project.project_filepath('config/extension_points.yml'))

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

@@ -5,7 +5,8 @@ module Script
     module Infrastructure
       class ProjectCreator
         PROJECT_CREATORS = {
-          "ts" => Infrastructure::AssemblyScriptProjectCreator,
+          "assemblyscript" => Infrastructure::AssemblyScriptProjectCreator,
+          "rust" => Infrastructure::RustProjectCreator,
         }
 
         def self.for(ctx, language, extension_point, script_name, path_to_project)

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

@@ -7,30 +7,42 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
 
-        def create_push_package(script, script_content, compiled_type)
-          build_file_path = file_path(script.name, compiled_type)
+        def create_push_package(
+          extension_point_type:,
+          script_name:,
+          description:,
+          script_content:,
+          compiled_type:,
+          metadata:
+        )
+          build_file_path = file_path(script_name, compiled_type)
           write_to_path(build_file_path, script_content)
 
           Domain::PushPackage.new(
-            build_file_path,
-            script,
-            script_content,
-            compiled_type,
+            id: build_file_path,
+            extension_point_type: extension_point_type,
+            script_name: script_name,
+            description: description,
+            script_content: script_content,
+            compiled_type: compiled_type,
+            metadata: metadata,
           )
         end
 
-        def get_push_package(script, compiled_type)
-          build_file_path = file_path(script.name, compiled_type)
-
+        def get_push_package(extension_point_type:, script_name:, description:, compiled_type:, metadata:)
+          build_file_path = file_path(script_name, compiled_type)
           raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
           script_content = File.read(build_file_path)
 
           Domain::PushPackage.new(
-            build_file_path,
-            script,
-            script_content,
-            compiled_type,
+            id: build_file_path,
+            extension_point_type: extension_point_type,
+            script_name: script_name,
+            description: description,
+            script_content: script_content,
+            compiled_type: compiled_type,
+            metadata: metadata,
           )
         end