shopify-cli 2.2.2 → 2.6.0

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

@@ -43,10 +43,12 @@ module Extension
         end
 
         def choose_port?(context)
+          return true if supports_development_server?
           argo_runtime(context).supports?(:port)
         end
 
         def establish_tunnel?(context)
+          return true if supports_development_server?
           argo_runtime(context).supports?(:public_url)
         end
 
@@ -66,6 +68,8 @@ module Extension
         end
 
         def argo_runtime(context)
+          return if supports_development_server?
+
           @argo_runtime ||= Features::ArgoRuntime.find(
             cli_package: cli_package(context),
             identifier: identifier
@@ -76,7 +80,7 @@ module Extension
           cli_package_name = specification.features.argo&.cli_package_name
           return unless cli_package_name
 
-          js_system = ShopifyCli::JsSystem.new(ctx: context)
+          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
@@ -87,7 +91,7 @@ module Extension
           if (str = messages.dig(*key_parts))
             str % params
           else
-            ShopifyCli::Context.message(key, *params)
+            ShopifyCLI::Context.message(key, *params)
           end
         end
 
@@ -99,6 +103,10 @@ module Extension
           raise NotImplementedError
         end
 
+        def server_config_file
+          "shopifile.yml"
+        end
+
         protected
 
         def argo
@@ -118,6 +126,10 @@ module Extension
         def messages
           @messages ||= Messages::TYPES[identifier.downcase.to_sym] || {}
         end
+
+        def supports_development_server?
+          Models::DevelopmentServerRequirements.supported?(identifier)
+        end
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Extension
           context.root = File.join(context.root, directory_name)
 
           if getting_started
-            ShopifyCli::Git.clone("https://github.com/Shopify/theme-extension-getting-started", context.root)
+            ShopifyCLI::Git.clone("https://github.com/Shopify/theme-extension-getting-started", context.root)
             context.rm_r(".git")
           else
             FileUtils.makedirs(SUPPORTED_BUCKETS.map { |b| File.join(context.root, b) })

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

@@ -5,7 +5,7 @@ module Extension
 
       property! :custom_handler_root,
         accepts: ->(d) { File.directory?(d) },
-        default: -> { File.expand_path("lib/project_types/extension/models/specification_handlers", ShopifyCli::ROOT) }
+        default: -> { File.expand_path("lib/project_types/extension/models/specification_handlers", ShopifyCLI::ROOT) }
 
       property! :custom_handler_namespace,
         accepts: ->(m) { m.respond_to?(:const_get) },
@@ -39,9 +39,9 @@ module Extension
       private
 
       def fetch_specifications_and_build_handlers
-        ShopifyCli::Result
+        ShopifyCLI::Result
           .call(&fetch_specifications)
-          .map(&ShopifyCli::TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
+          .map(&ShopifyCLI::TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
           .then(&method(:select_cli_extensions))
           .then(&Tasks::ConfigureFeatures)
           .then(&Tasks::ConfigureOptions)
@@ -61,7 +61,7 @@ module Extension
 
       def instantiate_specification_handlers(specifications)
         specifications.each_with_object({}) do |specification, handlers|
-          ShopifyCli::ResolveConstant.call(specification.identifier, namespace: custom_handler_namespace)
+          ShopifyCLI::ResolveConstant.call(specification.identifier, namespace: custom_handler_namespace)
             .rescue { |error| error.is_a?(NameError) ? SpecificationHandlers::Default : raise(error) }
             .then { |handler_class| handler_class.new(specification) }
             .unwrap { |error| raise error }

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

@@ -5,11 +5,11 @@ require "socket"
 module Extension
   module Tasks
     class ChooseNextAvailablePort
-      include ShopifyCli::MethodObject
+      include ShopifyCLI::MethodObject
 
       property! :from
       property! :to, default: -> { from + 10 }
-      property! :host, default: "localhost"
+      property! :host, default: "127.0.0.1"
 
       def call
         available_port = port_range(from: from, to: to).find { |p| available?(host, p) }

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

@@ -1,7 +1,7 @@
 module Extension
   module Tasks
     class ConfigureFeatures
-      include ShopifyCli::MethodObject
+      include ShopifyCLI::MethodObject
 
       class Error < RuntimeError; end
       class UnknownSurfaceArea < Error; end

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

@@ -1,7 +1,7 @@
 module Extension
   module Tasks
     class ConfigureOptions
-      include ShopifyCli::MethodObject
+      include ShopifyCLI::MethodObject
 
       def call(specification_attribute_sets)
         specification_attribute_sets.each do |attributes|

data/lib/project_types/extension/tasks/converters/product_converter.rb

@@ -12,7 +12,7 @@ module Extension
           variant = hash.dig(*VARIANT_PATH)
           return unless variant
           Models::Product.new(
-            variant_id: ShopifyCli::API.gid_to_id(variant)
+            variant_id: ShopifyCLI::API.gid_to_id(variant)
           )
         end
       end

data/lib/project_types/extension/tasks/converters/server_config_converter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module Converters
+      module ServerConfigConverter
+        def self.from_hash(hash, type)
+          context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
+
+          project = ExtensionProject.current
+
+          extension = Models::ServerConfig::Extension.new(
+            uuid: project.registration_uuid,
+            type: type.upcase,
+            user: Models::ServerConfig::User.new,
+            development: Models::ServerConfig::Development.new(
+              build_dir: hash.dig("development", "build_dir"),
+              renderer: Models::ServerConfig::DevelopmentRenderer.find(type),
+              entries: Models::ServerConfig::DevelopmentEntries.new(
+                main: hash.dig("development", "entries", "main")
+              )
+            )
+          )
+
+          Models::ServerConfig::Root.new(extensions: [extension])
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Extension
   module Tasks
-    class CreateExtension < ShopifyCli::Task
+    class CreateExtension < ShopifyCLI::Task
       include UserErrors
 
       GRAPHQL_FILE = "extension_create"
@@ -20,7 +20,7 @@ module Extension
           extension_context: extension_context,
         }
 
-        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
+        response = ShopifyCLI::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
         context.abort(context.message("tasks.errors.parse_error")) if response.nil?
 
         abort_if_user_errors(context, response)

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

@@ -1,13 +1,13 @@
 module Extension
   module Tasks
     class FetchSpecifications
-      include ShopifyCli::MethodObject
+      include ShopifyCLI::MethodObject
 
       property :context
       property :api_key
 
       def call
-        response = ShopifyCli::PartnersAPI
+        response = ShopifyCLI::PartnersAPI
           .query(context, "fetch_specifications", api_key: api_key)
           .dig("data", "extensionSpecifications")
         context.abort(context.message("tasks.errors.parse_error")) if response.nil?

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

@@ -1,9 +1,9 @@
 module Extension
   module Tasks
     class FindNpmPackages
-      include ShopifyCli::MethodObject
+      include ShopifyCLI::MethodObject
 
-      property! :js_system, accepts: ShopifyCli::JsSystem
+      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)
@@ -69,7 +69,7 @@ module Extension
           raise ArgumentError, "Expected a list of package names"
         end
 
-        ShopifyCli::Result
+        ShopifyCLI::Result
           .call(&method(:list_packages))
           .then(&method(:search_packages).curry[package_names])
           .then(&method(:filter_duplicates))
@@ -84,11 +84,11 @@ module Extension
       end
 
       def yarn_list
-        production_only? ? %w[list --production] : %w[list]
+        production_only? ? %w[list --production --depth=0] : %w[list]
       end
 
       def npm_list
-        production_only? ? %w[list --prod --depth=1] : %w[list --depth=1]
+        production_only? ? %w[list --prod --depth=0] : %w[list]
       end
 
       def search_packages(packages, package_list)

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

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Extension
   module Tasks
-    class GetApp < ShopifyCli::Task
+    class GetApp < ShopifyCLI::Task
       GRAPHQL_FILE = "get_app_by_api_key"
 
       RESPONSE_FIELD = %w(data)
@@ -12,7 +12,7 @@ module Extension
       def call(context:, api_key:)
         input = { api_key: api_key }
 
-        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
+        response = ShopifyCLI::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
         context.abort(context.message("tasks.errors.parse_error")) if response.nil?
 
         Converters::AppConverter.from_hash(response.dig(APP_FIELD))

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

@@ -3,9 +3,9 @@ require "shopify_cli"
 
 module Extension
   module Tasks
-    class GetApps < ShopifyCli::Task
+    class GetApps < ShopifyCLI::Task
       def call(context:)
-        organizations = ShopifyCli::PartnersAPI::Organizations.fetch_with_app(context)
+        organizations = ShopifyCLI::PartnersAPI::Organizations.fetch_with_app(context)
         apps_from_organizations(organizations)
       end
 

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

@@ -3,9 +3,9 @@ require "shopify_cli"
 
 module Extension
   module Tasks
-    class GetExtensions < ShopifyCli::Task
+    class GetExtensions < ShopifyCLI::Task
       def call(context:, type:)
-        organizations = ShopifyCli::PartnersAPI::Organizations.fetch_with_extensions(context, type)
+        organizations = ShopifyCLI::PartnersAPI::Organizations.fetch_with_extensions(context, type)
         extensions_from_organizations(organizations, context: context)
       end
 

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

@@ -3,12 +3,12 @@ require "shopify_cli"
 
 module Extension
   module Tasks
-    class GetProduct < ShopifyCli::Task
+    class GetProduct < ShopifyCLI::Task
       API_VERSION = "2021-07"
       GRAPHQL_FILE = "get_variant_id"
 
       def call(context, shop)
-        response = ShopifyCli::AdminAPI.query(
+        response = ShopifyCLI::AdminAPI.query(
           context,
           GRAPHQL_FILE,
           shop: shop,

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require "shopify_cli"
+require "yaml"
+
+module Extension
+  module Tasks
+    class LoadServerConfig < ShopifyCLI::Task
+      include SmartProperties
+
+      class << self
+        def call(file_name:, type:)
+          config = YAML.load_file(file_name)
+          Tasks::Converters::ServerConfigConverter.from_hash(config, type)
+        rescue Psych::SyntaxError => e
+          raise(
+            ShopifyCLI::Abort,
+            ShopifyCLI::Context.message("core.yaml.error.invalid", file_name, e.message)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class RunExtensionCommand < ShopifyCLI::Task
+      include SmartProperties
+
+      SUPPORTED_EXTENSION_TYPES = [
+        "checkout_ui_extension",
+      ]
+
+      SUPPORTED_COMMANDS = [
+        "create",
+        "build",
+        "serve",
+      ]
+
+      property! :command, accepts: SUPPORTED_COMMANDS
+      property! :type, accepts: SUPPORTED_EXTENSION_TYPES
+      property :context, accepts: ShopifyCLI::Context
+      property :config_file_name, accepts: String
+      property :port, accepts: Integer, default: 39351
+      property :root_dir, accepts: String
+      property :template, accepts: Models::ServerConfig::Development::VALID_TEMPLATES
+
+      def call
+        ShopifyCLI::Result.success(config_file_exists?)
+          .then(&method(:load_or_build_server_config))
+          .then(&method(:run_command))
+          .unwrap do |error|
+            raise error unless error.nil?
+          end
+      end
+
+      private
+
+      def config_file_exists?
+        return false if config_file_name.nil?
+        project = ExtensionProject.current
+        File.exist?(File.join(project.directory, config_file_name))
+      end
+
+      def load_or_build_server_config(config_file_exists)
+        return load_server_config if config_file_exists
+        build_server_config
+      end
+
+      def load_server_config
+        Tasks::LoadServerConfig.call(
+          file_name: config_file_name,
+          type: type,
+        )
+      end
+
+      def build_server_config
+        extension = Models::ServerConfig::Extension.build(
+          template: template,
+          type: type,
+          root_dir: root_dir,
+        )
+
+        Models::ServerConfig::Root.new(port: port, extensions: [extension])
+      end
+
+      def run_command(server_config)
+        case command
+        when "create"
+          Models::DevelopmentServer.new.create(server_config)
+        when "build"
+          Models::DevelopmentServer.new.build(server_config)
+        when "serve"
+          Models::DevelopmentServer.new.serve(context, server_config)
+        else
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Extension
   module Tasks
-    class UpdateDraft < ShopifyCli::Task
+    class UpdateDraft < ShopifyCLI::Task
       include UserErrors
 
       GRAPHQL_FILE = "extension_update_draft"
@@ -18,7 +18,7 @@ module Extension
           config: JSON.generate(config),
           extension_context: extension_context,
         }
-        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
+        response = ShopifyCLI::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
         context.abort(context.message("tasks.errors.parse_error")) if response.nil?
 
         abort_if_user_errors(context, response)

data/lib/project_types/node/cli.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 module Node
-  class Project < ShopifyCli::ProjectType
+  class Project < ShopifyCLI::ProjectType
     require Project.project_filepath("messages/messages")
     register_messages(Node::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
-  class Command < ShopifyCli::ProjectCommands
+  class Command < ShopifyCLI::ProjectCommands
     subcommand :Connect, "connect", Project.project_filepath("commands/connect")
     subcommand :Create, "create", Project.project_filepath("commands/create")
     subcommand :Deploy, "deploy", Project.project_filepath("commands/deploy")
@@ -15,7 +15,7 @@ module Node
     subcommand :Serve, "serve", Project.project_filepath("commands/serve")
     subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
   end
-  ShopifyCli::Commands.register("Node::Command", "node")
+  ShopifyCLI::Commands.register("Node::Command", "node")
 
   # define/autoload project specific Tasks
   module Tasks

data/lib/project_types/node/commands/connect.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 module Node
   class Command
-    class Connect < ShopifyCli::SubCommand
+    class Connect < ShopifyCLI::SubCommand
       prerequisite_task ensure_project_type: :node
 
       def call(*)
-        if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
+        if ShopifyCLI::Project.has_current? && ShopifyCLI::Project.current.env
           @ctx.puts(@ctx.message("node.connect.production_warning"))
         end
 
-        app = ShopifyCli::Connect.new(@ctx).default_connect("node")
+        app = ShopifyCLI::Connect.new(@ctx).default_connect("node")
         @ctx.done(@ctx.message("node.connect.connected", app))
       end
 
       def self.help
-        ShopifyCli::Context.message("node.connect.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("node.connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
     end
   end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Node
   class Command
-    class Create < ShopifyCli::SubCommand
+    class Create < ShopifyCLI::SubCommand
       prerequisite_task :ensure_authenticated
 
       options do |parser, flags|
@@ -26,37 +26,37 @@ module Node
         check_npm
         build(form.name)
 
-        ShopifyCli::Project.write(
+        ShopifyCLI::Project.write(
           @ctx,
           project_type: "node",
           organization_id: form.organization_id,
         )
 
-        api_client = ShopifyCli::Tasks::CreateApiClient.call(
+        api_client = ShopifyCLI::Tasks::CreateApiClient.call(
           @ctx,
           org_id: form.organization_id,
           title: form.title,
           type: form.type,
         )
 
-        ShopifyCli::Resources::EnvFile.new(
+        ShopifyCLI::Resources::EnvFile.new(
           api_key: api_client["apiKey"],
           secret: api_client["apiSecretKeys"].first["secret"],
           shop: form.shop_domain,
           scopes: "write_products,write_customers,write_draft_orders",
         ).write(@ctx)
 
-        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"], local_debug?)
+        partners_url = ShopifyCLI::PartnersAPI.partners_url_for(form.organization_id, api_client["id"])
 
         @ctx.puts(@ctx.message("apps.create.info.created", form.title, partners_url))
-        @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCli::TOOL_NAME, "node"))
-        unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCLI::TOOL_NAME, "node"))
+        unless ShopifyCLI::Shopifolk.acting_as_shopify_organization?
           @ctx.puts(@ctx.message("apps.create.info.install", partners_url, form.title))
         end
       end
 
       def self.help
-        ShopifyCli::Context.message("node.create.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("node.create.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -101,12 +101,12 @@ module Node
       end
 
       def build(name)
-        ShopifyCli::Git.clone("https://github.com/Shopify/shopify-app-node.git", name)
+        ShopifyCLI::Git.clone("https://github.com/Shopify/shopify-app-node.git", name)
 
         @ctx.root = File.join(@ctx.root, name)
 
         set_npm_config
-        ShopifyCli::JsDeps.install(@ctx, !options.flags[:verbose].nil?)
+        ShopifyCLI::JsDeps.install(@ctx, !options.flags[:verbose].nil?)
 
         begin
           @ctx.rm_r(".git")
@@ -120,10 +120,6 @@ module Node
           @ctx.debug(e)
         end
       end
-
-      def local_debug?
-        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
-      end
     end
   end
 end

data/lib/project_types/node/commands/deploy/heroku.rb

@@ -6,12 +6,12 @@ module Node
     class Deploy
       class Heroku
         def self.help
-          ShopifyCli::Context.message("node.deploy.heroku.help", ShopifyCli::TOOL_NAME)
+          ShopifyCLI::Context.message("node.deploy.heroku.help", ShopifyCLI::TOOL_NAME)
         end
 
         def self.start(ctx)
           spin_group = CLI::UI::SpinGroup.new
-          heroku_service = ShopifyCli::Heroku.new(ctx)
+          heroku_service = ShopifyCLI::Heroku.new(ctx)
 
           spin_group.add(ctx.message("node.deploy.heroku.downloading")) do |spinner|
             heroku_service.download
@@ -29,7 +29,7 @@ module Node
           spin_group.wait
 
           spin_group.add(ctx.message("node.deploy.heroku.git.checking")) do |spinner|
-            ShopifyCli::Git.init(ctx)
+            ShopifyCLI::Git.init(ctx)
             spinner.update_title(ctx.message("node.deploy.heroku.git.initialized"))
           end
           spin_group.wait
@@ -71,7 +71,7 @@ module Node
             end
           end
 
-          branches = ShopifyCli::Git.branches(ctx)
+          branches = ShopifyCLI::Git.branches(ctx)
           if branches.length == 1
             branch_to_deploy = branches[0]
             ctx.puts(ctx.message("node.deploy.heroku.git.branch_selected", branch_to_deploy))

data/lib/project_types/node/commands/deploy.rb

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Node
   class Command
-    class Deploy < ShopifyCli::SubCommand
+    class Deploy < ShopifyCLI::SubCommand
       prerequisite_task ensure_project_type: :node
 
       autoload :Heroku, Project.project_filepath("commands/deploy/heroku")
@@ -21,11 +21,11 @@ module Node
       end
 
       def self.help
-        ShopifyCli::Context.message("node.deploy.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("node.deploy.help", ShopifyCLI::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message("node.deploy.extended_help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("node.deploy.extended_help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/project_types/node/commands/generate.rb

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Node
   class Command
-    class Generate < ShopifyCli::SubCommand
+    class Generate < ShopifyCLI::SubCommand
       prerequisite_task ensure_project_type: :node
 
       def call(*)
@@ -11,7 +11,7 @@ module Node
       end
 
       def self.help
-        ShopifyCli::Context.message("node.generate.help")
+        ShopifyCLI::Context.message("node.generate.help")
       end
 
       def self.extended_help

data/lib/project_types/node/commands/open.rb

@@ -2,16 +2,16 @@ require "shopify_cli"
 
 module Node
   class Command
-    class Open < ShopifyCli::SubCommand
+    class Open < ShopifyCLI::SubCommand
       prerequisite_task ensure_project_type: :node
 
       def call(*)
-        project = ShopifyCli::Project.current
+        project = ShopifyCLI::Project.current
         @ctx.open_url!("#{project.env.host}/auth?shop=#{project.env.shop}")
       end
 
       def self.help
-        ShopifyCli::Context.message("node.open.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("node.open.help", ShopifyCLI::TOOL_NAME)
       end
     end
   end