shopify-cli 2.2.2 → 2.6.0

data/ext/shopify-cli/extconf.rb

@@ -1,5 +1,6 @@
 require "rbconfig"
 require "fileutils"
+require "date"
 
 gem = File.expand_path("../../../", __FILE__)
 exe = File.join(gem, "bin", "shopify")
@@ -56,4 +57,5 @@ else
   MAKEFILE
 end
 
+File.write(installation_date_path, Time.now.to_i.to_s)
 File.write("Makefile", makefile_content)

data/ext/shopify-extensions/extconf.rb

@@ -0,0 +1,21 @@
+require_relative "./shopify_extensions"
+
+installation_dir = ENV.fetch("SHOPIFY_CLI_EXTENSIONS_INSTALLATION_DIR", __dir__)
+
+File.write(File.expand_path("Makefile", installation_dir), <<~MAKEFILE)
+  .PHONY: clean
+
+  clean: ;
+
+  install: ;
+MAKEFILE
+
+begin
+  ShopifyExtensions.install(
+    target: File.expand_path("shopify-extensions", installation_dir)
+  )
+rescue ShopifyExtensions::InstallationError => error
+  STDERR.puts(error.message)
+rescue => error
+  STDERR.puts("Unable to install shopify-extensions: #{error}")
+end

data/ext/shopify-extensions/shopify_extensions.rb

@@ -0,0 +1,152 @@
+require "rbconfig"
+require "open-uri"
+require "zlib"
+require "open3"
+
+module ShopifyExtensions
+  def self.install(**args)
+    Install.call(**args)
+  end
+
+  class Install
+    def self.call(platform: Platform.new, **args)
+      new.call(platform: platform, **args)
+    end
+
+    def self.version
+      File.read(File.expand_path("../version", __FILE__)).strip
+    end
+
+    def call(platform:, version: self.class.version, target:)
+      target = platform.format_path(target.to_s)
+
+      asset = Asset.new(
+        platform: platform,
+        version: version,
+        owner: "Shopify",
+        repository: "shopify-cli-extensions",
+        basename: "shopify-extensions"
+      )
+      downloaded = asset.download(target: target)
+      raise InstallationError.asset_not_found(platform: platform, version: version) unless downloaded
+
+      raise InstallationError.installation_failed unless verify(target, version: version)
+    end
+
+    private
+
+    def fetch_release_details_for(version:)
+      JSON.parse(URI.parse(release_url_for(version: version)).open.read).yield_self(&Release)
+    rescue OpenURI::HTTPError
+      nil
+    end
+
+    def verify(target, version:)
+      return false unless File.executable?(target)
+      installed_server_version, exit_code = Open3.capture2(target, "version")
+      return false unless exit_code == 0
+      return false unless installed_server_version.strip == version.strip
+      true
+    end
+  end
+
+  class InstallationError < RuntimeError
+    def self.installation_failed
+      new("Failed to install shopify-extensions properly")
+    end
+
+    def self.asset_not_found(platform:, version:)
+      new(format(
+        "Unable to download shopify-extensions %{version} for %{os} (%{cpu})",
+        version: version,
+        os: platform.os,
+        cpu: platform.cpu
+      ))
+    end
+  end
+
+  Asset = Struct.new(:platform, :version, :owner, :repository, :basename, keyword_init: true) do
+    def download(target:)
+      Dir.chdir(File.dirname(target)) do
+        File.open(File.basename(target), "wb") do |target_file|
+          decompress(url.open, target_file)
+        end
+        File.chmod(0755, target)
+      end
+
+      true
+    rescue OpenURI::HTTPError
+      false
+    end
+
+    def url
+      URI.parse(format(
+        "https://github.com/%{owner}/%{repository}/releases/download/%{version}/%{filename}",
+        owner: owner,
+        repository: repository,
+        version: version,
+        filename: filename
+      ))
+    end
+
+    def filename
+      format(
+        "%{basename}-%{os}-%{cpu}.%{extension}",
+        basename: basename,
+        os: platform.os,
+        cpu: platform.cpu,
+        extension: platform.os == "windows" ? "exe.gz" : "gz"
+      )
+    end
+
+    private
+
+    def decompress(source, target)
+      zlib = Zlib::GzipReader.new(source)
+      target << zlib.read
+    ensure
+      zlib.close
+    end
+  end
+
+  Platform = Struct.new(:ruby_config) do
+    def initialize(ruby_config = RbConfig::CONFIG)
+      super(ruby_config)
+    end
+
+    def format_path(path)
+      case os
+      when "windows"
+        File.extname(path) != ".exe" ? path + ".exe" : path
+      else
+        path
+      end
+    end
+
+    def to_s
+      format("%{os}-%{cpu}", os: os, cpu: cpu)
+    end
+
+    def os
+      case ruby_config.fetch("host_os")
+      when /linux/
+        "linux"
+      when /darwin/
+        "darwin"
+      else
+        "windows"
+      end
+    end
+
+    def cpu
+      case ruby_config.fetch("host_cpu")
+      when /arm.*64/
+        "arm64"
+      when /64/
+        "amd64"
+      else
+        "386"
+      end
+    end
+  end
+end

