shopify-cli 1.1.2 → 1.4.1

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Extension
+  module Features
+    module Argo
+      class Admin < Base
+        GIT_TEMPLATE = 'https://github.com/Shopify/argo-admin-template.git'
+        RENDERER_PACKAGE = '@shopify/argo-admin'
+        private_constant :GIT_TEMPLATE, :RENDERER_PACKAGE
+
+        def git_template
+          GIT_TEMPLATE
+        end
+
+        def renderer_package_name
+          RENDERER_PACKAGE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require 'base64'
+require 'shopify_cli'
+require 'semantic/semantic'
+
+module Extension
+  module Features
+    module Argo
+      class Base
+        include SmartProperties
+
+        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
+
+        def git_template
+          raise NotImplementedError, "'#{__method__}' must be implemented for #{self.class}"
+        end
+
+        def renderer_package_name
+          # The renderer_package_name is used as a regex pattern to
+          # find a match in the output of yarn or npm list command.
+          # Use the full package name as it appears in the template without targeting a version.
+          # Examples: "@shopify/some-renderer-package", "argo-renderer-package"
+
+          raise NotImplementedError, "'#{__method__}' must be implemented for #{self.class}"
+        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
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Extension
+  module Features
+    module Argo
+      class Checkout < Base
+        GIT_TEMPLATE = 'https://github.com/Shopify/argo-checkout-template.git'
+        RENDERER_PACKAGE = '@shopify/argo-checkout'
+        private_constant :GIT_TEMPLATE, :RENDERER_PACKAGE
+
+        def git_template
+          GIT_TEMPLATE
+        end
+
+        def renderer_package_name
+          RENDERER_PACKAGE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Extension
+  module Features
+    class ArgoConfig
+      CONFIG_FILE_NAME = 'extension.config.yml'
+
+      class << self
+        def parse_yaml(context, permitted_keys = [])
+          file_name = File.join(context.root, CONFIG_FILE_NAME)
+
+          return {} unless File.size?(file_name)
+
+          require 'yaml' # takes 20ms, so deferred as late as possible.
+          begin
+            config = YAML.load_file(file_name)
+
+            # `YAML.load_file` returns nil if the file is not empty
+            # but does not contain any parsable yml data, e.g. only comments
+            # We consider this valid
+            return {} if config.nil?
+
+            unless config.is_a?(Hash)
+              raise ShopifyCli::Abort, ShopifyCli::Context.message('core.yaml.error.not_hash', CONFIG_FILE_NAME)
+            end
+
+            config.transform_keys!(&:to_sym)
+            assert_valid_config(config, permitted_keys) unless permitted_keys.empty?
+
+            config
+          rescue Psych::SyntaxError => e
+            raise(
+              ShopifyCli::Abort,
+              ShopifyCli::Context.message('core.yaml.error.invalid', CONFIG_FILE_NAME, e.message)
+            )
+          end
+        end
+
+        private
+
+        def assert_valid_config(config, permitted_keys)
+          unpermitted_keys = config.keys.select do |k|
+            !permitted_keys.include?(k)
+          end
+
+          unless unpermitted_keys.empty?
+            raise(
+              ShopifyCli::Abort,
+              ShopifyCli::Context.message(
+                'features.argo.config.unpermitted_keys',
+                CONFIG_FILE_NAME,
+                unpermitted_keys.map { |k| "\n- #{k}" }.join
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -95,6 +95,15 @@ module Extension
               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_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.',
+          },
+          config: {
+            unpermitted_keys: '`%s` contains the following unpermitted keys: %s',
           },
         },
       },
