shopify-cli 2.2.1 → 2.5.0

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

@@ -11,7 +11,7 @@ module Extension
       def call(context, identifier, directory_name, js_system)
         step_result = step.call(context, identifier, directory_name, js_system)
         can_fail? ? step_result : true
-      rescue ShopifyCli::Abort => e
+      rescue ShopifyCLI::Abort => e
         context.puts(e.message)
         false
       rescue StandardError => e

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

@@ -18,7 +18,7 @@ module Extension
       def self.clone_template(git_template)
         ArgoSetupStep.default do |context, _identifier, directory_name, _js_system|
           begin
-            ShopifyCli::Git.clone(git_template, directory_name, ctx: context)
+            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.")
@@ -28,7 +28,7 @@ module Extension
 
       def self.install_dependencies
         ArgoSetupStep.default do |context, _identifier, _directory_name, js_system|
-          ShopifyCli::JsDeps.new(ctx: context, system: js_system).install
+          ShopifyCLI::JsDeps.new(ctx: context, system: js_system).install
         end
       end
 

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

@@ -2,7 +2,7 @@
 
 module Extension
   module Forms
-    class Connect < ShopifyCli::Form
+    class Connect < ShopifyCLI::Form
       attr_reader :registration, :app
 
       flag_arguments :type
@@ -19,7 +19,7 @@ module Extension
       end
 
       def ask
-        ShopifyCli::Result.wrap(ExtensionProjectDetails.new)
+        ShopifyCLI::Result.wrap(ExtensionProjectDetails.new)
           .then(&Questions::AskRegistration.new(ctx: ctx, type: type))
           .unwrap { |e| raise e }
           .tap do |project_details|

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

@@ -2,8 +2,8 @@
 
 module Extension
   module Forms
-    class Create < ShopifyCli::Form
-      flag_arguments :name, :type, :api_key
+    class Create < ShopifyCLI::Form
+      flag_arguments :name, :type, :api_key, :template
 
       attr_reader :app
 
@@ -13,6 +13,7 @@ module Extension
         property :app, accepts: Models::App
         property :name, accepts: String
         property :type, accepts: Models::SpecificationHandlers::Default
+        property :template, accepts: String
 
         def complete?
           !!(app && name && type)
@@ -20,9 +21,10 @@ module Extension
       end
 
       def ask
-        ShopifyCli::Result.wrap(ExtensionProjectDetails.new)
+        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::AskTemplate.new(ctx: ctx))
           .then(&Questions::AskName.new(ctx: ctx, name: name))
           .unwrap { |e| raise e }
           .tap do |project_details|
@@ -30,6 +32,7 @@ module Extension
 
             self.app = project_details.app
             self.type = project_details.type
+            self.template = project_details.template
             self.name = project_details.name
           end
       end

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

@@ -2,7 +2,7 @@ module Extension
   module Forms
     module Questions
       class AskApp
-        include ShopifyCli::MethodObject
+        include ShopifyCLI::MethodObject
 
         property! :ctx
         property :api_key
@@ -45,7 +45,7 @@ module Extension
         def abort_no_apps
           ctx.puts(@ctx.message("create.no_apps"))
           ctx.puts(@ctx.message("create.learn_about_apps"))
-          raise ShopifyCli::AbortSilent
+          raise ShopifyCLI::AbortSilent
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Extension
   module Forms
     module Questions
       class AskName
-        include ShopifyCli::MethodObject
+        include ShopifyCLI::MethodObject
 
         property! :ctx
         property :name

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

@@ -4,7 +4,7 @@ module Extension
   module Forms
     module Questions
       class AskRegistration
-        include ShopifyCli::MethodObject
+        include ShopifyCLI::MethodObject
 
         property! :ctx
         property! :type
@@ -43,7 +43,7 @@ module Extension
         def abort_no_registrations
           ctx.puts(@ctx.message("connect.no_extensions", type))
           ctx.puts(@ctx.message("connect.learn_about_extensions"))
-          raise ShopifyCli::AbortSilent
+          raise ShopifyCLI::AbortSilent
         end
       end
     end

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

@@ -0,0 +1,44 @@
+module Extension
+  module Forms
+    module Questions
+      class AskTemplate
+        include ShopifyCLI::MethodObject
+
+        TEMPLATE_REQUIRED_TYPES = [
+          "checkout_ui_extension",
+        ]
+
+        property! :ctx
+        property :prompt,
+          accepts: ->(prompt) { prompt.respond_to?(:call) },
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          return project_details unless template_required?(project_details)
+          project_details.template = choose_interactively
+          project_details
+        end
+
+        private
+
+        def template_required?(project_details)
+          return false unless extension_server_beta?
+          type = project_details&.type&.identifier
+          TEMPLATE_REQUIRED_TYPES.include?(type.downcase)
+        end
+
+        def extension_server_beta?
+          ShopifyCLI::Shopifolk.check && ShopifyCLI::Feature.enabled?(:extension_server_beta)
+        end
+
+        def choose_interactively
+          prompt.call(ctx.message("create.ask_template")) do |handler|
+            Models::ServerConfig::Development::VALID_TEMPLATES.each do |template|
+              handler.option(template) { template }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module Extension
   module Forms
     module Questions
       class AskType
