shopify-cli 1.3.1 → 1.7.0

data/lib/project_types/extension/commands/serve.rb

@@ -7,9 +7,9 @@ module Extension
       NPM_SERVE_COMMAND = %w(run-script server)
 
       def call(_args, _command_name)
-        CLI::UI::Frame.open(@ctx.message('serve.frame_title')) do
+        CLI::UI::Frame.open(@ctx.message("serve.frame_title")) do
           success = ShopifyCli::JsSystem.call(@ctx, yarn: YARN_SERVE_COMMAND, npm: NPM_SERVE_COMMAND)
-          @ctx.abort(@ctx.message('serve.serve_failure_message')) unless success
+          @ctx.abort(@ctx.message("serve.serve_failure_message")) unless success
         end
       end
 

data/lib/project_types/extension/commands/tunnel.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
     class Tunnel < ExtensionCommand
       options do |parser, flags|
-        parser.on('--port=PORT') { |port| flags[:port] = port }
+        parser.on("--port=PORT") { |port| flags[:port] = port }
       end
 
-      AUTH_SUBCOMMAND = 'auth'
-      START_SUBCOMMAND = 'start'
-      STOP_SUBCOMMAND = 'stop'
-      STATUS_SUBCOMMAND = 'status'
+      AUTH_SUBCOMMAND = "auth"
+      START_SUBCOMMAND = "start"
+      STOP_SUBCOMMAND = "stop"
+      STATUS_SUBCOMMAND = "status"
       DEFAULT_PORT = 39351
 
       def call(args, _name)
@@ -27,11 +27,11 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.message('tunnel.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("tunnel.help", ShopifyCli::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message('tunnel.extended_help', ShopifyCli::TOOL_NAME, DEFAULT_PORT)
+        ShopifyCli::Context.message("tunnel.extended_help", ShopifyCli::TOOL_NAME, DEFAULT_PORT)
       end
 
       private
@@ -40,9 +40,9 @@ module Extension
         tunnel_url = ShopifyCli::Tunnel.urls.first
 
         if tunnel_url.nil?
-          @ctx.puts(@ctx.message('tunnel.no_tunnel_running'))
+          @ctx.puts(@ctx.message("tunnel.no_tunnel_running"))
         else
-          @ctx.puts(@ctx.message('tunnel.tunnel_running_at', tunnel_url))
+          @ctx.puts(@ctx.message("tunnel.tunnel_running_at", tunnel_url))
         end
       end
 
@@ -50,7 +50,7 @@ module Extension
         return DEFAULT_PORT unless options.flags.key?(:port)
 
         port = options.flags[:port].to_i
-        @ctx.abort(@ctx.message('tunnel.invalid_port', options.flags[:port])) unless port > 0
+        @ctx.abort(@ctx.message("tunnel.invalid_port", options.flags[:port])) unless port > 0
         port
       end
 
@@ -58,7 +58,7 @@ module Extension
         token = args.shift
 
         if token.nil?
-          @ctx.puts(@ctx.message('tunnel.missing_token'))
+          @ctx.puts(@ctx.message("tunnel.missing_token"))
           @ctx.puts("#{self.class.help}\n#{self.class.extended_help}")
         else
           ShopifyCli::Tunnel.auth(@ctx, token)

data/lib/project_types/extension/extension_project.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   class ExtensionProject < ShopifyCli::Project
@@ -13,7 +13,7 @@ module Extension
         )
       end
 
-      def write_env_file(context:, title:, api_key: '', api_secret: '', registration_id: nil)
+      def write_env_file(context:, title:, api_key: "", api_secret: "", registration_id: nil)
         ShopifyCli::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
@@ -34,11 +34,11 @@ module Extension
     end
 
     def app
-      Models::App.new(api_key: env['api_key'], secret: env['secret'])
+      Models::App.new(api_key: env["api_key"], secret: env["secret"])
     end
 
     def registered?
-      property_present?('api_key') && property_present?('secret') && registration_id?
+      property_present?("api_key") && property_present?("secret") && registration_id?
     end
 
     def title

data/lib/project_types/extension/extension_project_keys.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module ExtensionProjectKeys
-    REGISTRATION_ID_KEY = 'EXTENSION_ID'
-    EXTENSION_TYPE_KEY = 'EXTENSION_TYPE'
-    TITLE_KEY = 'EXTENSION_TITLE'
+    REGISTRATION_ID_KEY = "EXTENSION_ID"
+    EXTENSION_TYPE_KEY = "EXTENSION_TYPE"
+    TITLE_KEY = "EXTENSION_TITLE"
   end
 end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+require "base64"
