shopify-cli 1.13.1 → 2.1.0

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)

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

@@ -4,22 +4,28 @@ module Script
   module Messages
     MESSAGES = {
       script: {
+        help: <<~HELP,
+          Suite of commands for developing script applications. See {{command:%1$s script <command> --help}} for usage of each command.
+            Usage: {{command:%1$s script [ %2$s ]}}
+        HELP
+
         error: {
-          deprecated_ep: "This project uses an extension point %s which has been deprecated. "\
-                         "This Script will no longer function in production.",
-          deprecated_ep_cause: "Try using a different extension point.",
+          deprecated_ep: "This project uses a Script API (%s) that has been deprecated. "\
+                         "This Script won't work in production.",
+          deprecated_ep_cause: "Try using a different Script API.",
           generic: "{{red:{{x}} Error}}",
           eacces_cause: "You don't have permission to write to this directory.",
-          eacces_help: "Change your directory permissions and try again.",
+          eacces_help: "Try again and choose a different directory.",
 
-          enospc_cause: "You don't have enough disk space to perform this action.",
+          enospc_cause: "You don't have enough disk space to do this action.",
           enospc_help: "Free up some space and try again.",
 
           oauth_cause: "Something went wrong while authenticating your account with the Partner Dashboard.",
           oauth_help: "Try again.",
 
-          invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
-          invalid_context_help: "See https://help.shopify.com",
+          invalid_context_cause: "Your .shopify-cli.yml file is not correct. Values are missing for "\
+                                 "extension_point_type or script_name.",
+          invalid_context_help: "Add these values and try again.",
 
           invalid_config_props_cause: "{{command:--config-props}} is formatted incorrectly.",
           invalid_config_props_help: "Try again using this format: "\
@@ -29,68 +35,72 @@ module Script
           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: "Create an app with {{command:shopify create}} or "\
-                                 "visit https://partners.shopify.com/.",
+          no_existing_apps_cause: "You don't have any apps in your Partner Dashboard.",
+          no_existing_apps_help: "Create an app with {{command:shopify [node|rails] create}}" \
+                                 " or visit https://partners.shopify.com/.",
 
           no_existing_orgs_cause: "You don't have any partner organizations.",
           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_cause: "You don't have any stores in your Partner Dashboard.",
           no_existing_stores_help: "Visit https://partners.shopify.com/%{organization_id}/stores/ to create one.",
 
-          project_exists_cause: "Directory with the same name as the script already exists.",
-          project_exists_help: "Use different script name and try again.",
+          project_exists_cause: "A directory with this same name already exists.",
+          project_exists_help: "Try again and enter a different name for the script.",
 
-          invalid_extension_cause: "Invalid extension point %s.",
+          invalid_extension_cause: "Invalid Script API %s.",
           invalid_extension_help: "Allowed values: %s.",
 
           invalid_language_cause: "Invalid language %s.",
           invalid_language_help: "Allowed values: %s.",
 
           invalid_config: "Can't change the configuration values because %1$s is missing or "\
-                          "it is not formatted properly.",
+                          "it isn't formatted properly.",
+
+          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_config_ui_definition_cause: "The UI configuration file %s contains invalid YAML.",
-          invalid_config_ui_definition_help: "Fix the errors and try again.",
+          invalid_script_json_definition_cause: "The script.json file contains invalid JSON.",
+          invalid_script_json_definition_help: "Fix the errors and try again.",
 
-          missing_config_ui_definition_cause: "You are missing the UI configuration file %s.",
-          missing_config_ui_definition_help: "Create this file 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.",
 
-          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.",
+          configuration_syntax_error_cause: "The script.json is not formatted properly.",
+          configuration_syntax_error_help: "Fix the errors and try again.",
 
-          config_ui_missing_keys_error_cause: "The UI configuration file %{filename} is missing required keys: "\
+          configuration_missing_keys_error_cause: "The script.json file is missing required keys: "\
                                               "%{missing_keys}.",
-          config_ui_missing_keys_error_help: "Add the keys and try again.",
+          configuration_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.",
+          configuration_invalid_value_error_cause: "The script.json configuration only accepts "\
+                                                   "one of the following types(s): %{valid_input_modes}.",
+          configuration_invalid_value_error_help: "Change the type 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.",
+          configuration_schema_field_missing_keys_error_cause: "A configuration entry in the script.json file "\
+                                                     "is missing required keys: %{missing_keys}.",
+          configuration_definition_schema_field_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.",
+          configuration_schema_field_invalid_value_error_cause: "The configuration entries in the "\
+                                                     "script.json file only accept one of the following "\
+                                                     "type(s): %{valid_types}.",
+          configuration_schema_field_invalid_value_error_help: "Change the types and try again.",
 
-          script_not_found_cause: "Couldn't find script %s for extension point %s",
+          script_not_found_cause: "Couldn't find a script %s for the Script API %s",
 
           system_call_failure_cause: "An error was returned while running {{command:%{cmd}}}.",
           system_call_failure_help: "Review the following error and try again.\n{{red:%{out}}}",
 
-          metadata_validation_cause: "Invalid script extension metadata.",
+          metadata_validation_cause: "Invalid Script API metadata.",
           metadata_validation_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
 
-          metadata_schema_versions_missing: "Invalid script metadata:" \
+          metadata_schema_versions_missing: "Invalid Script metadata:" \
                                             " 'schemaVersions' field is missing",
-          metadata_schema_versions_single_key: "Invalid script extension metadata:" \
-                                               " 'schemaVersions' can have only one extension point name.",
-          metadata_schema_versions_missing_major: "Invalid script extension metadata:" \
+          metadata_schema_versions_single_key: "Invalid Script API metadata:" \
+                                               " 'schemaVersions' can have only one Script API name.",
+          metadata_schema_versions_missing_major: "Invalid Script API metadata:" \
                                                   " 'schemaVersions' is missing the 'major' field",
-          metadata_schema_versions_missing_minor: "Invalid script extension metadata:" \
+          metadata_schema_versions_missing_minor: "Invalid Script API metadata:" \
                                                   " 'schemaVersions' is missing the 'minor' field",
 
           metadata_not_found_cause: "Script version file (%s) cannot be found.",
@@ -102,7 +112,7 @@ module Script
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
 
-          dependency_install_cause: "Something went wrong while installing the dependencies that are needed.",
+          dependency_install_cause: "Something went wrong while installing the needed dependencies.",
           dependency_install_help: "Correct the errors and try again.",
 
           failed_api_request_cause: "Something went wrong while communicating with Shopify.",
@@ -113,7 +123,7 @@ module Script
           graphql_error_cause: "An error was returned: %s.",
           graphql_error_help: "\nReview the error and try again.",
 
-          script_repush_cause: "A script with this UUID already exists (UUID: %s).",
+          script_repush_cause: "A version of this script already exists on the app.",
           script_repush_help: "Use {{cyan:--force}} to replace the existing script.",
 
           shop_auth_cause: "Unable to authenticate with the store.",
@@ -135,12 +145,12 @@ module Script
 
         create: {
           help: <<~HELP,
-          {{command:%1$s create script}}: Creates a script project.
-            Usage: {{command:%1$s create script}}
-            Options:
-              {{command:--name=NAME}} Script project name. Use any string.
-              {{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.
+            {{command:%1$s script create}}: Creates a script project.
+              Usage: {{command:%1$s script create}}
+              Options:
+                {{command:--name=NAME}} Script project name. Use any string.
+                {{command:--extension-point=TYPE}} Script API name. Allowed values: %2$s.
+                {{command:--no-config-ui}} Specify this option when you don’t want your script to render an interface in Shopify admin.
           HELP
 
           error: {
@@ -154,10 +164,10 @@ module Script
 
         push: {
           help: <<~HELP,
-          Build the script and put it into production. If you've already pushed a script with the same extension point, use --force to replace the current script with the newest one.
-            Usage: {{command:%s push}}
-            Options:
-              {{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
+            Build the script, upload it to Shopify, and register it to an app.  If you've already pushed the script to this app, then use --force to replace the existing version on the app.
+              Usage: {{command:%s script push}}
+              Options:
+                {{command:[--force]}} Replaces the existing script on the app with this version.
           HELP
 
           error: {
@@ -177,9 +187,9 @@ module Script
 
         forms: {
           create: {
-            select_extension_point: "Which extension point do you want to use?",
+            select_extension_point: "Which Script API do you want to use?",
             select_language: "Which language do you want to use?",
-            script_name: "Script Name",
+            script_name: "Script name",
           },
         },
 
@@ -199,7 +209,7 @@ module Script
             app: "Script will be pushed to app {{green:%s}}.",
             app_select: "Which app do you want to push this script to?",
             ask_connect_to_existing_script: "The selected app has some scripts. Do you want to replace any of the "\
-              "existing scripts with the current script?",
+              "existing scripts on the app with this script?",
             ask_which_script_to_connect_to: "Which script do you want to replace?",
           },
         },

data/lib/project_types/script/tasks/ensure_env.rb

@@ -11,7 +11,7 @@ module Script
         script_project_repo = Layers::Infrastructure::ScriptProjectRepository.new(ctx: ctx)
         script_project = script_project_repo.get
 
-        return if script_project.api_key && script_project.api_secret && script_project.uuid_defined?
+        return false if script_project.api_key && script_project.api_secret && script_project.uuid_defined?
 
         org = ask_org
         app = ask_app(org["apps"])
@@ -22,6 +22,8 @@ module Script
           secret: app["apiSecretKeys"].first["secret"],
           uuid: uuid
         )
+
+        true
       end
 
       private

data/lib/project_types/script/ui/error_handler.rb

@@ -34,7 +34,7 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.enospc_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.enospc_help"),
           }
-        when ShopifyCli::OAuth::Error
+        when ShopifyCli::IdentityAuth::Error
           {
             cause_of_error: ShopifyCli::Context.message("script.error.oauth_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.oauth_help"),
@@ -120,17 +120,20 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.metadata_not_found_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.metadata_not_found_help"),
           }
-        when Layers::Domain::Errors::InvalidConfigUiDefinitionError
+        when Layers::Domain::Errors::MissingScriptJsonFieldError
           {
-            cause_of_error: ShopifyCli::Context
-              .message("script.error.invalid_config_ui_definition_cause", e.filename),
-            help_suggestion: ShopifyCli::Context.message("script.error.invalid_config_ui_definition_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.missing_script_json_field_cause", e.field),
+            help_suggestion: ShopifyCli::Context.message("script.error.missing_script_json_field_help"),
           }
-        when Layers::Domain::Errors::MissingSpecifiedConfigUiDefinitionError
+        when Layers::Domain::Errors::InvalidScriptJsonDefinitionError
           {
-            cause_of_error: ShopifyCli::Context
-              .message("script.error.missing_config_ui_definition_cause", e.filename),
-            help_suggestion: ShopifyCli::Context.message("script.error.missing_config_ui_definition_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.invalid_script_json_definition_cause"),
+            help_suggestion: ShopifyCli::Context.message("script.error.invalid_script_json_definition_help"),
+          }
+        when Layers::Domain::Errors::NoScriptJsonFile
+          {
+            cause_of_error: ShopifyCli::Context.message("script.error.no_script_json_file_cause"),
+            help_suggestion: ShopifyCli::Context.message("script.error.no_script_json_file_help"),
           }
         when Layers::Infrastructure::Errors::AppNotInstalledError
           {
@@ -141,49 +144,46 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.build_error_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.build_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiSyntaxError
+        when Layers::Infrastructure::Errors::ScriptJsonSyntaxError
           {
-            cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_syntax_error_cause",
-              filename: e.message
-            ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_syntax_error_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.configuration_syntax_error_cause"),
+            help_suggestion: ShopifyCli::Context.message("script.error.configuration_syntax_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiMissingKeysError
+        when Layers::Infrastructure::Errors::ScriptJsonMissingKeysError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_missing_keys_error_cause",
-              filename: e.filename,
+              "script.error.configuration_missing_keys_error_cause",
               missing_keys: e.missing_keys
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_missing_keys_error_help"),
+            help_suggestion: ShopifyCli::Context.message("script.error.configuration_missing_keys_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiInvalidInputModeError
+        when Layers::Infrastructure::Errors::ScriptJsonInvalidValueError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_invalid_input_mode_error_cause",
-              filename: e.filename,
+              "script.error.configuration_invalid_value_error_cause",
               valid_input_modes: e.valid_input_modes
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_invalid_input_mode_error_help"),
+            help_suggestion: ShopifyCli::Context.message("script.error.configuration_invalid_value_error_help"),
           }
-        when Layers::Infrastructure::Errors::ConfigUiFieldsMissingKeysError
+        when Layers::Infrastructure::Errors::ScriptJsonFieldsMissingKeysError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_fields_missing_keys_error_cause",
-              filename: e.filename,
+              "script.error.configuration_schema_field_missing_keys_error_cause",
               missing_keys: e.missing_keys
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_missing_keys_error_help"),
+            help_suggestion: ShopifyCli::Context.message(
+              "script.error.configuration_definition_schema_field_missing_keys_error_help"
+            ),
           }
-        when Layers::Infrastructure::Errors::ConfigUiFieldsInvalidTypeError
+        when Layers::Infrastructure::Errors::ScriptJsonFieldsInvalidValueError
           {
             cause_of_error: ShopifyCli::Context.message(
-              "script.error.config_ui_fields_invalid_type_error_cause",
-              filename: e.filename,
+              "script.error.configuration_schema_field_invalid_value_error_cause",
               valid_types: e.valid_types
             ),
-            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_invalid_type_error_help"),
+            help_suggestion: ShopifyCli::Context.message(
+              "script.error.configuration_schema_field_invalid_value_error_help"
+            ),
           }
         when Layers::Infrastructure::Errors::DependencyInstallError
           {
@@ -214,7 +214,7 @@ module Script
           }
         when Layers::Infrastructure::Errors::ScriptRepushError
           {
-            cause_of_error: ShopifyCli::Context.message("script.error.script_repush_cause", e.uuid),
+            cause_of_error: ShopifyCli::Context.message("script.error.script_repush_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.script_repush_help"),
           }
         when Layers::Infrastructure::Errors::ShopAuthenticationError