shopify-cli 2.7.0 → 2.7.4

data/lib/project_types/script/graphql/app_script_set.graphql

@@ -6,7 +6,7 @@ mutation AppScriptSet(
   $force: Boolean,
   $schemaMajorVersion: String,
   $schemaMinorVersion: String,
-  $scriptJsonVersion: String!,
+  $scriptConfigVersion: String!,
   $configurationUi: Boolean!,
   $configurationDefinition: String!,
   $moduleUploadUrl: String!,
@@ -20,7 +20,7 @@ mutation AppScriptSet(
     force: $force
     schemaMajorVersion: $schemaMajorVersion
     schemaMinorVersion: $schemaMinorVersion,
-    scriptJsonVersion: $scriptJsonVersion,
+    scriptConfigVersion: $scriptConfigVersion,
     configurationUi: $configurationUi,
     configurationDefinition: $configurationDefinition,
     moduleUploadUrl: $moduleUploadUrl,

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

@@ -23,7 +23,6 @@ module Script
                   ctx.puts("\n{{red:#{e.message}}}")
                 end
                 errors = [
-                  Infrastructure::Errors::InvalidBuildScriptError,
                   Infrastructure::Errors::BuildScriptNotFoundError,
                   Infrastructure::Errors::WebAssemblyBinaryNotFoundError,
                 ]

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "shopify_cli"
+
+module Script
+  module Layers
+    module Application
+      class ConnectApp
+        class << self
+          def call(ctx:, force: false, strict: false)
+            script_project_repo = Layers::Infrastructure::ScriptProjectRepository.new(ctx: ctx)
+            script_project = script_project_repo.get
+
+            return false if script_project.env_valid? && !force
+
+            if ShopifyCLI::Shopifolk.check && Forms::RunAgainstShopifyOrg.ask(ctx, nil, nil).response
+              ShopifyCLI::Shopifolk.act_as_shopify_organization
+            end
+
+            org =
+              if partner_proxy_bypass
+                stubbed_org
+              else
+                orgs = ShopifyCLI::PartnersAPI::Organizations.fetch_with_app(ctx)
+                Forms::AskOrg.ask(ctx, orgs, nil).org
+              end
+
+            app = Forms::AskApp.ask(
+              ctx,
+              {
+                apps: org["apps"],
+                acting_as_shopify_organization: ShopifyCLI::Shopifolk.acting_as_shopify_organization?,
+              },
+              nil
+            ).app
+
+            script_service = Layers::Infrastructure::ServiceLocator.script_service(ctx: ctx, api_key: app["apiKey"])
+            extension_point_type = script_project.extension_point_type
+            scripts = script_service.get_app_scripts(extension_point_type: extension_point_type)
+
+            uuid = Forms::AskScriptUuid.ask(ctx, scripts, nil)&.uuid
+
+            if strict && uuid.nil?
+              ctx.abort(ctx.message("script.connect.missing_script"))
+            end
+
+            script_project_repo.create_env(
+              api_key: app["apiKey"],
+              secret: app["apiSecretKeys"].first["secret"],
+              uuid: uuid
+            )
+            ctx.done(ctx.message("script.connect.connected", app["title"]))
+
+            true
+          end
+
+          private
+
+          def partner_proxy_bypass
+            !ENV["BYPASS_PARTNERS_PROXY"].nil?
+          end
+
+          def stubbed_org
+            {
+              "apps" => [
+                {
+                  "appType" => "custom",
+                  "apiKey" => "stubbed-api-key",
+                  "apiSecretKeys" => [{ "secret" => "stubbed-api-secret" }],
+                  "title" => "Fake App (Not connected to Partners)",
+                },
+              ],
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,11 +8,14 @@ module Script
       class CreateScript
         class << self
           def call(ctx:, language:, sparse_checkout_branch:, script_name:, extension_point_type:)
-            raise Infrastructure::Errors::ScriptProjectAlreadyExistsError, script_name if ctx.dir_exist?(script_name)
+            script_project_repo = Infrastructure::ScriptProjectRepository.new(
+              ctx: ctx,
+              directory: script_name,
+              initial_directory: ctx.root
+            )
 
-            in_new_directory_context(ctx, script_name) do
+            in_new_directory_context(script_project_repo) do
               extension_point = ExtensionPoints.get(type: extension_point_type)
-              script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
               project = script_project_repo.create(
                 script_name: script_name,
                 extension_point_type: extension_point_type,
@@ -36,7 +39,7 @@ module Script
               )
 
               install_dependencies(ctx, language, script_name, project_creator)
-              script_project_repo.update_or_create_script_json(title: script_name)
+              script_project_repo.update_script_config(title: script_name)
               project
             end
           end
@@ -62,19 +65,16 @@ module Script
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
           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
+          def in_new_directory_context(script_project_repo)
+            script_project_repo.create_project_directory
+            yield
+          rescue Infrastructure::Errors::ScriptProjectAlreadyExistsError
+            raise
+          rescue
+            script_project_repo.delete_project_directory
+            raise
+          ensure
+            script_project_repo.change_to_initial_directory
           end
         end
       end

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

@@ -43,7 +43,7 @@ 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,
               )

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/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
@@ -43,6 +43,10 @@ module Script
           !raw_uuid.nil?
         end
 
+        def env_valid?
+          api_key && api_secret && uuid_defined?
+        end
+
         private
 
         def raw_uuid

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,29 @@ module Script
           end
         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)
@@ -56,8 +79,15 @@ module Script
           end
         end
 
+        class DeprecatedEPError < ScriptProjectError
+          attr_reader(:extension_point)
+          def initialize(extension_point)
+            super()
+            @extension_point = extension_point
+          end
+        end
+
         class DependencyInstallError < ScriptProjectError; end
-        class DeprecatedEPError < ScriptProjectError; end
         class EmptyResponseError < ScriptProjectError; end
         class InvalidResponseError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
@@ -102,7 +132,6 @@ module Script
         class ScriptProjectAlreadyExistsError < ScriptProjectError; end
         class TaskRunnerNotFoundError < ScriptProjectError; end
         class BuildScriptNotFoundError < ScriptProjectError; end
-        class InvalidBuildScriptError < ScriptProjectError; end
 
         class WebAssemblyBinaryNotFoundError < ScriptProjectError
           def initialize

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

@@ -98,10 +98,6 @@ module Script
 
             raise Errors::BuildScriptNotFoundError,
               "Build script not found" if build_script.nil?
-
-            unless build_script.start_with?("shopify-scripts")
-              raise Errors::InvalidBuildScriptError, "Invalid build script"
-            end
           end
 
           def bytecode

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

@@ -100,10 +100,6 @@ module Script
 
             raise Errors::BuildScriptNotFoundError,
               "Build script not found" if build_script.nil?
-
-            unless build_script.start_with?("javy")
-              raise Errors::InvalidBuildScriptError, "Invalid build script"
-            end
           end
 
           def bytecode

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