-        include ShopifyCli::MethodObject
+        include ShopifyCLI::MethodObject
 
         property! :ctx
         property :type
@@ -39,7 +39,7 @@ module Extension
 
         def abort_due_to_missing_specifications
           ctx.puts(@ctx.message("create.no_available_extensions"))
-          raise ShopifyCli::AbortSilent
+          raise ShopifyCLI::AbortSilent
         end
       end
     end

data/lib/project_types/extension/messages/message_loading.rb

@@ -15,9 +15,9 @@ module Extension
       end
 
       def self.load_current_type_messages
-        return unless ShopifyCli::Project.has_current?
+        return unless ShopifyCLI::Project.has_current?
         messages_for_type(
-          ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
+          ShopifyCLI::Project.current.config[Extension::ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
         )
       end
 

data/lib/project_types/extension/messages/messages.rb

@@ -45,6 +45,7 @@ module Extension
           "or try creating a new app using {{command:shopify [node|rails] create}}.",
         loading_apps: "Loading your apps…",
         no_available_extensions: "{{x}} There are no available extensions for this app.",
+        ask_template: "Select a template to use for your extension",
       },
       connect: {
         connected: "Project now connected to {{green:%s: %s}}",
@@ -67,6 +68,8 @@ module Extension
         HELP
         frame_title: "Building extension with: %s…",
         build_failure_message: "Failed to build extension code.",
+        build_success_message: "Build was successful!",
+        directory_not_found: "Build directory not found.",
       },
       register: {
         help: <<~HELP,

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    class DevelopmentServer
+      class DevelopmentServerError < StandardError; end
+
+      include SmartProperties
+
+      EXECUTABLE_DIRECTORY = File.join(ShopifyCLI::ROOT, "ext", "shopify-extensions")
+
+      property :executable, converts: :to_s
+
+      def executable
+        super || begin
+          case RbConfig::CONFIG.fetch("host_os")
+          when /(linux)|(darwin)/
+            File.join(EXECUTABLE_DIRECTORY, "shopify-extensions")
+          else
+            File.join(EXECUTABLE_DIRECTORY, "shopify-extensions.exe")
+          end
+        end
+      end
+
+      def create(server_config)
+        CLI::Kit::System.capture3(executable, "create", "-", stdin_data: server_config.to_yaml)
+      rescue StandardError => error
+        raise error
+      end
+
+      def build(server_config)
+        _, error, status = CLI::Kit::System.capture3(executable, "build", "-", stdin_data: server_config.to_yaml)
+        return if status.success?
+        raise DevelopmentServerError, error
+      end
+
+      def serve(context, server_config)
+        CLI::Kit::System.popen3(executable, "serve", "-") do |input, out, err, status|
+          context.puts("Sending configuration data …")
+          input << server_config.to_yaml
+          input.close
+
+          forward_output_to_user(out, err, context)
+
+          status.value
+        end
+      end
+
+      def version
+        raise NotImplementedError
+      end
+
+      private
+
+      def forward_output_to_user(out, err, ctx)
+        ctx.puts("Starting monitoring threads …")
+
+        Thread.new do
+          ctx.puts("Ready to process standard output")
+          while (line = out.gets)
+            ctx.puts(line)
+          end
+        end
+
+        Thread.new do
+          ctx.puts("Ready to process standard error")
+          while (error = err.gets)
+            ctx.puts(error)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Models
+    class DevelopmentServerRequirements
+      SUPPORTED_EXTENSION_TYPES = [
+        "checkout_ui_extension",
+      ]
+
+      UNIX_NAME = "shopify-extensions"
+      WINDOWS_NAME = "shopify-extensions.exe"
+
+      class << self
+        def supported?(type)
+          binary_installed? && type_supported?(type) && beta_enabled?
+        end
+
+        private
+
+        def binary_installed?
+          extension_dir = File.join(ShopifyCLI::ROOT, "ext", "shopify-extensions")
+          File.exist?(File.join(extension_dir, UNIX_NAME)) || File.exist?(File.join(extension_dir, WINDOWS_NAME))
+        end
+
+        def type_supported?(type)
+          SUPPORTED_EXTENSION_TYPES.include?(type.downcase)
+        end
+
+        def beta_enabled?
+          ShopifyCLI::Shopifolk.check && ShopifyCLI::Feature.enabled?(:extension_server_beta)
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 module Extension
   module Models
-    class LazySpecificationHandler < ShopifyCli::LazyDelegator
+    class LazySpecificationHandler < ShopifyCLI::LazyDelegator
       attr_reader :identifier
 
       def initialize(identifier, &specification_handler_initializer)

data/lib/project_types/extension/models/server_config/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class Base
+        def to_h
+          to_hash
+        end
+
+        def to_hash
+          is_hashable = ->(obj) { obj.respond_to?(:to_hash) }
+          is_collection_of_hashables = ->(obj) { obj.is_a?(Enumerable) && obj.all?(&is_hashable) }
+
+          self.class.properties.each.reduce({}) do |data, (_, property)|
+            data.merge(property.name.to_s => send(property.reader).yield_self do |value|
+              case value
+              when is_collection_of_hashables
+                value.map { |element| element.to_hash.transform_keys(&:to_s) }
+              when is_hashable
+                value.to_hash.transform_keys(&:to_s)
+              else
+                value
+              end
+            end)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/development.rb

@@ -0,0 +1,23 @@
+module Extension
+  module Models
+    module ServerConfig
+      class Development < Base
+        include SmartProperties
+        VALID_TEMPLATES = [
+          "javascript",
+          "javascript-react",
+          "typescript",
+          "typescript-react",
+        ]
+
+        CURRENT_DIRECTORY = "."
+
+        property :root_dir, accepts: String, default: CURRENT_DIRECTORY
+        property! :build_dir, accepts: String, default: "build"
+        property :template, accepts: VALID_TEMPLATES
+        property :renderer, accepts: ServerConfig::DevelopmentRenderer
+        property :entries, accepts: ServerConfig::DevelopmentEntries
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/development_entries.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class DevelopmentEntries < Base
+        include SmartProperties
+
+        JAVASCRIPT = "javascript"
+        JAVASCRIPT_REACT = "javascript-react"
+        TYPESCRIPT = "typescript"
+        TYPESCRIPT_REACT = "typescript-react"
+
+        VALID_ENTRY_POINTS = [
+          "src/index.js",
+          "src/index.jsx",
+          "src/index.ts",
+          "src/index.tsx",
+        ]
+
+        property! :main, accepts: VALID_ENTRY_POINTS
+
+        def self.find(template)
+          case template
+          when JAVASCRIPT
+            new(main: "src/index.js")
+          when JAVASCRIPT_REACT
+            new(main: "src/index.jsx")
+          when TYPESCRIPT
+            new(main: "src/index.ts")
+          when TYPESCRIPT_REACT
+            new(main: "src/index.tsx")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/development_renderer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class DevelopmentRenderer < Base
+        include SmartProperties
+
+        VALID_RENDERERS = [
+          "@shopify/admin-ui-extensions",
+          "@shopify/post-purchase-ui-extensions",
+          "@shopify/checkout-ui-extensions",
+        ]
+
+        property! :name, accepts: VALID_RENDERERS
+
+        def self.find(type)
+          case type.downcase
+          when "admin_ui_extension"
+            new(name: "@shopify/admin-ui-extensions")
+          when "checkout_ui_extension"
+            new(name: "@shopify/checkout-ui-extensions")
+          when "checkout_post_purchase"
+            new(name: "@shopify/post-purchase-ui-extensions")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require "securerandom"
+
+module Extension
+  module Models
+    module ServerConfig
+      class Extension < Base
+        include SmartProperties
+        property! :uuid, accepts: String
+        property! :type, accepts: String
+        property! :user, accepts: ServerConfig::User
+        property! :development, accepts: ServerConfig::Development
+
+        def self.build(uuid: "", template:, type:, root_dir:)
+          renderer = ServerConfig::DevelopmentRenderer.find(type)
+          entry = ServerConfig::DevelopmentEntries.find(template)
+          new(
+            uuid: uuid.empty? ? generate_dev_uuid : uuid,
+            type: type.downcase,
+            user: ServerConfig::User.new,
+            development: ServerConfig::Development.new(
+              root_dir: root_dir,
+              template: template,
+              renderer: renderer,
+              entries: entry
+            )
+          )
+        end
+
+        def self.generate_dev_uuid
+          "dev-#{SecureRandom.uuid}"
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/root.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class Root < Base
+        include SmartProperties
+
+        property! :port, accepts: Integer, default: 39351
+        property! :extensions, accepts: Array, default: -> { [] }
+
+        def to_yaml
+          to_h.to_yaml.gsub("---\n", "")
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/user.rb

@@ -0,0 +1,10 @@
+module Extension
+  module Models
+    module ServerConfig
+      class User < Base
+        include SmartProperties
+        property! :metafields, accepts: Array, default: -> { [] }
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module Extension
         def self.build(feature_set_attributes)
           feature_set_attributes.each_with_object(OpenStruct.new) do |(identifier, feature_attributes), feature_set|
             next if feature_attributes.nil?
-            feature_set[identifier] = ShopifyCli::ResolveConstant
+            feature_set[identifier] = ShopifyCLI::ResolveConstant
               .call(identifier, namespace: Features)
               .rescue { OpenStruct }
               .then { |c| c.new(**feature_attributes) }

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

@@ -4,7 +4,7 @@ module Extension
   module Models
     module SpecificationHandlers
       class CheckoutUiExtension < Default
-        PERMITTED_CONFIG_KEYS = [:metafields, :extension_points]
+        PERMITTED_CONFIG_KEYS = [:extension_points, :metafields, :name]
 
         def config(context)
           {

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
 
@@ -118,6 +122,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) }