shopify-cli 1.3.0 → 1.6.0

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

@@ -10,11 +10,8 @@ module Script
         property! :script_name, accepts: String
         property! :path_to_project, accepts: String
 
-        BOOTSTRAP_SRC = "npx --no-install shopify-scripts-bootstrap src %{src_base}"
-        BOOTSTRAP_TEST = "npx --no-install shopify-scripts-bootstrap test %{test_base}"
-        SOURCE_DIR = "src"
-        TEST_DIR = "test"
-        LANGUAGE = "ts"
+        BOOTSTRAP = "npx --no-install shopify-scripts-toolchain-as bootstrap --from %{extension_point} --dest %{base}"
+        MIN_NODE_VERSION = "14.5.0"
 
         def setup_dependencies
           write_npmrc
@@ -22,42 +19,12 @@ module Script
         end
 
         def bootstrap
-          create_src_folder
-          create_test_folder
-        end
-
-        private
-
-        def create_src_folder
-          ctx.mkdir_p(src_base)
-          out, status = ctx.capture2e(format(BOOTSTRAP_SRC, src_base: src_base))
+          type = extension_point.type.gsub('_', '-')
+          out, status = ctx.capture2e(format(BOOTSTRAP, extension_point: type, base: path_to_project))
           raise Domain::Errors::ServiceFailureError, out unless status.success?
-
-          write_tsconfig_file(SOURCE_DIR, ".")
-        end
-
-        def create_test_folder
-          ctx.mkdir_p(test_base)
-          out, status = ctx.capture2e(format(BOOTSTRAP_TEST, test_base: test_base))
-          raise Domain::Errors::ServiceFailureError, out unless status.success?
-
-          copy_template_file(test_base, 'as-pect.config.js')
-          copy_template_file(test_base, 'as-pect.d.ts')
-          write_tsconfig_file(TEST_DIR, "../#{SOURCE_DIR}")
         end
 
-        def test_base
-          "#{path_to_project}/#{TEST_DIR}"
-        end
-
-        def src_base
-          "#{path_to_project}/#{SOURCE_DIR}"
-        end
-
-        def copy_template_file(destination, name)
-          template_file = Project.project_filepath("templates/#{LANGUAGE}/#{name}")
-          ctx.cp(template_file, "#{destination}/#{name}")
-        end
+        private
 
         def write_npmrc
           ctx.system(
@@ -68,12 +35,10 @@ module Script
           )
         end
 
-        def write_tsconfig_file(dir, path_to_source)
-          AssemblyScriptTsConfig
-            .new(dir_to_write_in: dir)
-            .with_extends_assemblyscript_config(relative_path_to_node_modules: ".")
-            .with_module_resolution_paths(paths: { "*": ["#{path_to_source}/*.ts"] })
-            .write
+        def extension_point_version
+          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
 
         def write_package_json
@@ -82,22 +47,22 @@ 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.sdks[:ts].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.0",
-                "assemblyscript": "^0.12.0"
+                "as-wasi": "^0.2.1",
+                "assemblyscript": "^0.16.1"
               },
               "scripts": {
-                "test": "asp --config test/as-pect.config.js --summary --verbose"
+                "test": "asp --summary --verbose",
+                "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": ">=14.5"
+                "node": ">=#{MIN_NODE_VERSION}"
               }
             }
           HERE
-
           ctx.write("package.json", package_json)
         end
       end

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

@@ -4,16 +4,15 @@ module Script
   module Layers
     module Infrastructure
       class AssemblyScriptTaskRunner
-        BYTECODE_FILE = "%{name}.wasm"
-        SCRIPT_SDK_BUILD = "npx --no-install shopify-scripts-build --src=../%{source} --binary=#{BYTECODE_FILE} "\
-                           "-- --lib=../node_modules --optimize --use Date="
+        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
@@ -28,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
 
@@ -39,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!
@@ -47,18 +56,40 @@ module Script
 
           require 'semantic/semantic'
           version = ::Semantic::Version.new(output[1..-1])
-          unless version >= ::Semantic::Version.new("12.16.0")
-            raise Errors::DependencyInstallError, "Node version must be >= v12.16.0. Current version: #{output.strip}."
+          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
-          out, status = ctx.capture2e(format(SCRIPT_SDK_BUILD, source: script_source_file, name: script_name))
+          check_compilation_dependencies!
+
+          out, status = ctx.capture2e(SCRIPT_SDK_BUILD)
           raise Domain::Errors::ServiceFailureError, out unless status.success?
         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
-          File.read(format(BYTECODE_FILE, name: script_name))
+          blob = format(BYTECODE_FILE, name: script_name)
+          raise Errors::WebAssemblyBinaryNotFoundError unless @ctx.file_exist?(blob)
+
+          contents = File.read(blob)
+          @ctx.rm(blob)
+
+          contents
         end
 
         def check_if_ep_dependencies_up_to_date!

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

@@ -9,7 +9,9 @@ module Script
         class AppScriptUndefinedError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
         class DependencyInstallError < ScriptProjectError; end
+        class EmptyResponseError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
+
         class GraphqlError < ScriptProjectError
           attr_reader :errors
           def initialize(errors)
@@ -17,7 +19,9 @@ module Script
             super("GraphQL failed with errors: #{errors}")
           end
         end
+
         class ProjectCreatorNotFoundError < ScriptProjectError; end
+
         class ScriptRepushError < ScriptProjectError
           attr_reader :api_key
           def initialize(api_key)
@@ -25,15 +29,18 @@ module Script
             @api_key = api_key
           end
         end
+
         class ScriptServiceUserError < ScriptProjectError
           def initialize(query_name, errors)
             super("Failed performing #{query_name}. Errors: #{errors}.")
           end
         end
+
         class ShopAuthenticationError < ScriptProjectError; end
         class ShopScriptConflictError < ScriptProjectError; end
         class ShopScriptUndefinedError < ScriptProjectError; end
         class TaskRunnerNotFoundError < ScriptProjectError; end
+
         class PackagesOutdatedError < ScriptProjectError
           attr_reader :outdated_packages
           def initialize(outdated_packages)
@@ -41,6 +48,15 @@ module Script
             @outdated_packages = outdated_packages
           end
         end
+
+        class BuildScriptNotFoundError < ScriptProjectError; end
+        class InvalidBuildScriptError < ScriptProjectError; end
+
+        class WebAssemblyBinaryNotFoundError < ScriptProjectError
+          def initialize
+            super("WebAssembly binary not found")
+          end
+        end
       end
     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