shopify-cli 1.6.0 → 1.9.1

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

@@ -10,8 +10,8 @@ module Script
         property! :script_name, accepts: String
         property! :path_to_project, accepts: String
 
-        ORIGIN_BRANCH = 'main'
-        SAMPLE_PATH = 'default'
+        ORIGIN_BRANCH = "main"
+        SAMPLE_PATH = "default"
 
         def setup_dependencies
           git_init
@@ -60,8 +60,8 @@ module Script
         end
 
         def set_script_name
-          config_file = 'Cargo.toml'
-          upstream_name = "#{extension_point.type.gsub('_', '-')}-default"
+          config_file = "Cargo.toml"
+          upstream_name = "#{extension_point.type.gsub("_", "-")}-default"
           contents = File.read(config_file)
           new_contents = contents.sub(upstream_name, script_name)
           File.write(config_file, new_contents)

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

@@ -31,7 +31,7 @@ module Script
 
         def metadata
           unless @ctx.file_exist?(METADATA_FILE)
-            msg = @ctx.message('script.error.metadata_not_found_cause', METADATA_FILE)
+            msg = @ctx.message("script.error.metadata_not_found_cause", METADATA_FILE)
             raise Domain::Errors::MetadataNotFoundError, msg
           end
 
@@ -51,7 +51,7 @@ module Script
           binary_path = "target/#{BUILD_TARGET}/release/#{binary_name}"
           raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(binary_path)
 
