shopify-cli 0.9.0 → 1.0.1

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

@@ -2,20 +2,14 @@ module Script
   module Layers
     module Application
       class ProjectDependencies
-        def self.bootstrap(ctx:, language:, extension_point:, script_name:)
-          dep_manager = Infrastructure::DependencyManager.for(ctx, language, extension_point, script_name)
-          dep_manager.bootstrap
-        end
-
-        def self.install(ctx:, language:, extension_point:, script_name:)
-          dep_manager = Infrastructure::DependencyManager.for(ctx, language, extension_point, script_name)
+        def self.install(ctx:, task_runner:)
           CLI::UI::Frame.open(ctx.message('script.project_deps.checking_with_npm')) do
             begin
-              if dep_manager.installed?
+              if task_runner.dependencies_installed?
                 ctx.puts(ctx.message('script.project_deps.none_required'))
               else
                 UI::StrictSpinner.spin(ctx.message('script.project_deps.installing')) do |spinner|
-                  dep_manager.install
+                  task_runner.install_dependencies
                   spinner.update_title(ctx.message('script.project_deps.installed'))
                 end
               end

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

@@ -5,21 +5,23 @@ module Script
     module Application
       class PushScript
         class << self
-          def call(ctx:, language:, extension_point_type:, script_name:, api_key:, force:)
-            extension_point = ExtensionPoints.get(type: extension_point_type)
-            script = Infrastructure::ScriptRepository.new.get_script(language, extension_point_type, script_name)
-            ProjectDependencies
-              .install(ctx: ctx, language: language, extension_point: extension_point, script_name: script_name)
-            BuildScript.call(ctx: ctx, script: script)
-            push_script(ctx, script, api_key, force)
+          def call(ctx:, language:, extension_point_type:, script_name:, source_file:, api_key:, force:)
+            script = Infrastructure::ScriptRepository.new(ctx: ctx).get_script(
+              language,
+              extension_point_type,
+              script_name
+            )
+            task_runner = Infrastructure::TaskRunner.for(ctx, language, script_name, source_file)
+            ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
+            BuildScript.call(ctx: ctx, task_runner: task_runner, script: script)
+            push_script(ctx, task_runner, script, api_key, force)
           end
 
           private
 
-          def push_script(ctx, script, api_key, force)
-            compiled_type = Infrastructure::ScriptBuilder.for(script).compiled_type
-            Infrastructure::PushPackageRepository.new
-              .get_push_package(script, compiled_type)
+          def push_script(ctx, task_runner, script, api_key, force)
+            Infrastructure::PushPackageRepository.new(ctx: ctx)
+              .get_push_package(script, task_runner.compiled_type)
               .push(Infrastructure::ScriptService.new(ctx: ctx), api_key, force)
             ctx.puts(ctx.message('script.application.pushed'))
           end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class AssemblyScriptProjectCreator
+        include SmartProperties
+        property! :ctx, accepts: ShopifyCli::Context
+        property! :extension_point, accepts: Domain::ExtensionPoint
+        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"
+
+        def setup_dependencies
+          write_npmrc
+          write_package_json
+        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))
+          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
+
+        def write_npmrc
+          ctx.system(
+            'npm', '--userconfig', './.npmrc', 'config', 'set', '@shopify:registry', 'https://registry.npmjs.com'
+          )
+          ctx.system(
+            'npm', '--userconfig', './.npmrc', 'config', 'set', 'engine-strict', 'true'
+          )
+        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
+        end
+
+        def write_package_json
+          package_json = <<~HERE
+            {
+              "name": "#{script_name}",
+              "version": "1.0.0",
+              "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}",
+                "@as-pect/cli": "4.0.0",
+                "as-wasi": "^0.0.1",
+                "assemblyscript": "^0.12.0"
+              },
+              "scripts": {
+                "test": "asp --config test/as-pect.config.js --summary --verbose"
+              },
+              "engines": {
+                "node": ">=12.16"
+              }
+            }
+          HERE
+
+          ctx.write("package.json", package_json)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+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 --validate --optimize"
+
+        attr_reader :ctx, :script_name, :script_source_file
+
+        def initialize(ctx, script_name, script_source_file)
+          @ctx = ctx
+          @script_name = script_name
+          @script_source_file = script_source_file
+        end
+
+        def build
+          compile
+          bytecode
+        end
+
+        def compiled_type
+          "wasm"
+        end
+
+        def install_dependencies
+          check_node_version!
+
+          output, status = ctx.capture2e("npm", "install", "--no-audit", "--no-optional", "--loglevel error")
+          raise Errors::DependencyInstallError, output unless status.success?
+        end
+
+        def dependencies_installed?
+          # Assuming if node_modules folder exist at root of script folder, all deps are installed
+          ctx.exist?("node_modules")
+        end
+
+        private
+
+        def check_node_version!
+          output, status = @ctx.capture2e("node", "--version")
+          raise Errors::DependencyInstallError, output unless status.success?
+
+          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}."
+          end
+        end
+
+        def compile
+          out, status = ctx.capture2e(format(SCRIPT_SDK_BUILD, source: script_source_file, name: script_name))
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+        end
+
+        def bytecode
+          File.read(format(BYTECODE_FILE, name: script_name))
+        end
+      end
+    end
+  end
+end

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

