shopify-cli 1.4.1 → 1.5.0

data/lib/project_types/script/cli.rb

@@ -3,7 +3,8 @@
 module Script
   class Project < ShopifyCli::ProjectType
     hidden_feature(feature_set: :script_project)
-    creator 'Script', 'Script::Commands::Create'
+    title('Script')
+    creator('Script::Commands::Create')
 
     register_command('Script::Commands::Push', 'push')
     register_command('Script::Commands::Disable', 'disable')

data/lib/project_types/script/commands/enable.rb

@@ -4,9 +4,7 @@ module Script
   module Commands
     class Enable < ShopifyCli::Command
       options do |parser, flags|
-        parser.on('--config_props=KEYVALUEPAIRS', Array) do |t|
-          flags[:config_props] = Hash[t.map { |s| s.split(':') }]
-        end
+        parser.on('--config_props=KEYVALUEPAIRS', Array) { |t| flags[:config_props] = t }
         parser.on('--config_file=CONFIGFILEPATH') { |t| flags[:config_file] = t }
       end
 
@@ -47,7 +45,7 @@ module Script
       def acquire_configuration(config_file: nil, config_props: nil)
         properties = {}
         properties = YAML.load(File.read(config_file)) unless config_file.nil?
-        properties = properties.merge(config_props) unless config_props.nil?
+        properties = properties.merge(parse_config_props(config_props)) unless config_props.nil?
 
         configuration = { entries: [] }
         properties.each do |key, value|
@@ -61,6 +59,16 @@ module Script
         raise Errors::InvalidConfigYAMLError, options.flags[:config_file]
       end
 
+      def parse_config_props(config_props)
+        Hash[
+          config_props.map do |s|
+            args = s.split(':').map(&:strip)
+            raise Errors::InvalidConfigProps unless args.size == 2
+            args
+          end
+        ]
+      end
+
       # No slice pre Ruby 2.5 so roll our own
       def slice(hash, *keys)
         Hash[hash.to_a - hash.select { |key, _value| !keys.include?(key) }.to_a]

data/lib/project_types/script/config/extension_points.yml

@@ -1,24 +1,25 @@
 discount:
   assemblyscript:
     package: "@shopify/extension-point-as-discount"
-    version: "^0.3.0"
     sdk-version: "^7.0.0"
-    toolchain-version: "^1.1.0"
+    toolchain-version: "^2.0.1"
 unit_limit_per_order:
   assemblyscript:
     package: "@shopify/extension-point-as-unit-limit-per-order"
-    version: "^0.2.0"
     sdk-version: "^7.0.0"
-    toolchain-version: "^1.1.0"
+    toolchain-version: "^2.0.1"
 payment_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-payment-filter"
-    version: "^0.5.0"
     sdk-version: "^7.0.0"
-    toolchain-version: "^1.1.0"
+    toolchain-version: "^2.0.1"
 shipping_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-shipping-filter"
-    version: "^0.3.0"
     sdk-version: "^7.0.0"
-    toolchain-version: "^1.1.0"
+    toolchain-version: "^2.0.1"
+tax_filter:
+  assemblyscript:
+    package: "@shopify/extension-point-as-tax-filter"
+    sdk-version: "^7.0.0"
+    toolchain-version: "^2.0.1"

data/lib/project_types/script/errors.rb

@@ -6,6 +6,7 @@ module Script
     class InvalidScriptNameError < ScriptProjectError; end
     class NoExistingAppsError < ScriptProjectError; end
     class NoExistingOrganizationsError < ScriptProjectError; end
+
     class NoExistingStoresError < ScriptProjectError
       attr_reader :organization_id
       def initialize(organization_id)
@@ -13,7 +14,10 @@ module Script
         @organization_id = organization_id
       end
     end
+
     class ScriptProjectAlreadyExistsError < ScriptProjectError; end
+    class InvalidConfigProps < ScriptProjectError; end
+
     class InvalidConfigYAMLError < ScriptProjectError
       attr_reader :config_file
       def initialize(config_file)

