shopify-cli 1.13.0 → 2.0.2

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

@@ -14,21 +14,16 @@ module Script
           end
         end
 
-        class InvalidConfigUiDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(filename)
+        class MissingScriptJsonFieldError < ScriptProjectError
+          attr_reader :field
+          def initialize(field)
             super()
-            @filename = filename
+            @field = field
           end
         end
 
-        class MissingSpecifiedConfigUiDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(filename)
-            super()
-            @filename = filename
-          end
-        end
+        class InvalidScriptJsonDefinitionError < ScriptProjectError; end
+        class NoScriptJsonFile < ScriptProjectError; end
 
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type

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

@@ -7,8 +7,7 @@ module Script
         attr_reader :id,
           :uuid,
           :extension_point_type,
-          :script_name,
-          :config_ui,
+          :script_json,
           :script_content,
           :compiled_type,
           :metadata
@@ -17,33 +16,30 @@ module Script
           id:,
           uuid:,
           extension_point_type:,
-          script_name:,
           script_content:,
           compiled_type:,
           metadata:,
-          config_ui:
+          script_json:
         )
           @id = id
           @uuid = uuid
           @extension_point_type = extension_point_type
-          @script_name = script_name
           @script_content = script_content
           @compiled_type = compiled_type
           @metadata = metadata
-          @config_ui = config_ui
+          @script_json = script_json
         end
 
         def push(script_service, api_key, force)
           script_service.push(
             uuid: @uuid,
             extension_point_type: @extension_point_type,
-            script_name: @script_name,
             script_content: @script_content,
             compiled_type: @compiled_type,
             api_key: api_key,
             force: force,
             metadata: @metadata,
-            config_ui: @config_ui,
+            script_json: @script_json,
           )
         end
       end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Domain
+      class ScriptJson
+        attr_reader :content, :version, :title, :description, :configuration_ui, :configuration
+
+        REQUIRED_FIELDS = %w(version title)
+
+        def initialize(content:)
+          validate_content!(content)
+
+          @content = content
+          @version = @content["version"].to_s
+          @title = @content["title"]
+          @description = @content["description"]
+          @configuration_ui = @content["configurationUi"]
+          @configuration = @content["configuration"]
+        end
+
+        private
+
+        def validate_content!(content)
+          REQUIRED_FIELDS.each do |field|
+            raise Errors::MissingScriptJsonFieldError, field if content[field].nil?
+          end
+        end
+      end
+    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 :config_ui, accepts: ConfigUi
+        property :script_json, accepts: ScriptJson
 
         def initialize(*)
           super

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

@@ -6,40 +6,36 @@ module Script
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
-        class ConfigUiSyntaxError < ScriptProjectError; end
+        class ScriptJsonSyntaxError < ScriptProjectError; end
 
-        class ConfigUiMissingKeysError < ScriptProjectError
-          attr_reader :filename, :missing_keys
-          def initialize(filename, missing_keys)
+        class ScriptJsonMissingKeysError < ScriptProjectError
+          attr_reader :missing_keys
+          def initialize(missing_keys)
             super()
-            @filename = filename
             @missing_keys = missing_keys
           end
         end
 
-        class ConfigUiInvalidInputModeError < ScriptProjectError
-          attr_reader :filename, :valid_input_modes
-          def initialize(filename, valid_input_modes)
+        class ScriptJsonInvalidValueError < ScriptProjectError
+          attr_reader :valid_input_modes
+          def initialize(valid_input_modes)
             super()
-            @filename = filename
             @valid_input_modes = valid_input_modes
           end
         end
 
-        class ConfigUiFieldsMissingKeysError < ScriptProjectError
-          attr_reader :filename, :missing_keys
-          def initialize(filename, missing_keys)
+        class ScriptJsonFieldsMissingKeysError < ScriptProjectError
+          attr_reader :missing_keys
+          def initialize(missing_keys)
             super()
-            @filename = filename
             @missing_keys = missing_keys
           end
         end
 
