shopify-cli 1.9.0 → 1.13.0

data/lib/project_types/extension/features/argo_serve_options.rb

@@ -0,0 +1,41 @@
+module Extension
+  module Features
+    class ArgoServeOptions
+      include SmartProperties
+
+      property! :argo_runtime, accepts: Features::ArgoRuntime
+      property! :context, accepts: ShopifyCli::Context
+      property  :port, accepts: Integer, default: 39351
+      property  :public_url, accepts: String, default: ""
+      property! :required_fields, accepts: Array, default: -> { [] }
+      property! :renderer_package, accepts: Models::NpmPackage
+
+      YARN_SERVE_COMMAND = %w(server)
+      NPM_SERVE_COMMAND = %w(run-script server)
+
+      def yarn_serve_command
+        YARN_SERVE_COMMAND + options
+      end
+
+      def npm_serve_command
+        NPM_SERVE_COMMAND  + ["--"] + options
+      end
+
+      private
+
+      def options
+        project = ExtensionProject.current
+        api_key = project.env.api_key
+
+        @serve_options ||= [].tap do |options|
+          options << "--port=#{port}" if argo_runtime.accepts_port?
+          options << "--shop=#{project.env.shop}" if required_fields.include?(:shop) && argo_runtime.accepts_shop?
+          options << "--apiKey=#{api_key}" if required_fields.include?(:api_key) && argo_runtime.accepts_api_key?
+          options << "--argoVersion=#{renderer_package.version}" if argo_runtime.accepts_argo_version?
+          options << "--uuid=#{project.registration_uuid}" if argo_runtime.accepts_uuid?
+          options << "--publicUrl=#{public_url}" if argo_runtime.accepts_tunnel_url?
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/features/argo_setup.rb

@@ -9,7 +9,7 @@ module Extension
       SCRIPTS_DIRECTORY = "scripts"
 
       property! :git_template, accepts: String
-      property! :dependency_checks, default: []
+      property! :dependency_checks, default: -> { [] }
 
       def call(directory_name, identifier, context)
         steps = [

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}}. "\
@@ -98,10 +100,8 @@ module Extension
               node_not_installed: "Node must be installed to create this extension.",
               version_too_low: "Your node version %s does not meet the minimum required version %s",
             },
-            argo_missing_renderer_package_error: "%s Install the missing package and try again.",
-            argo_renderer_package_invalid_version_error: <<~MESSAGE,
-              The renderer package version is not a valid SemVer Version (http://semver.org)
-            MESSAGE
+            argo_missing_renderer_package_error: "Extension template references invalid renderer package "\
+              "please contact Shopify for help.",
             yarn_install_error: "Something went wrong while running 'yarn install'. %s.",
             yarn_run_script_error: "Something went wrong while running script. %s.",
           },
@@ -117,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

@@ -10,8 +10,9 @@ module Extension
           property! :surface, converts: :to_str
           property! :renderer_package_name, converts: :to_str
           property! :git_template, converts: :to_str
-          property! :required_fields, accepts: Array, default: []
-          property! :required_shop_beta_flags, accepts: Array, default: []
+          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,50 @@ 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/models/version.rb

@@ -9,7 +9,7 @@ module Extension
       property! :last_user_interaction_at, accepts: Time
       property  :context, accepts: String
       property  :location, accepts: String
-      property :validation_errors, accepts: Models::ValidationError::IS_VALIDATION_ERROR_LIST, default: []
+      property :validation_errors, accepts: Models::ValidationError::IS_VALIDATION_ERROR_LIST, default: -> { [] }
     end
   end
 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/node/messages/messages.rb

@@ -59,21 +59,21 @@ module Node
             installed: "Installed Heroku CLI",
             authenticating: "Authenticating with Heroku…",
             authenticated: "{{v}} Authenticated with Heroku",
