shopify-cli 2.6.4 → 2.7.1

data/ext/javy/javy.rb

@@ -0,0 +1,186 @@
+require "rbconfig"
+require "open-uri"
+require "zlib"
+require "open3"
+
+module Javy
+  ROOT = __dir__
+  BIN_FOLDER = File.join(ROOT, "bin")
+  VERSION = File.read(File.join(ROOT, "version")).strip
+  TARGET = File.join(BIN_FOLDER, "javy-#{VERSION}")
+
+  class << self
+    def install
+      ShopifyCLI::Result
+        .wrap { Installer.call(target: target, platform: platform, version: VERSION) }
+        .call
+    end
+
+    def build(source:, dest: nil)
+      ensure_installed
+
+      optional_args = []
+      optional_args += ["-o", dest] unless dest.nil?
+
+      ShopifyCLI::Result
+        .wrap { exec(source, *optional_args) }
+        .call
+    end
+
+    private
+
+    def exec(*args, **kwargs)
+      out_and_err, stat = CLI::Kit::System.capture2e(target, *args, **kwargs)
+      raise ExecutionError, out_and_err unless stat.success?
+      true
+    end
+
+    def platform
+      Platform.new
+    end
+
+    def target
+      platform.format_executable_path(TARGET)
+    end
+
+    def ensure_installed
+      delete_outdated_installations
+      install unless Installer.installed?(target: target)
+    end
+
+    def delete_outdated_installations
+      installed_binaries
+        .reject { |v| v == target }
+        .each { |file| File.delete(file) }
+    end
+
+    def installed_binaries
+      Dir[File.join(BIN_FOLDER, "javy-*")]
+    end
+
+    module Installer
+      def self.call(target:, platform:, version:)
+        asset = Asset.new(
+          platform: platform,
+          version: version,
+          owner: "Shopify",
+          repository: "javy",
+          basename: "javy"
+        )
+
+        downloaded = asset.download(target: target)
+        raise InstallationError.asset_not_found(platform: platform, version: version, url: asset.url) unless downloaded
+
+        true
+      end
+
+      def self.installed?(target:)
+        File.executable?(target)
+      end
+    end
+  end
+
+  class Error < RuntimeError; end
+  class ExecutionError < Error; end
+
+  class InstallationError < Error
+    def self.cpu_unsupported
+      new("Javy is not supported on this CPU")
+    end
+
+    def self.asset_not_found(platform:, version:, url:)
+      new(format(
+        "Unable to download javy %{version} for %{os} (%{cpu}) at %{url}",
+        version: version,
+        os: platform.os,
+        cpu: platform.cpu,
+        url: url
+      ))
+    end
+  end
+
+  Asset = Struct.new(:platform, :version, :owner, :repository, :basename, keyword_init: true) do
+    def download(target:)
+      FileUtils.mkdir_p(BIN_FOLDER)
+
+      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}-%{cpu}-%{os}-%{version}.gz",
+        basename: basename,
+        cpu: platform.cpu,
+        os: platform.os,
+        version: version
+      )
+    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 to_s
+      format("%{cpu}-%{os}", cpu: cpu, os: os)
+    end
+
+    def os
+      case ruby_config.fetch("host_os")
+      when /linux/
+        "linux"
+      when /darwin/
+        "macos"
+      else
+        "windows"
+      end
+    end
+
+    def cpu
+      case ruby_config.fetch("host_cpu")
+      when "x64", "x86_64"
+        "x86_64"
+      else
+        raise InstallationError.cpu_unsupported
+      end
+    end
+
+    def format_executable_path(path)
+      case os
+      when "windows"
+        File.extname(path) != ".exe" ? path + ".exe" : path
+      else
+        path
+      end
+    end
+  end
+end

data/ext/javy/version

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

data/lib/project_types/extension/cli.rb

@@ -12,7 +12,7 @@ module Extension
     register_messages(Extension::Messages::MessageLoading.load)
   end
 
-  class Command < ShopifyCLI::ProjectCommands
+  class Command < ShopifyCLI::Command::ProjectCommand
     hidden_feature
     autoload :ExtensionCommand, Project.project_filepath("commands/extension_command")
 
@@ -42,7 +42,10 @@ module Extension
     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")
