shopify-cli 2.7.2 → 2.9.0

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

@@ -5,9 +5,10 @@ module Script
     module Application
       class PushScript
         class << self
-          def call(ctx:, force:)
+          def call(ctx:, force:, project:)
             script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
             script_project = script_project_repo.get
+            script_project.env = project.env
             task_runner = Infrastructure::Languages::TaskRunner
               .for(ctx, script_project.language, script_project.script_name)
 
@@ -43,11 +44,13 @@ module Script
                 extension_point_type: package.extension_point_type,
                 force: force,
                 metadata: package.metadata,
-                script_json: package.script_json,
+                script_config: package.script_config,
                 module_upload_url: module_upload_url,
                 library: package.library,
               )
-              script_project_repo.update_env(uuid: uuid)
+              if ShopifyCLI::Environment.interactive?
+                script_project_repo.update_env(uuid: uuid)
+              end
               spinner.update_title(p_ctx.message("script.application.pushed"))
             end
           end

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

@@ -14,7 +14,7 @@ module Script
           end
         end
 
-        class MissingScriptJsonFieldError < ScriptProjectError
+        class MissingScriptConfigFieldError < ScriptProjectError
           attr_reader :field
           def initialize(field)
             super()
@@ -22,9 +22,6 @@ module Script
           end
         end
 
-        class InvalidScriptJsonDefinitionError < ScriptProjectError; end
-        class NoScriptJsonFile < ScriptProjectError; end
-
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type
           def initialize(extension_point_type, script_name)

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

@@ -18,6 +18,10 @@ module Script
           @beta
         end
 
+        def stable?
+          !beta?
+        end
+
         def deprecated?
           @deprecated
         end
@@ -26,6 +30,12 @@ module Script
           @type.gsub("_", "-")
         end
 
+        def library_languages(include_betas: false)
+          @libraries.all.map do |library|
+            include_betas || library.stable? ? library.language : nil
+          end.compact
+        end
+
         class ExtensionPointLibraries
           def initialize(config)
             @config = config
@@ -57,6 +67,10 @@ module Script
             @beta
           end
 
+          def stable?
+            !beta?
+          end
+
           def versioned?
             @version
           end

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

@@ -7,7 +7,7 @@ module Script
         attr_reader :id,
           :uuid,
           :extension_point_type,
-          :script_json,
+          :script_config,
           :script_content,
           :compiled_type,
           :metadata,
@@ -20,7 +20,7 @@ module Script
           script_content:,
           compiled_type: nil,
           metadata:,
-          script_json:,
+          script_config:,
           library:
         )
           @id = id
@@ -29,7 +29,7 @@ module Script
           @script_content = script_content
           @compiled_type = compiled_type
           @metadata = metadata
-          @script_json = script_json
+          @script_config = script_config
           @library = library
         end
       end

data/lib/project_types/script/layers/domain/{script_json.rb → script_config.rb}

@@ -3,7 +3,7 @@
 module Script
   module Layers
     module Domain
-      class ScriptJson
+      class ScriptConfig
         attr_reader :content, :version, :title, :description, :configuration_ui, :configuration
 
         REQUIRED_FIELDS = %w(version title)
@@ -23,7 +23,7 @@ module Script
 
         def validate_content!(content)
           REQUIRED_FIELDS.each do |field|
-            raise Errors::MissingScriptJsonFieldError, field if content[field].nil?
+            raise Errors::MissingScriptConfigFieldError, field if content[field].nil?
           end
         end
       end

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

@@ -15,7 +15,7 @@ module Script
         property! :script_name, accepts: String
         property! :language, accepts: String
 
-        property :script_json, accepts: ScriptJson
+        property :script_config, accepts: ScriptConfig
 
         def initialize(*)
           super

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

@@ -5,9 +5,9 @@ module Script
     module Infrastructure
       module Errors
         class BuildError < ScriptProjectError; end
-        class ScriptJsonSyntaxError < ScriptProjectError; end
+        class ScriptConfigSyntaxError < ScriptProjectError; end
 
-        class ScriptJsonMissingKeysError < ScriptProjectError
+        class ScriptConfigMissingKeysError < ScriptProjectError
           attr_reader :missing_keys
           def initialize(missing_keys)
             super()
@@ -15,7 +15,7 @@ module Script
           end
         end
 
-        class ScriptJsonInvalidValueError < ScriptProjectError
+        class ScriptConfigInvalidValueError < ScriptProjectError
           attr_reader :valid_input_modes
           def initialize(valid_input_modes)
             super()
@@ -23,7 +23,7 @@ module Script
           end
         end
 
-        class ScriptJsonFieldsMissingKeysError < ScriptProjectError
+        class ScriptConfigFieldsMissingKeysError < ScriptProjectError
           attr_reader :missing_keys
           def initialize(missing_keys)
             super()
@@ -31,7 +31,7 @@ module Script
           end
         end
 
-        class ScriptJsonFieldsInvalidValueError < ScriptProjectError
+        class ScriptConfigFieldsInvalidValueError < ScriptProjectError
           attr_reader :valid_types
           def initialize(valid_types)
             super()