data/ext/shopify-extensions/version

@@ -0,0 +1 @@
+v0.1.0

data/lib/project_types/extension/cli.rb

@@ -3,7 +3,7 @@
 module Extension
   class PackageResolutionFailed < RuntimeError; end
 
-  class Project < ShopifyCli::ProjectType
+  class Project < ShopifyCLI::ProjectType
     hidden_feature
 
     require Project.project_filepath("messages/messages")
@@ -12,7 +12,7 @@ module Extension
     register_messages(Extension::Messages::MessageLoading.load)
   end
 
-  class Command < ShopifyCli::ProjectCommands
+  class Command < ShopifyCLI::ProjectCommands
     hidden_feature
     autoload :ExtensionCommand, Project.project_filepath("commands/extension_command")
 
@@ -26,7 +26,7 @@ module Extension
     subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
     subcommand :Check, "check", Project.project_filepath("commands/check")
   end
-  ShopifyCli::Commands.register("Extension::Command", "extension")
+  ShopifyCLI::Commands.register("Extension::Command", "extension")
 
   module Tasks
     autoload :UserErrors, Project.project_filepath("tasks/user_errors")
@@ -41,6 +41,8 @@ module Extension
     autoload :FindNpmPackages, Project.project_filepath("tasks/find_npm_packages")
     autoload :GetExtensions, Project.project_filepath("tasks/get_extensions")
     autoload :GetProduct, Project.project_filepath("tasks/get_product")
+    autoload :RunExtensionCommand, Project.project_filepath("tasks/run_extension_command")
+    autoload :LoadServerConfig, Project.project_filepath("tasks/load_server_config")
 
     module Converters
       autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
@@ -48,6 +50,7 @@ module Extension
       autoload :ValidationErrorConverter, Project.project_filepath("tasks/converters/validation_error_converter")
       autoload :AppConverter, Project.project_filepath("tasks/converters/app_converter")
       autoload :ProductConverter, Project.project_filepath("tasks/converters/product_converter")
+      autoload :ServerConfigConverter, Project.project_filepath("tasks/converters/server_config_converter")
     end
   end
 
@@ -55,6 +58,7 @@ module Extension
     module Questions
       autoload :AskApp, Project.project_filepath("forms/questions/ask_app")
       autoload :AskName, Project.project_filepath("forms/questions/ask_name")
+      autoload :AskTemplate, Project.project_filepath("forms/questions/ask_template")
       autoload :AskType, Project.project_filepath("forms/questions/ask_type")
       autoload :AskRegistration, Project.project_filepath("forms/questions/ask_registration")
     end
@@ -87,6 +91,16 @@ module Extension
       autoload :Default, Project.project_filepath("models/specification_handlers/default")
     end
 