+    autoload :MergeServerConfig, Project.project_filepath("tasks/merge_server_config")
+    autoload :FindPackageFromJson, Project.project_filepath("tasks/find_package_from_json.rb")
+    autoload :EnsureResourceUrl, Project.project_filepath("tasks/ensure_resource_url.rb")
+    autoload :ConvertServerConfig, Project.project_filepath("tasks/convert_server_config")
 
     module Converters
       autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
@@ -50,7 +53,6 @@ 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
 
@@ -93,9 +95,11 @@ module Extension
 
     module ServerConfig
       autoload :Base, Project.project_filepath("models/server_config/base")
+      autoload :App, Project.project_filepath("models/server_config/app")
       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 :DevelopmentResource, Project.project_filepath("models/server_config/development_resource")
       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")

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

@@ -28,6 +28,7 @@ module Extension
           type: project.specification_identifier.downcase,
           command: "build",
           config_file_name: specification_handler.server_config_file,
+          context: @ctx,
         ).call
 
         @ctx.puts(@ctx.message("build.build_success_message"))

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

@@ -2,15 +2,14 @@
 
 module Extension
   class Command
-    class Create < ShopifyCLI::SubCommand
-      DEVELOPMENT_SERVER_SUPPORTED_TYPES = [
-        "checkout_ui_extension",
-      ]
-
-      prerequisite_task :ensure_authenticated
+    class Create < ShopifyCLI::Command::SubCommand
+      unless ShopifyCLI::Environment.acceptance_test?
+        prerequisite_task :ensure_authenticated
+      end
 
       options do |parser, flags|
         parser.on("--name=NAME") { |name| flags[:name] = name }
+        parser.on("--template=TEMPLATE") { |template| flags[:template] = template }
         parser.on("--type=TYPE") { |type| flags[:type] = type.upcase }
         parser.on("--api-key=KEY") { |key| flags[:api_key] = key.downcase }
         parser.on("--getting-started") { flags[:getting_started] = true }
@@ -65,6 +64,7 @@ module Extension
         @ctx.chdir(form.directory_name)
         write_env_file(form)
       rescue => error
+        @ctx.debug(error)
         raise error
       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::Command::SubCommand
       def project
         @project ||= ExtensionProject.current
       end

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

@@ -48,14 +48,7 @@ module Extension
       end
 
       def renderer_package(context)
-        js_system = ShopifyCLI::JsSystem.new(ctx: context)
-        Tasks::FindNpmPackages
-          .exactly_one_of(renderer_package_name, js_system: js_system, production_only: true)
-          .unwrap { |err| raise err }
-      rescue Extension::PackageResolutionFailed
-        context.abort(
-          context.message("features.argo.dependencies.argo_missing_renderer_package_error")
-        )
+        Tasks::FindPackageFromJson.call(renderer_package_name, context: context)
       end
 
       private

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

@@ -63,7 +63,9 @@ module Extension
         ShopifyCLI::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
 
         project = ExtensionProject.current
-        ensure_resource_resource_url! if specification_handler.supplies_resource_url?
+        if resource_url_required?
+          Tasks::EnsureResourceUrl.call(context: context, specification_handler: specification_handler)
+        end
 
         return if required_fields.all? do |field|
           value = project.env.public_send(field)
@@ -73,6 +75,10 @@ module Extension
         context.abort(context.message("serve.serve_missing_information"))
       end
 
+      def resource_url_required?
+        specification_handler.supplies_resource_url? && resource_url.nil?
+      end
+
       def options
         project = ExtensionProject.current
 
@@ -88,28 +94,6 @@ module Extension
         end
       end
 
-      def ensure_resource_resource_url!
-        project = ExtensionProject.current(force_reload: true)
-
-        ShopifyCLI::Result
-          .wrap(project.resource_url)
-          .rescue { specification_handler.build_resource_url(shop: project.env.shop, context: context) }
-          .then(&method(:persist_resource_url))
-          .unwrap do |nil_or_exception|
-            case nil_or_exception
-            when nil
-              context.warn(context.message("warnings.resource_url_auto_generation_failed", project.env.shop))
-            else
-              context.abort(nil_or_exception)
-            end
-          end
-      end
-
-      def persist_resource_url(resource_url)
-        ExtensionProject.update_env_file(context: context, resource_url: resource_url)
-        resource_url
-      end
-
       def new_serve_flow
         Tasks::RunExtensionCommand.new(
           type: specification_handler.specification.identifier,
@@ -117,6 +101,8 @@ module Extension
           context: context,
           port: port,
           config_file_name: specification_handler.server_config_file,
+          resource_url: resource_url,
+          tunnel_url: tunnel_url
         ).call
       end
 

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

