shopify-cli 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac6d7ad80aa747af6b8334b1cf6f82b3dfc0c6db77e8e22eb9638365b11317b
-  data.tar.gz: f5a744abb193c02bad16f0978d93bac2825ce287f95e3143848be47c28c8bbfc
+  metadata.gz: 453f515f6f175bcc507b9a967880660da88455a97fc4ac593e5526ce6d410b0d
+  data.tar.gz: 134e8f9fc243aaad0eee527c37784680fef10ad2b53ab6d5787965a026457772
 SHA512:
-  metadata.gz: b934e0c4c5321cdb01d733886e2eae5fc23c94c1ea7115e9b18af302244512d93617440d1a4274ca764305c6797a10ef79285c97cf03636d473deec63a6a0d23
-  data.tar.gz: fec928d425a1be8c543d45d495156857fcf848c12170eaf825fdf549f70536198fdf076d71b35b448b97769869ac85e2eddb8d6dd1321a2f93949160cd2929fa
+  metadata.gz: 950380758e1d7babd1db489718f7487c6511f8d72dc26e3e894d1779c8097303ed58cb308d8db8db3ed136fd0e659af96ed06fdeff2191af8afca1e85cd68921
+  data.tar.gz: e3ed02e945e4211f529b2aae0c1caa6de6c39947adcf91cdd99c0ddf641e930abbd994a0f5bf918eb6f37c0142e69de477c0062985e565a25480856beaf70dd0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+Version 1.3.0
+------
+* Support for new `shopify config analytics` command to enable/disable anonymous usage reporting
+
 Version 1.2.0
 ------
 * Improvements and new functionality to various internal components

data/docs/core/index.md

@@ -68,3 +68,19 @@ Log out of the currently authenticated partner organization and store. The `logo
 $ shopify logout
 ```
 
+## `config`
+
+Configure Shopify App CLI options. Currently there are two available options.
+
+### `analytics`
+
+Configure anonymous usage reporting by enabling or disabling analytics 
+```console
+$ shopify config analytics [ --status | --enable | --disable ]
+```
+
+### `feature`
+Configure active [feature sets](https://github.com/Shopify/shopify-app-cli/wiki/Feature-Sets) in the CLI. This command is used for development and debugging work on the CLI tool itself. Only alter it if you know what you're doing. Check the [Shopify App CLI development guide](https://github.com/Shopify/shopify-app-cli/wiki) for more information.
+```console
+$ shopify config feature [ feature_name ] [ --status | --enable | --disable ]
+```

data/lib/project_types/extension/cli.rb

@@ -48,12 +48,16 @@ module Extension
   end
 
   module Features
-    autoload :Argo, Project.project_filepath('features/argo')
     autoload :ArgoSetup, Project.project_filepath('features/argo_setup')
     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')
+    module Argo
+      autoload :Base, Project.project_filepath('features/argo/base')
+      autoload :Admin, Project.project_filepath('features/argo/admin')
+      autoload :Checkout, Project.project_filepath('features/argo/checkout')
+    end
   end
 
   module Models

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

@@ -52,7 +52,7 @@ module Extension
         Tasks::CreateExtension.call(
           context: @ctx,
           api_key: app.api_key,
-          type: extension_type.identifier,
+          type: extension_type.graphql_identifier,
           title: project.title,
           config: {},
           extension_context: extension_type.extension_context(@ctx)

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/messages/messages.rb

@@ -95,6 +95,12 @@ 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',
@@ -112,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

@@ -8,13 +8,13 @@ module Extension
         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::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
-            **Features::Argo.checkout.config(context),
+            **Features::Argo::Checkout.new.config(context),
           }
         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, graphql_identifier, context)
+        end
+
+        def config(context)
+          Features::Argo::Admin.new.config(context)
+        end
+      end
+    end
+  end
+end

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

@@ -45,9 +45,7 @@ module Script
 
           app_not_installed_cause: "App not installed on store.",
 
-          app_script_not_pushed_help: "Push the script and then try this command again.",
-
-          app_script_undefined_help: "Push script to app.",
+          app_script_not_pushed_help: "Script isn't on the app. Run {{command:shopify push}}, and then try again.",
 
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
@@ -73,7 +71,7 @@ module Script
           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.",
+          packages_outdated_help: "Update them by running {{cyan:npm install --save-dev %s}}.",
         },
 
         create: {

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

@@ -96,14 +96,11 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
           }