data/lib/project_types/script/layers/application/build_script.rb

@@ -6,32 +6,28 @@ module Script
       class BuildScript
         class << self
           def call(ctx:, task_runner:, script:)
-            return if CLI::UI::Frame.open(ctx.message('script.application.building')) do
+            CLI::UI::Frame.open(ctx.message('script.application.building')) do
               begin
                 UI::StrictSpinner.spin(ctx.message('script.application.building_script')) do |spinner|
-                  build(ctx, task_runner, script)
+                  Infrastructure::PushPackageRepository
+                    .new(ctx: ctx)
+                    .create_push_package(script, task_runner.build, task_runner.compiled_type)
                   spinner.update_title(ctx.message('script.application.built'))
                 end
-                true
               rescue StandardError => e
                 CLI::UI::Frame.with_frame_color_override(:red) do
                   ctx.puts("\n{{red:#{e.message}}}")
                 end
-                false
-              end
-            end
-            raise Infrastructure::Errors::BuildError
-          end
+                errors = [
+                  Infrastructure::Errors::InvalidBuildScriptError,
+                  Infrastructure::Errors::BuildScriptNotFoundError,
+                  Infrastructure::Errors::WebAssemblyBinaryNotFoundError,
+                ]
 
-          private
-
-          def build(ctx, task_runner, script)
-            script_repo = Infrastructure::ScriptRepository.new(ctx: ctx)
-            script_content = script_repo.with_temp_build_context do
-              task_runner.build
+                raise Infrastructure::Errors::BuildError unless errors.any? { |err| e.is_a?(err) }
+                raise
+              end
             end
-            Infrastructure::PushPackageRepository.new(ctx: ctx)
-              .create_push_package(script, script_content, task_runner.compiled_type)
           end
         end
       end

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

@@ -5,6 +5,7 @@ module Script
     module Domain
       module Errors
         class PushPackageNotFoundError < ScriptProjectError; end
+
         class InvalidExtensionPointError < ScriptProjectError
           attr_reader :type
           def initialize(type)
@@ -12,6 +13,7 @@ module Script
             @type = type
           end
         end
+
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type
           def initialize(extension_point_type, script_name)
@@ -20,6 +22,7 @@ module Script
             @extension_point_type = extension_point_type
           end
         end
+
         class ServiceFailureError < ScriptProjectError; end
       end
     end

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

@@ -19,7 +19,6 @@ module Script
 
         def initialize(config)
           @package = config["package"]
-          @version = config["version"]
           @sdk_version = config["sdk-version"]
           @toolchain_version = config["toolchain-version"]
         end

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

@@ -10,11 +10,8 @@ module Script
         property! :script_name, accepts: String
         property! :path_to_project, accepts: String
 
-        BOOTSTRAP_SRC = "npx --no-install shopify-scripts-bootstrap src %{src_base}"
-        BOOTSTRAP_TEST = "npx --no-install shopify-scripts-bootstrap test %{test_base}"
-        SOURCE_DIR = "src"
-        TEST_DIR = "test"
-        LANGUAGE = "ts"
+        BOOTSTRAP = "npx --no-install shopify-scripts-toolchain-as bootstrap --from %{extension_point} --dest %{base}"
+        MIN_NODE_VERSION = "14.5.0"
 
         def setup_dependencies
           write_npmrc
@@ -22,42 +19,12 @@ module Script
         end
 
         def bootstrap
-          create_src_folder
-          create_test_folder
-        end
-
-        private
-
-        def create_src_folder
-          ctx.mkdir_p(src_base)
-          out, status = ctx.capture2e(format(BOOTSTRAP_SRC, src_base: src_base))
+          type = extension_point.type.gsub('_', '-')
+          out, status = ctx.capture2e(format(BOOTSTRAP, extension_point: type, base: path_to_project))
           raise Domain::Errors::ServiceFailureError, out unless status.success?