+require "shopify_cli"
+require "semantic/semantic"
+
+module Extension
+  module Features
+    class Argo
+      include SmartProperties
+
+      property! :git_template, converts: :to_str
+      property! :renderer_package_name, converts: :to_str
+
+      SCRIPT_PATH = %w(build main.js).freeze
+
+      NPM_LIST_COMMAND = %w(list).freeze
+      YARN_LIST_COMMAND = %w(list --pattern).freeze
+      NPM_LIST_PARAMETERS = %w(--prod).freeze
+      YARN_LIST_PARAMETERS = %w(--production).freeze
+      private_constant :NPM_LIST_COMMAND, :YARN_LIST_COMMAND, :NPM_LIST_PARAMETERS, :YARN_LIST_PARAMETERS
+
+      YARN_INSTALL_COMMAND = %w(install).freeze
+      YARN_INSTALL_PARAMETERS = %w(--silent).freeze
+      YARN_RUN_COMMAND = %w(run).freeze
+      YARN_RUN_SCRIPT_NAME = %w(build).freeze
+      private_constant :YARN_INSTALL_COMMAND, :YARN_INSTALL_PARAMETERS, :YARN_RUN_COMMAND, :YARN_RUN_SCRIPT_NAME
+
+      def create(directory_name, identifier, context)
+        Features::ArgoSetup.new(git_template: git_template).call(directory_name, identifier, context)
+      end
+
+      def config(context)
+        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        if js_system.package_manager == "yarn"
+          run_yarn_install(context, js_system)
+          run_yarn_run_script(context, js_system)
+        end
+        filepath = File.join(context.root, SCRIPT_PATH)
+        context.abort(context.message("features.argo.missing_file_error")) unless File.exist?(filepath)
+        begin
+          {
+            renderer_version: extract_argo_renderer_version(context),
+            serialized_script: Base64.strict_encode64(File.read(filepath).chomp),
+          }
+        rescue StandardError
+          context.abort(context.message("features.argo.script_prepare_error"))
+        end
+      end
+
+      private
+
+      def extract_argo_renderer_version(context)
+        result = run_list_command(context)
+        found_version = find_version_number(context, result)
+        context.abort(
+          context.message("features.argo.dependencies.argo_renderer_package_invalid_version_error")
+        ) if found_version.nil?
+        ::Semantic::Version.new(found_version).to_s
+      rescue ArgumentError
+        context.abort(
+          context.message("features.argo.dependencies.argo_renderer_package_invalid_version_error")
+        )
+      end
+
+      def find_version_number(context, result)
+        packages = result.to_json.split('\n')
+        found_package = packages.find do |package|
+          package.match(/#{renderer_package_name}@/)
+        end
+        if found_package.nil?
+          error = "'#{renderer_package_name}' not found."
+          context.abort(
+            context.message("features.argo.dependencies.argo_missing_renderer_package_error", error)
+          )
+        end
+        found_package.split("@")[2]&.strip
+      end
+
+      def run_list_command(context)
+        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        result, error, status = js_system.call(
+          yarn: YARN_LIST_COMMAND + [renderer_package_name] + YARN_LIST_PARAMETERS,
+          npm: NPM_LIST_COMMAND + [renderer_package_name] + NPM_LIST_PARAMETERS,
+          capture_response: true
+        )
+        context.abort(
+          context.message("features.argo.dependencies.argo_missing_renderer_package_error", error)
+        ) unless status.success?
+        result
+      end
+
+      def run_yarn_install(context, js_system)
+        _result, error, status = js_system.call(
+          yarn: YARN_INSTALL_COMMAND + YARN_INSTALL_PARAMETERS,
+          npm: [],
+          capture_response: true
+        )
+
+        context.abort(
+          context.message("features.argo.dependencies.yarn_install_error", error)
+        ) unless status.success?
+      end
+
+      def run_yarn_run_script(context, js_system)
+        _result, error, status = js_system.call(
+          yarn: YARN_RUN_COMMAND + YARN_RUN_SCRIPT_NAME,
+          npm: [],
+          capture_response: true
+        )
+
+        context.abort(
+          context.message("features.argo.dependencies.yarn_run_script_error", error)
+        ) unless status.success?
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Extension
   module Features
     class ArgoConfig
-      CONFIG_FILE_NAME = 'extension.config.yml'
+      CONFIG_FILE_NAME = "extension.config.yml"
 
       class << self
         def parse_yaml(context, permitted_keys = [])
@@ -11,7 +11,7 @@ module Extension
 
           return {} unless File.size?(file_name)
 
-          require 'yaml' # takes 20ms, so deferred as late as possible.
+          require "yaml" # takes 20ms, so deferred as late as possible.
           begin
             config = YAML.load_file(file_name)
 
@@ -21,7 +21,7 @@ module Extension
             return {} if config.nil?
 
             unless config.is_a?(Hash)
-              raise ShopifyCli::Abort, ShopifyCli::Context.message('core.yaml.error.not_hash', CONFIG_FILE_NAME)
+              raise ShopifyCli::Abort, ShopifyCli::Context.message("core.yaml.error.not_hash", CONFIG_FILE_NAME)
             end
 
             config.transform_keys!(&:to_sym)
@@ -31,7 +31,7 @@ module Extension
           rescue Psych::SyntaxError => e
             raise(
               ShopifyCli::Abort,
-              ShopifyCli::Context.message('core.yaml.error.invalid', CONFIG_FILE_NAME, e.message)
+              ShopifyCli::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
             )
           end
         end
@@ -47,7 +47,7 @@ module Extension
             raise(
               ShopifyCli::Abort,
               ShopifyCli::Context.message(
-                'features.argo.config.unpermitted_keys',
+                "features.argo.config.unpermitted_keys",
                 CONFIG_FILE_NAME,
                 unpermitted_keys.map { |k| "\n- #{k}" }.join
               )

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

@@ -5,21 +5,21 @@ module Extension
     class ArgoDependencies
       def self.node_installed(min_major:, min_minor: nil)
         -> (context) do
-          out, status = CLI::Kit::System.capture2('node', '-v')
-          context.abort(context.message('features.argo.dependencies.node.node_not_installed')) unless status.success?
+          out, status = CLI::Kit::System.capture2("node", "-v")
+          context.abort(context.message("features.argo.dependencies.node.node_not_installed")) unless status.success?
 
-          min_version = 'v' + min_major .to_s + '.' + (min_minor.nil? ? 'x' : min_minor.to_s) + '.x'
+          min_version = "v" + min_major .to_s + "." + (min_minor.nil? ? "x" : min_minor.to_s) + ".x"
           version = out.strip
           parsed_version = version.match(/v(?<major>\d+).(?<minor>\d+).(?<patch>\d+)/)
 
           unless min_major.nil? || parsed_version[:major].to_i >= min_major
-            context.abort(context.message('features.argo.dependencies.node.version_too_low', version, min_version))
+            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
           end
 
           return if parsed_version[:major].to_i > min_major
 
           unless min_minor.nil? || parsed_version[:minor].to_i >= min_minor
-            context.abort(context.message('features.argo.dependencies.node.version_too_low', version, min_version))
+            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
           end
         end
       end

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

@@ -5,8 +5,8 @@ module Extension
     class ArgoSetup
       include SmartProperties
 
-      GIT_DIRECTORY = '.git'
-      SCRIPTS_DIRECTORY = 'scripts'
+      GIT_DIRECTORY = ".git"
+      SCRIPTS_DIRECTORY = "scripts"
 
       property! :git_template, accepts: String
       property! :dependency_checks, default: []

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

@@ -5,7 +5,7 @@ module Extension
     module ArgoSetupSteps
       YARN_INITIALIZE_COMMAND = %w(generate).freeze
       NPM_INITIALIZE_COMMAND = %w(run generate --).freeze
-      INITIALIZE_TYPE_PARAMETER = '--type=%s'
+      INITIALIZE_TYPE_PARAMETER = "--type=%s"
 
       def self.check_dependencies(dependency_checks)
         ArgoSetupStep.always_successful do |context, _identifier, _directory_name, _js_system|
@@ -21,7 +21,7 @@ module Extension
             ShopifyCli::Git.clone(git_template, directory_name, ctx: context)
             context.root = File.join(context.root, directory_name)
           rescue StandardError
-            context.puts('{{x}} Unable to clone the repository.')
+            context.puts("{{x}} Unable to clone the repository.")
           end
         end
       end
@@ -34,8 +34,8 @@ module Extension
 
       def self.initialize_project
         ArgoSetupStep.default do |context, identifier, _directory_name, js_system|
-          frame_title = context.message('create.setup_project_frame_title')
-          failure_message = context.message('features.argo.initialization_error')
+          frame_title = context.message("create.setup_project_frame_title")
+          failure_message = context.message("features.argo.initialization_error")
 
           result = true
           CLI::UI::Frame.open(frame_title, failure_text: failure_message) do

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

@@ -3,50 +3,44 @@
 module Extension
   module Forms
     class Create < ShopifyCli::Form
-      flag_arguments :name, :type
+      flag_arguments :name, :type, :api_key
 
-      def ask
-        self.type = ask_type
-        self.name = ask_name
-      end
+      attr_reader :app
 
-      def directory_name
-        @directory_name ||= name.strip.gsub(/( )/, '_').downcase
-      end
+      class ExtensionProjectDetails
+        include SmartProperties
 
-      private
+        property :app, accepts: Models::App
+        property :name, accepts: String
+        property :type, accepts: Models::SpecificationHandlers::Default
 
-      def ask_name
-        ask_with_reprompt(
-          initial_value: name,
-          break_condition: -> (current_name) { Models::Registration.valid_title?(current_name) },
-          prompt_message: ctx.message('create.ask_name'),
-          reprompt_message: ctx.message('create.invalid_name', Models::Registration::MAX_TITLE_LENGTH)
-        )
+        def complete?
+          !!(app && name && type)
+        end
       end
 
-      def ask_type
-        return Models::Type.load_type(type) if Models::Type.valid?(type)
-        ctx.puts(ctx.message('create.invalid_type')) unless type.nil?
-
-        CLI::UI::Prompt.ask(ctx.message('create.ask_type')) do |handler|
-          Models::Type.repository.values.each do |type|
-            handler.option("#{type.name} #{type.tagline}") { type }
+      def ask
+        ShopifyCli::Result.wrap(ExtensionProjectDetails.new)
+          .then(&Questions::AskApp.new(ctx: ctx, api_key: api_key))
+          .then(&Questions::AskType.new(ctx: ctx, type: type))
+          .then(&Questions::AskName.new(ctx: ctx, name: name))
+          .unwrap { |e| raise e }
+          .tap do |project_details|
+            ctx.abort(ctx.message("create.incomplete_configuration")) unless project_details.complete?
+
+            self.app = project_details.app
+            self.type = project_details.type
+            self.name = project_details.name
           end
-        end
       end
 
-      def ask_with_reprompt(initial_value:, break_condition:, prompt_message:, reprompt_message:)
-        value = initial_value
-        reprompt = false
-
-        until break_condition.call(value)
-          ctx.puts(reprompt_message) if reprompt
-          value = CLI::UI::Prompt.ask(prompt_message)&.strip
-          reprompt = true
-        end
-        value
+      def directory_name
+        name.strip.gsub(/( )/, "_").downcase
       end
+
+      private
+
+      attr_writer :app
     end
   end
 end

data/lib/project_types/extension/forms/questions/ask_app.rb

@@ -0,0 +1,53 @@
+module Extension
+  module Forms
+    module Questions
+      class AskApp
+        include ShopifyCli::MethodObject
+
+        property! :ctx
+        property :api_key
+        property! :prompt,
+          converts: :to_proc,
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          project_details.tap(&method(:prompt_for_app))
+        end
+
+        private
+
+        def prompt_for_app(project_details)
+          project_details.app =
+            api_key.nil? ? choose_interactively(load_apps) : validate_app_ownership(api_key)
+        end
+
+        def validate_app_ownership(api_key)
+          found_app = Tasks::GetApp.call(context: ctx, api_key: api_key)
+          ctx.abort(ctx.message("create.invalid_api_key", api_key)) if found_app.nil?
+          found_app
+        end
+
+        def choose_interactively(apps)
+          prompt.call(ctx.message("create.ask_app")) do |handler|
+            apps.each do |app|
+              handler.option("#{app.title} by #{app.business_name}") { app }
+            end
+          end
+        end
+
+        def load_apps
+          ctx.puts(@ctx.message("create.loading_apps"))
+          apps = Tasks::GetApps.call(context: ctx)
+
+          apps.empty? ? abort_no_apps : apps
+        end
+
+        def abort_no_apps
+          ctx.puts(@ctx.message("create.no_apps"))
+          ctx.puts(@ctx.message("create.learn_about_apps"))
+          raise ShopifyCli::AbortSilent
+        end
+      end
+    end
+  end
+end