@@ -24,7 +24,7 @@ module Extension
         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::AskTemplate.new(ctx: ctx, template: template))
           .then(&Questions::AskName.new(ctx: ctx, name: name))
           .unwrap { |e| raise e }
           .tap do |project_details|

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

@@ -4,18 +4,15 @@ module Extension
       class AskTemplate
         include ShopifyCLI::MethodObject
 
-        TEMPLATE_REQUIRED_TYPES = [
-          "checkout_ui_extension",
-        ]
-
         property! :ctx
+        property :template, accepts: Models::ServerConfig::Development::VALID_TEMPLATES
         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.template = template || choose_interactively
           project_details
         end
 
@@ -24,7 +21,7 @@ module Extension
         def template_required?(project_details)
           return false unless extension_server_beta?
           type = project_details&.type&.identifier
-          TEMPLATE_REQUIRED_TYPES.include?(type.downcase)
+          Models::DevelopmentServerRequirements::SUPPORTED_EXTENSION_TYPES.include?(type.downcase)
         end
 
         def extension_server_beta?

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

@@ -175,6 +175,7 @@ module Extension
       errors: {
         unknown_type: "Unknown extension type %s",
         package_not_found: "`%s` package not found.",
+        module_not_found: "Unable to find module %s. Ensure your dependencies are up-to-date and try again.",
       },
       warnings: {
         resource_url_auto_generation_failed: "{{*}} {{yellow:Warning:}} Unable to auto generate " \

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

@@ -6,11 +6,10 @@ module Extension
     class DevelopmentServerRequirements
       SUPPORTED_EXTENSION_TYPES = [
         "checkout_ui_extension",
+        "checkout_post_purchase",
+        "product_subscription",
       ]
 
-      UNIX_NAME = "shopify-extensions"
-      WINDOWS_NAME = "shopify-extensions.exe"
-
       class << self
         def supported?(type)
           binary_installed? && type_supported?(type) && beta_enabled?

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class App < Base
+        include SmartProperties
+
+        property! :api_key, accepts: String
+      end
+    end
+  end
+end

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

@@ -12,11 +12,12 @@ module Extension
 
         CURRENT_DIRECTORY = "."
 
-        property :root_dir, accepts: String, default: 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
+        property  :template, accepts: VALID_TEMPLATES
+        property  :renderer, accepts: ServerConfig::DevelopmentRenderer
+        property  :entries, accepts: ServerConfig::DevelopmentEntries
+        property  :resource, accepts: ServerConfig::DevelopmentResource
       end
     end
   end

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

@@ -16,7 +16,7 @@ module Extension
 
         def self.find(type)
           case type.downcase
-          when "admin_ui_extension"
+          when "product_subscription"
             new(name: "@shopify/admin-ui-extensions")
           when "checkout_ui_extension"
             new(name: "@shopify/checkout-ui-extensions")

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class DevelopmentResource < Base
+        include SmartProperties
+
+        property! :url, accepts: String
+      end
+    end
+  end
+end

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

@@ -5,10 +5,14 @@ module Extension
     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
+        property  :extension_points, accepts: Array
+        property  :version, accepts: String
+        property  :title, accepts: String
 
         def self.build(uuid: "", template:, type:, root_dir:)
           renderer = ServerConfig::DevelopmentRenderer.find(type)

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

@@ -6,8 +6,11 @@ module Extension
       class Root < Base
         include SmartProperties
 
-        property! :port, accepts: Integer, default: 39351
+        property  :app, accepts: ServerConfig::App
         property! :extensions, accepts: Array, default: -> { [] }
+        property! :port, accepts: Integer, default: 39351
+        property  :public_url, accepts: String
+        property  :store, accepts: String
 
         def to_yaml
           to_h.to_yaml.gsub("---\n", "")

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class ConvertServerConfig
+      include SmartProperties
+
+      property! :api_key, accepts: String
+      property! :context, accepts: ShopifyCLI::Context
+      property! :hash, accepts: Hash
+      property! :registration_uuid, accepts: String
+      property  :resource_url, accepts: String
+      property! :store, accepts: String
+      property! :title, accepts: String
+      property :tunnel_url, accepts: String
+      property! :type, accepts: String
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def call
+        context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
+
+        renderer = Models::ServerConfig::DevelopmentRenderer.find(type)
+
+        extension = Models::ServerConfig::Extension.new(
+          uuid: registration_uuid,
+          type: type.upcase,
+          user: Models::ServerConfig::User.new,
+          development: Models::ServerConfig::Development.new(
+            build_dir: hash.dig("development", "build_dir"),
+            renderer: renderer,
+            entries: Models::ServerConfig::DevelopmentEntries.new(
+              main: hash.dig("development", "entries", "main")
+            )
+          ),
+          extension_points: hash.dig("extension_points"),
+          version: version(renderer.name, context),
+          title: title
+        )
+
+        unless resource_url.nil?
+          extension.development.resource = Models::ServerConfig::DevelopmentResource.new(url: resource_url)
+        end
+        server_config = Models::ServerConfig::Root.new(
+          extensions: [extension],
+          public_url: tunnel_url,
+          store: store
+        )
+
+        unless api_key.nil?
+          server_config.app = Models::ServerConfig::App.new(api_key: api_key)
+        end
+
+        server_config
+      end
+
+      def version(renderer, context)
+        Tasks::FindPackageFromJson.call(renderer, context: context).version
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class EnsureResourceUrl < ShopifyCLI::Task
+      include SmartProperties
+
+      property! :context, accepts: ShopifyCLI::Context
+      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def call
+        project = ExtensionProject.current(force_reload: true)
+
+        ShopifyCLI::Result
+          .wrap(project.resource_url)
+          .rescue { specification_handler.build_resource_url(shop: project.env.shop, context: context) }
+          .then(&method(:persist_resource_url))
+          .unwrap do |nil_or_exception|
+            case nil_or_exception
+            when nil
+              context.warn(context.message("warnings.resource_url_auto_generation_failed", project.env.shop))
+            else
+              context.abort(nil_or_exception)
+            end
+          end
+      end
+
+      def persist_resource_url(resource_url)
+        ExtensionProject.update_env_file(context: context, resource_url: resource_url)
+        resource_url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require "json"
+
+module Extension
+  module Tasks
+    class FindPackageFromJson < ShopifyCLI::Task
+      include SmartProperties
+
+      property! :context, accepts: ShopifyCLI::Context
+
+      def self.call(package_name, **config)
+        new(**config).call(package_name)
+      end
+
+      def call(package_name)
+        ShopifyCLI::Result.success(resolve_package_json(package_name))
+          .then { |file| File.read(file) }
+          .then { |file| JSON.parse(file) }
+          .then { |file| file.dig("version") }
+          .then { |version| return Models::NpmPackage.new(name: package_name, version: version) }
+          .unwrap do |error|
+            context.debug(error)
+            context.abort(context.message("errors.module_not_found", package_name))
+          end
+      end
+
+      private
+
+      def resolve_package_json(package_name)
+        path = "path.join(require.resolve('#{package_name}'), '../package.json')"
+        package_json, error, _ = CLI::Kit::System.capture3("node", "-p", path)
+        return error unless !error.nil?
+        package_json.chomp
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require "shopify_cli"
+require "yaml"
+
+module Extension
+  module Tasks
+    class MergeServerConfig < ShopifyCLI::Task
+      class << self
+        def call(context:, file_name:, resource_url:, tunnel_url:, type:)
+          config = YAML.load_file(file_name)
+          project = ExtensionProject.current
+          Tasks::ConvertServerConfig.call(
+            api_key: project.env.api_key,
+            context: context,
+            hash: config,
+            registration_uuid: project.registration_uuid,
+            resource_url: resource_url || project.resource_url,
+            store: project.env.shop || "",
+            title: project.title,
+            tunnel_url: tunnel_url,
+            type: type
+          )
+        rescue Psych::SyntaxError => e
+          raise(
+            ShopifyCLI::Abort,
+            ShopifyCLI::Context.message("core.yaml.error.invalid", file_name, e.message)
+          )
+        end
+      end
+    end
+  end
+end