shopify-cli 2.7.4 → 2.10.1

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

@@ -5,63 +5,78 @@ module Script
     module Infrastructure
       module Errors
         class BuildError < ScriptProjectError; end
-        class ScriptConfigSyntaxError < ScriptProjectError; end
+
+        class ScriptConfigurationDefinitionError < ScriptProjectError
+          attr_reader :filename
+          def initialize(message:, filename:)
+            @filename = filename
+            super(message)
+          end
+        end
+
+        class ScriptConfigSyntaxError < ScriptProjectError
+          attr_reader :filename
+          def initialize(filename)
+            @filename = filename
+            super()
+          end
+        end
 
         class ScriptConfigMissingKeysError < ScriptProjectError
-          attr_reader :missing_keys
-          def initialize(missing_keys)
+          attr_reader :missing_keys, :filename
+          def initialize(missing_keys:, filename:)
             super()
             @missing_keys = missing_keys
+            @filename = filename
           end
         end
 
         class ScriptConfigInvalidValueError < ScriptProjectError
-          attr_reader :valid_input_modes
-          def initialize(valid_input_modes)
+          attr_reader :valid_input_modes, :filename
+          def initialize(valid_input_modes:, filename:)
             super()
             @valid_input_modes = valid_input_modes
+            @filename = filename
           end
         end
 
         class ScriptConfigFieldsMissingKeysError < ScriptProjectError
-          attr_reader :missing_keys
-          def initialize(missing_keys)
+          attr_reader :missing_keys, :filename
+          def initialize(missing_keys:, filename:)
             super()
             @missing_keys = missing_keys
+            @filename = filename
           end
         end
 
         class ScriptConfigFieldsInvalidValueError < ScriptProjectError
-          attr_reader :valid_types
-          def initialize(valid_types)
+          attr_reader :valid_types, :filename
+          def initialize(valid_types:, filename:)
             super()
             @valid_types = valid_types
+            @filename = filename
           end
         end
 
-        class InvalidScriptConfigYmlDefinitionError < ScriptProjectError; end
+        class ScriptEnvAppNotConnectedError < ScriptProjectError; end
 
-        class InvalidScriptJsonDefinitionError < ScriptProjectError; end
-
-        class MissingScriptConfigYmlFieldError < ScriptProjectError
-          attr_reader :field
-          def initialize(field)
+        class ScriptConfigParseError < ScriptProjectError
+          attr_reader :filename, :serialization_format
+          def initialize(filename:, serialization_format:)
             super()
-            @field = field
+            @filename = filename
+            @serialization_format = serialization_format
           end
         end
 
-        class MissingScriptJsonFieldError < ScriptProjectError
-          attr_reader :field
-          def initialize(field)
+        class NoScriptConfigFileError < ScriptProjectError
+          attr_reader :filename
+          def initialize(filename)
             super()
-            @field = field
+            @filename = filename
           end
         end
 
-        class NoScriptConfigYmlFileError < ScriptProjectError; end
-        class NoScriptConfigFileError < ScriptProjectError; end
-
         class APILibraryNotFoundError < ScriptProjectError
           attr_reader :library_name
           def initialize(library_name)

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

@@ -21,10 +21,6 @@ module Script
             bytecode
           end
 
-          def compiled_type
-            "wasm"
-          end
-
           def install_dependencies
             check_node_version!
 

data/lib/project_types/script/layers/infrastructure/languages/typescript_task_runner.rb

@@ -22,10 +22,6 @@ module Script
             bytecode
           end
 
-          def compiled_type
-            "wasm"
-          end
-
           def install_dependencies
             check_node_version!
 

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

@@ -7,8 +7,8 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCLI::Context
 
-        def create_push_package(script_project:, script_content:, compiled_type:, metadata:, library:)
-          build_file_path = file_path(script_project.id, compiled_type)
+        def create_push_package(script_project:, script_content:, metadata:, library:)
+          build_file_path = file_path(script_project.id)
           write_to_path(build_file_path, script_content)
 
           Domain::PushPackage.new(
@@ -16,15 +16,14 @@ module Script
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
             script_content: script_content,
-            compiled_type: compiled_type,
             metadata: metadata,
             script_config: script_project.script_config,
             library: library
           )
         end
 