-        when Layers::Infrastructure::Errors::AppScriptNotPushedError
+        when Layers::Infrastructure::Errors::AppScriptNotPushedError,
+          Layers::Infrastructure::Errors::AppScriptUndefinedError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_script_not_pushed_help'),
           }
-        when Layers::Infrastructure::Errors::AppScriptUndefinedError
-          {
-            help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),
-          }
         when Layers::Infrastructure::Errors::BuildError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.build_error_cause'),
@@ -148,7 +145,10 @@ module Script
               'script.error.packages_outdated_cause',
               e.outdated_packages.join(', ')
             ),
-            help_suggestion: ShopifyCli::Context.message('script.error.packages_outdated_help'),
+            help_suggestion: ShopifyCli::Context.message(
+              'script.error.packages_outdated_help',
+              e.outdated_packages.collect { |package| "#{package}@latest" }.join(' ')
+            ),
           }
         end
       end

data/lib/shopify-cli/commands/config.rb

@@ -6,6 +6,7 @@ module ShopifyCli
       hidden_feature(feature_set: :debug)
 
       subcommand :Feature, 'feature'
+      subcommand :Analytics, 'analytics'
 
       def call(*)
         @ctx.puts(self.class.help)
@@ -16,6 +17,10 @@ module ShopifyCli
       end
 
       class Feature < ShopifyCli::SubCommand
+        def self.help
+          ShopifyCli::Context.message('core.config.feature.help', ShopifyCli::TOOL_NAME)
+        end
+
         options do |parser, flags|
           parser.on('--enable') { flags[:action] = 'enable' }
           parser.on('--disable') { flags[:action] = 'disable' }
@@ -28,7 +33,7 @@ module ShopifyCli
           is_enabled = ShopifyCli::Feature.enabled?(feature_name)
           if options.flags[:action] == 'disable' && is_enabled
             ShopifyCli::Feature.disable(feature_name)
-            @ctx.puts(@ctx.message('core.config.feature.disabled', is_enabled))
+            @ctx.puts(@ctx.message('core.config.feature.disabled', feature_name))
           elsif options.flags[:action] == 'enable' && !is_enabled
             ShopifyCli::Feature.enable(feature_name)
             @ctx.puts(@ctx.message('core.config.feature.enabled', feature_name))
@@ -39,6 +44,33 @@ module ShopifyCli
           end
         end
       end
+
+      class Analytics < ShopifyCli::SubCommand
+        def self.help
+          ShopifyCli::Context.message('core.config.analytics.help', ShopifyCli::TOOL_NAME)
+        end
+
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(_args, _name)
+          is_enabled = ShopifyCli::Config.get_bool('analytics', 'enabled')
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Config.set('analytics', 'enabled', false)
+            @ctx.puts(@ctx.message('core.config.analytics.disabled'))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Config.set('analytics', 'enabled', true)
+            @ctx.puts(@ctx.message('core.config.analytics.enabled'))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.analytics.is_enabled'))
+          else
+            @ctx.puts(@ctx.message('core.config.analytics.is_disabled'))
+          end
+        end
+      end
     end
   end
 end

data/lib/shopify-cli/js_system.rb

@@ -76,23 +76,40 @@ module ShopifyCli
     # - `ctx`: running context from your command
     # - `yarn`: The proc, array, or string command to run if yarn is available
     # - `npm`: The proc, array, or string command to run if npm is available
