shopify-cli 1.8.0 → 1.9.0

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

@@ -6,19 +6,17 @@ module Script
       class PushScript
         class << self
           def call(ctx:, force:)
-            script_project = ScriptProject.current
+            script_project = Infrastructure::ScriptProjectRepository.new(ctx: ctx).get
             task_runner = Infrastructure::TaskRunner.for(ctx, script_project.language, script_project.script_name)
-            config_ui = Infrastructure::ConfigUiRepository.new(ctx: ctx).get_config_ui(script_project.config_ui_file)
 
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
-            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project, config_ui: config_ui)
+            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project)
 
             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,
-                config_ui: config_ui,
               )
               package.push(Infrastructure::ScriptService.new(ctx: p_ctx), script_project.api_key, force)
               spinner.update_title(p_ctx.message("script.application.pushed"))

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

@@ -4,15 +4,20 @@ module Script
   module Layers
     module Domain
       class ExtensionPoint
-        attr_reader :type, :deprecated, :sdks, :domain
+        attr_reader :type, :beta, :deprecated, :sdks, :domain
 
         def initialize(type, config)
           @type = type
+          @beta = config["beta"] || false
           @deprecated = config["deprecated"] || false
           @domain = config["domain"] || nil
           @sdks = ExtensionPointSDKs.new(config)
         end
 
+        def beta?
+          @beta
+        end
+
         def deprecated?
           @deprecated
         end
@@ -20,68 +25,73 @@ module Script
         def dasherize_type
           @type.gsub("_", "-")
         end
-      end
 
-      class ExtensionPointSDKs
-        def initialize(config)
-          @config = config
-        end
+        class ExtensionPointSDKs
+          def initialize(config)
+            @config = config
+          end
 
-        def all
-          [assemblyscript, rust].compact
-        end
+          def all
+            [assemblyscript, rust].compact
+          end
 
-        def assemblyscript
-          @assemblyscript ||= new_sdk(ExtensionPointAssemblyScriptSDK)
-        end
+          def assemblyscript
+            @assemblyscript ||= new_sdk(ExtensionPointAssemblyScriptSDK)
+          end
 
-        def rust
-          @rust ||= new_sdk(ExtensionPointRustSDK)
-        end
+          def rust
+            @rust ||= new_sdk(ExtensionPointRustSDK)
+          end
 
-        private
+          private
 
-        def new_sdk(klass)
-          config = @config[klass.language]
-          return nil if config.nil?
-          klass.new(config)
+          def new_sdk(klass)
+            config = @config[klass.language]
+            return nil if config.nil?
+            klass.new(config)
+          end
         end
-      end
 
-      class ExtensionPointSDK
-        attr_reader :beta, :package
+        class ExtensionPointSDK
+          attr_reader :version, :beta, :package
 
-        def initialize(config)
-          @beta = config["beta"] || false
-          @package = config["package"]
-        end
+          def initialize(config)
+            @beta = config["beta"] || false
+            @package = config["package"]
+            @version = config["package-version"]
+          end
 
-        def beta?
-          @beta
-        end
+          def beta?
+            @beta
+          end
+
+          def versioned?
+            @version
+          end
 
-        def self.language
-          raise NotImplementedError
+          def self.language
+            raise NotImplementedError
+          end
         end
-      end
 
-      class ExtensionPointAssemblyScriptSDK < ExtensionPointSDK
-        attr_reader :sdk_version, :toolchain_version
+        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 initialize(config)
+            super
+            @sdk_version = config["sdk-version"]
+            @toolchain_version = config["toolchain-version"]
+          end
 
-        def self.language
-          "assemblyscript"
+          def self.language
+            "assemblyscript"
+          end
         end
-      end
 
-      class ExtensionPointRustSDK < ExtensionPointSDK
-        def self.language
-          "rust"
+        class ExtensionPointRustSDK < ExtensionPointSDK
+          def self.language
+            "rust"
+          end
         end
       end
     end

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

@@ -14,39 +14,32 @@ module Script
 
         class << self
           def create_from_json(ctx, metadata_json)
+            err_tag = nil
             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
+            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_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)
+            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
 
-            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)
+          rescue JSON::ParserError
+            err_tag = "script.error.metadata_validation_cause"
+          ensure
+            raise Errors::MetadataValidationError, ctx.message(err_tag) if err_tag
           end
         end
       end

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

@@ -7,7 +7,6 @@ module Script
         attr_reader :id,
           :extension_point_type,
           :script_name,
-          :description,
           :config_ui,
           :script_content,
           :compiled_type,
