shopify-cli 1.6.0 → 1.9.1

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

@@ -5,41 +5,45 @@ module Script
     module Domain
       class PushPackage
         attr_reader :id,
+          :uuid,
           :extension_point_type,
           :script_name,
-          :description,
+          :config_ui,
           :script_content,
           :compiled_type,
           :metadata
 
         def initialize(
           id:,
+          uuid:,
           extension_point_type:,
           script_name:,
-          description:,
           script_content:,
           compiled_type:,
-          metadata:
+          metadata:,
+          config_ui:
         )
           @id = id
+          @uuid = uuid
           @extension_point_type = extension_point_type
           @script_name = script_name
-          @description = description
           @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(
+            uuid: @uuid,
             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,
             metadata: @metadata,
+            config_ui: @config_ui,
           )
         end
       end

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

@@ -0,0 +1,38 @@
+# 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
+
+        def uuid
+          env&.extra&.[]("UUID")
+        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
+          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
@@ -49,14 +55,13 @@ 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}",
-                "@as-pect/cli": "4.0.0",
-                "as-wasi": "^0.2.1",
-                "assemblyscript": "^0.16.1"
+                "#{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 --metadata build/metadata.json -- --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

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

@@ -33,14 +33,12 @@ module Script
 
         def dependencies_installed?
           # Assuming if node_modules folder exist at root of script folder, all deps are installed
-          return false unless ctx.dir_exist?("node_modules")
-          check_if_ep_dependencies_up_to_date!
-          true
+          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)
+            msg = @ctx.message("script.error.metadata_not_found_cause", METADATA_FILE)
             raise Domain::Errors::MetadataNotFoundError, msg
           end
 
@@ -54,7 +52,7 @@ module Script
           output, status = @ctx.capture2e("node", "--version")
           raise Errors::DependencyInstallError, output unless status.success?
 
-          require 'semantic/semantic'
+          require "semantic/semantic"
           version = ::Semantic::Version.new(output[1..-1])
           unless version >= ::Semantic::Version.new(AssemblyScriptProjectCreator::MIN_NODE_VERSION)
             raise Errors::DependencyInstallError,
@@ -71,8 +69,8 @@ module Script
         end
 
         def check_compilation_dependencies!
-          pkg = JSON.parse(File.read('package.json'))
-          build_script = pkg.dig('scripts', 'build')
+          pkg = JSON.parse(File.read("package.json"))
+          build_script = pkg.dig("scripts", "build")
 
           raise Errors::BuildScriptNotFoundError,
             "Build script not found" if build_script.nil?
@@ -83,47 +81,14 @@ 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
-
-        def check_if_ep_dependencies_up_to_date!
-          return true if ENV['SHOPIFY_CLI_SCRIPTS_IGNORE_OUTDATED']
-
-          # ignore exit code since it will not be 0 unless every package is up to date which they probably won't be
-          out, _ = ctx.capture2e("npm", "outdated", "--json", "--depth", "0")
-          parsed_outdated_check = JSON.parse(out)
-          outdated_ep_packages = parsed_outdated_check
-            .select { |package_name, _| package_name.start_with?('@shopify/extension-point-as-') }
-            .select { |_, version_info| !package_is_up_to_date?(version_info) }
-            .keys
-          raise Errors::PackagesOutdatedError.new(outdated_ep_packages),
-            "NPM packages out of date: #{outdated_ep_packages.join(', ')}" unless outdated_ep_packages.empty?
-        end
-
-        def package_is_up_to_date?(version_info)
-          require 'semantic/semantic'
-          current_version = version_info['current']
-          latest_version = version_info['latest']
-
-          # making an assumption that the script developer knows what they're doing if they're not referencing a
-          # semver version
-          begin
-            current_version = ::Semantic::Version.new(current_version)
-            latest_version = ::Semantic::Version.new(latest_version)
-          rescue ArgumentError
-            return true
-          end
-
-          return false if current_version.major < latest_version.major
-          return false if latest_version.major == 0 && current_version.minor < latest_version.minor
-          true
-        end
       end
     end
   end

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

@@ -5,12 +5,59 @@ 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
+
+        class ConfigUiMissingKeysError < ScriptProjectError
+          attr_reader :filename, :missing_keys
+          def initialize(filename, 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)
+            super()
+            @filename = filename
+            @valid_input_modes = valid_input_modes
+          end
+        end
+
+        class ConfigUiFieldsMissingKeysError < ScriptProjectError
+          attr_reader :filename, :missing_keys
+          def initialize(filename, missing_keys)
+            super()
+            @filename = filename
+            @missing_keys = missing_keys
+          end
+        end
+
+        class ConfigUiFieldsInvalidTypeError < ScriptProjectError
+          attr_reader :filename, :valid_types
+          def initialize(filename, valid_types)
+            super()
+            @filename = filename
+            @valid_types = valid_types
+          end
+        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
@@ -30,25 +77,9 @@ 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 PackagesOutdatedError < ScriptProjectError
-          attr_reader :outdated_packages
-          def initialize(outdated_packages)
-            super("EP packages are outdated and need to be updated: #{outdated_packages.join(', ')}")
-            @outdated_packages = outdated_packages
-          end
-        end
-
         class BuildScriptNotFoundError < ScriptProjectError; end
         class InvalidBuildScriptError < ScriptProjectError; end
 

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

@@ -27,8 +27,8 @@ module Script
 
         def extension_point_configs
           @extension_points ||= begin
-            require 'yaml'
-            YAML.load_file(Project.project_filepath('config/extension_points.yml'))
+            require "yaml"
+            YAML.load_file(Project.project_filepath("config/extension_points.yml"))
           end
         end
       end

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

@@ -7,42 +7,37 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
 
-        def create_push_package(
-          extension_point_type:,
-          script_name:,
-          description:,
-          script_content:,
-          compiled_type:,
-          metadata:
-        )
-          build_file_path = file_path(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: extension_point_type,
-            script_name: script_name,
-            description: description,
+            uuid: script_project.uuid,
+            extension_point_type: script_project.extension_point_type,
+            script_name: script_project.script_name,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
+            config_ui: script_project.config_ui,
           )
         end
 
-        def get_push_package(extension_point_type:, script_name:, description:, compiled_type:, metadata:)
-          build_file_path = file_path(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: extension_point_type,
-            script_name: script_name,
-            description: description,
+            uuid: script_project.uuid,
+            extension_point_type: script_project.extension_point_type,
+            script_name: script_project.script_name,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
+            config_ui: script_project.config_ui,
           )
         end
 
@@ -50,11 +45,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