+    # - `capture_response`: The boolean flag to capture the output of the running command if it is set to true
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).call(yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+    #   ShopifyCli::JsSystem.new(ctx: ctx).call(
+    #     yarn: ['install', '--silent'],
+    #     npm: ['install', '--no-audit'],
+    #     capture_response: false
+    #   )
     #
-    def call(yarn:, npm:)
-      yarn? ? call_command(yarn, YARN_CORE_COMMAND) : call_command(npm, NPM_CORE_COMMAND)
+    def call(yarn:, npm:, capture_response: false)
+      if yarn?
+        call_command(yarn, YARN_CORE_COMMAND, capture_response)
+      else
+        call_command(npm, NPM_CORE_COMMAND, capture_response)
+      end
     end
 
     private
 
-    def call_command(command, core_command)
+    def call_command(command, core_command, capture_response)
       if command.is_a?(String) || command.is_a?(Array)
-        CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+        capture_response ? call_with_capture(command, core_command) : call_without_capture(command, core_command)
       else
         command.call
       end
     end
+
+    def call_with_capture(command, core_command)
+      CLI::Kit::System.capture3(core_command, *command, chdir: ctx.root)
+    end
+
+    def call_without_capture(command, core_command)
+      CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+    end
   end
 end

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

@@ -48,13 +48,27 @@ module ShopifyCli
         config: {
           help: <<~HELP,
           Change configuration of how the CLI operates
-            Usage: {{command:%s config [ feature ] [ feature_name ] }}
+            Usage: {{command:%s config [ feature | analytics ] }}
           HELP
           feature: {
-            enabled: "{{v}} feature {{green:%s}} was enabled",
-            disabled: "{{v}} feature {{green:%s}} was disabled",
-            is_enabled: "{{v}} feature {{green:%s}} is enabled",
-            is_disabled: "{{v}} feature {{green:%s}} is disabled",
+            help: <<~HELP,
+            Change configuration of various features
+              Usage: {{command:%s config [ feature ] [ feature_name ] }}
+            HELP
+            enabled: "{{v}} feature {{green:%s}} has been enabled",
+            disabled: "{{v}} feature {{green:%s}} has been disabled",
+            is_enabled: "{{v}} feature {{green:%s}} is currently enabled",
+            is_disabled: "{{v}} feature {{green:%s}} is currently disabled",
+          },
+          analytics: {
+            help: <<~HELP,
+            Opt in/out of anonymous usage reporting
+              Usage: {{command:%s config [ analytics ] }}
+            HELP
+            enabled: "{{v}} analytics have been enabled",
+            disabled: "{{v}} analytics have been disabled",
+            is_enabled: "{{v}} analytics are currently enabled",
+            is_disabled: "{{v}} analytics are currently disabled",
           },
         },
 

data/lib/shopify-cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,7 +147,9 @@ files:
 - lib/project_types/extension/commands/tunnel.rb
 - 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/admin.rb
+- lib/project_types/extension/features/argo/base.rb
+- lib/project_types/extension/features/argo/checkout.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
@@ -162,7 +164,7 @@ files:
 - lib/project_types/extension/models/registration.rb
 - lib/project_types/extension/models/type.rb
 - lib/project_types/extension/models/types/checkout_post_purchase.rb
-- lib/project_types/extension/models/types/subscription_management.rb
+- lib/project_types/extension/models/types/product_subscription.rb
 - lib/project_types/extension/models/validation_error.rb
 - lib/project_types/extension/models/version.rb
 - lib/project_types/extension/tasks/converters/app_converter.rb

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-require 'base64'
-
-module Extension
-  module Features
-    class Argo
-      include SmartProperties
-
-      GIT_ADMIN_TEMPLATE = 'https://github.com/Shopify/argo-admin-template.git'
-      GIT_CHECKOUT_TEMPLATE = 'https://github.com/Shopify/argo-checkout-template.git'
-      SCRIPT_PATH = %w(build main.js).freeze
-
-      class << self
-        def admin
-          @admin ||= Argo.new(setup: ArgoSetup.new(git_template: GIT_ADMIN_TEMPLATE))
-        end
-
-        def checkout
-          @checkout ||= Argo.new(
-            setup: ArgoSetup.new(
-              git_template: GIT_CHECKOUT_TEMPLATE,
-              dependency_checks: [ArgoDependencies.node_installed(min_major: 10, min_minor: 16)]
-            )
-          )
-        end
-      end
-
-      property! :setup, accepts: Features::ArgoSetup
-
-      def create(directory_name, identifier, context)
-        setup.call(directory_name, identifier, context)
-      end
-
-      def config(context)
-        filepath = File.join(context.root, SCRIPT_PATH)
-        context.abort(context.message('features.argo.missing_file_error')) unless File.exist?(filepath)
-
-        begin
-          {
-            serialized_script: Base64.strict_encode64(File.open(filepath).read.chomp),
-          }
-        rescue StandardError
-          context.abort(context.message('features.argo.script_prepare_error'))
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require 'base64'
-
-module Extension
-  module Models
-    module Types
-      class SubscriptionManagement < Models::Type
-        IDENTIFIER = 'SUBSCRIPTION_MANAGEMENT'
-
-        def create(directory_name, context)
-          Features::Argo.admin.create(directory_name, IDENTIFIER, context)
-        end
-
-        def config(context)
-          Features::Argo.admin.config(context)
-        end
-      end
-    end
-  end
-end