shopify-cli 1.3.1 → 1.7.0

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class RustProjectCreator
+        include SmartProperties
+        property! :ctx, accepts: ShopifyCli::Context
+        property! :extension_point, accepts: Domain::ExtensionPoint
+        property! :script_name, accepts: String
+        property! :path_to_project, accepts: String
+
+        ORIGIN_BRANCH = "main"
+        SAMPLE_PATH = "default"
+
+        def setup_dependencies
+          git_init
+          setup_remote
+          setup_sparse_checkout
+          pull
+          clean
+          set_script_name
+        end
+
+        def bootstrap
+        end
+
+        private
+
+        def git_init
+          out, status = ctx.capture2e("git init")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+        end
+
+        def setup_remote
+          repo = extension_point.sdks.rust.package
+          out, status = ctx.capture2e("git remote add -f origin #{repo}")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+        end
+
+        def setup_sparse_checkout
+          type = extension_point.type
+          out, status = ctx.capture2e("git config core.sparsecheckout true")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+          out, status = ctx.capture2e("echo #{type}/#{SAMPLE_PATH} >> .git/info/sparse-checkout")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+        end
+
+        def pull
+          out, status = ctx.capture2e("git pull origin #{ORIGIN_BRANCH}")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+        end
+
+        def clean
+          type = extension_point.type
+          ctx.rm_rf(".git")
+          source = File.join(path_to_project, File.join(type, SAMPLE_PATH))
+          FileUtils.copy_entry(source, path_to_project)
+          ctx.rm_rf(type)
+        end
+
+        def set_script_name
+          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)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module Script
+  module Layers
+    module Infrastructure
+      class RustTaskRunner
+        attr_reader :ctx, :script_name
+
+        BUILD_TARGET = "wasm32-unknown-unknown"
+        METADATA_FILE = "build/metadata.json"
+
+        def initialize(ctx, script_name)
+          @ctx = ctx
+          @script_name = script_name
+        end
+
+        def dependencies_installed?
+          true
+        end
+
+        def install_dependencies
+        end
+
+        def build
+          compile
+          bytecode
+        end
+
+        def compiled_type
+          "wasm"
+        end
+
+        def metadata
+          unless @ctx.file_exist?(METADATA_FILE)
+            msg = @ctx.message("script.error.metadata_not_found_cause", METADATA_FILE)
+            raise Domain::Errors::MetadataNotFoundError, msg
+          end
+
+          raw_contents = File.read(METADATA_FILE)
+          Domain::Metadata.create_from_json(@ctx, raw_contents)
+        end
+
+        private
+
+        def compile
+          out, status = ctx.capture2e("cargo build --target=#{BUILD_TARGET} --release")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+        end
+
+        def bytecode
+          binary_name = "#{script_name}.wasm"
+          binary_path = "target/#{BUILD_TARGET}/release/#{binary_name}"
+          raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(binary_path)
+
+          File.read(binary_path)
+        end
+      end
+    end
+  end
+end

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

@@ -15,23 +15,31 @@ module Script
           script_name:,
           script_content:,
           compiled_type:,
+          description: nil,
           api_key: nil,
-          force: false
+          force: false,
+          metadata:,
+          config_ui:
         )
           query_name = "app_script_update_or_create"
           variables = {
             extensionPointName: extension_point_type.upcase,
             title: script_name,
+            description: description,
+            configUi: config_ui,
             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,
           }
           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?
 
-          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
           else
             raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
@@ -56,11 +64,11 @@ module Script
 
           return resp_hash if user_errors.empty?
 
-          if user_errors.any? { |e| e['tag'] == 'app_script_not_found' }
+          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' }
+          elsif user_errors.any? { |e| e["tag"] == "shop_script_conflict" }
             raise Errors::ShopScriptConflictError
-          elsif user_errors.any? { |e| e['tag'] == 'app_script_not_pushed' }
+          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)
@@ -82,7 +90,7 @@ module Script
           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' }
+          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)
@@ -106,8 +114,8 @@ module Script
           def self.api_client(ctx, api_key, shop_domain)
             new(
               ctx: ctx,
-              url: 'https://script-service.myshopify.io/graphql',
-              token: '',
+              url: "https://script-service.myshopify.io/graphql",
+              token: "",
               api_key: api_key,
               shop_id: shop_domain&.to_i
             )
@@ -142,26 +150,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)
-          return unless response.key?('errors')
-          case error_code(response['errors'])
-          when 'forbidden'
+          raise Errors::EmptyResponseError if response.nil?
+
+          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"].map { |e| e["message"] }
           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/layers/infrastructure/task_runner.rb

@@ -5,12 +5,13 @@ module Script
     module Infrastructure
       class TaskRunner
         TASK_RUNNERS = {
-          "ts" => Infrastructure::AssemblyScriptTaskRunner,
+          "assemblyscript" => Infrastructure::AssemblyScriptTaskRunner,
+          "rust" => Infrastructure::RustTaskRunner,
         }
 
-        def self.for(ctx, language, script_name, script_source_file)
+        def self.for(ctx, language, script_name)
           raise Errors::TaskRunnerNotFoundError unless TASK_RUNNERS[language]
-          TASK_RUNNERS[language].new(ctx, script_name, script_source_file)
+          TASK_RUNNERS[language].new(ctx, script_name)
         end
       end
     end

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