@@ -109,8 +118,8 @@ module Extension
     }
 
     TYPES = {
-      subscription_management: {
-        name: 'Subscription Management',
+      product_subscription: {
+        name: 'Product Subscription',
         tagline: '(limit 1 per app)',
         overrides: {
           register: {

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

@@ -38,6 +38,10 @@ module Extension
         self.class::IDENTIFIER
       end
 
+      def graphql_identifier
+        identifier
+      end
+
       def name
         message('name')
       end

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

@@ -6,13 +6,16 @@ module Extension
     module Types
       class CheckoutPostPurchase < Models::Type
         IDENTIFIER = 'CHECKOUT_POST_PURCHASE'
-
+        PERMITTED_CONFIG_KEYS = [:metafields]
         def create(directory_name, context)
-          Features::Argo.checkout.create(directory_name, IDENTIFIER, context)
+          Features::Argo::Checkout.new.create(directory_name, IDENTIFIER, context)
         end
 
         def config(context)
-          Features::Argo.checkout.config(context)
+          {
+            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
+            **Features::Argo::Checkout.new.config(context),
+          }
         end
       end
     end

data/lib/project_types/extension/models/types/product_subscription.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'base64'
+
+module Extension
+  module Models
+    module Types
+      class ProductSubscription < Models::Type
+        IDENTIFIER = 'PRODUCT_SUBSCRIPTION'
+
+        def graphql_identifier
+          'SUBSCRIPTION_MANAGEMENT'
+        end
+
+        def create(directory_name, context)
+          Features::Argo::Admin.new.create(directory_name, IDENTIFIER, context)
+        end
+
+        def config(context)
+          Features::Argo::Admin.new.config(context)
+        end
+      end
+    end
+  end
+end

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

@@ -40,7 +40,7 @@ module Node
           scopes: 'write_products,write_customers,write_draft_orders',
         ).write(@ctx)
 
-        partners_url = "https://partners.shopify.com/#{form.organization_id}/apps/#{api_client['id']}"
+        partners_url = "#{partners_endpoint}/#{form.organization_id}/apps/#{api_client['id']}"
 
         @ctx.puts(@ctx.message('node.create.info.created', form.title, partners_url))
         @ctx.puts(@ctx.message('node.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
@@ -112,6 +112,11 @@ module Node
           @ctx.debug(e)
         end
       end
+
+      def partners_endpoint
+        return 'https://partners.myshopify.io' if @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
+        'https://partners.shopify.com'
+      end
     end
   end
 end

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

@@ -55,7 +55,7 @@ module Rails
           scopes: 'write_products,write_customers,write_draft_orders',
         ).write(@ctx)
 
-        partners_url = "https://partners.shopify.com/#{form.organization_id}/apps/#{api_client['id']}"
+        partners_url = "#{partners_endpoint}/#{form.organization_id}/apps/#{api_client['id']}"
 
         @ctx.puts(@ctx.message('rails.create.info.created', form.title, partners_url))
         @ctx.puts(@ctx.message('rails.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
@@ -172,6 +172,11 @@ module Rails
       def install_gem(name, version = nil)
         Gem.install(@ctx, name, version)
       end
+
+      def partners_endpoint
+        return 'https://partners.myshopify.io' if @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
+        'https://partners.shopify.com'
+      end
     end
   end
 end

data/lib/project_types/script/config/extension_points.yml

@@ -1,24 +1,24 @@
 discount:
   assemblyscript:
     package: "@shopify/extension-point-as-discount"
-    version: "^0.2.10"
-    sdk-version: "^6.0.0"
+    version: "^0.3.0"
+    sdk-version: "^7.0.0"
     toolchain-version: "^1.1.0"
 unit_limit_per_order:
   assemblyscript:
     package: "@shopify/extension-point-as-unit-limit-per-order"
-    version: "^0.1.12"
-    sdk-version: "^6.0.0"
+    version: "^0.2.0"
+    sdk-version: "^7.0.0"
     toolchain-version: "^1.1.0"
 payment_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-payment-filter"
-    version: "^0.2.8"
-    sdk-version: "^6.0.0"
+    version: "^0.5.0"
+    sdk-version: "^7.0.0"
     toolchain-version: "^1.1.0"
 shipping_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-shipping-filter"
-    version: "^0.2.10"
-    sdk-version: "^6.0.0"
+    version: "^0.3.0"
+    sdk-version: "^7.0.0"
     toolchain-version: "^1.1.0"

data/lib/project_types/script/layers/infrastructure/assemblyscript_project_creator.rb

@@ -86,8 +86,8 @@ module Script
                 "@shopify/scripts-toolchain-as": "#{extension_point.sdks[:ts].toolchain_version}",
                 "#{extension_point.sdks[:ts].package}": "#{extension_point.sdks[:ts].version}",
                 "@as-pect/cli": "4.0.0",
-                "as-wasi": "^0.2.0",
-                "assemblyscript": "^0.12.0"
+                "as-wasi": "^0.2.1",
+                "assemblyscript": "^0.14.0"
               },
               "scripts": {
                 "test": "asp --config test/as-pect.config.js --summary --verbose"

data/lib/project_types/script/layers/infrastructure/assemblyscript_task_runner.rb

@@ -34,7 +34,9 @@ module Script
 
         def dependencies_installed?
           # Assuming if node_modules folder exist at root of script folder, all deps are installed
-          ctx.dir_exist?("node_modules")
+          return false unless ctx.dir_exist?("node_modules")
+          check_if_ep_dependencies_up_to_date!
+          true
         end
 
         private
@@ -58,6 +60,39 @@ module Script
         def bytecode
           File.read(format(BYTECODE_FILE, name: script_name))
         end
+
+        def check_if_ep_dependencies_up_to_date!
+          return true if ENV['SHOPIFY_CLI_SCRIPTS_IGNORE_OUTDATED']
+
+          # ignore exit code since it will not be 0 unless every package is up to date which they probably won't be
+          out, _ = ctx.capture2e("npm", "outdated", "--json", "--depth", "0")
+          parsed_outdated_check = JSON.parse(out)
+          outdated_ep_packages = parsed_outdated_check
+            .select { |package_name, _| package_name.start_with?('@shopify/extension-point-as-') }
+            .select { |_, version_info| !package_is_up_to_date?(version_info) }
+            .keys
+          raise Errors::PackagesOutdatedError.new(outdated_ep_packages),
+            "NPM packages out of date: #{outdated_ep_packages.join(', ')}" unless outdated_ep_packages.empty?
+        end
+
+        def package_is_up_to_date?(version_info)
+          require 'semantic/semantic'
+          current_version = version_info['current']
+          latest_version = version_info['latest']
+
+          # making an assumption that the script developer knows what they're doing if they're not referencing a
+          # semver version
+          begin
+            current_version = ::Semantic::Version.new(current_version)
+            latest_version = ::Semantic::Version.new(latest_version)
+          rescue ArgumentError
+            return true
+          end
+
+          return false if current_version.major < latest_version.major
+          return false if latest_version.major == 0 && current_version.minor < latest_version.minor
+          true
+        end
       end
     end
   end