shopify-cli 0.9.2 → 0.9.3

data/lib/project_types/script/cli.rb

@@ -51,15 +51,16 @@ module Script
       autoload :Errors, Project.project_filepath('layers/infrastructure/errors')
       autoload :AssemblyScriptDependencyManager,
                Project.project_filepath('layers/infrastructure/assemblyscript_dependency_manager')
+      autoload :AssemblyScriptProjectCreator,
+               Project.project_filepath('layers/infrastructure/assemblyscript_project_creator')
       autoload :AssemblyScriptTaskRunner, Project.project_filepath('layers/infrastructure/assemblyscript_task_runner')
       autoload :AssemblyScriptTsConfig, Project.project_filepath('layers/infrastructure/assemblyscript_tsconfig')
-      autoload :DependencyManager, Project.project_filepath('layers/infrastructure/dependency_manager')
       autoload :PushPackageRepository, Project.project_filepath('layers/infrastructure/push_package_repository')
       autoload :ExtensionPointRepository, Project.project_filepath('layers/infrastructure/extension_point_repository')
+      autoload :ProjectCreator, Project.project_filepath('layers/infrastructure/project_creator')
       autoload :ScriptRepository, Project.project_filepath('layers/infrastructure/script_repository')
       autoload :ScriptService, Project.project_filepath('layers/infrastructure/script_service')
       autoload :TaskRunner, Project.project_filepath('layers/infrastructure/task_runner')
-      autoload :TestSuiteRepository, Project.project_filepath('layers/infrastructure/test_suite_repository')
     end
   end
 

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

@@ -19,16 +19,17 @@ module Script
           return @ctx.puts(self.class.help)
         end
 
-        script = Layers::Application::CreateScript.call(
+        Layers::Application::CreateScript.call(
           ctx: @ctx,
           language: language,
           script_name: form.name,
           extension_point_type: form.extension_point
         )
-        @ctx.puts(@ctx.message('script.create.script_path', folder: script.name))
-        @ctx.puts(@ctx.message('script.create.script_created', script_id: File.join(script.name, script.id)))
+        project = ScriptProject.current
+        @ctx.puts(@ctx.message('script.create.script_path', folder: project.script_name))
+        @ctx.puts(@ctx.message('script.create.script_created', script_id: project.source_file))
       rescue StandardError => e
-        ScriptProject.cleanup(ctx: @ctx, script_name: form.name, root_dir: cur_dir)
+        ScriptProject.cleanup(ctx: @ctx, script_name: form.name, root_dir: cur_dir) if form
         UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))
       end
 

data/lib/project_types/script/errors.rb

@@ -3,6 +3,7 @@
 module Script
   module Errors
     class InvalidContextError < ScriptProjectError; end
+    class InvalidScriptNameError < ScriptProjectError; end
     class NoExistingAppsError < ScriptProjectError; end
     class NoExistingOrganizationsError < ScriptProjectError; end
     class NoExistingStoresError < ScriptProjectError

data/lib/project_types/script/forms/create.rb

@@ -6,7 +6,7 @@ module Script
       flag_arguments :extension_point, :name
 
       def ask
-        self.name = (name || ask_name).downcase.gsub(' ', '_')
+        self.name = valid_name
         self.extension_point ||= ask_extension_point
       end
 
@@ -20,9 +20,13 @@ module Script
       end
 
       def ask_name
-        name = CLI::UI::Prompt.ask(@ctx.message('script.forms.create.script_name'))
-        return name if name.match?(/^[0-9A-Za-z _-]*$/)
-        @ctx.abort(@ctx.message('script.forms.create.error.invalid_name'))
+        CLI::UI::Prompt.ask(@ctx.message('script.forms.create.script_name'))
+      end
+
+      def valid_name
+        n = (name || ask_name).downcase.gsub(' ', '_')
+        return n if n.match?(/^[0-9A-Za-z_-]*$/)
+        raise Errors::InvalidScriptNameError
       end
     end
   end

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

@@ -9,14 +9,16 @@ module Script
         class << self
           def call(ctx:, language:, script_name:, extension_point_type:)
             extension_point = ExtensionPoints.get(type: extension_point_type)
-            project = create_project(ctx, script_name, extension_point)
-            install_dependencies(ctx, language, script_name, extension_point, project)
-            create_definition(ctx, language, extension_point, script_name)
+            project = setup_project(ctx, script_name, extension_point)
+            project_creator = Infrastructure::ProjectCreator
+              .for(ctx, language, extension_point, script_name, project.directory)
+            install_dependencies(ctx, language, script_name, project, project_creator)
+            bootstrap(ctx, project_creator)
           end
 
           private
 
