shopify-cli 1.2.0 → 1.5.0

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

@@ -3,7 +3,8 @@
 module Extension
   class Project < ShopifyCli::ProjectType
     hidden_feature
-    creator 'App Extension', 'Extension::Commands::Create'
+    title('App Extension')
+    creator('Extension::Commands::Create')
 
     register_command('Extension::Commands::Build', "build")
     register_command('Extension::Commands::Register', "register")
@@ -48,12 +49,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, IDENTIFIER, context)
+        end
+
+        def config(context)
+          Features::Argo::Admin.new.config(context)
+        end
+      end
+    end
+  end
+end

data/lib/project_types/node/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module Node
   class Project < ShopifyCli::ProjectType
-    creator 'Node.js App', 'Node::Commands::Create'
+    title('Node.js App')
+    creator('Node::Commands::Create')
+    connector('Node::Commands::Connect')
 
     register_command('Node::Commands::Deploy', "deploy")
     register_command('Node::Commands::Generate', "generate")
@@ -17,6 +19,7 @@ module Node
 
   # define/autoload project specific Commands
   module Commands
+    autoload :Connect, Project.project_filepath('commands/connect')
     autoload :Create, Project.project_filepath('commands/create')
     autoload :Deploy, Project.project_filepath('commands/deploy')
     autoload :Generate, Project.project_filepath('commands/generate')

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Node
+  module Commands
+    class Connect < ShopifyCli::SubCommand
+      def call(*)
+        if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
+          @ctx.puts(@ctx.message('node.connect.production_warning'))
+        end
+
+        app = ShopifyCli::Commands::Connect.new.default_connect('node')
+        @ctx.done(@ctx.message('node.connect.connected', app))
+      end
+    end
+  end
+end

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

@@ -40,11 +40,11 @@ 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 = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client['id'], local_debug?)
 
-        @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))
-        @ctx.puts(@ctx.message('node.create.info.install', partners_url, form.title))
+        @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))
       end
 
       def self.help
@@ -112,6 +112,10 @@ module Node
           @ctx.debug(e)
         end
       end
+
+      def local_debug?
+        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
+      end
     end
   end
 end

data/lib/project_types/node/messages/messages.rb

@@ -8,6 +8,13 @@ module Node
           generic: "Error",
         },
 
+        connect: {
+          connected: "Project now connected to {{green:%s}}",
+          production_warning: <<~MESSAGE,
+          {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
+          MESSAGE
+        },
+
         create: {
           help: <<~HELP,
           {{command:%s create node}}: Creates an embedded nodejs app.
@@ -26,12 +33,6 @@ module Node
             npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
               "the instructions at https://www.npmjs.com/get-npm.",
           },
-          info: {
-            created: "{{v}} {{green:%s}} was created in your Partner Dashboard {{underline:%s}}",
-            serve: "{{*}} Change directories to your new project folder {{green:%s}} and run {{command:%s serve}} " \
-              "to start a local server",
-            install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
-          },
           node_version: "node %s",
           npm_version: "npm %s",
         },

data/lib/project_types/rails/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module Rails
   class Project < ShopifyCli::ProjectType
-    creator 'Ruby on Rails App', 'Rails::Commands::Create'
+    title('Ruby on Rails App')
+    creator('Rails::Commands::Create')
+    connector('Rails::Commands::Connect')
 
     register_command('Rails::Commands::Deploy', "deploy")
     register_command('Rails::Commands::Generate', "generate")
@@ -17,6 +19,7 @@ module Rails
 
   # define/autoload project specific Commands
   module Commands
+    autoload :Connect, Project.project_filepath('commands/connect')
     autoload :Create, Project.project_filepath('commands/create')
     autoload :Deploy, Project.project_filepath('commands/deploy')
     autoload :Generate, Project.project_filepath('commands/generate')

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Rails
+  module Commands
+    class Connect < ShopifyCli::SubCommand
+      def call(*)
+        if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
+          @ctx.puts(@ctx.message('rails.connect.production_warning'))
+        end
+
+        app = ShopifyCli::Commands::Connect.new.default_connect('rails')
+        @ctx.done(@ctx.message('rails.connect.connected', app))
+      end
+    end
+  end
+end

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

@@ -55,11 +55,11 @@ 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 = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client['id'], local_debug?)
 
-        @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))
-        @ctx.puts(@ctx.message('rails.create.info.install', partners_url, form.title))
+        @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))
       end
 
       def self.help
@@ -172,6 +172,10 @@ module Rails
       def install_gem(name, version = nil)
         Gem.install(@ctx, name, version)
       end
+
+      def local_debug?
+        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
+      end
     end
   end
 end