shopify-cli 1.7.1 → 1.11.0

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

@@ -7,59 +7,27 @@ module Script
     module Application
       class CreateScript
         class << self
-          def call(ctx:, language:, script_name:, extension_point_type:, description:, no_config_ui:)
-            extension_point = ExtensionPoints.get(type: extension_point_type)
-            project = setup_project(
-              ctx: ctx,
-              language: language,
-              script_name: script_name,
-              extension_point: extension_point,
-              description: description,
-              no_config_ui: no_config_ui
-            )
-            project_creator = Infrastructure::ProjectCreator
-              .for(ctx, language, extension_point, script_name, project.directory)
-            install_dependencies(ctx, language, script_name, project_creator)
-            bootstrap(ctx, project_creator)
-            project
+          def call(ctx:, language:, script_name:, extension_point_type:, no_config_ui:)
+            raise Infrastructure::Errors::ScriptProjectAlreadyExistsError, script_name if ctx.dir_exist?(script_name)
+
+            in_new_directory_context(ctx, script_name) do
+              extension_point = ExtensionPoints.get(type: extension_point_type)
+              project = Infrastructure::ScriptProjectRepository.new(ctx: ctx).create(
+                script_name: script_name,
+                extension_point_type: extension_point_type,
+                language: language,
+                no_config_ui: no_config_ui
+              )
+              project_creator = Infrastructure::ProjectCreator
+                .for(ctx, language, extension_point, script_name, project.id)
+              install_dependencies(ctx, language, script_name, project_creator)
+              bootstrap(ctx, project_creator)
+              project
+            end
           end
 
           private
 
-          DEFAULT_CONFIG_UI_FILENAME = "config-ui.yml"
-          DEFAULT_CONFIG = {
-            "version" => 1,
-            "type" => "single",
-            "fields" => [],
-          }
-
-          def setup_project(ctx:, language:, script_name:, extension_point:, description:, no_config_ui:)
-            ScriptProject.create(ctx, script_name)
-
-            identifiers = {
-              extension_point_type: extension_point.type,
-              script_name: script_name,
-              language: language,
-              description: description,
-            }
-
-            unless no_config_ui
-              require "yaml" # takes 20ms, so deferred as late as possible.
-              identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME)
-              Infrastructure::ConfigUiRepository
-                .new(ctx: ctx)
-                .create_config_ui(DEFAULT_CONFIG_UI_FILENAME, YAML.dump(DEFAULT_CONFIG))
-            end
-
-            ScriptProject.write(
-              ctx,
-              project_type: :script,
-              organization_id: nil, # TODO: can you provide this at creation
-              **identifiers
-            )
-            ScriptProject.current
-          end
-
           def install_dependencies(ctx, language, script_name, project_creator)
             task_runner = Infrastructure::TaskRunner.for(ctx, language, script_name)
             project_creator.setup_dependencies
@@ -72,6 +40,21 @@ module Script
               spinner.update_title(ctx.message("script.create.created"))
             end
           end
+
+          def in_new_directory_context(ctx, directory)
+            initial_directory = ctx.root
+            begin
+              ctx.mkdir_p(directory)
+              ctx.chdir(directory)
+              yield
+            rescue
+              ctx.chdir(initial_directory)
+              ctx.rm_r(directory)
+              raise
+            ensure
+              ctx.chdir(initial_directory)
+            end
+          end
         end
       end
     end

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

@@ -12,9 +12,10 @@ module Script
           Infrastructure::ExtensionPointRepository.new.extension_point_types
         end
 
-        def self.non_deprecated_types
+        def self.available_types
           Infrastructure::ExtensionPointRepository.new.extension_points.select do |ep|
-            !ep.deprecated?
+            next false if ep.deprecated?
+            !ep.beta? || ShopifyCli::Feature.enabled?(:scripts_beta_extension_points)
           end.map(&:type)
         end
 

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

@@ -6,21 +6,21 @@ module Script
       class PushScript
         class << self
           def call(ctx:, force:)