-        class ConfigUiFieldsInvalidTypeError < ScriptProjectError
-          attr_reader :filename, :valid_types
-          def initialize(filename, valid_types)
+        class ScriptJsonFieldsInvalidValueError < ScriptProjectError
+          attr_reader :valid_types
+          def initialize(valid_types)
             super()
-            @filename = filename
             @valid_types = valid_types
           end
         end

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

@@ -45,27 +45,20 @@ module Script
           end
 
           def write_package_json
-            package_json = <<~HERE
-              {
-                "name": "#{script_name}",
-                "version": "1.0.0",
-                "devDependencies": {
-                  "@shopify/scripts-sdk-as": "#{extension_point.sdks.assemblyscript.sdk_version}",
-                  "@shopify/scripts-toolchain-as": "#{extension_point.sdks.assemblyscript.toolchain_version}",
-                  "#{extension_point.sdks.assemblyscript.package}": "#{extension_point_version}",
-                  "@as-pect/cli": "^6.0.0",
-                  "assemblyscript": "^0.18.13"
-                },
-                "scripts": {
-                  "test": "asp --summary --verbose",
-                  "build": "#{build_command}"
-                },
-                "engines": {
-                  "node": ">=#{MIN_NODE_VERSION}"
-                }
-              }
-            HERE
-            ctx.write("package.json", package_json)
+            package_json = {
+              name: script_name,
+              version: "1.0.0",
+              devDependencies: dev_dependencies,
+              scripts: {
+                test: "asp --summary --verbose",
+                build: build_command,
+              },
+              engines: {
+                node: ">=#{MIN_NODE_VERSION}",
+              },
+            }
+
+            ctx.write("package.json", JSON.pretty_generate(package_json))
           end
 
           def bootstap_command
@@ -90,6 +83,21 @@ module Script
               "#{BUILD} --domain #{domain} --ep #{type} #{ASC_ARGS}"
             end
           end
+
+          def dev_dependencies
+            dependencies = {
+              "@as-pect/cli": "^6.0.0",
+              "assemblyscript": "^0.18.13",
+              "@shopify/scripts-toolchain-as": extension_point.sdks.assemblyscript.toolchain_version,
+              "#{extension_point.sdks.assemblyscript.package}": extension_point_version,
+            }
+
+            if extension_point.sdks.assemblyscript.sdk_version
+              dependencies["@shopify/scripts-sdk-as"] = extension_point.sdks.assemblyscript.sdk_version
+            end
+
+            dependencies
+          end
         end
       end
     end

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

@@ -15,11 +15,10 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
-            script_name: script_project.script_name,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            config_ui: script_project.config_ui,
+            script_json: script_project.script_json,
           )
         end
 
@@ -32,11 +31,10 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
-            script_name: script_project.script_name,
             script_content: script_content,
             compiled_type: compiled_type,
             metadata: metadata,
-            config_ui: script_project.config_ui,
+            script_json: script_project.script_json,
           )
         end
 

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

@@ -7,24 +7,19 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
 
-        DEFAULT_CONFIG_UI_FILENAME = "config-ui.yml"
+        SCRIPT_JSON_FILENAME = "script.json"
         MUTABLE_ENV_VALUES = %i(uuid)
 
-        def create(script_name:, extension_point_type:, language:, no_config_ui:)
+        def create(script_name:, extension_point_type:, language:)
           validate_metadata!(extension_point_type, language)
 
-          config_ui_file = nil
-          optional_identifiers = {}
-          optional_identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME) unless no_config_ui
-
           ShopifyCli::Project.write(
             ctx,
             project_type: :script,
             organization_id: nil,
             extension_point_type: extension_point_type,
             script_name: script_name,
-            language: language,
-            **optional_identifiers
+            language: language
           )
 
           Domain::ScriptProject.new(
@@ -32,23 +27,20 @@ module Script
             env: project.env,
             script_name: script_name,
             extension_point_type: extension_point_type,
-            language: language,
-            config_ui: config_ui_file
+            language: language
           )
         end
 
         def get
           validate_metadata!(extension_point_type, language)
 
