shopify-cli 1.5.0 → 1.9.0

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

@@ -11,6 +11,31 @@ module Script
         def self.types
           Infrastructure::ExtensionPointRepository.new.extension_point_types
         end
+
+        def self.available_types
+          Infrastructure::ExtensionPointRepository.new.extension_points.select do |ep|
+            next false if ep.deprecated?
+            !ep.beta? || ShopifyCli::Feature.enabled?(:scripts_beta_extension_points)
+          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/project_dependencies.rb

@@ -3,14 +3,14 @@ module Script
     module Application
       class ProjectDependencies
         def self.install(ctx:, task_runner:)
-          CLI::UI::Frame.open(ctx.message('script.project_deps.checking_with_npm')) do
+          CLI::UI::Frame.open(ctx.message("script.project_deps.checking_with_npm")) do
             begin
               if task_runner.dependencies_installed?
-                ctx.puts(ctx.message('script.project_deps.none_required'))
+                ctx.puts(ctx.message("script.project_deps.none_required"))
               else
-                UI::StrictSpinner.spin(ctx.message('script.project_deps.installing')) do |spinner|
+                UI::StrictSpinner.spin(ctx.message("script.project_deps.installing")) do |spinner|
                   task_runner.install_dependencies
-                  spinner.update_title(ctx.message('script.project_deps.installed'))
+                  spinner.update_title(ctx.message("script.project_deps.installed"))
                 end
               end
               true

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

@@ -5,26 +5,21 @@ 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)
-            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
+          def call(ctx:, force:)
+            script_project = Infrastructure::ScriptProjectRepository.new(ctx: ctx).get
+            task_runner = Infrastructure::TaskRunner.for(ctx, script_project.language, script_project.script_name)
 
-          private
+            ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
+            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project)
 
-          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)
-              spinner.update_title(p_ctx.message('script.application.pushed'))
+            UI::PrintingSpinner.spin(ctx, ctx.message("script.application.pushing")) do |p_ctx, spinner|
+              package = Infrastructure::PushPackageRepository.new(ctx: p_ctx).get_push_package(
+                script_project: script_project,
+                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
         end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class ConfigUi
+        attr_reader :filename, :content
+
+        def initialize(filename:, content:)
+          @filename = filename
+          @content = content
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,22 @@ module Script
           end
         end
 
+        class InvalidConfigUiDefinitionError < ScriptProjectError
+          attr_reader :filename
+          def initialize(filename)
+            super()
+            @filename = filename
+          end
+        end
+
+        class MissingSpecifiedConfigUiDefinitionError < ScriptProjectError
+          attr_reader :filename
+          def initialize(filename)
+            super()
+            @filename = filename
+          end
+        end
+
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type
           def initialize(extension_point_type, script_name)
@@ -24,6 +40,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,23 +4,94 @@ module Script
   module Layers
     module Domain
       class ExtensionPoint
-        attr_reader :type, :sdks
+        attr_reader :type, :beta, :deprecated, :sdks, :domain
 
         def initialize(type, config)
           @type = type
-          @sdks = {
-            ts: ExtensionPointAssemblyScriptSDK.new(config["assemblyscript"]),
-          }
+          @beta = config["beta"] || false
+          @deprecated = config["deprecated"] || false
+          @domain = config["domain"] || nil
+          @sdks = ExtensionPointSDKs.new(config)
         end
-      end
 
-      class ExtensionPointAssemblyScriptSDK
-        attr_reader :package, :version, :sdk_version, :toolchain_version
+        def beta?
+          @beta
+        end
+
+        def deprecated?
+          @deprecated
+        end
+
+        def dasherize_type
+          @type.gsub("_", "-")
+        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 ExtensionPointSDK
+          attr_reader :version, :beta, :package
+
+          def initialize(config)
+            @beta = config["beta"] || false
+            @package = config["package"]
+            @version = config["package-version"]
+          end
+
+          def beta?
+            @beta
+          end
+
+          def versioned?
+            @version
+          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
 
-        def initialize(config)
-          @package = config["package"]
-          @sdk_version = config["sdk-version"]
-          @toolchain_version = config["toolchain-version"]
+        class ExtensionPointRustSDK < ExtensionPointSDK
+          def self.language
+            "rust"
+          end
         end
       end
     end

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

@@ -0,0 +1,48 @@
+# 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)
+            err_tag = nil
+            metadata_hash = JSON.parse(metadata_json)
+
+            use_msgpack = !!metadata_hash.dig("flags", "use_msgpack")
+            schema_versions = metadata_hash["schemaVersions"] || {}
+
+            version = schema_versions.values.first || {}
+            schema_major_version = version["major"]
+            schema_minor_version = version["minor"]
+
+            if schema_versions.empty?
+              err_tag = "script.error.metadata_schema_versions_missing"
+            elsif schema_versions.count != 1
+              # Scripts may be attached to more than one EP in the future but not right now
+              err_tag = "script.error.metadata_schema_versions_single_key"
+            elsif schema_major_version.nil?
+              err_tag = "script.error.metadata_schema_versions_missing_major"
+            elsif schema_minor_version.nil?
+              err_tag = "script.error.metadata_schema_versions_missing_minor"
+            end
+
+            Metadata.new(schema_major_version, schema_minor_version, use_msgpack)
+          rescue JSON::ParserError
+            err_tag = "script.error.metadata_validation_cause"
+          ensure
+            raise Errors::MetadataValidationError, ctx.message(err_tag) if err_tag
+          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,
+          :config_ui,
+          :script_content,
+          :compiled_type,
+          :metadata
 
-        def initialize(id, script, script_content, compiled_type)
+        def initialize(
+          id:,
+          extension_point_type:,
+          script_name:,
+          script_content:,
+          compiled_type:,
+          metadata:,
+          config_ui:
+        )
           @id = id
-          @script = script
+          @extension_point_type = extension_point_type
+          @script_name = script_name
           @script_content = script_content
           @compiled_type = compiled_type
+          @metadata = metadata
+          @config_ui = config_ui
         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,
             script_content: @script_content,
             compiled_type: @compiled_type,
             api_key: api_key,
-            force: force
+            force: force,
+            metadata: @metadata,
+            config_ui: @config_ui,
           )
         end
       end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class ScriptProject