-            script_project = ScriptProject.current
+            script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
+            script_project = script_project_repo.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)
+              uuid = package.push(Infrastructure::ScriptService.new(ctx: p_ctx), script_project.api_key, force)
+              script_project_repo.update_env(uuid: uuid)
               spinner.update_title(p_ctx.message("script.application.pushed"))
             end
           end

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

@@ -39,8 +39,6 @@ module Script
           end
         end
 
-        class ServiceFailureError < ScriptProjectError; end
-
         class MetadataNotFoundError < ScriptProjectError; end
 
         class MetadataValidationError < ScriptProjectError; end

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

@@ -4,79 +4,94 @@ module Script
   module Layers
     module Domain
       class ExtensionPoint
-        attr_reader :type, :deprecated, :sdks
+        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
-      end
 
-      class ExtensionPointSDKs
-        def initialize(config)
-          @config = config
+        def dasherize_type
+          @type.gsub("_", "-")
         end
 
-        def all
-          [assemblyscript, rust].compact
-        end
+        class ExtensionPointSDKs
+          def initialize(config)
+            @config = config
+          end
 
-        def assemblyscript
-          @assemblyscript ||= new_sdk(ExtensionPointAssemblyScriptSDK)
-        end
+          def all
+            [assemblyscript, rust].compact
+          end
 
-        def rust
-          @rust ||= new_sdk(ExtensionPointRustSDK)
-        end
+          def assemblyscript
+            @assemblyscript ||= new_sdk(ExtensionPointAssemblyScriptSDK)
+          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

@@ -5,9 +5,9 @@ module Script
     module Domain
       class PushPackage
         attr_reader :id,
+          :uuid,
           :extension_point_type,
           :script_name,
-          :description,
           :config_ui,
           :script_content,
           :compiled_type,
@@ -15,18 +15,18 @@ module Script
 
         def initialize(
           id:,
+          uuid:,
           extension_point_type:,
           script_name:,
-          description:,
           script_content:,
           compiled_type:,
           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
@@ -35,9 +35,9 @@ module Script
 
         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,

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class ScriptProject
+        include SmartProperties
+
+        UUID_ENV_KEY = "UUID"
+
+        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 api_secret
+          env&.secret
+        end
+
+        def uuid
+          uuid_defined? && !raw_uuid.empty? ? raw_uuid : nil
+        end
+
+        def uuid_defined?
+          !raw_uuid.nil?
+        end
+
+        private
+
+        def raw_uuid
+          env&.extra&.[](UUID_ENV_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.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,26 +22,25 @@ module Script
         end
 
         def bootstrap
-          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?
+          command_runner.call(bootstap_command)
         end
 
         private
 
+        def command_runner
+          @command_runner ||= CommandRunner.new(ctx: ctx)
+        end
+
         def write_npmrc
-          ctx.system(
-            "npm", "--userconfig", "./.npmrc", "config", "set", "@shopify:registry", "https://registry.npmjs.com"
-          )
-          ctx.system(
-            "npm", "--userconfig", "./.npmrc", "config", "set", "engine-strict", "true"
-          )
+          command_runner.call("npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com")
+          command_runner.call("npm --userconfig ./.npmrc config set engine-strict true")
         end
 
         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)
+          return extension_point.sdks.assemblyscript.version if extension_point.sdks.assemblyscript.versioned?
+
+          out = command_runner.call("npm show #{extension_point.sdks.assemblyscript.package} version --json")
+          "^#{JSON.parse(out)}"
         end
 
         def write_package_json
@@ -49,13 +51,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}",
+                "#{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/shopify_main.ts --binary build/#{script_name}.wasm --metadata build/metadata.json -- --lib node_modules --optimize --use Date="
+                "build": "#{build_command}"
               },
               "engines": {
                 "node": ">=#{MIN_NODE_VERSION}"
@@ -64,6 +66,29 @@ 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
+          domain = extension_point.domain
+
+          if domain.nil?
+            "#{BUILD} #{ASC_ARGS}"
+          else
+            "#{BUILD} --domain #{domain} --ep #{type} #{ASC_ARGS}"
+          end
+        end
       end
     end
   end