+    module ServerConfig
+      autoload :Base, Project.project_filepath("models/server_config/base")
+      autoload :Development, Project.project_filepath("models/server_config/development")
+      autoload :DevelopmentEntries, Project.project_filepath("models/server_config/development_entries")
+      autoload :DevelopmentRenderer, Project.project_filepath("models/server_config/development_renderer")
+      autoload :Extension, Project.project_filepath("models/server_config/extension")
+      autoload :Root, Project.project_filepath("models/server_config/root")
+      autoload :User, Project.project_filepath("models/server_config/user")
+    end
+
     autoload :App, Project.project_filepath("models/app")
     autoload :Registration, Project.project_filepath("models/registration")
     autoload :Version, Project.project_filepath("models/version")
@@ -96,6 +110,8 @@ module Extension
     autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
     autoload :NpmPackage, Project.project_filepath("models/npm_package")
     autoload :Product, Project.project_filepath("models/product")
+    autoload :DevelopmentServer, Project.project_filepath("models/development_server")
+    autoload :DevelopmentServerRequirements, Project.project_filepath("models/development_server_requirements")
   end
 
   autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")

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

@@ -12,7 +12,36 @@ module Extension
       NPM_BUILD_COMMAND = %w(run-script build)
 
       def call(_args, _command_name)