-        def get_push_package(script_project:, compiled_type:, metadata:, library:)
-          build_file_path = file_path(script_project.id, compiled_type)
+        def get_push_package(script_project:, metadata:, library:)
+          build_file_path = file_path(script_project.id)
           raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
           script_content = ctx.binread(build_file_path)
@@ -46,8 +45,8 @@ module Script
           ctx.binwrite(path, content)
         end
 
-        def file_path(path_to_script, compiled_type)
-          "#{path_to_script}/build/script.#{compiled_type}"
+        def file_path(path_to_script)
+          "#{path_to_script}/build/script.wasm"
         end
       end
     end

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

@@ -10,6 +10,7 @@ module Script
         property :initial_directory, accepts: String
 
         MUTABLE_ENV_VALUES = %i(uuid)
+        INPUT_QUERY_PATH = "input.graphql"
 
         def create_project_directory
           raise Infrastructure::Errors::ScriptProjectAlreadyExistsError, directory if ctx.dir_exist?(directory)
@@ -38,13 +39,7 @@ module Script
             language: language
           )
 
-          Domain::ScriptProject.new(
-            id: ctx.root,
-            env: project.env,
-            script_name: script_name,
-            extension_point_type: extension_point_type,
-            language: language
-          )
+          build_script_project(script_config: nil)
         end
 
         def get
@@ -56,7 +51,8 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            script_config: script_config_repository.get!
+            script_config: script_config_repository.get!,
+            input_query: read_input_query,
           )
         end
 
@@ -68,14 +64,7 @@ module Script
             end
           end
 
-          Domain::ScriptProject.new(
-            id: ctx.root,
-            env: project.env,
-            script_name: script_name,
-            extension_point_type: extension_point_type,
-            language: language,
-            script_config: script_config_repository.get!,
-          )
+          build_script_project
         end
 
         def create_env(api_key:, secret:, uuid:)
@@ -87,19 +76,19 @@ module Script
             }
           ).write(ctx)
 
-          Domain::ScriptProject.new(
-            id: ctx.root,
-            env: project.env,
-            script_name: script_name,
-            extension_point_type: extension_point_type,
-            language: language,
-            script_config: script_config_repository.get!,
-          )
+          build_script_project
         end
 
         def update_script_config(title:)
           script_config = script_config_repository.update!(title: title)
+          build_script_project(script_config: script_config)
+        end
+
+        private
 
+        def build_script_project(
+          script_config: script_config_repository.get!
+        )
           Domain::ScriptProject.new(
             id: ctx.root,
             env: project.env,
@@ -110,8 +99,6 @@ module Script
           )
         end
 
-        private
-
         def change_directory(directory:)
           ctx.chdir(directory)
         end
@@ -160,16 +147,23 @@ module Script
 
         def script_config_repository
           @script_config_repository ||= begin
+            script_config_yml_repo = ScriptConfigYmlRepository.new(ctx: ctx)
             supported_repos = [
-              ScriptConfigYmlRepository.new(ctx: ctx),
+              script_config_yml_repo,
               ScriptJsonRepository.new(ctx: ctx),
             ]
             repo = supported_repos.find(&:active?)
-            raise Infrastructure::Errors::NoScriptConfigYmlFileError if repo.nil?
+            if repo.nil?
+              raise Infrastructure::Errors::NoScriptConfigFileError, script_config_yml_repo.filename
+            end
             repo
           end
         end
 
+        def read_input_query
+          ctx.read(INPUT_QUERY_PATH) if ctx.file_exist?(INPUT_QUERY_PATH)
+        end
+
         class ScriptConfigRepository
           include SmartProperties
           property! :ctx, accepts: ShopifyCLI::Context
@@ -179,7 +173,7 @@ module Script
           end
 
           def get!
-            raise Infrastructure::Errors::NoScriptConfigFileError unless active?
+            raise Infrastructure::Errors::NoScriptConfigFileError, filename unless active?
 
             content = ctx.read(filename)
             hash = file_content_to_hash(content)
@@ -196,6 +190,10 @@ module Script
             from_h(hash)
           end
 
