shopify-cli 1.10.0 → 1.11.0

data/lib/project_types/extension/messages/messages.rb

@@ -56,8 +56,10 @@ module Extension
       },
       serve: {
         frame_title: "Serving extension...",
+        no_available_ports_found: "No available ports found to run extension.",
         serve_failure_message: "Failed to run extension code.",
         serve_missing_information: "Missing shop or api_key.",
+        tunnel_already_running: "A tunnel running on another port has been detected. Close the tunnel and try again.",
       },
       tunnel: {
         missing_token: "{{x}} {{red:auth requires a token argument}}. "\
@@ -115,6 +117,7 @@ module Extension
       },
       errors: {
         unknown_type: "Unknown extension type %s",
+        package_not_found: "`%s` package not found.",
       },
     }
 

data/lib/project_types/extension/models/npm_package.rb

@@ -0,0 +1,14 @@
+require "semantic/semantic"
+
+module Extension
+  module Models
+    NpmPackage = Struct.new(:name, :version, keyword_init: true) do
+      include Comparable
+
+      def <=>(other)
+        return nil unless name == other.name
+        Semantic::Version.new(version) <=> Semantic::Version.new(other.version)
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/specification.rb

@@ -12,6 +12,7 @@ module Extension
           property! :git_template, converts: :to_str
           property! :required_fields, accepts: Array, default: -> { [] }
           property! :required_shop_beta_flags, accepts: Array, default: -> { [] }
+          property! :cli_package_name, accepts: String, converts: :to_str, default: ""
         end
 
         def self.build(feature_set_attributes)

data/lib/project_types/extension/models/specification_handlers/checkout_argo_extension.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class CheckoutArgoExtension < Default
+        PERMITTED_CONFIG_KEYS = [:metafields, :extension_points]
+
+        def config(context)
+          {
+            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
+            **argo.config(context),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/specification_handlers/default.rb

@@ -42,20 +42,45 @@ module Extension
           []
         end
 
-        def serve(context)
-          Features::ArgoServe.new(specification_handler: self, context: context).call
+        def choose_port?(context)
+          argo_runtime(context).accepts_port?
+        end
+
+        def establish_tunnel?(context)
+          argo_runtime(context).accepts_tunnel_url?
+        end
+
+        def serve(context:, port:, tunnel_url:)
+          Features::ArgoServe.new(specification_handler: self, argo_runtime: argo_runtime(context),
+          context: context, port: port, tunnel_url: tunnel_url).call
         end
 
         def renderer_package(context)
           argo.renderer_package(context)
         end
 
+        def argo_runtime(context)
+          @argo_runtime ||= Features::ArgoRuntime.new(
+            renderer: renderer_package(context),
+            cli: cli_package(context)
+          )
+        end
+
+        def cli_package(context)
+          cli_package_name = specification.features.argo&.cli_package_name
+          return unless cli_package_name
+
+          js_system = ShopifyCli::JsSystem.new(ctx: context)
+          Tasks::FindNpmPackages.exactly_one_of(cli_package_name, js_system: js_system)
+            .unwrap { |_e| context.abort(context.message("errors.package_not_found", cli_package_name)) }
+        end
+
         protected
 
         def argo
           Features::Argo.new(
             git_template: specification.features.argo.git_template,
-            renderer_package_name: specification.features.argo.renderer_package_name,
+            renderer_package_name: specification.features.argo.renderer_package_name
           )
         end
 

data/lib/project_types/extension/tasks/choose_next_available_port.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require "shopify_cli"
+require "socket"
+
+module Extension
+  module Tasks
+    class ChooseNextAvailablePort
+      include ShopifyCli::MethodObject
+
+      property! :from
+      property! :to, default: -> { from + 10 }
+      property! :host, default: "localhost"
+
+      def call
+        available_port = port_range(from: from, to: to).find { |p| available?(host, p) }
+        raise ArgumentError, "Ports between #{from} and #{to} are unavailable" if available_port.nil?
+        available_port
+      end
+
+      private
+
+      def port_range(from:, to:)
+        (from..to)
+      end
+
+      def available?(host, port)
+        Socket.tcp(host, port, connect_timeout: 1) do |socket|
+          socket.close
+          false
+        end
+      rescue Errno::ECONNREFUSED
+        true
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/configure_features.rb

@@ -42,10 +42,12 @@ module Extension
             renderer_package_name: "@shopify/argo-admin",
             required_fields: [:shop, :api_key],
             required_shop_beta_flags: [:argo_admin_beta],
+            cli_package_name: "@shopify/argo-admin-cli",
           },
           checkout: {
             git_template: "https://github.com/Shopify/argo-checkout-template.git",
             renderer_package_name: "@shopify/argo-checkout",
+            cli_package_name: "@shopify/argo-run",
           },
         }
       end