-          File.read(binary_path)
+          ctx.binread(binary_path)
         end
       end
     end

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class ScriptProjectRepository
+        include SmartProperties
+        property! :ctx, accepts: ShopifyCli::Context
+
+        DEFAULT_CONFIG_UI_FILENAME = "config-ui.yml"
+        MUTABLE_ENV_VALUES = %i(uuid)
+
+        def create(script_name:, extension_point_type:, language:, no_config_ui:)
+          validate_metadata!(extension_point_type, language)
+
+          optional_identifiers = {}
+          config_ui_file = nil
+
+          unless no_config_ui
+            optional_identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME)
+            config_ui_file = ConfigUiRepository
+              .new(ctx: ctx)
+              .create(DEFAULT_CONFIG_UI_FILENAME, default_config_ui_content(script_name))
+          end
+
+          ShopifyCli::Project.write(
+            ctx,
+            project_type: :script,
+            organization_id: nil,
+            extension_point_type: extension_point_type,
+            script_name: script_name,
+            language: language,
+            **optional_identifiers
+          )
+
+          Domain::ScriptProject.new(
+            id: ctx.root,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            config_ui: config_ui_file
+          )
+        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
+          )
+        end
+
+        def update_env(**args)
+          capture_io do
+            args.slice(*MUTABLE_ENV_VALUES).each do |key, value|
+              project.env.extra[key.to_s.upcase] = value
+              project.env.update(ctx, :extra, project.env.extra)
+            end
+          end
+
+          Domain::ScriptProject.new(
+            id: ctx.root,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            config_ui: ConfigUiRepository.new(ctx: ctx).get(config_ui_file),
+          )
+        end
+
+        private
+
+        def capture_io(&block)
+          CLI::UI::StdoutRouter::Capture.new(&block).run
+        end
+
+        def extension_point_type
+          project_config_value!("extension_point_type")
+        end
+
+        def script_name
+          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
+
+        def project_config_value(key)
+          return nil unless project.config.key?(key)
+          project.config[key]
+        end
+
+        def project_config_value!(key)
+          raise Errors::InvalidContextError, key unless project.config.key?(key)
+          project.config[key]
+        end
+
+        def project
+          ShopifyCli::Project.current
+        end
+
+        def default_config_ui_content(title)
+          require "yaml" # takes 20ms, so deferred as late as possible.
+          YAML.dump({
+            "version" => 1,
+            "inputMode" => "single",
+            "title" => title,
+            "description" => "",
+            "fields" => [],
+          })
+        end
+
+        def default_language
+          Domain::ExtensionPoint::ExtensionPointAssemblyScriptSDK.language
+        end
+
+        def validate_metadata!(extension_point_type, language)
+          if Application::ExtensionPoints.deprecated_types.include?(extension_point_type)
+            raise Errors::DeprecatedEPError, extension_point_type
+          elsif !Application::ExtensionPoints.supported_language?(type: extension_point_type, language: language)
+            raise Errors::InvalidLanguageError.new(language, extension_point_type)
+          end
+        end
+
+        class ConfigUiRepository
+          include SmartProperties
+          property! :ctx, accepts: ShopifyCli::Context
+
+          def create(filename, content)
+            File.write(filename, content)
+
+            Domain::ConfigUi.new(
+              filename: filename,
+              content: content,
+            )
+          end
+
+          def get(filename)
+            return nil unless filename
+
+            path = File.join(ctx.root, filename)
+            raise Domain::Errors::MissingSpecifiedConfigUiDefinitionError, filename unless File.exist?(path)
+
+            content = File.read(path)
+            raise Domain::Errors::InvalidConfigUiDefinitionError, filename unless valid_config_ui?(content)
+
+            Domain::ConfigUi.new(
+              filename: filename,
+              content: content,
+            )
+          end
+
+          private
+
+          def valid_config_ui?(raw_yaml)
+            require "yaml" # takes 20ms, so deferred as late as possible.
+            YAML.safe_load(raw_yaml)
+            true
+          rescue Psych::SyntaxError
+            false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,20 +11,22 @@ module Script
         property! :ctx, accepts: ShopifyCli::Context
 
         def push(
+          uuid:,
           extension_point_type:,
           script_name:,
           script_content:,
           compiled_type:,
-          description: nil,
           api_key: nil,
           force: false,
-          metadata:
+          metadata:,
+          config_ui:
         )
           query_name = "app_script_update_or_create"
           variables = {
+            uuid: uuid,
             extensionPointName: extension_point_type.upcase,
             title: script_name,
-            description: description,
+            configUi: config_ui&.content,
             sourceCode: Base64.encode64(script_content),
             language: compiled_type,
             force: force,
@@ -35,92 +37,47 @@ module Script
           resp_hash = script_service_request(query_name: query_name, api_key: api_key, variables: variables)
           user_errors = resp_hash["data"]["appScriptUpdateOrCreate"]["userErrors"]
 
-          return resp_hash if user_errors.empty?
+          return resp_hash["data"]["appScriptUpdateOrCreate"]["appScript"]["uuid"] if user_errors.empty?
 
-          if user_errors.any? { |e| e['tag'] == 'already_exists_error' }
+          if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, api_key
+          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 user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
+            raise Domain::Errors::MetadataValidationError
           else
-            raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
-          end
-        end
-
-        def enable(api_key:, shop_domain:, configuration:, extension_point_type:, title:)
-          query_name = "shop_script_update_or_create"
-          variables = {
-            extensionPointName: extension_point_type.upcase,
-            configuration: configuration,
-            title: title,
-          }
-
-          resp_hash = script_service_request(
-            query_name: query_name,
-            api_key: api_key,
-            shop_domain: format_shop_domain(shop_domain),
-            variables: variables,
-          )
-          user_errors = resp_hash["data"]["shopScriptUpdateOrCreate"]["userErrors"]
-
-          return resp_hash if user_errors.empty?
-
-          if user_errors.any? { |e| e['tag'] == 'app_script_not_found' }
-            raise Errors::AppScriptUndefinedError, api_key
-          elsif user_errors.any? { |e| e['tag'] == 'shop_script_conflict' }
-            raise Errors::ShopScriptConflictError
-          elsif user_errors.any? { |e| e['tag'] == 'app_script_not_pushed' }
-            raise Errors::AppScriptNotPushedError
-          else
-            raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
-          end
-        end
-
-        def disable(api_key:, shop_domain:, extension_point_type:)
-          query_name = "shop_script_delete"
-          variables = {
-            extensionPointName: extension_point_type.upcase,
-          }
-
-          resp_hash = script_service_request(
-            query_name: query_name,
-            api_key: api_key,
-            shop_domain: format_shop_domain(shop_domain),
-            variables: variables,
-          )
-          user_errors = resp_hash["data"]["shopScriptDelete"]["userErrors"]
-          return resp_hash if user_errors.empty?
-
-          if user_errors.any? { |e| e['tag'] == 'shop_script_not_found' }
-            raise Errors::ShopScriptUndefinedError, api_key
-          else
-            raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
+            raise Errors::GraphqlError, user_errors
           end
         end
 
         private
 
-        def format_shop_domain(shop_domain)
-          shop_domain.delete_suffix("/")
-        end
-
         class ScriptServiceAPI < ShopifyCli::API
           property(:api_key, accepts: String)
-          property(:shop_id, accepts: Integer)
 
-          def self.query(ctx, query_name, api_key: nil, shop_domain: nil, variables: {})
-            api_client(ctx, api_key, shop_domain).query(query_name, variables: variables)
+          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, shop_domain)
+          def self.api_client(ctx, api_key)
             new(
               ctx: ctx,
-              url: 'https://script-service.myshopify.io/graphql',
-              token: '',
-              api_key: api_key,
-              shop_id: shop_domain&.to_i
+              url: "https://script-service.myshopify.io/graphql",
+              token: "",
+              api_key: api_key
             )
           end
 
           def auth_headers(*)
