shopify-cli 1.7.0 → 1.10.0

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

@@ -11,11 +11,11 @@ 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:,
@@ -23,10 +23,10 @@ module Script
         )
           query_name = "app_script_update_or_create"
           variables = {
+            uuid: uuid,
             extensionPointName: extension_point_type.upcase,
             title: script_name,
-            description: description,
-            configUi: config_ui,
+            configUi: config_ui&.content,
             sourceCode: Base64.encode64(script_content),
             language: compiled_type,
             force: force,
@@ -37,92 +37,53 @@ 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" }
             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)
+            raise Errors::GraphqlError, user_errors
           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)
-          end
+        def get_app_scripts(api_key:, extension_point_type:)
+          query_name = "get_app_scripts"
+          variables = { appKey: api_key, extensionPointName: extension_point_type.upcase }
+          script_service_request(query_name: query_name, api_key: api_key, variables: variables)["data"]["appScripts"]
         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
+              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
@@ -165,7 +126,7 @@ module Script
           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
 

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

@@ -57,14 +57,30 @@ module Script
           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.",
 
@@ -83,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.",
 
@@ -105,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." \
@@ -134,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:--no-config-ui}} Specify this option if you don’t want Scripts to render an interface in the Shopify admin.
           HELP
 
           error: {
@@ -162,40 +167,6 @@ module Script
           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",
@@ -208,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",
           },
         },
 
@@ -222,6 +192,13 @@ module Script
           disabled: "Disabled",
           enabling: "Enabling",
           enabled: "Enabled",
+          ensure_env: {
+            organization_select: "Which partner organization do you want to use?",
+            app_select: "Which app do you want to push this script to?",
+            ask_connect_to_existing_script: "This app has some scripts. Do you want to replace any of the "\
+              "existing scripts with the current script?",
+            ask_which_script_to_connect_to: "Which script do you want to replace?",
+          },
         },
       },
     }.freeze

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

@@ -0,0 +1,77 @@
+require "shopify_cli"
+
+module Script
+  module Tasks
+    class EnsureEnv < ShopifyCli::Task
+      attr_accessor :ctx
+
+      def call(ctx)
+        self.ctx = ctx
+
+        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?
+
+        org = ask_org
+        app = ask_app(org["apps"])
+        uuid = ask_script_uuid(app, script_project.extension_point_type)
+
+        script_project_repo.create_env(
+          api_key: app["apiKey"],
+          secret: app["apiSecretKeys"].first["secret"],
+          uuid: uuid
+        )
+      end
+
+      private
+
+      def ask_org
+        if ShopifyCli::Shopifolk.check && wants_to_run_against_shopify_org?
+          ShopifyCli::Shopifolk.act_as_shopify_organization
+        end
+
+        orgs = ShopifyCli::PartnersAPI::Organizations.fetch_with_app(ctx)
+        if orgs.count == 1
+          orgs.first
+        elsif orgs.count > 0
+          CLI::UI::Prompt.ask(ctx.message("script.application.ensure_env.organization_select")) do |handler|
+            orgs.each do |org|
+              handler.option("#{org["businessName"]} (#{org["id"]})") { org }
+            end
+          end
+        else
+          raise Errors::NoExistingOrganizationsError
+        end
+      end
+
+      def ask_app(apps)
+        if apps.count == 1
+          apps.first
+        elsif apps.count > 0
+          CLI::UI::Prompt.ask(ctx.message("script.application.ensure_env.app_select")) do |handler|
+            apps.each do |app|
+              handler.option(app["title"]) { app }
+            end
+          end
+        else
+          raise Errors::NoExistingAppsError
+        end
+      end
+
+      def ask_script_uuid(app, extension_point_type)
+        script_service = Layers::Infrastructure::ScriptService.new(ctx: ctx)
+        scripts = script_service.get_app_scripts(api_key: app["apiKey"], extension_point_type: extension_point_type)
+
+        return nil unless scripts.count > 0 &&
+          CLI::UI::Prompt.confirm(ctx.message("script.application.ensure_env.ask_connect_to_existing_script"))
+
+        CLI::UI::Prompt.ask(ctx.message("script.application.ensure_env.ask_which_script_to_connect_to")) do |handler|
+          scripts.each do |script|
+            handler.option("#{script["title"]} (#{script["uuid"]})") { script["uuid"] }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -39,7 +39,7 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.oauth_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.oauth_help"),
           }
-        when Errors::InvalidContextError
+        when Layers::Infrastructure::Errors::InvalidContextError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_context_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.invalid_context_help"),
@@ -53,7 +53,7 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_config", e.config_file),
           }
-        when Errors::InvalidLanguageError
+        when Layers::Infrastructure::Errors::InvalidLanguageError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_language_cause", e.language),
             help_suggestion: ShopifyCli::Context.message(
@@ -61,18 +61,6 @@ module Script
               Script::Layers::Application::ExtensionPoints.languages(type: e.extension_point_type).join(", ")
             ),
           }