@@ -17,7 +16,6 @@ module Script
           id:,
           extension_point_type:,
           script_name:,
-          description:,
           script_content:,
           compiled_type:,
           metadata:,
@@ -26,7 +24,6 @@ module Script
           @id = id
           @extension_point_type = extension_point_type
           @script_name = script_name
-          @description = description
           @script_content = script_content
           @compiled_type = compiled_type
           @metadata = metadata
@@ -37,7 +34,6 @@ module Script
           script_service.push(
             extension_point_type: @extension_point_type,
             script_name: @script_name,
-            description: @description,
             script_content: @script_content,
             compiled_type: @compiled_type,
             api_key: api_key,

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

@@ -38,9 +38,13 @@ module Script
         end
 
         def extension_point_version
+          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
@@ -51,7 +55,7 @@ module Script
               "devDependencies": {
                 "@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}",
+                "#{extension_point.sdks.assemblyscript.package}": "#{extension_point_version}",
                 "@as-pect/cli": "^6.0.0",
                 "assemblyscript": "^0.18.13"
               },

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

@@ -81,11 +81,11 @@ module Script
         end
 
         def bytecode
-          blob = format(BYTECODE_FILE, name: script_name)
-          raise Errors::WebAssemblyBinaryNotFoundError unless @ctx.file_exist?(blob)
+          filename = format(BYTECODE_FILE, name: script_name)
+          raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(filename)
 
-          contents = File.read(blob)
-          @ctx.rm(blob)
+          contents = ctx.binread(filename)
+          ctx.rm(filename)
 
           contents
         end

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

@@ -5,8 +5,6 @@ module Script
     module Infrastructure
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
-        class AppScriptNotPushedError < ScriptProjectError; end
-        class AppScriptUndefinedError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
         class ConfigUiSyntaxError < ScriptProjectError; end
 
@@ -29,8 +27,19 @@ module Script
         end
 
         class DependencyInstallError < ScriptProjectError; end
+        class DeprecatedEPError < ScriptProjectError; end
         class EmptyResponseError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
+        class InvalidContextError < ScriptProjectError; end
+
+        class InvalidLanguageError < ScriptProjectError
+          attr_reader :language, :extension_point_type
+          def initialize(language, extension_point_type)
+            super()
+            @language = language
+            @extension_point_type = extension_point_type
+          end
+        end
 
         class GraphqlError < ScriptProjectError
           attr_reader :errors
@@ -50,15 +59,8 @@ module Script
           end
         end
 
-        class ScriptServiceUserError < ScriptProjectError
-          def initialize(query_name, errors)
-            super("Failed performing #{query_name}. Errors: #{errors}.")
-          end
-        end
-
+        class ScriptProjectAlreadyExistsError < ScriptProjectError; end
         class ShopAuthenticationError < ScriptProjectError; end
-        class ShopScriptConflictError < ScriptProjectError; end
-        class ShopScriptUndefinedError < ScriptProjectError; end
         class TaskRunnerNotFoundError < ScriptProjectError; end
         class BuildScriptNotFoundError < ScriptProjectError; end
         class InvalidBuildScriptError < ScriptProjectError; end

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

@@ -7,37 +7,35 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
 
-        def create_push_package(script_project:, script_content:, compiled_type:, metadata:, config_ui:)
-          build_file_path = file_path(script_project.script_name, compiled_type)
+        def create_push_package(script_project:, script_content:, compiled_type:, metadata:)
+          build_file_path = file_path(script_project.id, script_project.script_name, compiled_type)
           write_to_path(build_file_path, script_content)
 
           Domain::PushPackage.new(
             id: build_file_path,
             extension_point_type: script_project.extension_point_type,
             script_name: script_project.script_name,
-            description: script_project.description,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            config_ui: config_ui,
+            config_ui: script_project.config_ui,
           )
         end
 
-        def get_push_package(script_project:, compiled_type:, metadata:, config_ui:)
-          build_file_path = file_path(script_project.script_name, compiled_type)
+        def get_push_package(script_project:, compiled_type:, metadata:)
+          build_file_path = file_path(script_project.id, script_project.script_name, compiled_type)
           raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
-          script_content = File.read(build_file_path)
+          script_content = ctx.binread(build_file_path)
 
           Domain::PushPackage.new(
             id: build_file_path,
             extension_point_type: script_project.extension_point_type,
             script_name: script_project.script_name,
-            description: script_project.description,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            config_ui: config_ui,
+            config_ui: script_project.config_ui,
           )
         end
 
@@ -45,11 +43,11 @@ module Script
 
         def write_to_path(path, content)
           ctx.mkdir_p(File.dirname(path))
-          ctx.write(path, content)
+          ctx.binwrite(path, content)
         end
 
-        def file_path(script_name, compiled_type)
-          "#{ScriptProject.current.directory}/build/#{script_name}.#{compiled_type}"
+        def file_path(path_to_script, script_name, compiled_type)
+          "#{path_to_script}/build/#{script_name}.#{compiled_type}"
         end
       end
     end

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

@@ -51,7 +51,7 @@ module Script
           binary_path = "target/#{BUILD_TARGET}/release/#{binary_name}"
           raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(binary_path)
 
-          File.read(binary_path)
+          ctx.binread(binary_path)
         end
       end
     end

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class ScriptProjectRepository
+        include SmartProperties
+        property! :ctx, accepts: ShopifyCli::Context
+
+        DEFAULT_CONFIG_UI_FILENAME = "config-ui.yml"
+
+        def create(script_name:, extension_point_type:, language:, no_config_ui:)
+          validate_metadata!(extension_point_type, language)
+
+          optional_identifiers = {}
+          config_ui_file = nil
+
+          unless no_config_ui
+            optional_identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME)
+            config_ui_file = ConfigUiRepository
+              .new(ctx: ctx)
+              .create(DEFAULT_CONFIG_UI_FILENAME, default_config_ui_content(script_name))
+          end
+
+          ShopifyCli::Project.write(
+            ctx,
+            project_type: :script,
+            organization_id: nil,
+            extension_point_type: extension_point_type,
+            script_name: script_name,
+            language: language,
+            **optional_identifiers
+          )
+
+          Domain::ScriptProject.new(
+            id: ctx.root,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            config_ui: config_ui_file
+          )
+        end
+
+        def get
+          extension_point_type = project_config_value!("extension_point_type")
+          script_name = project_config_value!("script_name")
+          config_ui_file = project_config_value("config_ui_file")
+          language = project_config_value("language")&.downcase || default_language
+
+          validate_metadata!(extension_point_type, language)
+
+          config_ui = ConfigUiRepository.new(ctx: ctx).get(config_ui_file)
+
+          Domain::ScriptProject.new(
+            id: project.directory,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            config_ui: config_ui
+          )
+        end
+
+        private
+
+        def project_config_value(key)
+          return nil unless project.config.key?(key)
+          project.config[key]
+        end
+
+        def project_config_value!(key)
+          raise Errors::InvalidContextError, key unless project.config.key?(key)
+          project.config[key]
+        end
+
+        def project
+          ShopifyCli::Project.current
+        end
+
+        def default_config_ui_content(title)
+          require "yaml" # takes 20ms, so deferred as late as possible.
+          YAML.dump({
+            "version" => 1,
+            "inputMode" => "single",
+            "title" => title,
+            "description" => "",
+            "fields" => [],
+          })
+        end
+
+        def default_language
+          Domain::ExtensionPoint::ExtensionPointAssemblyScriptSDK.language
+        end
+
+        def validate_metadata!(extension_point_type, language)
+          if Application::ExtensionPoints.deprecated_types.include?(extension_point_type)
+            raise Errors::DeprecatedEPError, extension_point_type
+          elsif !Application::ExtensionPoints.supported_language?(type: extension_point_type, language: language)
+            raise Errors::InvalidLanguageError.new(language, extension_point_type)
+          end
+        end
+
+        class ConfigUiRepository
+          include SmartProperties
+          property! :ctx, accepts: ShopifyCli::Context
+
+          def create(filename, content)
+            File.write(filename, content)
+
+            Domain::ConfigUi.new(
+              filename: filename,
+              content: content,
+            )
+          end
+
+          def get(filename)
+            return nil unless filename
+
+            path = File.join(ctx.root, filename)
+            raise Domain::Errors::MissingSpecifiedConfigUiDefinitionError, filename unless File.exist?(path)
+
+            content = File.read(path)
+            raise Domain::Errors::InvalidConfigUiDefinitionError, filename unless valid_config_ui?(content)
+
+            Domain::ConfigUi.new(
+              filename: filename,
+              content: content,
+            )
+          end
+
+          private
+
+          def valid_config_ui?(raw_yaml)
+            require "yaml" # takes 20ms, so deferred as late as possible.
+            YAML.safe_load(raw_yaml)
+            true
+          rescue Psych::SyntaxError
+            false
+          end
+        end
+      end
+    end
+  end
+end