data/lib/project_types/extension/tasks/find_npm_packages.rb

@@ -0,0 +1,106 @@
+module Extension
+  module Tasks
+    class FindNpmPackages
+      include ShopifyCli::MethodObject
+
+      property! :js_system, accepts: ShopifyCli::JsSystem
+      property! :production_only, accepts: [true, false], default: false, reader: :production_only?
+
+      def self.at_least_one_of(*package_names, **config)
+        new(**config).at_least_one_of(*package_names)
+      end
+
+      def self.all(*package_names, **config)
+        new(**config).all(*package_names)
+      end
+
+      def self.exactly_one_of(*package_names, **config)
+        new(**config).exactly_one_of(*package_names)
+      end
+
+      def all(*package_names)
+        call(*package_names) do |found_packages|
+          found_package_names = found_packages.map(&:name)
+          next found_packages if Set.new(found_package_names) == Set.new(package_names)
+          raise PackageResolutionFailed, format(
+            "Missing packages: %s",
+            (package_names - found_package_names).join(", ")
+          )
+        end
+      end
+
+      def at_least_one_of(*package_names)
+        call(*package_names) do |found_packages|
+          found_package_names = found_packages.map(&:name)
+          next found_packages unless (found_package_names & package_names).empty?
+          raise PackageResolutionFailed, format(
+            "Expected at least one of the following packages: %s",
+            package_names.join(", ")
+          )
+        end
+      end
+
+      def exactly_one_of(*package_names)
+        call(*package_names) do |found_packages|
+          case found_packages.count
+          when 0
+            raise PackageResolutionFailed, format(
+              "Expected one of the following packages: %s",
+              package_names.join(", ")
+            )
+          when 1
+            found_packages.first.tap do |found_package|
+              next found_package if package_names.include?(found_package.name)
+              raise PackageResolutionFailed, format(
+                "Expected the following package: %s",
+                found_package.name
+              )
+            end
+          else
+            raise PackageResolutionFailed, "Found more than one package"
+          end
+        end
+      end
+
+      def call(*package_names, &validate)
+        validate ||= ->(found_packages) { found_packages }
+
+        unless package_names.all? { |name| name.is_a?(String) }
+          raise ArgumentError, "Expected a list of package names"
+        end
+
+        ShopifyCli::Result
+          .call(&method(:list_packages))
+          .then(&method(:search_packages).curry[package_names])
+          .then(&method(:filter_duplicates))
+          .then(&validate)
+      end
+
+      def list_packages
+        result, error, status =
+          js_system.call(yarn: yarn_list, npm: npm_list, capture_response: true)
+        raise error unless status.success?
+        result
+      end
+
+      def yarn_list
+        production_only? ? %w[list --production] : %w[list]
+      end
+
+      def npm_list
+        production_only? ? %w[list --prod --depth=1] : %w[list --depth=1]
+      end
+
+      def search_packages(packages, package_list)
+        pattern = /(#{packages.join("|")})@(\d.*)$/
+        package_list.scan(pattern).map do |(name, version)|
+          Models::NpmPackage.new(name: name, version: version.strip)
+        end
+      end
+
+      def filter_duplicates(packages)
+        packages.reject { |p| p.version.match(/deduped/) }.uniq
+      end
+    end
+  end
+end

data/lib/project_types/script/cli.rb

@@ -54,6 +54,7 @@ module Script
         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 :CommandRunner, Project.project_filepath("layers/infrastructure/command_runner")
       autoload :RustProjectCreator,
         Project.project_filepath("layers/infrastructure/rust_project_creator.rb")
       autoload :RustTaskRunner, Project.project_filepath("layers/infrastructure/rust_task_runner")

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

@@ -39,8 +39,6 @@ module Script
           end
         end
 
-        class ServiceFailureError < ScriptProjectError; end
-
         class MetadataNotFoundError < ScriptProjectError; end
 
         class MetadataValidationError < ScriptProjectError; end

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

@@ -12,7 +12,7 @@ module Script
 
         BOOTSTRAP = "npx --no-install shopify-scripts-toolchain-as bootstrap --from %{extension_point} --dest %{base}"
         BUILD = "shopify-scripts-toolchain-as build --src src/shopify_main.ts " \
-        "--binary build/%{script_name}.wasm --metadata build/metadata.json"
+        "--binary build/script.wasm --metadata build/metadata.json"
         MIN_NODE_VERSION = "14.5.0"
         ASC_ARGS = "-- --lib node_modules --optimize --use Date="
 
@@ -22,28 +22,24 @@ module Script
         end
 
         def bootstrap
-          out, status = ctx.capture2e(bootstap_command)
-          raise Domain::Errors::ServiceFailureError, out unless status.success?
+          command_runner.call(bootstap_command)
         end
 
         private
 
+        def command_runner
+          @command_runner ||= CommandRunner.new(ctx: ctx)
+        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"
-          )
+          command_runner.call("npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com")
+          command_runner.call("npm --userconfig ./.npmrc config set engine-strict true")
         end
 
         def extension_point_version