@@ -6,9 +6,7 @@ module Script
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
         class AppScriptUndefinedError < ScriptProjectError; end
-        class BuilderNotFoundError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
-        class DependencyError < ScriptProjectError; end
         class DependencyInstallError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
         class GraphqlError < ScriptProjectError
@@ -18,6 +16,7 @@ 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)
@@ -32,6 +31,7 @@ module Script
         class ShopAuthenticationError < ScriptProjectError; end
         class ShopScriptConflictError < ScriptProjectError; end
         class ShopScriptUndefinedError < ScriptProjectError; end
+        class TaskRunnerNotFoundError < ScriptProjectError; end
       end
     end
   end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class ProjectCreator
+        PROJECT_CREATORS = {
+          "ts" => Infrastructure::AssemblyScriptProjectCreator,
+        }
+
+        def self.for(ctx, language, extension_point, script_name, path_to_project)
+          raise Errors::ProjectCreatorNotFoundError unless PROJECT_CREATORS[language]
+          PROJECT_CREATORS[language].new(
+            ctx: ctx,
+            extension_point: extension_point,
+            script_name: script_name,
+            path_to_project: path_to_project
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,9 @@ module Script
   module Layers
     module Infrastructure
       class PushPackageRepository
+        include SmartProperties
+        property! :ctx, accepts: ShopifyCli::Context
+
         def create_push_package(script, script_content, compiled_type)
           build_file_path = file_path(script.name, compiled_type)
           write_to_path(build_file_path, script_content)
@@ -34,8 +37,8 @@ module Script
         private
 
         def write_to_path(path, content)
-          FileUtils.mkdir_p(File.dirname(path))
-          File.write(path, content)
+          ctx.mkdir_p(File.dirname(path))
+          ctx.write(path, content)
         end
 
         def file_path(script_name, compiled_type)

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

@@ -4,22 +4,8 @@ module Script
   module Layers
     module Infrastructure
       class ScriptRepository
-        BOOTSTRAP_SRC = "npx --no-install shopify-scripts-bootstrap src %{src_base}"
-
-        def create_script(language, extension_point, script_name)
-          FileUtils.mkdir_p(src_base)
-          out, status = CLI::Kit::System.capture2e(format(BOOTSTRAP_SRC, src_base: src_base))
-          raise Domain::Errors::ServiceFailureError, out unless status.success?
-
-          write_tsconfig if language == "ts"
-
-          Domain::Script.new(
-            script_id(language),
-            script_name,
-            extension_point.type,
-            language
-          )
-        end
+        include SmartProperties
+        property! :ctx, accepts: ShopifyCli::Context
 
         def get_script(language, extension_point_type, script_name)
           source_file_path = src_code_file(language)
@@ -33,13 +19,13 @@ module Script
         def with_temp_build_context
           prev_dir = Dir.pwd
           temp_dir = "#{project_base}/temp"
-          FileUtils.mkdir_p(temp_dir)
-          Dir.chdir(temp_dir)
-          FileUtils.cp_r("#{src_base}/.", ".")
+          ctx.mkdir_p(temp_dir)
+          ctx.chdir(temp_dir)
+          ctx.cp_r("#{src_base}/.", ".")
           yield
         ensure
-          Dir.chdir(prev_dir)
-          FileUtils.rm_rf(temp_dir)
+          ctx.chdir(prev_dir)
+          ctx.rm_rf(temp_dir)
         end
 
         def relative_path_to_src
@@ -48,18 +34,6 @@ module Script
 
         private
 
-        def write_sdk(extension_point_type, language, sdk_types)
-          return unless language == "ts"
-          File.write(sdk_types_file(extension_point_type, language), sdk_types)
-        end
-
-        def write_tsconfig
-          AssemblyScriptTsConfig
-            .new(dir_to_write_in: relative_path_to_src)
-            .with_extends_assemblyscript_config(relative_path_to_node_modules: ".")
-            .write
-        end
-
         def project_base
           ScriptProject.current.directory
         end
@@ -79,10 +53,6 @@ module Script
         def file_name(language)
           "script.#{language}"
         end
-
-        def sdk_types_file(extension_point_type, language)
-          "#{src_base}/#{extension_point_type}.#{language}"
-        end
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class TaskRunner
+        TASK_RUNNERS = {
+          "ts" => Infrastructure::AssemblyScriptTaskRunner,
+        }
+
+        def self.for(ctx, language, script_name, script_source_file)
+          raise Errors::TaskRunnerNotFoundError unless TASK_RUNNERS[language]
+          TASK_RUNNERS[language].new(ctx, script_name, script_source_file)
+        end
+      end
+    end
+  end
+end

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

@@ -18,8 +18,12 @@ module Script
           invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
           invalid_context_help: "See https://help.shopify.com",
 
+          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: "Please create an app with {{command:shopify create}} or "\
                                  "visit https://partners.shopify.com/.",
 
           no_existing_orgs_cause: "You don't have any partner organizations.",
@@ -169,11 +173,6 @@ module Script
           create: {
             select_extension_point: "Which extension point do you want to use?",
             script_name: "Script Name",
-
-            error: {
-              invalid_name: "Invalid script name: replace or remove unsupported characters. Valid "\
-                            "characters are numbers, letters, spaces, hyphens, or underscores.",
-            },
           },
           script_form: {
             ask_app_api_key_default: "Which app do you want this script to belong to?",

data/lib/project_types/script/script_project.rb

@@ -3,14 +3,28 @@
 module Script
   class ScriptProject < ShopifyCli::Project
     SUPPORTED_LANGUAGES = %w(ts)
+    SOURCE_DIR = "src"
 
     attr_reader :extension_point_type, :script_name, :language
 
-    def initialize(dir)
-      super(dir)
+    def initialize(*args)
+      super
       @extension_point_type = lookup_config('extension_point_type')
       @script_name = lookup_config('script_name')
       @language = 'ts'
+      ShopifyCli::Core::Monorail.metadata = {
+        "script_name" => @script_name,
+        "extension_point_type" => @extension_point_type,
+        "language" => @language,
+      }
+    end
+
+    def source_file
+      "#{SOURCE_DIR}/#{file_name}"
+    end
+
+    def file_name
+      "script.#{language}"
     end
 
     private
@@ -21,16 +35,15 @@ module Script
     end
 
     class << self
-      def create(dir)
-        raise Errors::ScriptProjectAlreadyExistsError, dir if Dir.exist?(dir)
-
-        FileUtils.mkdir_p(dir)
-        Dir.chdir(dir)
+      def create(ctx, dir)
+        raise Errors::ScriptProjectAlreadyExistsError, dir if ctx.exist?(dir)
+        ctx.mkdir_p(dir)
+        ctx.chdir(dir)
       end
 
       def cleanup(ctx:, script_name:, root_dir:)
-        Dir.chdir(root_dir)
-        ctx.rm_r("#{root_dir}/#{script_name}") if Dir.exist?("#{root_dir}/#{script_name}")
+        ctx.chdir(root_dir)
+        ctx.rm_r("#{root_dir}/#{script_name}") if ctx.exist?("#{root_dir}/#{script_name}")
       end
     end
   end