-            tokens = { "APP_KEY" => api_key, "SHOP_ID" => shop_id }.compact.to_json
+            tokens = { "APP_KEY" => api_key }.compact.to_json
             { "X-Shopify-Authenticated-Tokens" => tokens }
           end
         end
@@ -148,28 +105,28 @@ module Script
           options[:variables] = variables.to_json if variables
           resp = PartnersProxyAPI.query(ctx, query_name, **options)
           raise_if_graphql_failed(resp)
-          JSON.parse(resp['data']['scriptServiceProxy'])
+          JSON.parse(resp["data"]["scriptServiceProxy"])
         end
 
         def raise_if_graphql_failed(response)
           raise Errors::EmptyResponseError if response.nil?
 
-          return unless response.key?('errors')
-          case error_code(response['errors'])
-          when 'forbidden'
+          return unless response.key?("errors")
+          case error_code(response["errors"])
+          when "forbidden"
             raise Errors::ForbiddenError
-          when 'forbidden_on_shop'
+          when "forbidden_on_shop"
             raise Errors::ShopAuthenticationError
-          when 'app_not_installed_on_shop'
+          when "app_not_installed_on_shop"
             raise Errors::AppNotInstalledError
           else
-            raise Errors::GraphqlError, response['errors'].map { |e| e['message'] }
+            raise Errors::GraphqlError, response["errors"]
           end
         end
 
         def error_code(errors)
           errors.map do |e|
-            code = e.dig('extensions', 'code')
+            code = e.dig("extensions", "code")
             return code if code
           end
         end

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

@@ -21,20 +21,20 @@ module Script
           invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
           invalid_context_help: "See https://help.shopify.com",
 
-          invalid_config_props_cause: "{{command:--config_props}} is formatted incorrectly.",
+          invalid_config_props_cause: "{{command:--config-props}} is formatted incorrectly.",
           invalid_config_props_help: "Try again using this format: "\
-                                     "{{cyan:--config_props='name1:value1, name2:value2'}}",
+                                     "{{cyan:--config-props='name1:value1, name2:value2'}}",
 
           invalid_script_name_cause: "Invalid script name.",
           invalid_script_name_help: "Replace or remove unsupported characters. Valid characters "\
                                     "are numbers, letters, hyphens, or underscores.",
 
           no_existing_apps_cause: "You don't have any apps.",
-          no_existing_apps_help: "Please create an app with {{command:shopify create}} or "\
+          no_existing_apps_help: "Create an app with {{command:shopify create}} or "\
                                  "visit https://partners.shopify.com/.",
 
           no_existing_orgs_cause: "You don't have any partner organizations.",
-          no_existing_orgs_help: "Please visit https://partners.shopify.com/ to create a partners account.",
+          no_existing_orgs_help: "Visit https://partners.shopify.com/ to create a partners account.",
 
           no_existing_stores_cause: "You don't have any stores.",
           no_existing_stores_help: "Visit https://partners.shopify.com/%{organization_id}/stores/ to create one.",
@@ -51,14 +51,36 @@ module Script
           invalid_config: "Can't change the configuration values because %1$s is missing or "\
                           "it is not formatted properly.",
 
+          invalid_config_ui_definition_cause: "The UI configuration file %s contains invalid YAML.",
+          invalid_config_ui_definition_help: "Fix the errors and try again.",
+
+          missing_config_ui_definition_cause: "You are missing the UI configuration file %s.",
+          missing_config_ui_definition_help: "Create this file and try again.",
+
+          config_ui_syntax_error_cause: "The UI configuration file %{filename} is not formatted properly.",
+          config_ui_syntax_error_help: "Fix the errors and try again.",
+
+          config_ui_missing_keys_error_cause: "The UI configuration file %{filename} is missing required keys: "\
+                                              "%{missing_keys}.",
+          config_ui_missing_keys_error_help: "Add the keys and try again.",
+
+          config_ui_invalid_input_mode_error_cause: "The UI configuration file %{filename} only accept "\
+                                              "one of the following input mode(s): %{valid_input_modes}.",
+          config_ui_invalid_input_mode_error_help: "Change the input modes and try again.",
+
+          config_ui_fields_missing_keys_error_cause: "A field entry in the UI configuration file %{filename} is "\
+                                                     "missing required keys: %{missing_keys}.",
+          config_ui_fields_missing_keys_error_help: "Add the keys and try again.",
+
+          config_ui_fields_invalid_type_error_cause: "The UI configuration file %{filename} fields only accept "\
+                                                     "one of the following type(s): %{valid_types}.",
+          config_ui_fields_invalid_type_error_help: "Change the types and try again.",
+
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 
           service_failure_cause: "Internal service error.",
           service_failure_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
 