-
-          write_tsconfig_file(SOURCE_DIR, ".")
-        end
-
-        def create_test_folder
-          ctx.mkdir_p(test_base)
-          out, status = ctx.capture2e(format(BOOTSTRAP_TEST, test_base: test_base))
-          raise Domain::Errors::ServiceFailureError, out unless status.success?
-
-          copy_template_file(test_base, 'as-pect.config.js')
-          copy_template_file(test_base, 'as-pect.d.ts')
-          write_tsconfig_file(TEST_DIR, "../#{SOURCE_DIR}")
         end
 
-        def test_base
-          "#{path_to_project}/#{TEST_DIR}"
-        end
-
-        def src_base
-          "#{path_to_project}/#{SOURCE_DIR}"
-        end
-
-        def copy_template_file(destination, name)
-          template_file = Project.project_filepath("templates/#{LANGUAGE}/#{name}")
-          ctx.cp(template_file, "#{destination}/#{name}")
-        end
+        private
 
         def write_npmrc
           ctx.system(
@@ -68,12 +35,10 @@ module Script
           )
         end
 
-        def write_tsconfig_file(dir, path_to_source)
-          AssemblyScriptTsConfig
-            .new(dir_to_write_in: dir)
-            .with_extends_assemblyscript_config(relative_path_to_node_modules: ".")
-            .with_module_resolution_paths(paths: { "*": ["#{path_to_source}/*.ts"] })
-            .write
+        def extension_point_version
+          out, status = ctx.capture2e("npm show #{extension_point.sdks[:ts].package} version --json")
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+          JSON.parse(out)
         end
 
         def write_package_json
@@ -84,20 +49,20 @@ module Script
               "devDependencies": {
                 "@shopify/scripts-sdk-as": "#{extension_point.sdks[:ts].sdk_version}",
                 "@shopify/scripts-toolchain-as": "#{extension_point.sdks[:ts].toolchain_version}",
-                "#{extension_point.sdks[:ts].package}": "#{extension_point.sdks[:ts].version}",
+                "#{extension_point.sdks[:ts].package}": "^#{extension_point_version}",
                 "@as-pect/cli": "4.0.0",
                 "as-wasi": "^0.2.1",
                 "assemblyscript": "^0.14.0"
               },
               "scripts": {
-                "test": "asp --config test/as-pect.config.js --summary --verbose"
+                "test": "asp --summary --verbose",
+                "build": "shopify-scripts-toolchain-as build --src src/script.ts --binary build/#{script_name}.wasm -- --lib node_modules --optimize --use Date="
               },
               "engines": {
-                "node": ">=14.5"
+                "node": ">=#{MIN_NODE_VERSION}"
               }
             }
           HERE
-
           ctx.write("package.json", package_json)
         end
       end

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

@@ -4,9 +4,8 @@ module Script
   module Layers
     module Infrastructure
       class AssemblyScriptTaskRunner
-        BYTECODE_FILE = "%{name}.wasm"
-        SCRIPT_SDK_BUILD = "npx --no-install shopify-scripts-build --src=../%{source} --binary=#{BYTECODE_FILE} "\
-                           "-- --lib=../node_modules --optimize --use Date="
+        BYTECODE_FILE = "build/%{name}.wasm"
+        SCRIPT_SDK_BUILD = "npm run build"
 
         attr_reader :ctx, :script_name, :script_source_file
 
@@ -47,18 +46,40 @@ module Script
 
           require 'semantic/semantic'
           version = ::Semantic::Version.new(output[1..-1])
-          unless version >= ::Semantic::Version.new("12.16.0")
-            raise Errors::DependencyInstallError, "Node version must be >= v12.16.0. Current version: #{output.strip}."
+          unless version >= ::Semantic::Version.new(AssemblyScriptProjectCreator::MIN_NODE_VERSION)
+            raise Errors::DependencyInstallError,
+                  "Node version must be >= v#{AssemblyScriptProjectCreator::MIN_NODE_VERSION}. "\
+                  "Current version: #{output.strip}."
           end
         end
 
         def compile
