shopify-cli 1.6.0 → 1.9.1

data/lib/graphql/fetch_specifications.graphql

@@ -0,0 +1,14 @@
+query fetchSpecifications($api_key: String!) {
+  extensionSpecifications(apiKey: $api_key) {
+    name
+    identifier
+    options {
+      managementExperience
+    }
+    features {
+      argo {
+        surface
+      }
+    }
+  }
+}

data/lib/project_types/extension/cli.rb

@@ -1,87 +1,88 @@
 # frozen_string_literal: true
 
 module Extension
+  class PackageNotFound < RuntimeError; end
+
   class Project < ShopifyCli::ProjectType
     hidden_feature
-    title('App Extension')
-    creator('Extension::Commands::Create')
+    title("App Extension")
+    creator("Extension::Commands::Create")
 
-    register_command('Extension::Commands::Build', "build")
-    register_command('Extension::Commands::Register', "register")
-    register_command('Extension::Commands::Push', "push")
-    register_command('Extension::Commands::Serve', "serve")
-    register_command('Extension::Commands::Tunnel', "tunnel")
+    register_command("Extension::Commands::Build", "build")
+    register_command("Extension::Commands::Register", "register")
+    register_command("Extension::Commands::Push", "push")
+    register_command("Extension::Commands::Serve", "serve")
+    register_command("Extension::Commands::Tunnel", "tunnel")
 
-    require Project.project_filepath('messages/messages')
-    require Project.project_filepath('messages/message_loading')
-    require Project.project_filepath('extension_project_keys')
+    require Project.project_filepath("messages/messages")
+    require Project.project_filepath("messages/message_loading")
+    require Project.project_filepath("extension_project_keys")
     register_messages(Extension::Messages::MessageLoading.load)
   end
 
   module Commands
-    autoload :ExtensionCommand, Project.project_filepath('commands/extension_command')
-    autoload :Create, Project.project_filepath('commands/create')
-    autoload :Register, Project.project_filepath('commands/register')
-    autoload :Build, Project.project_filepath('commands/build')
-    autoload :Serve, Project.project_filepath('commands/serve')
-    autoload :Push, Project.project_filepath('commands/push')
-    autoload :Tunnel, Project.project_filepath('commands/tunnel')
+    autoload :ExtensionCommand, Project.project_filepath("commands/extension_command")
+    autoload :Create, Project.project_filepath("commands/create")
+    autoload :Register, Project.project_filepath("commands/register")
+    autoload :Build, Project.project_filepath("commands/build")
+    autoload :Serve, Project.project_filepath("commands/serve")
+    autoload :Push, Project.project_filepath("commands/push")
+    autoload :Tunnel, Project.project_filepath("commands/tunnel")
   end
 
   module Tasks
-    autoload :UserErrors, Project.project_filepath('tasks/user_errors')
-    autoload :GetApps, Project.project_filepath('tasks/get_apps')
-    autoload :GetApp, Project.project_filepath('tasks/get_app')
-    autoload :CreateExtension, Project.project_filepath('tasks/create_extension')
-    autoload :UpdateDraft, Project.project_filepath('tasks/update_draft')
-    autoload :FetchSpecifications, Project.project_filepath('tasks/fetch_specifications')
-    autoload :ConfigureFeatures, Project.project_filepath('tasks/configure_features')
+    autoload :UserErrors, Project.project_filepath("tasks/user_errors")
+    autoload :GetApps, Project.project_filepath("tasks/get_apps")
+    autoload :GetApp, Project.project_filepath("tasks/get_app")
+    autoload :CreateExtension, Project.project_filepath("tasks/create_extension")
+    autoload :UpdateDraft, Project.project_filepath("tasks/update_draft")
+    autoload :FetchSpecifications, Project.project_filepath("tasks/fetch_specifications")
+    autoload :ConfigureFeatures, Project.project_filepath("tasks/configure_features")
 
     module Converters
-      autoload :RegistrationConverter, Project.project_filepath('tasks/converters/registration_converter')
-      autoload :VersionConverter, Project.project_filepath('tasks/converters/version_converter')
-      autoload :ValidationErrorConverter, Project.project_filepath('tasks/converters/validation_error_converter')
-      autoload :AppConverter, Project.project_filepath('tasks/converters/app_converter')
+      autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
+      autoload :VersionConverter, Project.project_filepath("tasks/converters/version_converter")
+      autoload :ValidationErrorConverter, Project.project_filepath("tasks/converters/validation_error_converter")
+      autoload :AppConverter, Project.project_filepath("tasks/converters/app_converter")
     end
   end
 
   module Forms
