shopify-cli 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8765adff2578420b0bbaaf7aa30e7e3f6b28b20363671f9e64a419f8b97fe647
-  data.tar.gz: 17e00973e6c881c58c1e0ade838a98e93a17a39f7d960261a36f9cdc74a87940
+  metadata.gz: 5832060f2695566da5c38ce98ccd1c67d522e8bb8306a5b2a16d95f92b3e56f1
+  data.tar.gz: e223c587130318b500d5cd12b494c50aef424957aef5da797dafea4b233e9933
 SHA512:
-  metadata.gz: '08b07fe290962b6ba6416214165dde7d9c78d01c7eade8662917ec530af18af1a773b08957c58be5b6c10c733bd4be8e2c40a24c2241153d575a158d3988bb84'
-  data.tar.gz: 171f11dd5a4e740cb91345ed51e10485f9499e328bc6dec0ab3027c415b35fd312b616c451137639c224c07862d8651836074ef5bbb85563229ca93d85aa944a
+  metadata.gz: b85a1e420f5d8b80a46f93ca4d16ebc1198fd31899bc7fbb8c9e0fbfa485c5f38fe9eca820782b0c4743b53e10266ce73bb0010fa90cd5b08fff199bb6a99585
+  data.tar.gz: 0dfd783ede5fcad7b04d648ec0f4d7084bea778d1fe7c73c0d2a86e683181cce73e8706a53462b7e285c04095dcebcc0c7cc489587f35ceb34716be4ec71efa2

data/.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@ Shopify App CLI is an open source project. We want to make it as easy and transp
 
 ## Code of conduct
 
-We expect all participants to read our [code of conduct](https://github.com/Shopify/shopify-app-cli/.github/CODE_OF_CONDUCT.md) to understand which actions are and aren’t tolerated.
+We expect all participants to read our [code of conduct](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CODE_OF_CONDUCT.md) to understand which actions are and aren’t tolerated.
 
 ## Open development
 

data/.gitignore

@@ -1,4 +1,3 @@
-.rubocop-*
 .tmp/*
 .bundle/*
 .DS_Store

data/.rubocop.yml

@@ -1,5 +1,8 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop-cli.yml
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  rubocop-shopify:
+    - rubocop-cli.yml
 
 AllCops:
   Exclude:
@@ -45,3 +48,4 @@ Style/MethodCallWithArgsParentheses:
     - assert_equal
     - assert
     - refute
+    - assert_requested # from Webmock

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-10-17 00:53:36 UTC using RuboCop version 0.93.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 66
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreMacros, IgnoredMethods, IgnoredPatterns, IncludedMacros, AllowParenthesesInMultilineCall, AllowParenthesesInChaining, AllowParenthesesInCamelCaseMethod, EnforcedStyle.
+# SupportedStyles: require_parentheses, omit_parentheses
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'test/test_helper.rb'

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+Unreleased
+------
+
+Version 1.4.0
+------
+* Updates to tests, dependencies and internal tooling
+* #924: Improve debugging messages on Partner API errors
+
+Version 1.3.1
+------
+* Allow any characters in ngrok account names
+
+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
+
+Version 1.1.2
+------
+* Fix various minor bugs (check dir before creating Rails project, catch stderr from failed git command)
+
 Version 1.1.1
 ------
 * Fix a bug where usernames with spaces caused issues on Windows

data/Gemfile

@@ -8,11 +8,10 @@ group :development, :test do
   gem 'rake'
   gem 'pry-byebug'
   gem 'byebug'
-  gem 'rubocop'
+  gem 'rubocop-shopify', require: false
 end
 
 group :test do
-  gem 'session'
   gem 'mocha', require: false
   gem 'minitest', '>= 5.0.0', require: false
   gem 'minitest-reporters', require: false

data/Gemfile.lock

@@ -23,7 +23,7 @@ GEM
     mocha (1.7.0)
       metaclass (~> 0.0.1)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -34,22 +34,23 @@ GEM
     public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
-    rubocop (0.89.1)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    rubocop-shopify (1.0.6)
+      rubocop (>= 0.92, < 0.94)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.4)
-    session (3.2.0)
     timecop (0.9.1)
     unicode-display_width (1.7.0)
     webmock (2.3.2)
@@ -68,8 +69,7 @@ DEPENDENCIES
   mocha
   pry-byebug
   rake
-  rubocop
-  session
+  rubocop-shopify
   timecop
   webmock
 

data/RELEASING.md

@@ -2,42 +2,54 @@
 
 1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
 
-2. Create a branch named `release_X_Y_Z` (replacing `X_Y_Z` with the intended release version)
+1. Make sure you're on the most recent `master`
+   ```
+   $ git checkout master
+   $ git pull
+   ```
+
+1. Create a branch named `release_X_Y_Z` (replacing `X_Y_Z` with the intended release version)
    ```
    $ git checkout -b release_X_Y_Z
    ```
 
-3. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
+1. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
 
-4. Add an entry for the new release to `CHANGELOG.md`
+1. Add an entry for the new release to `CHANGELOG.md`
 
-5. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+1. Commit the changes with a commit message like "Packaging for release X.Y.Z"
    ```
    $ git commit -am "Packaging for release vX.Y.Z"
    ```
 
-6. Push out the changes
+1. Push out the changes
    ```
    $ git push -u origin release_X_Y_Z
    ```
 
-7. Open a PR for the branch, get necessary approvals from code owners and merge into main branch. Note that the PR title will be the release note in Shipit, so make sure it mentions the release
+1. Open a PR for the branch, get necessary approvals from code owners and merge into main branch. Note that the PR title will be the release note in Shipit, so make sure it mentions the release
 
-8. Deploy using Shipit
+1. Deploy using Shipit
+
+1. Update your `master` branch to the latest version
+   ```
+   $ git checkout master
+   $ git pull
+   ```
 
-9. On local machine and _AFTER_ gem has been published to https://rubygems.org, run
+1. On local machine and _AFTER_ gem has been published to https://rubygems.org, run
    ```
    $ rake package
    ```
    This will generate the `.deb`, `.rpm` and brew formula files, which will be located in `packaging/builds/X.Y.Z/`.
 
-10. Clone the `Shopify/homebrew-shopify` repository (if not already cloned), and then
+1. Clone the `Shopify/homebrew-shopify` repository (if not already cloned), and then
     * create a branch named `release_X_Y_Z_of_shopify-cli`
     * update the brew formula in `shopify-cli.rb` with the generated formula in `packaging/builds/X.Y.Z/` in the `Shopify/shopify-app-cli` repo (from step 9)
     * commit the change and create a PR on the [Shopify Homebrew repository](https://github.com/Shopify/homebrew-shopify)
     * when PR is approved, merge into main branch
 
-11. Go to [releases](https://github.com/Shopify/shopify-app-cli/releases) page of `Shopify/shopify-app-cli` repo and create a new release:
+1. Go to [releases](https://github.com/Shopify/shopify-app-cli/releases) page of `Shopify/shopify-app-cli` repo and create a new release:
     * use the tag created in step 8 by Shipit (should be "vX.Y.Z")
     * release title = "Version X.Y.Z"
     * description should be 

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,11 +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/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