-          config_ui = ConfigUiRepository.new(ctx: ctx).get(config_ui_file)
-
           Domain::ScriptProject.new(
             id: project.directory,
             env: project.env,
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            config_ui: config_ui
+            script_json: ScriptJsonRepository.new(ctx: ctx).get
           )
         end
 
@@ -66,7 +58,7 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            config_ui: ConfigUiRepository.new(ctx: ctx).get(config_ui_file),
+            script_json: ScriptJsonRepository.new(ctx: ctx).get,
           )
         end
 
@@ -85,7 +77,22 @@ module Script
             script_name: script_name,
             extension_point_type: extension_point_type,
             language: language,
-            config_ui: ConfigUiRepository.new(ctx: ctx).get(config_ui_file),
+            script_json: ScriptJsonRepository.new(ctx: ctx).get,
+          )
+        end
+
+        def update_or_create_script_json(title:, configuration_ui: false)
+          script_json = ScriptJsonRepository
+            .new(ctx: ctx)
+            .update_or_create(title: title, configuration_ui: configuration_ui)
+
+          Domain::ScriptProject.new(
+            id: ctx.root,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            script_json: script_json,
           )
         end
 
@@ -103,10 +110,6 @@ module Script
           project_config_value!("script_name")
         end
 
-        def config_ui_file
-          project_config_value("config_ui_file")
-        end
-
         def language
           project_config_value("language")&.downcase || default_language
         end
@@ -137,32 +140,40 @@ module Script
           end
         end
 
-        class ConfigUiRepository
+        class ScriptJsonRepository
           include SmartProperties
           property! :ctx, accepts: ShopifyCli::Context
 
-          def get(filename)
-            return nil unless filename
+          def get
+            current_script_json || raise(Domain::Errors::NoScriptJsonFile)
+          end
 
-            path = File.join(ctx.root, filename)
-            raise Domain::Errors::MissingSpecifiedConfigUiDefinitionError, filename unless File.exist?(path)
+          def update_or_create(title:, configuration_ui:)
+            json = current_script_json&.content || {}
+            json["version"] ||= "1"
+            json["title"] = title
+            json["configurationUi"] = !!configuration_ui
 
-            content = File.read(path)
-            raise Domain::Errors::InvalidConfigUiDefinitionError, filename unless valid_config_ui?(content)
+            ctx.write(SCRIPT_JSON_FILENAME, JSON.pretty_generate(json))
 
-            Domain::ConfigUi.new(
-              filename: filename,
-              content: content,
-            )
+            Domain::ScriptJson.new(content: json)
           end
 
           private
 
-          def valid_config_ui?(raw_yaml)
-            require "yaml" # takes 20ms, so deferred as late as possible.
-            YAML.safe_load(raw_yaml)
+          def current_script_json
+            return nil unless ctx.file_exist?(SCRIPT_JSON_FILENAME)
+
+            content = ctx.read(SCRIPT_JSON_FILENAME)
+            raise Domain::Errors::InvalidScriptJsonDefinitionError unless valid_script_json?(content)
+
+            Domain::ScriptJson.new(content: JSON.parse(content))
+          end
+
+          def valid_script_json?(content)
+            JSON.parse(content)
             true
-          rescue Psych::SyntaxError
+          rescue JSON::ParserError
             false
           end
         end

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

@@ -13,26 +13,28 @@ module Script
         def push(
           uuid:,
           extension_point_type:,
-          script_name:,
           script_content:,
           compiled_type:,
           api_key: nil,
           force: false,
           metadata:,
-          config_ui:
+          script_json:
         )
           query_name = "app_script_update_or_create"
           variables = {
             uuid: uuid,
             extensionPointName: extension_point_type.upcase,
-            title: script_name,
-            configUi: config_ui&.content,
+            title: script_json.title,
+            description: script_json.description,
             sourceCode: Base64.encode64(script_content),
             language: compiled_type,
             force: force,
             schemaMajorVersion: metadata.schema_major_version.to_s, # API expects string value
             schemaMinorVersion: metadata.schema_minor_version.to_s, # API expects string value
             useMsgpack: metadata.use_msgpack,
+            scriptJsonVersion: script_json.version,
+            configurationUi: script_json.configuration_ui,
+            configurationDefinition: script_json.configuration&.to_json,
           }
           resp_hash = script_service_request(query_name: query_name, api_key: api_key, variables: variables)
           user_errors = resp_hash["data"]["appScriptUpdateOrCreate"]["userErrors"]