-            authenticated_with_account: "{{v}} Authenticated with Heroku as `%s`",
+            authenticated_with_account: "{{v}} Authenticated with Heroku as {{green:%s}}",
             deploying: "Deploying to Heroku…",
             deployed: "{{v}} Deployed to Heroku",
             git: {
               checking: "Checking git repo…",
               initialized: "Git repo initialized",
               what_branch: "What branch would you like to deploy?",
-              branch_selected: "{{v}} Git branch `%s` selected for deploy",
+              branch_selected: "{{v}} Git branch {{green:%s}} selected for deploy",
             },
             app: {
               no_apps_found: "No existing Heroku app found. What would you like to do?",
               name: "What is your Heroku app’s name?",
               select: "Specify an existing Heroku app",
-              selecting: "Selecting Heroku app `%s`…",
-              selected: "{{v}} Heroku app `%s` selected",
+              selecting: "Selecting Heroku app %s…",
+              selected: "{{v}} Heroku app {{green:%s}} selected",
               create: "Create a new Heroku app",
               creating: "Creating new Heroku app…",
               created: "{{v}} New Heroku app created",

data/lib/project_types/rails/messages/messages.rb

@@ -89,7 +89,7 @@ module Rails
             downloaded: "Downloaded Heroku CLI",
             installing: "Installing Heroku CLI...",
             installed: "Installed Heroku CLI",
-            authenticated_with_account: "{{v}} Authenticated with Heroku as `%s`",
+            authenticated_with_account: "{{v}} Authenticated with Heroku as {{green:%s}}",
             authenticating: "Authenticating with Heroku...",
             authenticated: "{{v}} Authenticated with Heroku",
             deploying: "Deploying to Heroku...",
@@ -109,14 +109,14 @@ module Rails
               checking: "Checking git repo...",
               initialized: "Git repo initialized",
               what_branch: "What branch would you like to deploy?",
-              branch_selected: "{{v}} Git branch `%s` selected for deploy",
+              branch_selected: "{{v}} Git branch {{green:%s}} selected for deploy",
             },
             app: {
               no_apps_found: "No existing Heroku app found. What would you like to do?",
               name: "What is your Heroku app’s name?",
               select: "Specify an existing Heroku app",
-              selecting: "Selecting Heroku app `%s`...",
-              selected: "{{v}} Heroku app `%s` selected",
+              selecting: "Selecting Heroku app %s...",
+              selected: "{{v}} Heroku app {{green:%s}} selected",
               create: "Create a new Heroku app",
               creating: "Creating new Heroku app...",
               created: "{{v}} New Heroku app created",

data/lib/project_types/script/cli.rb

@@ -24,6 +24,10 @@ module Script
     autoload :ScriptForm, Project.project_filepath("forms/script_form")
   end
 
+  module Tasks
+    autoload :EnsureEnv, Project.project_filepath("tasks/ensure_env")
+  end
+
   module Layers
     module Application
       autoload :BuildScript, Project.project_filepath("layers/application/build_script")
@@ -44,22 +48,23 @@ module Script
 
     module Infrastructure
       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 :RustProjectCreator,
-        Project.project_filepath("layers/infrastructure/rust_project_creator.rb")
-      autoload :RustTaskRunner, Project.project_filepath("layers/infrastructure/rust_task_runner")
-
+      autoload :CommandRunner, Project.project_filepath("layers/infrastructure/command_runner")
       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 :ScriptProjectRepository, Project.project_filepath("layers/infrastructure/script_project_repository")
       autoload :ScriptService, Project.project_filepath("layers/infrastructure/script_service")
-      autoload :TaskRunner, Project.project_filepath("layers/infrastructure/task_runner")
+
+      module Languages
+        autoload :AssemblyScriptProjectCreator,
+          Project.project_filepath("layers/infrastructure/languages/assemblyscript_project_creator")
+        autoload :AssemblyScriptTaskRunner,
+          Project.project_filepath("layers/infrastructure/languages/assemblyscript_task_runner")
+        autoload :ProjectCreator, Project.project_filepath("layers/infrastructure/languages/project_creator")
+        autoload :RustProjectCreator,
+          Project.project_filepath("layers/infrastructure/languages/rust_project_creator.rb")
+        autoload :RustTaskRunner, Project.project_filepath("layers/infrastructure/languages/rust_task_runner")
+        autoload :TaskRunner, Project.project_filepath("layers/infrastructure/languages/task_runner")
+      end
     end
   end