-        when Errors::InvalidConfigUiDefinitionError
-          {
-            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"),
-          }
-        when Errors::MissingSpecifiedConfigUiDefinitionError
-          {
-            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"),
-          }
         when Errors::InvalidScriptNameError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_script_name_cause"),
@@ -96,12 +84,12 @@ module Script
               organization_id: e.organization_id
             ),
           }
-        when Errors::ScriptProjectAlreadyExistsError
+        when Layers::Infrastructure::Errors::ScriptProjectAlreadyExistsError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.project_exists_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.project_exists_help"),
           }
-        when Errors::DeprecatedEPError
+        when Layers::Infrastructure::Errors::DeprecatedEPError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.deprecated_ep", e.ep),
             help_suggestion: ShopifyCli::Context.message("script.error.deprecated_ep_cause"),
@@ -137,20 +125,71 @@ 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::Infrastructure::Errors::AppNotInstalledError
+        when Layers::Domain::Errors::InvalidConfigUiDefinitionError
           {
-            cause_of_error: ShopifyCli::Context.message("script.error.app_not_installed_cause"),
+            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"),
           }
-        when Layers::Infrastructure::Errors::AppScriptNotPushedError,
-          Layers::Infrastructure::Errors::AppScriptUndefinedError
+        when Layers::Domain::Errors::MissingSpecifiedConfigUiDefinitionError
+          {
+            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"),
+          }
+        when Layers::Infrastructure::Errors::AppNotInstalledError
           {
-            cause_of_error: ShopifyCli::Context.message("script.error.app_script_not_pushed_help"),
+            cause_of_error: ShopifyCli::Context.message("script.error.app_not_installed_cause"),
           }
         when Layers::Infrastructure::Errors::BuildError
           {
             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
+          {
+            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"),
+          }
+        when Layers::Infrastructure::Errors::ConfigUiMissingKeysError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.config_ui_missing_keys_error_cause",
+              filename: e.filename,
+              missing_keys: e.missing_keys
+            ),
+            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_missing_keys_error_help"),
+          }
+        when Layers::Infrastructure::Errors::ConfigUiInvalidInputModeError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.config_ui_invalid_input_mode_error_cause",
+              filename: e.filename,
+              valid_input_modes: e.valid_input_modes
+            ),
+            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_invalid_input_mode_error_help"),
+          }
+        when Layers::Infrastructure::Errors::ConfigUiFieldsMissingKeysError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.config_ui_fields_missing_keys_error_cause",
+              filename: e.filename,
+              missing_keys: e.missing_keys
+            ),
+            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_missing_keys_error_help"),
+          }
+        when Layers::Infrastructure::Errors::ConfigUiFieldsInvalidTypeError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.config_ui_fields_invalid_type_error_cause",
+              filename: e.filename,
+              valid_types: e.valid_types
+            ),
+            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_invalid_type_error_help"),
+          }
         when Layers::Infrastructure::Errors::DependencyInstallError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.dependency_install_cause"),
@@ -167,7 +206,9 @@ module Script
           }
         when Layers::Infrastructure::Errors::GraphqlError
           {
-            cause_of_error: ShopifyCli::Context.message("script.error.graphql_error_cause", e.errors.join(", ")),
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.graphql_error_cause", JSON.pretty_generate(e.errors)
+            ),
             help_suggestion: ShopifyCli::Context.message("script.error.graphql_error_help"),
           }
         when Layers::Infrastructure::Errors::ScriptRepushError
@@ -175,36 +216,11 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.script_repush_cause", e.api_key),
             help_suggestion: ShopifyCli::Context.message("script.error.script_repush_help"),
           }
-        when Layers::Infrastructure::Errors::ScriptServiceUserError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.user_error_cause"),
-            help_suggestion: ShopifyCli::Context.message("script.error.user_error_help"),
-          }
         when Layers::Infrastructure::Errors::ShopAuthenticationError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.shop_auth_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.shop_auth_help"),
           }
-        when Layers::Infrastructure::Errors::ShopScriptConflictError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.shop_script_conflict_cause"),
-            help_suggestion: ShopifyCli::Context.message("script.error.shop_script_conflict_help"),
-          }
-        when Layers::Infrastructure::Errors::ShopScriptUndefinedError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.shop_script_undefined_cause"),
-          }
-        when Layers::Infrastructure::Errors::PackagesOutdatedError
-          {
-            cause_of_error: ShopifyCli::Context.message(
-              "script.error.packages_outdated_cause",
-              e.outdated_packages.join(", ")
-            ),
-            help_suggestion: ShopifyCli::Context.message(
-              "script.error.packages_outdated_help",
-              e.outdated_packages.collect { |package| "#{package}@latest" }.join(" ")
-            ),
-          }
         when Layers::Infrastructure::Errors::BuildScriptNotFoundError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.build_script_not_found"),