@@ -5,6 +5,9 @@ module Script
     MESSAGES = {
       script: {
         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.",
           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.",
@@ -18,16 +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_help: "Try again using this format: "\
+                                     "{{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.",
@@ -35,14 +42,45 @@ module Script
           project_exists_cause: "Directory with the same name as the script already exists.",
           project_exists_help: "Use different script name and try again.",
 
-          invalid_extension_cause: "Invalid extension point %s",
+          invalid_extension_cause: "Invalid extension point %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.",
 
+          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.",
+
           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.",
+
+          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:" \
+                                                  " 'schemaVersions' is missing the 'major' field",
+          metadata_schema_versions_missing_minor: "Invalid script extension metadata:" \
+                                                  " 'schemaVersions' is missing the 'minor' field",
+
+          metadata_not_found_cause: "Script version file (%s) cannot be found.",
+          metadata_not_found_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date and " \
+                                     "'package.json' contains a 'scripts/build' entry with a " \
+                                     "'--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.",
@@ -53,6 +91,9 @@ module Script
           dependency_install_cause: "Something went wrong while installing the dependencies that are needed.",
           dependency_install_help: "Correct the errors and try again.",
 
+          failed_api_request_cause: "Something went wrong while communicating with Shopify.",
+          failed_api_request_help: "Try again.",
+
           forbidden_error_cause: "You do not have permission to do this action.",
 
           graphql_error_cause: "An error was returned: %s.",
@@ -70,8 +111,21 @@ module Script
 
           shop_script_undefined_cause: "Script is already turned off in store.",
 
-          packages_outdated_cause: "The following npm packages are out of date: %s.",
-          packages_outdated_help: "Update them by running {{cyan:npm install --save-dev %s}}.",
+          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=",
+
+          web_assembly_binary_not_found: "WebAssembly binary not found.",
+          web_assembly_binary_not_found_suggestion: "No WebAssembly binary found." \
+            "Check that your build npm script outputs the generated binary to the root of the directory." \
+            "Generated binary should match the script name: <script_name>.wasm",
         },
 
         create: {
@@ -80,7 +134,8 @@ module Script
             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:--description=DESCRIPTION}} Description of the project. Use any string.
+              {{command:--extension-point=TYPE}} Extension point name. Allowed values: %2$s.
           HELP
 
           error: {
@@ -89,7 +144,7 @@ module Script
 
           change_directory_notice: "{{*}} Change directories to {{green:%s}} to run script commands",
           creating: "Creating script",
-          created: "Created script: {{green:%s}}",
+          created: "Created script",
         },
 
         push: {
@@ -101,7 +156,7 @@ 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}).",
@@ -125,8 +180,8 @@ module Script
           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.
+              {{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 "\
@@ -151,7 +206,9 @@ module Script
         forms: {
           create: {
             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",
           },
         },
 

data/lib/project_types/script/script_project.rb

@@ -2,16 +2,16 @@
 
 module Script
   class ScriptProject < ShopifyCli::Project
-    SUPPORTED_LANGUAGES = %w(ts)
-    SOURCE_DIR = "src"
-
-    attr_reader :extension_point_type, :script_name, :language
+    attr_reader :extension_point_type, :script_name, :language, :description, :config_ui
 
     def initialize(*args)
       super
-      @extension_point_type = lookup_config('extension_point_type')
-      @script_name = lookup_config('script_name')
-      @language = 'ts'
+      @extension_point_type = lookup_config!("extension_point_type")
+      raise Errors::DeprecatedEPError, @extension_point_type if deprecated?(@extension_point_type)
+      @script_name = lookup_config!("script_name")
+      @description = lookup_config("description")
+      @config_ui = lookup_config_ui
+      @language = lookup_language
       ShopifyCli::Core::Monorail.metadata = {
         "script_name" => @script_name,
         "extension_point_type" => @extension_point_type,
@@ -19,25 +19,56 @@ module Script
       }
     end
 
-    def file_name
-      "script.#{language}"
+    def api_key
+      env[:api_key]
     end
 
-    def source_file
-      "#{SOURCE_DIR}/#{file_name}"
-    end
+    private
 
-    def source_path
-      "#{script_name}/#{source_file}"
+    def deprecated?(ep)
+      Script::Layers::Application::ExtensionPoints.deprecated_types.include?(ep)
     end
 
-    private
-
     def lookup_config(key)
+      return nil unless config.key?(key)
+      config[key]
+    end
+
+    def lookup_config!(key)
       raise Errors::InvalidContextError, key unless config.key?(key)
       config[key]
     end
 
+    def lookup_config_ui
+      filename = lookup_config("config_ui_file")
+      return nil unless filename
+
+      path = File.join(directory, filename)
+      raise Errors::MissingSpecifiedConfigUiDefinitionError, filename unless File.exist?(path)
+
+      contents = File.read(path)
+      raise Errors::InvalidConfigUiDefinitionError, filename unless valid_config_ui?(contents)
+
+      contents
+    end
+
+    def lookup_language
+      lang = lookup_config("language")&.downcase || Layers::Domain::ExtensionPointAssemblyScriptSDK.language
+      if Layers::Application::ExtensionPoints.supported_language?(type: extension_point_type, language: lang)
+        lang
+      else
+        raise Errors::InvalidLanguageError.new(lang, extension_point_type)
+      end
+    end
+
+    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
+
     class << self
       def create(ctx, dir)
         raise Errors::ScriptProjectAlreadyExistsError, dir if ctx.dir_exist?(dir)