-          user_error_cause: "Invalid script extension metadata.",
-          user_error_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
-
           metadata_validation_cause: "Invalid script extension metadata.",
           metadata_validation_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
 
@@ -77,8 +99,6 @@ module Script
                                      "'--metadata build/metadata.json' argument",
           app_not_installed_cause: "App not installed on store.",
 
-          app_script_not_pushed_help: "Script isn't on the app. Run {{command:shopify push}}, and then try again.",
-
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
 
@@ -99,22 +119,13 @@ module Script
           shop_auth_cause: "Unable to authenticate with the store.",
           shop_auth_help: "Try again.",
 
-          shop_script_conflict_cause: "Another app in this store has already enabled a script "\
-                                      "on this extension point.",
-          shop_script_conflict_help: "Disable that script or uninstall that app and try again.",
-
-          shop_script_undefined_cause: "Script is already turned off in store.",
-
-          packages_outdated_cause: "These npm packages are out of date: %s.",
-          packages_outdated_help: "To update them, run {{cyan:npm install --save-dev %s}}.",
-
           invalid_build_script: "The root package.json contains an invalid build command that " \
                                 "is needed to compile your script to WebAssembly.",
           build_script_not_found: "The root package.json is missing the build command that " \
                                   "is needed to compile your script to WebAssembly.",
           # rubocop:disable Layout/LineLength
           build_script_suggestion: "\n\nFor example, your package.json needs the following command:" \
-            "\nbuild: npx shopify-scripts-toolchain-as build --src src/script.ts --binary build/<script_name>.wasm --metadata build/metadata.json -- --lib node_modules --optimize --use Date=",
+            "\nbuild: npx shopify-scripts-toolchain-as build --src src/shopify_main.ts --binary build/<script_name>.wasm --metadata build/metadata.json -- --lib node_modules --optimize --use Date=",
 
           web_assembly_binary_not_found: "WebAssembly binary not found.",
           web_assembly_binary_not_found_suggestion: "No WebAssembly binary found." \
@@ -128,8 +139,8 @@ module Script
             Usage: {{command:%1$s create script}}
             Options:
               {{command:--name=NAME}} Script project name. Use any string.
-              {{command:--description=DESCRIPTION}} Description of the project. Use any string.
-              {{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
+              {{command:--extension-point=TYPE}} Extension point name. Allowed values: %2$s.
+              {{command:--no-config-ui}} Specify this option if you don’t want Scripts to render an interface in the Shopify admin.
           HELP
 
           error: {
@@ -150,46 +161,12 @@ module Script
           HELP
 
           error: {
-            operation_failed: "Couldn't push script to app.",
+            operation_failed: "Couldn't push script to app (API key: %{api_key}).",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
         },
 
-        disable: {
-          help: <<~HELP,
-          Turn off script in store.
-            Usage: {{command:%s disable}}
-          HELP
-
-          error: {
-            operation_failed: "Can't disable script.",
-          },
-
-          script_disabled: "{{v}} Script disabled. Script is turned off in store.",
-        },
-
-        enable: {
-          help: <<~HELP,
-          Turn on script in store.
-            Usage: {{command:%s enable}}
-            Options:
-              {{command:--config_props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config_props will override those set in the file.
-              {{command:--config_file=<path/to/YAMLFilename>}} Optional. Define the configuration of your script using a YAML formatted file. --config_props values override properties in this file.
-          HELP
-
-          info: "{{*}} A script always remains enabled until you disable it - even after pushing "\
-                "script changes with the same extension point to an app. To disable a script, use "\
-                "the 'disable' command.",
-
-          error: {
-            operation_failed: "Can't enable script.",
-          },
-
-          script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
-                          "is turned on in store {{green:%{shop_domain}}}",
-        },
-
         project_deps: {
           none_required: "{{v}} None required",
           checking_with_npm: "Checking dependencies with npm",
@@ -202,7 +179,6 @@ module Script
             select_extension_point: "Which extension point do you want to use?",
             select_language: "Which language do you want to use?",
             script_name: "Script Name",
-            description: "Description",
           },
         },