-          out, status = ctx.capture2e(format(SCRIPT_SDK_BUILD, source: script_source_file, name: script_name))
+          check_compilation_dependencies!
+
+          out, status = ctx.capture2e(SCRIPT_SDK_BUILD)
           raise Domain::Errors::ServiceFailureError, out unless status.success?
         end
 
+        def check_compilation_dependencies!
+          pkg = JSON.parse(File.read('package.json'))
+          build_script = pkg.dig('scripts', 'build')
+
+          raise Errors::BuildScriptNotFoundError,
+            "Build script not found" if build_script.nil?
+
+          unless build_script.start_with?("shopify-scripts")
+            raise Errors::InvalidBuildScriptError, "Invalid build script"
+          end
+        end
+
         def bytecode
-          File.read(format(BYTECODE_FILE, name: script_name))
+          blob = format(BYTECODE_FILE, name: script_name)
+          raise Errors::WebAssemblyBinaryNotFoundError unless @ctx.file_exist?(blob)
+
+          contents = File.read(blob)
+          @ctx.rm(blob)
+
+          contents
         end
 
         def check_if_ep_dependencies_up_to_date!

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

@@ -9,7 +9,9 @@ module Script
         class AppScriptUndefinedError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
         class DependencyInstallError < ScriptProjectError; end
+        class EmptyResponseError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
+
         class GraphqlError < ScriptProjectError
           attr_reader :errors
           def initialize(errors)
@@ -17,7 +19,9 @@ module Script
             super("GraphQL failed with errors: #{errors}")
           end
         end
+
         class ProjectCreatorNotFoundError < ScriptProjectError; end
+
         class ScriptRepushError < ScriptProjectError
           attr_reader :api_key
           def initialize(api_key)
@@ -25,15 +29,18 @@ module Script
             @api_key = api_key
           end
         end
+
         class ScriptServiceUserError < ScriptProjectError
           def initialize(query_name, errors)
             super("Failed performing #{query_name}. Errors: #{errors}.")
           end
         end
+
         class ShopAuthenticationError < ScriptProjectError; end
         class ShopScriptConflictError < ScriptProjectError; end
         class ShopScriptUndefinedError < ScriptProjectError; end
         class TaskRunnerNotFoundError < ScriptProjectError; end
+
         class PackagesOutdatedError < ScriptProjectError
           attr_reader :outdated_packages
           def initialize(outdated_packages)
@@ -41,6 +48,15 @@ module Script
             @outdated_packages = outdated_packages
           end
         end
+
+        class BuildScriptNotFoundError < ScriptProjectError; end
+        class InvalidBuildScriptError < ScriptProjectError; end
+
+        class WebAssemblyBinaryNotFoundError < ScriptProjectError
+          def initialize
+            super("WebAssembly binary not found")
+          end
+        end
       end
     end
   end

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

@@ -16,18 +16,6 @@ module Script
           Domain::Script.new(script_id(language), script_name, extension_point_type, language)
         end
 
-        def with_temp_build_context
-          prev_dir = Dir.pwd
-          temp_dir = "#{project_base}/temp"
-          ctx.mkdir_p(temp_dir)
-          ctx.chdir(temp_dir)
-          ctx.cp_r("#{src_base}/.", ".")
-          yield
-        ensure
-          ctx.chdir(prev_dir)
-          ctx.rm_rf(temp_dir)
-        end
-
         def relative_path_to_src
           "src"
         end

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

@@ -146,6 +146,8 @@ module Script
         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'

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

@@ -18,6 +18,10 @@ 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.",
@@ -53,6 +57,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 +77,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: "Invalid build script.",
+          build_script_not_found: "Build script not found.",
+          # rubocop:disable Layout/LineLength
+          build_script_suggestion: "Root package.json needs a script named build, which" \
+            "uses @shopify/scripts-toolchain-as to compile to WebAssembly.\n" \
+            "Example:\n" \
+            "build: npx shopify-scripts-toolchain-as build --src src/script.ts --binary <script_name>.wasm -- --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: {