+        include SmartProperties
+
+        property! :id, accepts: String
+        property :env, accepts: ShopifyCli::Resources::EnvFile
+
+        property! :extension_point_type, accepts: String
+        property! :script_name, accepts: String
+        property! :language, accepts: String
+
+        property :config_ui, accepts: ConfigUi
+
+        def initialize(*)
+          super
+
+          ShopifyCli::Core::Monorail.metadata = {
+            "script_name" => script_name,
+            "extension_point_type" => extension_point_type,
+            "language" => language,
+          }
+        end
+
+        def api_key
+          env[:api_key]
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,10 @@ module Script
         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_name}.wasm --metadata build/metadata.json"
         MIN_NODE_VERSION = "14.5.0"
+        ASC_ARGS = "-- --lib node_modules --optimize --use Date="
 
         def setup_dependencies
           write_npmrc
@@ -19,8 +22,7 @@ module Script
         end
 
         def bootstrap
-          type = extension_point.type.gsub('_', '-')
-          out, status = ctx.capture2e(format(BOOTSTRAP, extension_point: type, base: path_to_project))
+          out, status = ctx.capture2e(bootstap_command)
           raise Domain::Errors::ServiceFailureError, out unless status.success?
         end
 
@@ -28,17 +30,21 @@ module Script
 
         def write_npmrc
           ctx.system(
-            'npm', '--userconfig', './.npmrc', 'config', 'set', '@shopify:registry', 'https://registry.npmjs.com'
+            "npm", "--userconfig", "./.npmrc", "config", "set", "@shopify:registry", "https://registry.npmjs.com"
           )
           ctx.system(
-            'npm', '--userconfig', './.npmrc', 'config', 'set', 'engine-strict', 'true'
+            "npm", "--userconfig", "./.npmrc", "config", "set", "engine-strict", "true"
           )
         end
 
         def extension_point_version
-          out, status = ctx.capture2e("npm show #{extension_point.sdks[:ts].package} version --json")
+          if extension_point.sdks.assemblyscript.versioned?
+            return extension_point.sdks.assemblyscript.version
+          end
+
+          out, status = ctx.capture2e("npm show #{extension_point.sdks.assemblyscript.package} version --json")
           raise Domain::Errors::ServiceFailureError, out unless status.success?
-          JSON.parse(out)
+          "^#{JSON.parse(out)}"
         end
 
         def write_package_json
@@ -47,16 +53,15 @@ 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}",
-                "@as-pect/cli": "4.0.0",
-                "as-wasi": "^0.2.1",
-                "assemblyscript": "^0.14.0"
+                "@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": "^6.0.0",
+                "assemblyscript": "^0.18.13"
               },
               "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": "#{build_command}"
               },
               "engines": {
                 "node": ">=#{MIN_NODE_VERSION}"
@@ -65,6 +70,30 @@ module Script
           HERE
           ctx.write("package.json", 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
+          base_command = format(BUILD, script_name: script_name)
+          domain = extension_point.domain
+
+          if domain.nil?
+            "#{base_command} #{ASC_ARGS}"
+          else
+            "#{base_command} --domain #{domain} --ep #{type} #{ASC_ARGS}"
+          end
+        end
       end
     end
   end