shopify-cli 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46dd31f52ee5649fcf42ca444e124fb2bf91e65c8cf2450a3e0a296da669e13
-  data.tar.gz: 1712d16f7849ec0fa33c898fb425e5543dc792549bf1925311b5cb52b6dbc7d2
+  metadata.gz: 5832060f2695566da5c38ce98ccd1c67d522e8bb8306a5b2a16d95f92b3e56f1
+  data.tar.gz: e223c587130318b500d5cd12b494c50aef424957aef5da797dafea4b233e9933
 SHA512:
-  metadata.gz: 20fa92e7de4e785804a620c612ca40317c341d69ef636e0d611d9dda081decb57bca95ca478cef2ed4f151fb7613fe749000f1f4d85c17d211c4367cfbd8f676
-  data.tar.gz: af418cf9c0d05c82e4f29776111286760865d54e7b99774a8d63d70537de69073152a8a643c33965870d85e3209af1f21e27daea6f77826ff096bfbc2aa50ceb
+  metadata.gz: b85a1e420f5d8b80a46f93ca4d16ebc1198fd31899bc7fbb8c9e0fbfa485c5f38fe9eca820782b0c4743b53e10266ce73bb0010fa90cd5b08fff199bb6a99585
+  data.tar.gz: 0dfd783ede5fcad7b04d648ec0f4d7084bea778d1fe7c73c0d2a86e683181cce73e8706a53462b7e285c04095dcebcc0c7cc489587f35ceb34716be4ec71efa2

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

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/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/shopify-cli/api.rb

@@ -1,5 +1,4 @@
 require 'shopify_cli'
-require 'net/http'
 
 module ShopifyCli
   class API
@@ -32,8 +31,9 @@ module ShopifyCli
       )
       ctx.debug(resp)
       resp
-    rescue API::APIRequestServerError, API::APIRequestUnexpectedError
+    rescue API::APIRequestServerError, API::APIRequestUnexpectedError => e
       ctx.puts(ctx.message('core.api.error.internal_server_error'))
+      ctx.debug(ctx.message('core.api.error.internal_server_error_debug', e.message))
     end
 
     protected
@@ -58,14 +58,10 @@ module ShopifyCli
         unless uri.is_a?(URI::HTTP)
           ctx.abort("Invalid URL: #{graphql_url}")
         end
-        http = ::Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
 
-        req = ::Net::HTTP::Post.new(uri.request_uri)
-        req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
-        req['Content-Type'] = 'application/json'
-        headers.each { |header, value| req[header] = value }
-        response = http.request(req)
+        # we delay this require so as to avoid a performance hit on starting the CLI
+        require 'shopify-cli/http_request'
+        response = HttpRequest.call(uri, body, variables, headers)
 
         case response.code.to_i
         when 200..399

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

@@ -23,6 +23,7 @@ module ShopifyCli
         display_cli_ruby(show_all_details)
         display_utility_commands(show_all_details)
         display_project_commands(show_all_details)
+        display_shopify_staff_identity if show_all_details
       end
 
       def self.help
@@ -139,6 +140,14 @@ module ShopifyCli
         end
         @ctx.puts("")
       end
+
+      def display_shopify_staff_identity
+        is_shopifolk = ShopifyCli::Shopifolk.check
+        if is_shopifolk
+          @ctx.puts("\n" + @ctx.message('core.system.identity_header'))
+          @ctx.puts("  " + @ctx.message('core.system.identity_is_shopifolk'))
+        end
+      end
     end
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -28,7 +28,7 @@ module ShopifyCli
             ctx.puts(
               ctx.message('core.warning.development_version', File.join(ShopifyCli::ROOT, 'bin', ShopifyCli::TOOL_NAME))
             )
-          else
+          elsif !ctx.testing?
             new_version = ctx.new_version
             ctx.puts(ctx.message('core.warning.new_version', ShopifyCli::VERSION, new_version)) unless new_version.nil?
           end

data/lib/shopify-cli/http_request.rb

@@ -0,0 +1,15 @@
+require 'net/http'
+
+module ShopifyCli
+  class HttpRequest
+    def self.call(uri, body, variables, headers)
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      req = ::Net::HTTP::Post.new(uri.request_uri)
+      req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
+      req['Content-Type'] = 'application/json'
+      headers.each { |header, value| req[header] = value }
+      http.request(req)
+    end
+  end
+end

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