@@ -39,6 +39,31 @@ module Script
           end
         end
 
+        class ScriptEnvAppNotConnectedError < ScriptProjectError; end
+
+        class InvalidScriptConfigYmlDefinitionError < ScriptProjectError; end
+
+        class InvalidScriptJsonDefinitionError < ScriptProjectError; end
+
+        class MissingScriptConfigYmlFieldError < ScriptProjectError
+          attr_reader :field
+          def initialize(field)
+            super()
+            @field = field
+          end
+        end
+
+        class MissingScriptJsonFieldError < ScriptProjectError
+          attr_reader :field
+          def initialize(field)
+            super()
+            @field = field
+          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/push_package_repository.rb

@@ -18,7 +18,7 @@ module Script
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            script_json: script_project.script_json,
+            script_config: script_project.script_config,
             library: library
           )
         end
@@ -34,7 +34,7 @@ module Script
             extension_point_type: script_project.extension_point_type,
             script_content: script_content,
             metadata: metadata,
-            script_json: script_project.script_json,
+            script_config: script_project.script_config,
             library: library
           )
         end

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

@@ -6,10 +6,26 @@ module Script
       class ScriptProjectRepository
         include SmartProperties
         property! :ctx, accepts: ShopifyCLI::Context
+        property :directory, accepts: String
+        property :initial_directory, accepts: String
 
-        SCRIPT_JSON_FILENAME = "script.json"
         MUTABLE_ENV_VALUES = %i(uuid)
 
+        def create_project_directory
+          raise Infrastructure::Errors::ScriptProjectAlreadyExistsError, directory if ctx.dir_exist?(directory)
+          ctx.mkdir_p(directory)
+          change_directory(directory: directory)
+        end
+
+        def delete_project_directory
+          change_to_initial_directory
+          ctx.rm_r(directory)
+        end
+
+        def change_to_initial_directory
+          change_directory(directory: initial_directory)
+        end
+
         def create(script_name:, extension_point_type:, language:)
           validate_metadata!(extension_point_type, language)
 
@@ -40,7 +56,7 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            script_json: ScriptJsonRepository.new(ctx: ctx).get
+            script_config: script_config_repository.get!
           )
         end
 
@@ -58,7 +74,7 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            script_json: ScriptJsonRepository.new(ctx: ctx).get,
+            script_config: script_config_repository.get!,
           )
         end
 
@@ -77,14 +93,12 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            script_json: ScriptJsonRepository.new(ctx: ctx).get,
+            script_config: script_config_repository.get!,
           )
         end
 
-        def update_or_create_script_json(title:)
-          script_json = ScriptJsonRepository
-            .new(ctx: ctx)
-            .update_or_create(title: title)
+        def update_script_config(title:)
+          script_config = script_config_repository.update!(title: title)
 
           Domain::ScriptProject.new(
             id: ctx.root,
@@ -92,12 +106,16 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            script_json: script_json,
+            script_config: script_config,
           )
         end
 
         private
 
+        def change_directory(directory:)
+          ctx.chdir(directory)
+        end
+
         def capture_io(&block)
           CLI::UI::StdoutRouter::Capture.new(&block).run
         end
@@ -140,40 +158,120 @@ module Script
           end
         end
 
-        class ScriptJsonRepository
+        def script_config_repository
+          @script_config_repository ||= begin
+            supported_repos = [
+              ScriptConfigYmlRepository.new(ctx: ctx),
+              ScriptJsonRepository.new(ctx: ctx),
+            ]
+            repo = supported_repos.find(&:active?)
+            raise Infrastructure::Errors::NoScriptConfigYmlFileError if repo.nil?
+            repo
+          end
+        end
+
+        class ScriptConfigRepository
           include SmartProperties
           property! :ctx, accepts: ShopifyCLI::Context
 
-          def get
-            current_script_json || raise(Domain::Errors::NoScriptJsonFile)
+          def active?
+            ctx.file_exist?(filename)
+          end
+
+          def get!
+            raise Infrastructure::Errors::NoScriptConfigFileError unless active?
+
+            content = ctx.read(filename)
+            hash = file_content_to_hash(content)
+
+            from_h(hash)
+          end
+
+          def update!(title:)
+            hash = get!.content
+            update_hash(hash: hash, title: title)
+
+            ctx.write(filename, hash_to_file_content(hash))
+
+            from_h(hash)
+          end
+
+          private
+
+          def update_hash(hash:, title:)
+            hash["version"] ||= "2"
+            hash["title"] = title
+          end
+
+          def from_h(hash)
+            Domain::ScriptConfig.new(content: hash)
+          rescue Domain::Errors::MissingScriptConfigFieldError => e
+            raise missing_field_error, e.field
           end
 
-          def update_or_create(title:)
-            json = current_script_json&.content || {}
-            json["version"] ||= "1"
-            json["title"] = title
+          # to be implemented by subclasses
+          def filename
+            raise NotImplementedError
+          end
 