+          def filename
+            raise NotImplementedError
+          end
+
           private
 
           def update_hash(hash:, title:)
@@ -204,14 +202,7 @@ module Script
           end
 
           def from_h(hash)
-            Domain::ScriptConfig.new(content: hash)
-          rescue Domain::Errors::MissingScriptConfigFieldError => e
-            raise missing_field_error, e.field
-          end
-
-          # to be implemented by subclasses
-          def filename
-            raise NotImplementedError
+            Domain::ScriptConfig.new(content: hash, filename: filename)
           end
 
           def file_content_to_hash(file_content)
@@ -221,26 +212,22 @@ module Script
           def hash_to_file_content(hash)
             raise NotImplementedError
           end
-
-          def missing_field_error
-            raise NotImplementedError
-          end
         end
 
         class ScriptConfigYmlRepository < ScriptConfigRepository
-          private
-
           def filename
             "script.config.yml"
           end
 
+          private
+
           def file_content_to_hash(file_content)
             begin
               hash = YAML.load(file_content)
             rescue Psych::SyntaxError
-              raise Errors::InvalidScriptConfigYmlDefinitionError
+              raise parse_error
             end
-            raise Errors::InvalidScriptConfigYmlDefinitionError unless hash.is_a?(Hash)
+            raise parse_error unless hash.is_a?(Hash)
             hash
           end
 
@@ -248,30 +235,34 @@ module Script
             YAML.dump(hash)
           end
 
-          def missing_field_error
-            Errors::MissingScriptConfigYmlFieldError
+          def parse_error
+            Errors::ScriptConfigParseError.new(filename: filename, serialization_format: "YAML")
           end
         end
 
         class ScriptJsonRepository < ScriptConfigRepository
-          private
-
           def filename
             "script.json"
           end
 
+          private
+
           def file_content_to_hash(file_content)
-            JSON.parse(file_content)
-          rescue JSON::ParserError
-            raise Errors::InvalidScriptJsonDefinitionError
+            begin
+              hash = JSON.parse(file_content)
+            rescue JSON::ParserError
+              raise parse_error
+            end
+            raise parse_error unless hash.is_a?(Hash)
+            hash
           end
 
           def hash_to_file_content(hash)
             JSON.pretty_generate(hash)
           end
 
-          def missing_field_error
-            Errors::MissingScriptJsonFieldError
+          def parse_error
+            Errors::ScriptConfigParseError.new(filename: filename, serialization_format: "JSON")
           end
         end
       end

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

@@ -19,7 +19,8 @@ module Script
           metadata:,
           script_config:,
           module_upload_url:,
-          library:
+          library:,
+          input_query: nil
         )
           query_name = "app_script_set"
           variables = {
@@ -38,6 +39,7 @@ module Script
               language: library[:language],
               version: library[:version],
             },
+            inputQuery: input_query,
           }
           resp_hash = make_request(query_name: query_name, variables: variables)
           user_errors = resp_hash["data"]["appScriptSet"]["userErrors"]
@@ -46,20 +48,37 @@ module Script
 
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, uuid
+          elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_error" })
+            raise Errors::ScriptConfigurationDefinitionError.new(
+              message: e["message"],
+              filename: script_config.filename,
+            )
           elsif (e = user_errors.any? { |err| err["tag"] == "configuration_definition_syntax_error" })
-            raise Errors::ScriptConfigSyntaxError
+            raise Errors::ScriptConfigSyntaxError, script_config.filename
           elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_missing_keys_error" })
-            raise Errors::ScriptConfigMissingKeysError, e["message"]
+            raise Errors::ScriptConfigMissingKeysError.new(
+              missing_keys: e["message"],
+              filename: script_config.filename,
+            )
           elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_invalid_value_error" })
-            raise Errors::ScriptConfigInvalidValueError, e["message"]
+            raise Errors::ScriptConfigInvalidValueError.new(
+              valid_input_modes: e["message"],
+              filename: script_config.filename,
+            )
           elsif (e = user_errors.find do |err|
                    err["tag"] == "configuration_definition_schema_field_missing_keys_error"
                  end)
