shopify-cli 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff1487d9bbf811bd4640cb9d67ea439ad198794e409355477757dac56052d65
-  data.tar.gz: 396f98fe6702a8c37cd58c906d843bc92888a7943375f99d723e7269d2dcda04
+  metadata.gz: aac6d7ad80aa747af6b8334b1cf6f82b3dfc0c6db77e8e22eb9638365b11317b
+  data.tar.gz: f5a744abb193c02bad16f0978d93bac2825ce287f95e3143848be47c28c8bbfc
 SHA512:
-  metadata.gz: 93ad0fa7d1f935f07bc0549acaf7fdc4041dd7b00c1e097a13dcd591cec4e0a76f380c9fef0a69d33eb114703aebee8a57b6ad81fdac8f3b4c7463a22048af81
-  data.tar.gz: d326315732e87f9343a71bbf5719c46f9a951974b31c5e927437cb8e1bb64373c312aaef2fda2ddd904bb79f36fd25309fadd3cea21b6c0482d3abd6d1e7a1ea
+  metadata.gz: b934e0c4c5321cdb01d733886e2eae5fc23c94c1ea7115e9b18af302244512d93617440d1a4274ca764305c6797a10ef79285c97cf03636d473deec63a6a0d23
+  data.tar.gz: fec928d425a1be8c543d45d495156857fcf848c12170eaf825fdf549f70536198fdf076d71b35b448b97769869ac85e2eddb8d6dd1321a2f93949160cd2929fa

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+Version 1.2.0
+------
+* Improvements and new functionality to various internal components
+
 Version 1.1.2
 ------
 * Fix various minor bugs (check dir before creating Rails project, catch stderr from failed git command)

data/lib/project_types/extension/cli.rb

@@ -53,6 +53,7 @@ module Extension
     autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
     autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
     autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
+    autoload :ArgoConfig, Project.project_filepath('features/argo_config')
   end
 
   module Models

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

@@ -96,6 +96,9 @@ module Extension
               version_too_low: 'Your node version %s does not meet the minimum required version %s',
             },
           },
+          config: {
+            unpermitted_keys: '`%s` contains the following unpermitted keys: %s',
+          },
         },
       },
       tasks: {

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)
         end
 
         def config(context)
-          Features::Argo.checkout.config(context)
+          {
+            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
+            **Features::Argo.checkout.config(context),
+          }
         end
       end
     end

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

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

@@ -34,6 +34,13 @@ module Script
         class ShopScriptConflictError < ScriptProjectError; end
         class ShopScriptUndefinedError < ScriptProjectError; end
         class TaskRunnerNotFoundError < ScriptProjectError; end
+        class PackagesOutdatedError < ScriptProjectError
+          attr_reader :outdated_packages
+          def initialize(outdated_packages)
+            super("EP packages are outdated and need to be updated: #{outdated_packages.join(', ')}")
+            @outdated_packages = outdated_packages
+          end
+        end
       end
     end
   end

data/lib/project_types/script/messages/messages.rb

@@ -71,6 +71,9 @@ module Script
           shop_script_conflict_help: "Disable that script or uninstall that app and try again.",
 
           shop_script_undefined_cause: "Script is already turned off in store.",
+
+          packages_outdated_cause: "The following npm packages are out of date: %s.",
+          packages_outdated_help: "Run `npm update` to update them.",
         },
 
         create: {

data/lib/project_types/script/ui/error_handler.rb

@@ -142,6 +142,14 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.shop_script_undefined_cause'),
           }
+        when Layers::Infrastructure::Errors::PackagesOutdatedError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              'script.error.packages_outdated_cause',
+              e.outdated_packages.join(', ')
+            ),
+            help_suggestion: ShopifyCli::Context.message('script.error.packages_outdated_help'),
+          }
         end
       end
     end

data/lib/shopify-cli/messages/messages.rb

@@ -184,11 +184,14 @@ module ShopifyCli
             {{x}} You are not in a Shopify app project
             {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify create}}{{reset: to create your app}}
             MESSAGE
-            cli_yaml: {
-              not_hash: "{{x}} .shopify-cli.yml was not a proper YAML file. Expecting a hash.",
-              invalid: "{{x}} %s contains invalid YAML: %s",
-              not_found: "{{x}} %s not found",
-            },
+          },
+        },
+
+        yaml: {
+          error: {
+            not_hash: "{{x}} %s was not a proper YAML file. Expecting a hash.",
+            invalid: "{{x}} %s contains invalid YAML: %s",
+            not_found: "{{x}} %s not found",
           },
         },
 

data/lib/shopify-cli/project.rb

@@ -166,7 +166,7 @@ module ShopifyCli
       @config ||= begin
         config = load_yaml_file('.shopify-cli.yml')
         unless config.is_a?(Hash)
-          raise ShopifyCli::Abort, Context.message('core.project.error.cli_yaml.not_hash')
+          raise ShopifyCli::Abort, Context.message('core.yaml.error.not_hash', '.shopify-cli.yml')
         end
 
         # The app_type key was deprecated in favour of project_type, so replace it
@@ -187,12 +187,12 @@ module ShopifyCli
       begin
         YAML.load_file(f)
       rescue Psych::SyntaxError => e
-        raise(ShopifyCli::Abort, Context.message('core.project.error.cli_yaml.invalid', relative_path, e.message))
+        raise(ShopifyCli::Abort, Context.message('core.yaml.error.invalid', relative_path, e.message))
       # rescue Errno::EACCES => e
       # TODO
       #   Dev::Helpers::EaccesHandler.diagnose_and_raise(f, e, mode: :read)
       rescue Errno::ENOENT
-        raise ShopifyCli::Abort, Context.message('core.project.error.cli_yaml.not_found', f)
+        raise ShopifyCli::Abort, Context.message('core.yaml.error.not_found', f)
       end
     end
   end

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,7 @@ files:
 - lib/project_types/extension/extension_project.rb
 - lib/project_types/extension/extension_project_keys.rb
 - lib/project_types/extension/features/argo.rb
+- lib/project_types/extension/features/argo_config.rb
 - lib/project_types/extension/features/argo_dependencies.rb
 - lib/project_types/extension/features/argo_setup.rb
 - lib/project_types/extension/features/argo_setup_step.rb