shopify-cli 1.4.1 → 1.8.0

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
@@ -12,9 +12,9 @@ module Extension
       def call(_args, _command_name)
         system = ShopifyCli::JsSystem.new(ctx: @ctx)
 
-        CLI::UI::Frame.open(@ctx.message('build.frame_title', system.package_manager)) do
+        CLI::UI::Frame.open(@ctx.message("build.frame_title", system.package_manager)) do
           success = system.call(yarn: YARN_BUILD_COMMAND, npm: NPM_BUILD_COMMAND)
-          @ctx.abort(@ctx.message('build.build_failure_message')) unless success
+          @ctx.abort(@ctx.message("build.build_failure_message")) unless success
         end
       end
 

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

@@ -4,24 +4,30 @@ module Extension
   module Commands
     class Create < ShopifyCli::SubCommand
       options do |parser, flags|
-        parser.on('--name=NAME') { |name| flags[:name] = name }
-        parser.on('--type=TYPE') { |type| flags[:type] = type.upcase }
+        parser.on("--name=NAME") { |name| flags[:name] = name }
+        parser.on("--type=TYPE") { |type| flags[:type] = type.upcase }
+        parser.on("--api-key=KEY") { |key| flags[:api_key] = key.downcase }
       end
 
       def call(args, _)
         with_create_form(args) do |form|
           if Dir.exist?(form.directory_name)
-            @ctx.abort(@ctx.message('create.errors.directory_exists', form.directory_name))
+            @ctx.abort(@ctx.message("create.errors.directory_exists", form.directory_name))
           end
 
           if form.type.create(form.directory_name, @ctx)
             ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
-            ExtensionProject.write_env_file(context: @ctx, title: form.name)
-
-            @ctx.puts(@ctx.message('create.ready_to_start', form.directory_name, form.name))
-            @ctx.puts(@ctx.message('create.learn_more', form.type.name))
+            ExtensionProject.write_env_file(
+              context: @ctx,
+              title: form.name,
+              api_key: form.app.api_key,
+              api_secret: form.app.secret
+            )
+
+            @ctx.puts(@ctx.message("create.ready_to_start", form.directory_name, form.name))
+            @ctx.puts(@ctx.message("create.learn_more", form.type.name))
           else
-            @ctx.puts(@ctx.message('create.try_again'))
+            @ctx.puts(@ctx.message("create.try_again"))
           end
         end
       end
@@ -29,10 +35,11 @@ module Extension
       def self.help
         <<~HELP
           Create a new app extension.