@@ -177,6 +177,7 @@ module ShopifyCli
         api: {
           error: {
             internal_server_error: '{{red:{{x}} An unexpected error occurred on Shopify.}}',
+            internal_server_error_debug: "\n{{red:Response details:}}\n%s\n\n",
           },
         },
 
@@ -251,6 +252,8 @@ module ShopifyCli
           },
           environment_header: "{{bold:Environment}}",
           env: "%-17s = %s",
+          identity_header: "{{bold:Identity}}",
+          identity_is_shopifolk: "{{v}} Checked user settings: you’re Shopify staff!",
         },
 
         tasks: {

data/lib/shopify-cli/shopifolk.rb

@@ -0,0 +1,67 @@
+module ShopifyCli
+  ##
+  # ShopifyCli::Shopifolk contains the logic to determine if the user appears to be a Shopify staff
+  #
+  # The Shopifolk Feature flag will persist between runs so if the flag is enabled or disabled,
+  # it will still be in that same state until the next class invocation.
+  class Shopifolk
+    GCLOUD_CONFIG_FILE = File.expand_path('~/.config/gcloud/configurations/config_default')
+    DEV_PATH = '/opt/dev'
+    SECTION = 'core'
+    FEATURE_NAME = 'shopifolk'
+
+    ##
+    # will return if the user appears to be a Shopify employee, based on several heuristics
+    #
+    # #### Returns
+    #
+    # * `is_shopifolk` - returns true if the user is a Shopify Employee
+    #
+    # #### Example
+    #
+    #     ShopifyCli::Shopifolk.check
+    #
+    def self.check
+      ShopifyCli::Shopifolk.new.shopifolk?
+    end
+
+    ##
+    # will return if the user is a Shopify employee
+    #
+    # #### Returns
+    #
+    # * `is_shopifolk` - returns true if the user has `dev` installed and
+    # a valid google cloud config file with email ending in "@shopify.com"
+    #
+    def shopifolk?
+      return true if Feature.enabled?(FEATURE_NAME)
+      if shopifolk_by_gcloud? && shopifolk_by_dev?
+        ShopifyCli::Feature.enable(FEATURE_NAME)
+        true
+      else
+        ShopifyCli::Feature.disable(FEATURE_NAME)
+        false
+      end
+    end
+
+    private
+
+    def shopifolk_by_gcloud?
+      ini&.dig("[#{SECTION}]", 'account')&.match?(/@shopify.com\z/)
+    end
+
+    def shopifolk_by_dev?
+      File.exist?("#{DEV_PATH}/bin/dev") && File.exist?("#{DEV_PATH}/.shopify-build")
+    end
+
+    def ini
+      @ini ||= begin
+        if File.exist?(GCLOUD_CONFIG_FILE)
+          CLI::Kit::Ini
+            .new(GCLOUD_CONFIG_FILE, default_section: "[#{SECTION}]", convert_types: false)
+            .tap(&:parse).ini
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/lib/shopify_cli.rb

@@ -116,6 +116,7 @@ module ShopifyCli
   autoload :Project, 'shopify-cli/project'
   autoload :ProjectType, 'shopify-cli/project_type'
   autoload :Resources, 'shopify-cli/resources'
+  autoload :Shopifolk, 'shopify-cli/shopifolk'
   autoload :SubCommand, 'shopify-cli/sub_command'
   autoload :Task, 'shopify-cli/task'
   autoload :Tasks, 'shopify-cli/tasks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - ".github/probots.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".tmp/.gitkeep"
 - ".tmp/sv/.gitkeep"
@@ -278,6 +279,7 @@ files:
 - lib/shopify-cli/helpers.rb
 - lib/shopify-cli/helpers/haikunator.rb
 - lib/shopify-cli/heroku.rb
+- lib/shopify-cli/http_request.rb
 - lib/shopify-cli/js_deps.rb
 - lib/shopify-cli/js_system.rb
 - lib/shopify-cli/messages/messages.rb
@@ -292,6 +294,7 @@ files:
 - lib/shopify-cli/project_type.rb
 - lib/shopify-cli/resources.rb
 - lib/shopify-cli/resources/env_file.rb
+- lib/shopify-cli/shopifolk.rb
 - lib/shopify-cli/sub_command.rb
 - lib/shopify-cli/task.rb
 - lib/shopify-cli/tasks.rb