-            raise Errors::ScriptConfigFieldsMissingKeysError, e["message"]
+            raise Errors::ScriptConfigFieldsMissingKeysError.new(
+              missing_keys: e["message"],
+              filename: script_config.filename,
+            )
           elsif (e = user_errors.find do |err|
                    err["tag"] == "configuration_definition_schema_field_invalid_value_error"
                  end)
-            raise Errors::ScriptConfigFieldsInvalidValueError, e["message"]
+            raise Errors::ScriptConfigFieldsInvalidValueError.new(
+              valid_types: e["message"],
+              filename: script_config.filename,
+            )
           elsif user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
             raise Domain::Errors::MetadataValidationError
           else

data/lib/project_types/script/loaders/project.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Script
+  module Loaders
+    module Project
+      def self.load(directory:, api_key:, uuid:, api_secret:, context: ShopifyCLI::Context.new)
+        env_overrides = {
+          "SHOPIFY_API_KEY" => api_key,
+          "SHOPIFY_API_SECRET" => api_secret,
+          "UUID" => uuid,
+        }.compact
+        env_file_present = env_file_exists?(directory)
+        env = if env_file_present
+          ShopifyCLI::Resources::EnvFile.read(directory, overrides: env_overrides)
+        else
+          ShopifyCLI::Resources::EnvFile.from_hash(env_overrides)
+        end
+
+        project = ShopifyCLI::Project.at(directory)
+        project.env = env
+        project
+      rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
+        handle_error(error, context: context, env_file_present: env_file_present)
+      end
+
+      def self.handle_error(error, context:, env_file_present:)
+        if env_file_present
+          properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
+          missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+          raise ShopifyCLI::Abort,
+            context.message("script.error.missing_env_file_variables", missing_env_variables, ShopifyCLI::TOOL_NAME)
+        else
+          properties_hash = { api_key: "--api-key", secret: "--api-secret" }
+          missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+          raise ShopifyCLI::Abort, context.message("script.error.missing_push_options", missing_options)
+        end
+      end
+
+      def self.env_file_exists?(directory)
+        File.exist?(ShopifyCLI::Resources::EnvFile.path(directory))
+      end
+    end
+  end
+end

data/lib/project_types/script/loaders/specification_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Script
+  module Loaders
+    module SpecificationHandler
+      def self.load(project:, context:)
+        identifier = project.specification_identifier
+        Models::LazySpecificationHandler.new(identifier) do
+          specifications = Models::Specifications.new(
+            fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: context)
+          )
+
+          unless specifications.valid?(identifier)
+            context.abort(context.message("errors.unknown_type", project.specification_identifier))
+          end
+
+          specifications[identifier]
+        end
+      end
+    end
+  end
+end

data/lib/project_types/script/messages/messages.rb

@@ -47,38 +47,39 @@ module Script
           invalid_language_cause: "Invalid language %s.",
           invalid_language_help: "Allowed values: %s.",
 
-          missing_script_config_yml_field_cause: "The script.config.yml file is missing the required %s field.",
-          missing_script_config_yml_field_help: "Add the field and try again.",
+          missing_script_config_field_cause: "The %{filename} file is missing the required %{field} field.",
+          missing_script_config_field_help: "Add the field and try again.",
 
-          missing_script_json_field_cause: "The script.json file is missing the required %s field.",
-          missing_script_json_field_help: "Add the field and try again.",
+          script_config_parse_error_cause: "The %{filename} file contains invalid %{serialization_format}.",
+          script_config_parse_error_help: "Fix the errors and try again.",
 
-          invalid_script_json_definition_cause: "The script.json file contains invalid JSON.",
-          invalid_script_json_definition_help: "Fix the errors and try again.",
+          no_script_config_file_cause: "The %{filename} file is missing.",
+          no_script_config_file_help: "Create this file and try again.",
 
-          invalid_script_config_yml_definition_cause: "The script.config.yml file contains invalid YAML.",
-          invalid_script_config_yml_definition_help: "Fix the errors and try again.",
+          app_not_connected_cause: "Script is not connected to an app.",
+          app_not_connected_help: "Run shopify connect or enter fields for api-key and api-secret.",
 
