shopify-cli 1.5.0 → 1.9.0

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

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Messages
     MESSAGES = {
       create: {
-        ask_name: 'Extension name',
-        invalid_name: 'Extension name must be under %s characters',
-        ask_type: 'What type of extension are you creating?',
-        invalid_type: 'Extension type is invalid.',
-        setup_project_frame_title: 'Initializing project',
+        ask_name: "Extension name",
+        invalid_name: "Extension name must be under %s characters",
+        ask_type: "What type of extension are you creating?",
+        invalid_type: "Extension type is invalid.",
+        setup_project_frame_title: "Initializing project",
         ready_to_start: <<~MESSAGE,
           {{v}} A new folder was generated at {{green:./%s}}.
           {{*}} You’re ready to start building {{green:%s}}!
@@ -19,49 +19,52 @@ module Extension
           {{*}} Once you're ready to version and publish your extension,
           run {{command:shopify register}} to register this extension with one of your apps.
         MESSAGE
-        try_again: '{{*}} Fix the errors and run {{command:shopify create extension}} again.',
+        try_again: "{{*}} Fix the errors and run {{command:shopify create extension}} again.",
         errors: {
-          directory_exists: 'Directory ‘%s’ already exists. Please remove it or choose a new name for your project.',
+          directory_exists: "Directory ‘%s’ already exists. Please remove it or choose a new name for your project.",
         },
+        incomplete_configuration: "Cannot create extension due to missing configuration information",
+        invalid_api_key: "The API key %s does not match any of your apps.",
+        ask_app: "Which app would you like to register this extension with?",
+        no_apps: "{{x}} You don’t have any apps.",
+        learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/concepts/apps>, " \
+          "or try creating a new app using {{command:shopify create}}.",
+        loading_apps: "Loading your apps...",
+        no_available_extensions: "{{x}} There are no available extensions for this app.",
       },
       build: {
-        frame_title: 'Building extension with: %s...',
-        build_failure_message: 'Failed to build extension code.',
+        frame_title: "Building extension with: %s...",
+        build_failure_message: "Failed to build extension code.",
       },
       register: {
-        frame_title: 'Registering Extension',
-        waiting_text: 'Registering with Shopify...',
-        already_registered: 'Extension is already registered.',
-        loading_apps: 'Loading your apps...',
-        ask_app: 'Which app would you like to register this extension with?',
-        no_apps: '{{x}} You don’t have any apps.',
-        learn_about_apps: '{{*}} Learn more about building apps at <https://shopify.dev/concepts/apps>, ' \
-          'or try creating a new app using {{command:shopify create}}.',
-        invalid_api_key: 'The API key %s does not match any of your apps.',
-        confirm_info: 'This will create a new extension registration for %s, which can’t be undone.',
-        confirm_question: 'Would you like to register this extension with {{green:%s}}? (y/n)',
-        confirm_abort: 'Extension was not registered.',
-        success: '{{v}} Registered {{green:%s}} with {{green:%s}}.',
-        success_info: '{{*}} Run {{command:shopify push}} to push your extension to Shopify.',
+        frame_title: "Registering Extension",
+        waiting_text: "Registering with Shopify...",
+        already_registered: "Extension is already registered.",
+        confirm_info: "This will create a new extension registration for %s, which can’t be undone.",
+        confirm_question: "Would you like to register this extension? (y/n)",
+        confirm_abort: "Extension was not registered.",
+        success: "{{v}} Registered {{green:%s}}.",
+        success_info: "{{*}} Run {{command:shopify push}} to push your extension to Shopify.",
       },
       push: {
-        frame_title: 'Pushing your extension to Shopify',
-        waiting_text: 'Pushing code to Shopify...',
-        pushed_with_errors: '{{x}} Code pushed to Shopify with errors on %s.',
-        push_with_errors_info: '{{*}} Fix these errors and run {{command:shopify push}} to revalidate your extension.',
-        success_confirmation: '{{v}} Pushed {{green:%s}} to a draft on %s.',
-        success_info: '{{*}} Visit %s to version and publish your extension.',
+        frame_title: "Pushing your extension to Shopify",
+        waiting_text: "Pushing code to Shopify...",
+        pushed_with_errors: "{{x}} Code pushed to Shopify with errors on %s.",
+        push_with_errors_info: "{{*}} Fix these errors and run {{command:shopify push}} to revalidate your extension.",
+        success_confirmation: "{{v}} Pushed {{green:%s}} to a draft on %s.",
+        success_info: "{{*}} Visit %s to version and publish your extension.",
       },
       serve: {
-        frame_title: 'Serving extension...',
-        serve_failure_message: 'Failed to run extension code.',
+        frame_title: "Serving extension...",
+        serve_failure_message: "Failed to run extension code.",
+        serve_missing_information: "Missing shop or api_key.",
       },
       tunnel: {
-        missing_token: '{{x}} {{red:auth requires a token argument}}. '\
-          'Find it on your ngrok dashboard: {{underline:https://dashboard.ngrok.com/auth/your-authtoken}}.',
-        invalid_port: '%s is not a valid port.',
-        no_tunnel_running: 'No tunnel running.',
-        tunnel_running_at: 'Tunnel running at: {{underline:%s}}',
+        missing_token: "{{x}} {{red:auth requires a token argument}}. "\
+          "Find it on your ngrok dashboard: {{underline:https://dashboard.ngrok.com/auth/your-authtoken}}.",
+        invalid_port: "%s is not a valid port.",
+        no_tunnel_running: "No tunnel running.",
+        tunnel_running_at: "Tunnel running at: {{underline:%s}}",
         help: <<~HELP,
           Start or stop an http tunnel to your local development extension using ngrok.
             Usage: {{command:%s tunnel [ auth | start | stop | status ]}}
@@ -69,7 +72,7 @@ module Extension
         extended_help: <<~HELP,
           {{bold:Subcommands:}}
 
-            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. 
+            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account.
             Visit https://dashboard.ngrok.com/signup to sign up.
               Usage: {{command:%1$s tunnel auth <token>}}
 
@@ -87,48 +90,48 @@ module Extension
       },
       features: {
         argo: {
-          missing_file_error: 'Could not find built extension file.',
-          script_prepare_error: 'An error occurred while attempting to prepare your script.',
-          initialization_error: '{{x}} There was an error while initializing the project.',
+          missing_file_error: "Could not find built extension file.",
+          script_prepare_error: "An error occurred while attempting to prepare your script.",
+          initialization_error: "{{x}} There was an error while initializing the project.",
           dependencies: {
             node: {
-              node_not_installed: 'Node must be installed to create this extension.',
-              version_too_low: 'Your node version %s does not meet the minimum required version %s',
+              node_not_installed: "Node must be installed to create this extension.",
+              version_too_low: "Your node version %s does not meet the minimum required version %s",
             },
-            argo_missing_renderer_package_error: '%s Install the missing package and try again.',
+            argo_missing_renderer_package_error: "%s Install the missing package and try again.",
             argo_renderer_package_invalid_version_error: <<~MESSAGE,
               The renderer package version is not a valid SemVer Version (http://semver.org)
             MESSAGE
             yarn_install_error: "Something went wrong while running 'yarn install'. %s.",
-            yarn_run_script_error: 'Something went wrong while running script. %s.',
+            yarn_run_script_error: "Something went wrong while running script. %s.",
           },
           config: {
-            unpermitted_keys: '`%s` contains the following unpermitted keys: %s',
+            unpermitted_keys: "`%s` contains the following unpermitted keys: %s",
           },
         },
       },
       tasks: {
         errors: {
-          parse_error: 'Unable to parse response from Partners Dashboard.',
+          parse_error: "Unable to parse response from Partners Dashboard.",
         },
       },
       errors: {
-        unknown_type: 'Unknown extension type %s',
+        unknown_type: "Unknown extension type %s",
       },
     }
 
     TYPES = {
       product_subscription: {
-        name: 'Product Subscription',
-        tagline: '(limit 1 per app)',
+        name: "Product Subscription",
+        tagline: "(limit 1 per app)",
         overrides: {
           register: {
-            confirm_info: 'You can only create one %s extension per app, which can’t be undone.',
+            confirm_info: "You can only create one %s extension per app, which can’t be undone.",
           },
         },
       },
       checkout_post_purchase: {
-        name: 'Checkout Post Purchase',
+        name: "Checkout Post Purchase",
       },
     }
   end

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

@@ -0,0 +1,12 @@
+module Extension
+  module Models
+    class LazySpecificationHandler < ShopifyCli::LazyDelegator
+      attr_reader :identifier
+
+      def initialize(identifier, &specification_handler_initializer)
+        super(&specification_handler_initializer)
+        @identifier = identifier
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ module Extension
       include SmartProperties
 
       property! :id, accepts: Integer
+      property! :uuid, accepts: String
       property! :type, accepts: String
       property! :title, accepts: String
       property! :draft_version, accepts: Extension::Models::Version

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

@@ -0,0 +1,39 @@
+module Extension
+  module Models
+    class Specification
+      include SmartProperties
+
+      module Features
+        class Argo
+          include SmartProperties
+
+          property! :surface, converts: :to_str
+          property! :renderer_package_name, converts: :to_str
+          property! :git_template, converts: :to_str
+          property! :required_fields, accepts: Array, default: []
+          property! :required_shop_beta_flags, accepts: Array, default: []
+        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 :name, converts: :to_str
+      property :graphql_identifier, converts: :to_str
+      property! :features, converts: Features.method(:build), default: -> { [] }
+      property! :options, converts: ->(options) { OpenStruct.new(options) }, default: -> { OpenStruct.new }
+
+      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,75 @@
+# 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") || specification.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
+
+        def serve(context)
+          Features::ArgoServe.new(specification_handler: self, context: context).call
+        end
+
+        def renderer_package(context)
+          argo.renderer_package(context)
+        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,88 @@
+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
+
+      def none?
+        each.none?
+      end
+
+      protected
+
+      def handlers
+        @handlers ||= fetch_specifications_and_build_handlers
+      end
+
+      private
+
+      def fetch_specifications_and_build_handlers
+        ShopifyCli::Result
+          .call(&fetch_specifications)
+          .map(&ShopifyCli::TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
+          .then(&method(:select_cli_extensions))
+          .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) == "subscription_management"
+          attributes[: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
+
+      def select_cli_extensions(specification_attribute_sets)
+        specification_attribute_sets.select { |attributes| attributes.dig(:options, :management_experience) == "cli" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+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) 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",
+            required_fields: [:shop, :api_key],
+            required_shop_beta_flags: [:argo_admin_beta],
+          },
+          checkout: {
+            git_template: "https://github.com/Shopify/argo-checkout-template.git",
+            renderer_package_name: "@shopify/argo-checkout",
+          },
+        }
+      end
+    end
+  end
+end