-            ctx.write(SCRIPT_JSON_FILENAME, JSON.pretty_generate(json))
+          def file_content_to_hash(file_content)
+            raise NotImplementedError
+          end
 
-            Domain::ScriptJson.new(content: json)
+          def hash_to_file_content(hash)
+            raise NotImplementedError
           end
 
+          def missing_field_error
+            raise NotImplementedError
+          end
+        end
+
+        class ScriptConfigYmlRepository < ScriptConfigRepository
           private
 
-          def current_script_json
-            return nil unless ctx.file_exist?(SCRIPT_JSON_FILENAME)
+          def filename
+            "script.config.yml"
+          end
+
+          def file_content_to_hash(file_content)
+            begin
+              hash = YAML.load(file_content)
+            rescue Psych::SyntaxError
+              raise Errors::InvalidScriptConfigYmlDefinitionError
+            end
+            raise Errors::InvalidScriptConfigYmlDefinitionError unless hash.is_a?(Hash)
+            hash
+          end
+
+          def hash_to_file_content(hash)
+            YAML.dump(hash)
+          end
 
-            content = ctx.read(SCRIPT_JSON_FILENAME)
-            raise Domain::Errors::InvalidScriptJsonDefinitionError unless valid_script_json?(content)
+          def missing_field_error
+            Errors::MissingScriptConfigYmlFieldError
+          end
+        end
 
-            Domain::ScriptJson.new(content: JSON.parse(content))
+        class ScriptJsonRepository < ScriptConfigRepository
+          private
+
+          def filename
+            "script.json"
           end
 
-          def valid_script_json?(content)
-            JSON.parse(content)
-            true
+          def file_content_to_hash(file_content)
+            JSON.parse(file_content)
           rescue JSON::ParserError
-            false
+            raise Errors::InvalidScriptJsonDefinitionError
+          end
+
+          def hash_to_file_content(hash)
+            JSON.pretty_generate(hash)
+          end
+
+          def missing_field_error
+            Errors::MissingScriptJsonFieldError
           end
         end
       end

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

@@ -17,7 +17,7 @@ module Script
           extension_point_type:,
           force: false,
           metadata:,
-          script_json:,
+          script_config:,
           module_upload_url:,
           library:
         )
@@ -25,14 +25,14 @@ module Script
           variables = {
             uuid: uuid,
             extensionPointName: extension_point_type.upcase,
-            title: script_json.title,
-            description: script_json.description,
+            title: script_config.title,
+            description: script_config.description,
             force: force,
             schemaMajorVersion: metadata.schema_major_version.to_s, # API expects string value
             schemaMinorVersion: metadata.schema_minor_version.to_s, # API expects string value
-            scriptJsonVersion: script_json.version,
-            configurationUi: script_json.configuration_ui,
-            configurationDefinition: script_json.configuration&.to_json,
+            scriptConfigVersion: script_config.version,
+            configurationUi: script_config.configuration_ui,
+            configurationDefinition: script_config.configuration&.to_json,
             moduleUploadUrl: module_upload_url,
             library: {
               language: library[:language],
@@ -47,19 +47,19 @@ module Script
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, uuid
           elsif (e = user_errors.any? { |err| err["tag"] == "configuration_definition_syntax_error" })
-            raise Errors::ScriptJsonSyntaxError
+            raise Errors::ScriptConfigSyntaxError
           elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_missing_keys_error" })
-            raise Errors::ScriptJsonMissingKeysError, e["message"]
+            raise Errors::ScriptConfigMissingKeysError, e["message"]
           elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_invalid_value_error" })
-            raise Errors::ScriptJsonInvalidValueError, e["message"]
+            raise Errors::ScriptConfigInvalidValueError, e["message"]
           elsif (e = user_errors.find do |err|
                    err["tag"] == "configuration_definition_schema_field_missing_keys_error"
                  end)
-            raise Errors::ScriptJsonFieldsMissingKeysError, e["message"]
+            raise Errors::ScriptConfigFieldsMissingKeysError, e["message"]
           elsif (e = user_errors.find do |err|
                    err["tag"] == "configuration_definition_schema_field_invalid_value_error"
                  end)
-            raise Errors::ScriptJsonFieldsInvalidValueError, e["message"]
+            raise Errors::ScriptConfigFieldsInvalidValueError, e["message"]
           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,14 +47,23 @@ 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_json_field_cause: "The script.json file is missing the required %s field.",
           missing_script_json_field_help: "Add the field 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_json_file_cause: "The script.json file is missing.",
-          no_script_json_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.",
+
+          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.",
+
+          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.",
 
           configuration_syntax_error_cause: "The script.json is not formatted properly.",
           configuration_syntax_error_help: "Fix the errors and try again.",
@@ -138,6 +147,12 @@ 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: {
@@ -147,6 +162,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: {
@@ -164,16 +180,31 @@ 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.",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
         },
-
+        connect: {
+          connected: "Connected! Your project is now connected to {{green:%s}}",
+          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: {
           help: <<~HELP,
             Compile the JavaScript code into WebAssembly.