@@ -41,16 +43,20 @@ module Script
 
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, uuid
-          elsif (e = user_errors.any? { |err| err["tag"] == "config_ui_syntax_error" })
-            raise Errors::ConfigUiSyntaxError, config_ui&.filename
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_missing_keys_error" })
-            raise Errors::ConfigUiMissingKeysError.new(config_ui&.filename, e["message"])
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_invalid_input_mode_error" })
-            raise Errors::ConfigUiInvalidInputModeError.new(config_ui&.filename, e["message"])
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_fields_missing_keys_error" })
-            raise Errors::ConfigUiFieldsMissingKeysError.new(config_ui&.filename, e["message"])
-          elsif (e = user_errors.find { |err| err["tag"] == "config_ui_fields_invalid_type_error" })
-            raise Errors::ConfigUiFieldsInvalidTypeError.new(config_ui&.filename, e["message"])
+          elsif (e = user_errors.any? { |err| err["tag"] == "configuration_syntax_error" })
+            raise Errors::ScriptJsonSyntaxError
+          elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_missing_keys_error" })
+            raise Errors::ScriptJsonMissingKeysError, e["message"]
+          elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_invalid_value_error" })
+            raise Errors::ScriptJsonInvalidValueError, e["message"]
+          elsif (e = user_errors.find do |err|
+                   err["tag"] == "configuration_definition_schema_field_missing_keys_error"
+                 end)
+            raise Errors::ScriptJsonFieldsMissingKeysError, e["message"]
+          elsif (e = user_errors.find do |err|
+                   err["tag"] == "configuration_definition_schema_field_invalid_value_error"
+                 end)
+            raise Errors::ScriptJsonFieldsInvalidValueError, e["message"]
           elsif user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
             raise Domain::Errors::MetadataValidationError
           else
@@ -69,19 +75,30 @@ module Script
         class ScriptServiceAPI < ShopifyCli::API
           property(:api_key, accepts: String)
 
+          LOCAL_INSTANCE_URL = "https://script-service.myshopify.io"
+
           def self.query(ctx, query_name, api_key: nil, variables: {})
             api_client(ctx, api_key).query(query_name, variables: variables)
           end
 
           def self.api_client(ctx, api_key)
+            instance_url = spin_instance_url || LOCAL_INSTANCE_URL
             new(
               ctx: ctx,
-              url: "https://script-service.myshopify.io/graphql",
+              url: "#{instance_url}/graphql",
               token: "",
               api_key: api_key
             )
           end
 
+          def self.spin_instance_url
+            workspace = ENV["SPIN_WORKSPACE"]
+            namespace = ENV["SPIN_NAMESPACE"]
+            return if workspace.nil? || namespace.nil?
+
+            "https://script-service.#{workspace}.#{namespace}.us.spin.dev"
+          end
+
           def auth_headers(*)
             tokens = { "APP_KEY" => api_key }.compact.to_json
             { "X-Shopify-Authenticated-Tokens" => tokens }
@@ -98,7 +115,7 @@ module Script
         private_constant(:PartnersProxyAPI)
 
         def script_service_request(query_name:, variables: nil, **options)
-          resp = if ENV["BYPASS_PARTNERS_PROXY"]
+          resp = if bypass_partners_proxy
             ScriptServiceAPI.query(ctx, query_name, variables: variables, **options)
           else
             proxy_through_partners(query_name: query_name, variables: variables, **options)
@@ -107,6 +124,10 @@ module Script
           resp
         end
 
+        def bypass_partners_proxy
+          !ENV["BYPASS_PARTNERS_PROXY"].nil?
+        end
+
         def proxy_through_partners(query_name:, variables: nil, **options)
           options[:variables] = variables.to_json if variables
           resp = PartnersProxyAPI.query(ctx, query_name, **options)