-    autoload :Create, Project.project_filepath('forms/create')
-    autoload :Register, Project.project_filepath('forms/register')
+    module Questions
+      autoload :AskApp, Project.project_filepath("forms/questions/ask_app")
+      autoload :AskName, Project.project_filepath("forms/questions/ask_name")
+      autoload :AskType, Project.project_filepath("forms/questions/ask_type")
+    end
+
+    autoload :Create, Project.project_filepath("forms/create")
+    autoload :Register, Project.project_filepath("forms/register")
   end
 
   module Features
-    autoload :ArgoSetup, Project.project_filepath('features/argo_setup')
-    autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
-    autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
-    autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
-    autoload :ArgoConfig, Project.project_filepath('features/argo_config')
-    autoload :Argo, Project.project_filepath('features/argo')
+    autoload :ArgoRendererPackage, Project.project_filepath("features/argo_renderer_package")
+    autoload :ArgoServe, Project.project_filepath("features/argo_serve")
+    autoload :ArgoSetup, Project.project_filepath("features/argo_setup")
+    autoload :ArgoSetupStep, Project.project_filepath("features/argo_setup_step")
+    autoload :ArgoSetupSteps, Project.project_filepath("features/argo_setup_steps")
+    autoload :ArgoDependencies, Project.project_filepath("features/argo_dependencies")
+    autoload :ArgoConfig, Project.project_filepath("features/argo_config")
+    autoload :Argo, Project.project_filepath("features/argo")
   end
 
   module Models
     module SpecificationHandlers
-      autoload :Default, Project.project_filepath('models/specification_handlers/default')
+      autoload :Default, Project.project_filepath("models/specification_handlers/default")
     end
 
-    autoload :App, Project.project_filepath('models/app')
-    autoload :Registration, Project.project_filepath('models/registration')
-    autoload :Version, Project.project_filepath('models/version')
-    autoload :ValidationError, Project.project_filepath('models/validation_error')
-    autoload :Specification, Project.project_filepath('models/specification')
-    autoload :Specifications, Project.project_filepath('models/specifications')
+    autoload :App, Project.project_filepath("models/app")
+    autoload :Registration, Project.project_filepath("models/registration")
+    autoload :Version, Project.project_filepath("models/version")
+    autoload :ValidationError, Project.project_filepath("models/validation_error")
+    autoload :Specification, Project.project_filepath("models/specification")
+    autoload :Specifications, Project.project_filepath("models/specifications")
+    autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
   end
 
-  autoload :ExtensionProjectKeys, Project.project_filepath('extension_project_keys')
-  autoload :ExtensionProject, Project.project_filepath('extension_project')
-
-  def self.specifications
-    @specifications ||= Models::Specifications.new(
-      fetch_specifications: Tasks::FetchSpecifications
-    )
-  end
-
-  def self.specifications=(specifications)
-    @specifications = specifications
-  end
+  autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")
+  autoload :ExtensionProject, Project.project_filepath("extension_project")
 end

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
@@ -8,13 +8,20 @@ module Extension
         @project ||= ExtensionProject.current
       end
 
-      def extension_type
-        @extension_type ||= begin
-          unless Extension.specifications.valid?(project.extension_type_identifier)
-            @ctx.abort(@ctx.message('errors.unknown_type', project.extension_type_identifier))
-          end
+      def specification_handler
+        @specification_handler ||= begin
+          identifier = project.specification_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.specification_identifier))
+            end
 
-          Extension.specifications[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
 
@@ -59,8 +59,8 @@ module Extension
             context: @ctx,
             api_key: project.app.api_key,
             registration_id: project.registration_id,
-            config: extension_type.config(@ctx),
-            extension_context: extension_type.extension_context(@ctx)
+            config: specification_handler.config(@ctx),
+            extension_context: specification_handler.extension_context(@ctx)
           )
         end
       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,50 +21,46 @@ 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", specification_handler.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,
           api_key: app.api_key,
-          type: extension_type.graphql_identifier,
+          type: specification_handler.graphql_identifier,
           title: project.title,
           config: {},
-          extension_context: extension_type.extension_context(@ctx)
+          extension_context: specification_handler.extension_context(@ctx)
         )
       end
 
-      def update_project_files(app, registration)
+      def update_project_files(registration)
         ExtensionProject.write_env_file(
           context: @ctx,
           api_key: app.api_key,
           api_secret: app.secret,
           registration_id: registration.id,
+          registration_uuid: registration.uuid,
           title: project.title
         )
       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

@@ -3,14 +3,8 @@
 module Extension
   module Commands
     class Serve < ExtensionCommand
-      YARN_SERVE_COMMAND = %w(server)
-      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
-        end
+        specification_handler.serve(@ctx)
       end
 
       def self.help

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)