-            Usage: {{command:#{ShopifyCli::TOOL_NAME} create extension <name>}}
+            Usage: {{command:#{ShopifyCli::TOOL_NAME} create extension}}
             Options:
               {{command:--type=TYPE}} The type of extension you would like to create.
-              {{command:--name=NAME}} The name of your extension (50 characters).”
+              {{command:--name=NAME}} The name of your extension (50 characters).
+              {{command:--api-key=KEY}} The API key of your app.
         HELP
       end
 

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
@@ -10,11 +10,18 @@ module Extension
 
       def extension_type
         @extension_type ||= begin
-          unless Models::Type.valid?(project.extension_type_identifier)
-            @ctx.abort(@ctx.message('errors.unknown_type', project.extension_type_identifier))
-          end
+          identifier = project.extension_type_identifier
+          Models::LazySpecificationHandler.new(identifier) do
+            specifications = Models::Specifications.new(
+              fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: @ctx)
+            )
+
+            unless specifications.valid?(identifier)
+              @ctx.abort(@ctx.message("errors.unknown_type", project.extension_type_identifier))
+            end
 
-          Models::Type.load_type(project.extension_type_identifier)
+            specifications[identifier]
+          end
         end
       end
     end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
@@ -10,7 +10,7 @@ module Extension
         Commands::Register.new(@ctx).call(args, name) unless project.registered?
         Commands::Build.new(@ctx).call(args, name)
 
-        CLI::UI::Frame.open(@ctx.message('push.frame_title')) do
+        CLI::UI::Frame.open(@ctx.message("push.frame_title")) do
           updated_draft_version = update_draft
           show_message(updated_draft_version)
         end
@@ -30,18 +30,18 @@ module Extension
       end
 
       def output_success_messages(draft)
-        @ctx.puts(@ctx.message('push.success_confirmation', project.title, format_time(draft.last_user_interaction_at)))
-        @ctx.puts(@ctx.message('push.success_info', draft.location))
+        @ctx.puts(@ctx.message("push.success_confirmation", project.title, format_time(draft.last_user_interaction_at)))
+        @ctx.puts(@ctx.message("push.success_info", draft.location))
       end
 
       def output_validation_errors(draft)
-        @ctx.puts(@ctx.message('push.pushed_with_errors', format_time(draft.last_user_interaction_at)))
+        @ctx.puts(@ctx.message("push.pushed_with_errors", format_time(draft.last_user_interaction_at)))
 
         draft.validation_errors.each do |error|
-          @ctx.puts(format('{{x}} %s: %s', error.field.last, error.message))
+          @ctx.puts(format("{{x}} %s: %s", error.field.last, error.message))
         end
 
-        @ctx.puts(@ctx.message('push.push_with_errors_info'))
+        @ctx.puts(@ctx.message("push.push_with_errors_info"))
       end
 
       def format_time(time)
@@ -49,7 +49,7 @@ module Extension
       end
 
       def with_waiting_text
-        @ctx.puts(@ctx.message('push.waiting_text'))
+        @ctx.puts(@ctx.message("push.waiting_text"))
         yield
       end
 

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

@@ -3,23 +3,17 @@
 module Extension
   module Commands
     class Register < ExtensionCommand
-      options do |parser, flags|
-        parser.on('--api_key=KEY') { |key| flags[:api_key] = key.downcase }
-      end
-
-      def call(args, _command_name)
-        CLI::UI::Frame.open(@ctx.message('register.frame_title')) do
-          @ctx.abort(@ctx.message('register.already_registered')) if project.registered?
+      def call(_args, _command_name)
+        CLI::UI::Frame.open(@ctx.message("register.frame_title")) do
+          @ctx.abort(@ctx.message("register.already_registered")) if project.registered?
 
-          with_register_form(args) do |form|
-            should_continue = confirm_registration(form.app)
-            registration = should_continue ? register_extension(form.app) : abort_not_registered
+          should_continue = confirm_registration
+          registration = should_continue ? register_extension : abort_not_registered
 
-            update_project_files(form.app, registration)
+          update_project_files(registration)
 
-            @ctx.puts(@ctx.message('register.success', project.title, form.app.title))
-            @ctx.puts(@ctx.message('register.success_info'))
-          end
+          @ctx.puts(@ctx.message("register.success", project.title))
+          @ctx.puts(@ctx.message("register.success_info"))
         end
       end
 
@@ -27,27 +21,18 @@ module Extension
         <<~HELP
           Register your local extension to a Shopify app
               Usage: {{command:#{ShopifyCli::TOOL_NAME} register}}
-              Options:
-                {{command:--api_key=API_KEY}} The API key used to register an app with the extension. This can be found on the app page on Partners Dashboard.
         HELP
       end
 
       private
 
-      def with_register_form(args)
-        form = Forms::Register.ask(@ctx, args, options.flags)
-        return @ctx.puts(self.class.help) if form.nil?
-
-        yield form
+      def confirm_registration
+        @ctx.puts(@ctx.message("register.confirm_info", extension_type.name))
+        CLI::UI::Prompt.confirm(@ctx.message("register.confirm_question"))
       end
 
-      def confirm_registration(app)
-        @ctx.puts(@ctx.message('register.confirm_info', extension_type.name))
-        CLI::UI::Prompt.confirm(@ctx.message('register.confirm_question', app.title))
-      end
-
-      def register_extension(app)
-        @ctx.puts(@ctx.message('register.waiting_text'))
+      def register_extension
+        @ctx.puts(@ctx.message("register.waiting_text"))
 
         Tasks::CreateExtension.call(
           context: @ctx,
@@ -59,7 +44,7 @@ module Extension
         )
       end
 
-      def update_project_files(app, registration)
+      def update_project_files(registration)
         ExtensionProject.write_env_file(
           context: @ctx,
           api_key: app.api_key,
@@ -69,8 +54,12 @@ module Extension
         )
       end
 
+      def app
+        @app ||= project.app
+      end
+
       def abort_not_registered
-        @ctx.puts(@ctx.message('register.confirm_abort'))
+        @ctx.puts(@ctx.message("register.confirm_abort"))
         raise ShopifyCli::AbortSilent
       end
     end

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

@@ -7,9 +7,22 @@ module Extension
       NPM_SERVE_COMMAND = %w(run-script server)
 
       def call(_args, _command_name)
-        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
+        if argo_admin?
+          ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
+          ShopifyCli::Tasks::EnsureDevStore.call(@ctx)
+          validate_env
+        end
+
+        CLI::UI::Frame.open(@ctx.message("serve.frame_title")) do
+          yarn_serve_command = YARN_SERVE_COMMAND
+          npm_serve_command = NPM_SERVE_COMMAND
+          if argo_admin?
+            serve_args = %W(--shop=#{project.env.shop} --apiKey=#{project.env.api_key})
+            yarn_serve_command += serve_args
+            npm_serve_command += %w(--) + serve_args
+          end
+          success = ShopifyCli::JsSystem.call(@ctx, yarn: yarn_serve_command, npm: npm_serve_command)
+          @ctx.abort(@ctx.message("serve.serve_failure_message")) unless success
         end
       end
 
@@ -19,6 +32,21 @@ module Extension
             Usage: {{command:#{ShopifyCli::TOOL_NAME} serve}}
         HELP
       end
+
+      private
+
+      def argo_admin?
+        ShopifyCli::Shopifolk.check &&
+          ShopifyCli::Feature.enabled?(:argo_admin_beta) &&
+          extension_type.specification.features&.argo&.surface == "admin"
+      end
+
+      def validate_env
+        ExtensionProject.reload
+        @ctx.abort(@ctx.message("serve.serve_missing_information")) if
+          project.env.shop.nil? || project.env.api_key.nil? ||
+          project.env.shop.strip.empty? || project.env.api_key.strip.empty?
+      end
     end
   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,
@@ -23,6 +23,10 @@ module Extension
           }.compact
         ).write(context)
 
+        reload
+      end
+
+      def reload
         current.reload unless project_empty?
       end
 
@@ -34,11 +38,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