-          def create_project(ctx, script_name, extension_point)
+          def setup_project(ctx, script_name, extension_point)
             ScriptProject.create(ctx, script_name)
             ScriptProject.write(
               ctx,
@@ -28,26 +30,17 @@ module Script
             ScriptProject.current
           end
 
-          def install_dependencies(ctx, language, script_name, extension_point, project)
+          def install_dependencies(ctx, language, script_name, project, project_creator)
             task_runner = Infrastructure::TaskRunner.for(ctx, language, script_name, project.source_file)
-            ProjectDependencies
-              .bootstrap(ctx: ctx, language: language, extension_point: extension_point, script_name: script_name)
-            ProjectDependencies
-              .install(ctx: ctx, task_runner: task_runner)
+            project_creator.setup_dependencies
+            ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
           end
 
-          def create_definition(ctx, language, extension_point, script_name)
-            script = nil
+          def bootstrap(ctx, project_creator)
             UI::StrictSpinner.spin(ctx.message('script.create.creating')) do |spinner|
-              script = Infrastructure::ScriptRepository.new(ctx: ctx).create_script(
-                language,
-                extension_point,
-                script_name
-              )
-              Infrastructure::TestSuiteRepository.new(ctx: ctx).create_test_suite(script)
+              project_creator.bootstrap
               spinner.update_title(ctx.message('script.create.created'))
             end
-            script
           end
         end
       end

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

@@ -2,11 +2,6 @@ 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:, task_runner:)
           CLI::UI::Frame.open(ctx.message('script.project_deps.checking_with_npm')) do
             begin

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/errors.rb

@@ -7,7 +7,6 @@ module Script
         class AppNotInstalledError < ScriptProjectError; end
         class AppScriptUndefinedError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
-        class DependencyError < ScriptProjectError; end
         class DependencyInstallError < ScriptProjectError; end
         class ForbiddenError < ScriptProjectError; end
         class GraphqlError < ScriptProjectError
@@ -17,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)

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/script_repository.rb

@@ -7,23 +7,6 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCli::Context
 
-        BOOTSTRAP_SRC = "npx --no-install shopify-scripts-bootstrap src %{src_base}"
-
-        def create_script(language, extension_point, script_name)
-          ctx.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
-
         def get_script(language, extension_point_type, script_name)
           source_file_path = src_code_file(language)
           unless File.exist?(source_file_path)
@@ -51,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
@@ -82,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/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/templates/ts/as-pect.d.ts

@@ -0,0 +1 @@
+/// <reference types="@as-pect/assembly/types/as-pect" />

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

@@ -44,6 +44,11 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
           }
+        when Errors::InvalidScriptNameError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_script_name_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.invalid_script_name_help'),
+          }
         when Errors::NoExistingAppsError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.no_existing_apps_cause'),

data/lib/shopify-cli/tunnel.rb

@@ -11,7 +11,7 @@ module ShopifyCli
   class Tunnel
     extend SingleForwardable
 
-    def_delegators :new, :start, :stop, :auth
+    def_delegators :new, :start, :stop, :auth, :stats, :urls
 
     class FetchUrlError < RuntimeError; end
     class NgrokError < RuntimeError; end
@@ -23,6 +23,10 @@ module ShopifyCli
       linux: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip',
     }
 
+    NGROK_TUNNELS_URI = URI.parse('http://localhost:4040/api/tunnels')
+    TUNNELS_FIELD = 'tunnels'
+    PUBLIC_URL_FIELD = 'public_url'
+
     ##
     # will find and stop a running tunnel process. It will also output if the
     # operation was successful or not
@@ -82,6 +86,34 @@ module ShopifyCli
       ctx.system(File.join(ShopifyCli::CACHE_DIR, 'ngrok'), 'authtoken', token)
     end
 
+    ##
+    # will return the statistics of the current running tunnels
+    #
+    # #### Returns
+    #
+    # * `stats` - the hash of running statistics returning from the ngrok api
+    #
+    def stats
+      response = Net::HTTP.get_response(NGROK_TUNNELS_URI)
+      JSON.parse(response.body)
+    rescue
+      {}
+    end
+
+    ##
+    # will return the urls of the current running tunnels
+    #
+    # #### Returns
+    #
+    # * `stats` - the array of urls
+    #
+    def urls
+      tunnels = stats.dig(TUNNELS_FIELD)
+      tunnels.map { |tunnel| tunnel.dig(PUBLIC_URL_FIELD) }
+    rescue
+      []
+    end
+
     private
 
     def install(ctx)

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 end

data/vendor/deps/cli-ui/REVISION

@@ -1 +1 @@
-35e1b188f19b2ba0ab85bbf48ab983b1f72a361b
+c59f601fe271432dfe304f30f08a48b2a343606e