-        system = ShopifyCli::JsSystem.new(ctx: @ctx)
+        project = ExtensionProject.current(force_reload: true)
+        return run_new_flow(project) if supports_development_server?(project.specification_identifier)
+        run_legacy_flow
+      end
+
+      def self.help
+        ShopifyCLI::Context.new.message("build.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def run_new_flow(project)
+        Tasks::RunExtensionCommand.new(
+          type: project.specification_identifier.downcase,
+          command: "build",
+          config_file_name: specification_handler.server_config_file,
+        ).call
+
+        @ctx.puts(@ctx.message("build.build_success_message"))
+      rescue => error
+        if error.message.include?("no such file or directory")
+          @ctx.abort(@ctx.message("build.directory_not_found"))
+        else
+          @ctx.debug(error)
+          @ctx.abort(@ctx.message("build.build_failure_message"))
+        end
+      end
+
+      def run_legacy_flow
+        system = ShopifyCLI::JsSystem.new(ctx: @ctx)
 
         CLI::UI::Frame.open(@ctx.message("build.frame_title", system.package_manager)) do
           success = system.call(yarn: YARN_BUILD_COMMAND, npm: NPM_BUILD_COMMAND)
@@ -20,8 +49,8 @@ module Extension
         end
       end
 
-      def self.help
-        ShopifyCli::Context.new.message("build.help", ShopifyCli::TOOL_NAME)
+      def supports_development_server?(type)
+        Models::DevelopmentServerRequirements.supported?(type)
       end
     end
   end

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

@@ -4,7 +4,7 @@ require "theme_check"
 module Extension
   class Command
     class Check < ExtensionCommand
-      class CheckOptions < ShopifyCli::Options
+      class CheckOptions < ShopifyCLI::Options
         def initialize(ctx, theme_check)
           super()
           @theme_check = theme_check
@@ -37,7 +37,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.message("check.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("check.help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

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

@@ -19,7 +19,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("connect.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
 
       private

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

@@ -2,7 +2,11 @@
 
 module Extension
   class Command
-    class Create < ShopifyCli::SubCommand
+    class Create < ShopifyCLI::SubCommand
+      DEVELOPMENT_SERVER_SUPPORTED_TYPES = [
+        "checkout_ui_extension",
+      ]
+
       prerequisite_task :ensure_authenticated
 
       options do |parser, flags|
@@ -18,25 +22,15 @@ module Extension
             @ctx.abort(message_for_extension["create.errors.directory_exists", form.directory_name])
           end
 
-          if form.type.create(form.directory_name, @ctx, getting_started: options.flags[:getting_started])
-            ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
-            ExtensionProject.write_env_file(
-              context: @ctx,
-              title: form.name,
-              api_key: form.app.api_key,
-              api_secret: form.app.secret
-            )
-
-            @ctx.puts(message_for_extension["create.ready_to_start", form.directory_name, form.name])
-            @ctx.puts(message_for_extension["create.learn_more", form.type.name])
-          else
-            @ctx.puts(message_for_extension["create.try_again"])
-          end
+          ShopifyCLI::Result.success(supports_development_server?(form.type.identifier))
+            .then { |supported| create_extension(supported, form) }
+            .then { notify_success(form, message_for_extension) }
+            .unwrap { |err| @ctx.puts(message_for_extension["create.try_again"]) unless err.nil? }
         end
       end
 
       def self.help
-        @ctx.message("create.help", ShopifyCli::TOOL_NAME)
+        @ctx.message("create.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -47,6 +41,55 @@ module Extension
 
         yield form, form.type.method(:message_for_extension)
       end
+
+      def supports_development_server?(type)
+        Models::DevelopmentServerRequirements.supported?(type)
+      end
+
+      def create_extension(supported, form)
+        if supported
+          use_new_create_flow(form)
+        else
+          use_legacy_flow(form)
+        end
+        ShopifyCLI::Result.success(nil)
+      end
+
+      def use_new_create_flow(form)
+        Tasks::RunExtensionCommand.new(
+          root_dir: form.directory_name,
+          template: form.template,
+          type: form.type.identifier.downcase,
+          command: "create"
+        ).call
+        @ctx.chdir(form.directory_name)
+        write_env_file(form)
+      rescue => error
+        raise error
+      end
+
+      def use_legacy_flow(form)
+        if form.type.create(form.directory_name, @ctx, getting_started: options.flags[:getting_started])
+          write_env_file(form)
+        else
+          raise StandardError
+        end
+      end
+
+      def write_env_file(form)
+        ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
+        ExtensionProject.write_env_file(
+          context: @ctx,
+          title: form.name,
+          api_key: form.app.api_key,
+          api_secret: form.app.secret
+        )
+      end
+
+      def notify_success(form, msg)
+        @ctx.puts(msg["create.ready_to_start", form.directory_name, form.name])
+        @ctx.puts(msg["create.learn_more", form.type.name])
+      end
     end
   end
 end

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

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Extension
   class Command
-    class ExtensionCommand < ShopifyCli::SubCommand
+    class ExtensionCommand < ShopifyCLI::SubCommand
       def project
         @project ||= ExtensionProject.current
       end

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

@@ -14,7 +14,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("info.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("info.help", ShopifyCLI::TOOL_NAME)
       end
 
       private

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

@@ -18,7 +18,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("push.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("push.help", ShopifyCLI::TOOL_NAME)
       end
 
       private

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

@@ -20,7 +20,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("register.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("register.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -60,7 +60,7 @@ module Extension
 
       def abort_not_registered
         @ctx.puts(@ctx.message("register.confirm_abort"))
-        raise ShopifyCli::AbortSilent
+        raise ShopifyCLI::AbortSilent
       end
     end
   end

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

@@ -29,7 +29,7 @@ module Extension
           resource_url: options.flags[:resource_url]
         )
 
-        ShopifyCli::Result
+        ShopifyCLI::Result
           .success(config)
           .then(&method(:find_available_port))
           .then(&method(:start_tunnel_if_required))
@@ -38,7 +38,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("serve.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("serve.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -66,12 +66,12 @@ module Extension
       end
 
       def can_start_tunnel?(runtime_configuration)
-        return true if ShopifyCli::Tunnel.urls.empty?
-        ShopifyCli::Tunnel.running_on?(runtime_configuration.port)
+        return true if ShopifyCLI::Tunnel.urls.empty?
+        ShopifyCLI::Tunnel.running_on?(runtime_configuration.port)
       end
 
       def start_tunnel(runtime_configuration)
-        tunnel_url = ShopifyCli::Tunnel.start(@ctx, port: runtime_configuration.port)
+        tunnel_url = ShopifyCLI::Tunnel.start(@ctx, port: runtime_configuration.port)
         runtime_configuration.tap { |c| c.tunnel_url = tunnel_url }
       end
 

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

@@ -21,25 +21,25 @@ module Extension
 
         case subcommand
         when AUTH_SUBCOMMAND then authorize(args)
-        when START_SUBCOMMAND then ShopifyCli::Tunnel.start(@ctx, port: port)
-        when STOP_SUBCOMMAND then ShopifyCli::Tunnel.stop(@ctx)
+        when START_SUBCOMMAND then ShopifyCLI::Tunnel.start(@ctx, port: port)
+        when STOP_SUBCOMMAND then ShopifyCLI::Tunnel.stop(@ctx)
         when STATUS_SUBCOMMAND then status
         else @ctx.puts(self.class.help)
         end
       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
 
       def status
-        tunnel_urls = ShopifyCli::Tunnel.urls
+        tunnel_urls = ShopifyCLI::Tunnel.urls
         tunnel_url = tunnel_urls.find { |url| url.start_with?("https://") }
         tunnel_url = tunnel_urls.first if tunnel_url.nil?
 
@@ -65,7 +65,7 @@ module Extension
           @ctx.puts(@ctx.message("tunnel.missing_token"))
           @ctx.puts("#{self.class.help}\n#{self.class.extended_help}")
         else
-          ShopifyCli::Tunnel.auth(@ctx, token)
+          ShopifyCLI::Tunnel.auth(@ctx, token)
         end
       end
     end

data/lib/project_types/extension/extension_project.rb

@@ -3,10 +3,10 @@ require "shopify_cli"
 require "securerandom"
 
 module Extension
-  class ExtensionProject < ShopifyCli::Project
+  class ExtensionProject < ShopifyCLI::Project
     class << self
       def write_cli_file(context:, type:)
-        ShopifyCli::Project.write(
+        ShopifyCLI::Project.write(
           context,
           project_type: :extension,
           organization_id: nil,
@@ -42,7 +42,7 @@ module Extension
         resource_url: nil,
         shop: nil
       )
-        ShopifyCli::Resources::EnvFile.new(
+        ShopifyCLI::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
           shop: shop,
@@ -134,7 +134,7 @@ module Extension
 
     def validate_env_present
       return if env
-      raise ShopifyCli::Abort, "Missing .env file. Run `shopify extension connect` to generate an .env file."
+      raise ShopifyCLI::Abort, "Missing .env file. Run `shopify extension connect` to generate an .env file."
     end
 
     def integer?(value)

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

@@ -24,7 +24,7 @@ module Extension
       end
 
       def config(context)
-        js_system = ShopifyCli::JsSystem.new(ctx: 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)
@@ -42,9 +42,9 @@ module Extension
       end
 
       def renderer_package(context)
-        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        js_system = ShopifyCLI::JsSystem.new(ctx: context)
         Tasks::FindNpmPackages
-          .exactly_one_of(renderer_package_name, js_system: js_system)
+          .exactly_one_of(renderer_package_name, js_system: js_system, production_only: true)
           .unwrap { |err| raise err }
       rescue Extension::PackageResolutionFailed
         context.abort(

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

@@ -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)
@@ -30,8 +30,8 @@ module Extension
             config
           rescue Psych::SyntaxError => e
             raise(
-              ShopifyCli::Abort,
-              ShopifyCli::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
+              ShopifyCLI::Abort,
+              ShopifyCLI::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
             )
           end
         end
@@ -45,8 +45,8 @@ module Extension
 
           unless unpermitted_keys.empty?
             raise(
-              ShopifyCli::Abort,
-              ShopifyCli::Context.message(
+              ShopifyCLI::Abort,
+              ShopifyCLI::Context.message(
                 "features.argo.config.unpermitted_keys",
                 CONFIG_FILE_NAME,
                 unpermitted_keys.map { |k| "\n- #{k}" }.join