-          no_script_config_yml_file_cause: "The script.config.yml file is missing.",
-          no_script_config_yml_file_help: "Create this file and try again.",
+          configuration_definition_error_cause: "In the %{filename} file, there was a problem with the "\
+                                                "configuration. %{message}",
+          configuration_definition_error_help: "Fix the error and try again.",
 
-          configuration_syntax_error_cause: "The script.json is not formatted properly.",
+          configuration_syntax_error_cause: "The %{filename} is not formatted properly.",
           configuration_syntax_error_help: "Fix the errors and try again.",
 
-          configuration_missing_keys_error_cause: "The script.json file is missing required keys: "\
+          configuration_missing_keys_error_cause: "The %{filename} file is missing required keys: "\
                                               "%{missing_keys}.",
           configuration_missing_keys_error_help: "Add the keys and try again.",
 
-          configuration_invalid_value_error_cause: "The script.json configuration only accepts "\
+          configuration_invalid_value_error_cause: "The %{filename} configuration only accepts "\
                                                    "one of the following types(s): %{valid_input_modes}.",
           configuration_invalid_value_error_help: "Change the type and try again.",
 
-          configuration_schema_field_missing_keys_error_cause: "A configuration entry in the script.json file "\
+          configuration_schema_field_missing_keys_error_cause: "A configuration entry in the %{filename} file "\
                                                      "is missing required keys: %{missing_keys}.",
           configuration_definition_schema_field_missing_keys_error_help: "Add the keys and try again.",
 
           configuration_schema_field_invalid_value_error_cause: "The configuration entries in the "\
-                                                     "script.json file only accept one of the following "\
+                                                     "%{filename} file only accept one of the following "\
                                                      "type(s): %{valid_types}.",
           configuration_schema_field_invalid_value_error_help: "Change the types and try again.",
 
@@ -145,6 +146,11 @@ module Script
           language_library_for_api_not_found_cause: "Script can’t be pushed because the %{language} library for API %{api} is missing.",
           language_library_for_api_not_found_help: "Make sure extension_point.yml contains the correct API library.",
           no_scripts_found_in_app: "The selected apps have no scripts. Please, create them first on the partners' dashboard.",
+          missing_env_file_variables: "The following variables are missing in the .env file: %s."\
+            " It might happen when the script hasn't been previously connected to an app."\
+            " To connect the script to an app, run {{command:%s script connect}}",
+          missing_push_options: "The following options are required: %s."\
+            " You can obtain them from the .env file generated after connecting the script to an app.",
         },
 
         create: {
@@ -154,6 +160,7 @@ module Script
               Options:
                 {{command:--name=NAME}} Script project name. Use any string.
                 {{command:--api=TYPE}} Script API name. Allowed values: %2$s.
+                {{command:--language=LANGUAGE}} Programming language. Allowed values: %3$s.
           HELP
 
           error: {
@@ -171,9 +178,13 @@ module Script
               Usage: {{command:%s script push}}
               Options:
                 {{command:[--force]}} Replaces the existing script on the app with this version.
+                {{command:[--api-key=API_KEY]}} The API key used to register an app with the script. This can be found on the app page on Partners Dashboard. Overrides the value in the .env file, if present.
+                {{command:[--api-secret=API_SECRET]}} The API secret of the app the script is registered with. Overrides the value in the .env file, if present.
+                {{command:[--uuid=UUID]}} The uuid of the script. Overrides the value in the .env file, if present.
           HELP
 
           error: {
+            operation_failed_no_uuid: "UUID is required to push in a CI environment.",
             operation_failed_with_api_key: "Couldn't push script to app (API key: %{api_key}).",
             operation_failed_no_api_key: "Couldn't push script to app.",
           },
@@ -182,13 +193,14 @@ module Script
         },
         connect: {
           connected: "Connected! Your project is now connected to {{green:%s}}",
-          missing_script: "No script has been selected.",
           help: <<~HELP,
             {{command:%s script connect}}: Connects an existing script to an app.
               Usage: {{command:%s script connect}}
           HELP
           error: {
             operation_failed: "Couldn't connect script to app.",
+            missing_env_file_variables: "The following variables are missing in the .env file: %s."\
+            " To connect the script to an app, either enter the value into the .env file or delete the .env file, then run {{command:%s script connect}}",
           },
         },
         javy: {