shopify-cli 1.5.0 → 1.6.0

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+require 'base64'
+require 'shopify_cli'
+require 'semantic/semantic'
+
+module Extension
+  module Features
+    class Argo
+      include SmartProperties
+
+      property! :git_template, converts: :to_str
+      property! :renderer_package_name, converts: :to_str
+
+      SCRIPT_PATH = %w(build main.js).freeze
+
+      NPM_LIST_COMMAND = %w(list).freeze
+      YARN_LIST_COMMAND = %w(list --pattern).freeze
+      NPM_LIST_PARAMETERS = %w(--prod).freeze
+      YARN_LIST_PARAMETERS = %w(--production).freeze
+      private_constant :NPM_LIST_COMMAND, :YARN_LIST_COMMAND, :NPM_LIST_PARAMETERS, :YARN_LIST_PARAMETERS
+
+      YARN_INSTALL_COMMAND = %w(install).freeze
+      YARN_INSTALL_PARAMETERS = %w(--silent).freeze
+      YARN_RUN_COMMAND = %w(run).freeze
+      YARN_RUN_SCRIPT_NAME = %w(build).freeze
+      private_constant :YARN_INSTALL_COMMAND, :YARN_INSTALL_PARAMETERS, :YARN_RUN_COMMAND, :YARN_RUN_SCRIPT_NAME
+
+      def create(directory_name, identifier, context)
+        Features::ArgoSetup.new(git_template: git_template).call(directory_name, identifier, context)
+      end
+
+      def config(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)
+        end
+        filepath = File.join(context.root, SCRIPT_PATH)
+        context.abort(context.message('features.argo.missing_file_error')) unless File.exist?(filepath)
+        begin
+          {
+            renderer_version: extract_argo_renderer_version(context),
+            serialized_script: Base64.strict_encode64(File.read(filepath).chomp),
+          }
+        rescue StandardError
+          context.abort(context.message('features.argo.script_prepare_error'))
+        end
+      end
+
+      private
+
+      def extract_argo_renderer_version(context)
+        result = run_list_command(context)
+        found_version = find_version_number(context, result)
+        context.abort(
+          context.message('features.argo.dependencies.argo_renderer_package_invalid_version_error')
+        ) if found_version.nil?
+        ::Semantic::Version.new(found_version).to_s
+      rescue ArgumentError
+        context.abort(
+          context.message('features.argo.dependencies.argo_renderer_package_invalid_version_error')
+        )
+      end
+
+      def find_version_number(context, result)
+        packages = result.to_json.split('\n')
+        found_package = packages.find do |package|
+          package.match(/#{renderer_package_name}@/)
+        end
+        if found_package.nil?
+          error = "'#{renderer_package_name}' not found."
+          context.abort(
+            context.message('features.argo.dependencies.argo_missing_renderer_package_error', error)
+          )
+        end
+        found_package.split('@')[2]&.strip
+      end
+
+      def run_list_command(context)
+        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        result, error, status = js_system.call(
+          yarn: YARN_LIST_COMMAND + [renderer_package_name] + YARN_LIST_PARAMETERS,
+          npm: NPM_LIST_COMMAND + [renderer_package_name] + NPM_LIST_PARAMETERS,
+          capture_response: true
+        )
+        context.abort(
+          context.message('features.argo.dependencies.argo_missing_renderer_package_error', error)
+        ) unless status.success?
+        result
+      end
+
+      def run_yarn_install(context, js_system)
+        _result, error, status = js_system.call(
+          yarn: YARN_INSTALL_COMMAND + YARN_INSTALL_PARAMETERS,
+          npm: [],
+          capture_response: true
+        )
+
+        context.abort(
+          context.message('features.argo.dependencies.yarn_install_error', error)
+        ) unless status.success?
+      end
+
+      def run_yarn_run_script(context, js_system)
+        _result, error, status = js_system.call(
+          yarn: YARN_RUN_COMMAND + YARN_RUN_SCRIPT_NAME,
+          npm: [],
+          capture_response: true
+        )
+
+        context.abort(
+          context.message('features.argo.dependencies.yarn_run_script_error', error)
+        ) unless status.success?
+      end
+    end
+  end
+end

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

@@ -26,11 +26,11 @@ module Extension
       end
 
       def ask_type
-        return Models::Type.load_type(type) if Models::Type.valid?(type)
+        return Extension.specifications[type] if Extension.specifications.valid?(type)
         ctx.puts(ctx.message('create.invalid_type')) unless type.nil?
 
         CLI::UI::Prompt.ask(ctx.message('create.ask_type')) do |handler|
-          Models::Type.repository.values.each do |type|
+          Extension.specifications.each do |type|
             handler.option("#{type.name} #{type.tagline}") { type }
           end
         end

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

@@ -0,0 +1,35 @@
+module Extension
+  module Models
+    class Specification
+      include SmartProperties
+
+      module Features
+        class Argo
+          include SmartProperties
+
+          property! :surface_area, converts: :to_str
+          property! :renderer_package_name, converts: :to_str
+          property! :git_template, converts: :to_str
+        end
+
+        def self.build(feature_set_attributes)
+          feature_set_attributes.each_with_object(OpenStruct.new) do |(identifier, feature_attributes), feature_set|
+            feature_set[identifier] = ShopifyCli::ResolveConstant
+              .call(identifier, namespace: Features)
+              .rescue { OpenStruct }
+              .then { |c| c.new(**feature_attributes) }
+              .unwrap { |error| raise error }
+          end
+        end
+      end
+
+      property! :identifier
+      property :graphql_identifier, converts: :to_str
+      property! :features, converts: Features.method(:build), default: -> { [] }
+
+      def graphql_identifier
+        super || identifier
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'base64'
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class CheckoutPostPurchase < Default
+        PERMITTED_CONFIG_KEYS = [:metafields]
+
+        def config(context)
+          {
+            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
+            **argo.config(context),
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class Default
+        attr_reader :specification
+
+        def initialize(specification)
+          @specification = specification
+        end
+
+        def identifier
+          specification.identifier.to_s.upcase
+        end
+
+        def graphql_identifier
+          specification.graphql_identifier.to_s.upcase
+        end
+
+        def name
+          message('name')
+        end
+
+        def tagline
+          message('tagline') || ""
+        end
+
+        def config(context)
+          argo.config(context)
+        end
+
+        def create(directory_name, context)
+          argo.create(directory_name, identifier, context)
+        end
+
+        def extension_context(_context)
+          nil
+        end
+
+        def valid_extension_contexts
+          []
+        end
+
+        protected
+
+        def argo
+          Features::Argo.new(
+            git_template: specification.features.argo.git_template,
+            renderer_package_name: specification.features.argo.renderer_package_name,
+          )
+        end
+
+        private
+
+        def message(key, *params)
+          return unless messages.key?(key.to_sym)
+          messages[key.to_sym] % params
+        end
+
+        def messages
+          @messages ||= Messages::TYPES[identifier.downcase.to_sym] || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Extension
+  module Models
+    class Specifications
+      include SmartProperties
+
+      property! :custom_handler_root,
+        accepts: ->(d) { File.directory?(d) },
+        default: -> { File.expand_path('lib/project_types/extension/models/specification_handlers', ShopifyCli::ROOT) }
+
+      property! :custom_handler_namespace,
+        accepts: ->(m) { m.respond_to?(:const_get) },
+        default: -> { ::Extension::Models::SpecificationHandlers }
+
+      property! :fetch_specifications,
+        accepts: ->(p) { p.respond_to?(:to_proc) }
+
+      def [](identifier)
+        handlers[identifier]
+      end
+
+      def valid?(identifier)
+        handlers.key?(identifier)
+      end
+
+      def each(&block)
+        handlers.values.each(&block)
+      end
+
+      protected
+
+      def handlers
+        @handlers ||= fetch_specifications_and_build_handlers
+      end
+
+      private
+
+      def fetch_specifications_and_build_handlers
+        ShopifyCli::Result
+          .call(&fetch_specifications)
+          .then(&Tasks::ConfigureFeatures)
+          .then(&method(:ensure_legacy_compatibility))
+          .then(&method(:build_specifications))
+          .then(&method(:require_handler_implementations))
+          .then(&method(:instantiate_specification_handlers))
+          .unwrap { |err| raise err }
+      end
+
+      def require_handler_implementations(specifications)
+        specifications.each do |s|
+          implementation_file = File.join(custom_handler_root, "#{s.identifier}.rb")
+          require(implementation_file) if File.file?(implementation_file)
+        end
+      end
+
+      def instantiate_specification_handlers(specifications)
+        specifications.each_with_object({}) do |specification, handlers|
+          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 }
+            .yield_self { |handler| handlers[handler.identifier] = handler }
+        end
+      end
+
+      def ensure_legacy_compatibility(specification_attribute_sets)
+        specification_attribute_sets.each do |attributes|
+          next unless attributes.fetch(:identifier) == 'product_subscription'
+          attributes[:graphql_identifier] = 'SUBSCRIPTION_MANAGEMENT'
+        end
+      end
+
+      def build_specifications(specification_attribute_sets)
+        specification_attribute_sets.map { |attributes| Models::Specification.new(**attributes) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Extension
+  module Tasks
+    class ConfigureFeatures
+      include ShopifyCli::MethodObject
+
+      class Error < RuntimeError; end
+      class UnknownSurfaceArea < Error; end
+      class UnspecifiedSurfaceArea < Error; end
+
+      def call(specification_attribute_sets)
+        specification_attribute_sets.each do |attributes|
+          argo_configuration = extract_argo_configuration(attributes)
+          next if argo_configuration.nil?
+          surface_area = extract_surface_area(argo_configuration)
+          surface_area_configuration = fetch_surface_area_configuration(surface_area)
+          argo_configuration.merge!(surface_area_configuration)
+        end
+      end
+
+      private
+
+      def extract_argo_configuration(attributes)
+        attributes.dig(:features, :argo)
+      end
+
+      def extract_surface_area(argo_configuration)
+        argo_configuration.fetch(:surface_area) do
+          raise UnspecifiedSurfaceArea, "Argo configuration does not specify surface area"
+        end
+      end
+
+      def fetch_surface_area_configuration(surface_area)
+        surface_area_configurations.fetch(surface_area.to_sym) do
+          raise UnknownSurfaceArea, "Unknown surface area: #{surface_area}"
+        end
+      end
+
+      def surface_area_configurations
+        {
+          admin: {
+            git_template: 'https://github.com/Shopify/argo-admin-template.git',
+            renderer_package_name: '@shopify/argo-admin',
+          },
+          checkout: {
+            git_template: 'https://github.com/Shopify/argo-checkout-template.git',
+            renderer_package_name: '@shopify/argo-checkout',
+          },
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Extension
+  module Tasks
+    class FetchSpecifications
+      include ShopifyCli::MethodObject
+
+      def call
+        [
+          product_subscription_specification,
+          checkout_post_purchase_specification,
+        ]
+      end
+
+      private
+
+      def product_subscription_specification
+        {
+          identifier: 'product_subscription',
+          features: {
+            argo: {
+              surface_area: 'admin',
+            },
+          },
+        }
+      end
+
+      def checkout_post_purchase_specification
+        {
+          identifier: 'checkout_post_purchase',
+          features: {
+            argo: {
+              surface_area: 'checkout',
+            },
+          },
+        }
+      end
+    end
+  end
+end

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

@@ -44,7 +44,9 @@ module Node
 
         @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))
-        @ctx.puts(@ctx.message('apps.create.info.install', partners_url, form.title))
+        unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
+          @ctx.puts(@ctx.message('apps.create.info.install', partners_url, form.title))
+        end
       end
 
       def self.help

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

@@ -13,20 +13,11 @@ module Node
       end
 
       def self.help
-        ShopifyCli::Context.message('node.generate.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message('node.generate.help')
       end
 
       def self.extended_help
-        extended_help = "{{bold:Subcommands:}}\n"
-        subcommand_registry.resolved_commands.sort.each do |name, klass|
-          extended_help += "  {{cyan:#{name}}}: "
-
-          if (subcmd_help = klass.help)
-            extended_help += subcmd_help.gsub("\n  ", "\n    ")
-          end
-          extended_help += "\n"
-        end
-        extended_help += ShopifyCli::Context.message('node.generate.extended_help', ShopifyCli::TOOL_NAME)
+        help
       end
 
       def self.run_generate(script, name, ctx)