-          if extension_point.sdks.assemblyscript.versioned?
-            return extension_point.sdks.assemblyscript.version
-          end
+          return extension_point.sdks.assemblyscript.version if extension_point.sdks.assemblyscript.versioned?
 
-          out, status = ctx.capture2e("npm show #{extension_point.sdks.assemblyscript.package} version --json")
-          raise Domain::Errors::ServiceFailureError, out unless status.success?
+          out = command_runner.call("npm show #{extension_point.sdks.assemblyscript.package} version --json")
           "^#{JSON.parse(out)}"
         end
 
@@ -85,13 +81,12 @@ module Script
 
         def build_command
           type = extension_point.dasherize_type
-          base_command = format(BUILD, script_name: script_name)
           domain = extension_point.domain
 
           if domain.nil?
-            "#{base_command} #{ASC_ARGS}"
+            "#{BUILD} #{ASC_ARGS}"
           else
-            "#{base_command} --domain #{domain} --ep #{type} #{ASC_ARGS}"
+            "#{BUILD} --domain #{domain} --ep #{type} #{ASC_ARGS}"
           end
         end
       end

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

@@ -63,9 +63,7 @@ module Script
 
         def compile
           check_compilation_dependencies!
-
-          out, status = ctx.capture2e(SCRIPT_SDK_BUILD)
-          raise Domain::Errors::ServiceFailureError, out unless status.success?
+          CommandRunner.new(ctx: ctx).call(SCRIPT_SDK_BUILD)
         end
 
         def check_compilation_dependencies!
@@ -81,11 +79,19 @@ module Script
         end
 
         def bytecode
-          filename = format(BYTECODE_FILE, name: script_name)
-          raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(filename)
+          legacy_filename = format(BYTECODE_FILE, name: script_name)
+          filename = format(BYTECODE_FILE, name: "script")
+
+          bytecode_file = if ctx.file_exist?(filename)
+            filename
+          elsif ctx.file_exist?(legacy_filename)
+            legacy_filename
+          else
+            raise Errors::WebAssemblyBinaryNotFoundError
+          end
 
-          contents = ctx.binread(filename)
-          ctx.rm(filename)
+          contents = ctx.binread(bytecode_file)
+          ctx.rm(bytecode_file)
 
           contents
         end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class CommandRunner
+        include SmartProperties
+
+        property! :ctx, accepts: ShopifyCli::Context
+
+        def call(cmd)
+          out, status = ctx.capture2e(cmd)
+          raise Errors::SystemCallFailureError.new(out: out.chomp, cmd: cmd) unless status.success?
+          out
+        end
+      end
+    end
+  end
+end

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

@@ -69,11 +69,20 @@ module Script
 
         class ProjectCreatorNotFoundError < ScriptProjectError; end
 
+        class SystemCallFailureError < ScriptProjectError
+          attr_reader :out, :cmd
+          def initialize(out:, cmd:)
+            super()
+            @out = out
+            @cmd = cmd
+          end
+        end
+
         class ScriptRepushError < ScriptProjectError
-          attr_reader :api_key
-          def initialize(api_key)
+          attr_reader :uuid
+          def initialize(uuid)
             super()
-            @api_key = api_key
+            @uuid = uuid
           end
         end
 

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

@@ -8,7 +8,7 @@ module Script
         property! :ctx, accepts: ShopifyCli::Context
 
         def create_push_package(script_project:, script_content:, compiled_type:, metadata:)
-          build_file_path = file_path(script_project.id, script_project.script_name, compiled_type)
+          build_file_path = file_path(script_project.id, compiled_type)
           write_to_path(build_file_path, script_content)
 
           Domain::PushPackage.new(
@@ -24,7 +24,7 @@ module Script
         end
 
         def get_push_package(script_project:, compiled_type:, metadata:)
-          build_file_path = file_path(script_project.id, script_project.script_name, compiled_type)
+          build_file_path = file_path(script_project.id, compiled_type)
           raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
           script_content = ctx.binread(build_file_path)
@@ -47,8 +47,8 @@ module Script
           ctx.binwrite(path, content)
         end
 
-        def file_path(path_to_script, script_name, compiled_type)
-          "#{path_to_script}/build/#{script_name}.#{compiled_type}"
+        def file_path(path_to_script, compiled_type)
+          "#{path_to_script}/build/script.#{compiled_type}"
         end
       end
     end