shopify-cli 1.7.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 718e73fd7541d075d7caf66c078dfe9ba3723299aa4fc668164dda9953c5dc7f
-  data.tar.gz: 116ed7d69bca5345c7120b9ca5e53172afe3bebaceb0a0539a2d128ebab6235f
+  metadata.gz: ea41fa5cbfa0eb2bf575fe82111c6be56df6807ed7696e64acc741ef2fa2e6be
+  data.tar.gz: 899299251ed4b0a50b0c3a5c5ae55324ebd64e92fbb981da7d4a093df94d5596
 SHA512:
-  metadata.gz: 11d8373057ed9d845c71863ba6443a47949a8c4e3c9d281b731638f0a1326be30076c94d38ee2d99a02a3779b4eaabd2a04b656306e4f1cd157888b483fe5946
-  data.tar.gz: 866966d912d1d65731619afe68fe37c9679852fd41a1e7c0b1eecc80a6182d505e06f0c5608f98ff7b53b8dde52d136ce6ac5e3b037282f62458086df2fabb52
+  metadata.gz: 8b757bbf4ef686593f3fe8fdf82da6c83468f40d04bc312476e2bea614d5f75e3d63afe097c149f3de34b35631032c096799f0728b12732dfbbb5bd3e5141384
+  data.tar.gz: 2059062ef9aff95cad44d2b4bcad442e2cf82636d6733c065bb83544ac4d0b8cef2a5de3c438d5f252a251fa0cf813b03fc064db407940e3469b476a26c35e0d

data/.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.version }}
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        version:
+          - 3.0.0
+          - 2.6.6
+          - 2.7.1
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with: 
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Run Tests
+        run: bundle exec rake

data/.rubocop_todo.yml

@@ -1,11 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-12-01 16:33:09 UTC using RuboCop version 1.4.1.
+# on 2021-04-08 18:25:36 UTC using RuboCop version 1.12.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: 30
+# Offense count: 35
 Minitest/MultipleAssertions:
   Max: 9
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'lib/docgen/markdown.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/shopify-cli/shopifolk.rb'
+    - 'test/shopify-cli/tunnel_test.rb'

data/CHANGELOG.md

@@ -1,8 +1,29 @@
 Unreleased
 ------
 
+Version 1.10.0
+-------------
+* Updating internal features in development
+
+Version 1.9.1
+-------------
+* [1201](https://github.com/Shopify/shopify-app-cli/pull/1201) Determine Argo Renderer Dynamically. This fixes `shopify serve` and `shopify push` for extensions.
+
+Version 1.9.0
+-------------
+* [1181](https://github.com/Shopify/shopify-app-cli/pull/1181): Remove the subcommand references of the `generate` command for node apps (fixes [1176](https://github.com/Shopify/shopify-app-cli/issues/1176))
+
+Version 1.8.0
+-------------
+* [1119](https://github.com/Shopify/shopify-app-cli/pull/1119): Enable guest serialization for scripts
+
+Version 1.7.1
+------
+* Updating internal features in development
+
 Version 1.7.0
 -----
+* [#1109](https://github.com/Shopify/shopify-app-cli/pull/1109): Abort app generation if name contains disallowed text.
 * [#1075](https://github.com/Shopify/shopify-app-cli/pull/1075): Add support for kebab-case flags
 
 Version 1.6.0

data/Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
@@ -22,7 +22,7 @@ GEM
       ruby-progressbar
     mocha (1.11.2)
     parallel (1.20.1)
-    parser (2.7.2.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -33,26 +33,26 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
-    rubocop (1.4.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.12.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.1.1)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-minitest (0.10.1)
       rubocop (>= 0.87)
-    rubocop-shopify (1.0.7)
-      rubocop (~> 1.4)
-    ruby-progressbar (1.10.1)
+    rubocop-shopify (2.0.1)
+      rubocop (~> 1.11)
+    ruby-progressbar (1.11.0)
     timecop (0.9.2)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     webmock (3.9.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

data/README.md

@@ -1,6 +1,7 @@
 # [Shopify App CLI](https://shopify.dev/tools/cli)
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)[![Build Status](https://travis-ci.com/Shopify/shopify-app-cli.svg?token=qtPazgjyosjEEgxgq7VZ&branch=master)](https://travis-ci.com/Shopify/shopify-app-cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
+[![Build Status](https://github.com/Shopify/shopify-app-cli/workflows/CI/badge.svg)](https://github.com/Shopify/shopify-app-cli/actions)
 
 Shopify App CLI helps you build Shopify apps faster. It quickly generates Node.js and Ruby on Rails apps and automates many common development tasks.
 

data/dev.yml

@@ -5,6 +5,9 @@ type:
 up:
   - ruby: 2.5.1
   - bundler
+  - node:
+      version: 14.9.0
+      yarn: true
 
 test:
   desc: 'Run tests.'

data/lib/docgen/markdown.rb

@@ -89,7 +89,7 @@ module RDoc
         lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
         lines.each do |line|
           next unless line =~ /^ *(?=\S)/
-          n = $&.length
+          n = Regexp.last_match(0).length
           indent = n if n < indent
           break if n == 0
         end

data/lib/graphql/extension_create.graphql

@@ -1,7 +1,22 @@
-mutation ExtensionCreate($api_key: String!, $type: ExtensionType!, $title: String!, $config: JSON!, $extension_context: String) {
-  extensionCreate(input: {apiKey: $api_key, type: $type, title: $title, config: $config, context: $extension_context}) {
+mutation ExtensionCreate(
+  $api_key: String!
+  $type: ExtensionType!
+  $title: String!
+  $config: JSON!
+  $extension_context: String
+) {
+  extensionCreate(
+    input: {
+      apiKey: $api_key
+      type: $type
+      title: $title
+      config: $config
+      context: $extension_context
+    }
+  ) {
     extensionRegistration {
       id
+      uuid
       type
       title
       draftVersion {

data/lib/graphql/fetch_specifications.graphql

@@ -0,0 +1,14 @@
+query fetchSpecifications($api_key: String!) {
+  extensionSpecifications(apiKey: $api_key) {
+    name
+    identifier
+    options {
+      managementExperience
+    }
+    features {
+      argo {
+        surface
+      }
+    }
+  }
+}

data/lib/project_types/extension/cli.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Extension
+  class PackageNotFound < RuntimeError; end
+
   class Project < ShopifyCli::ProjectType
     hidden_feature
     title("App Extension")
@@ -57,6 +59,8 @@ module Extension
   end
 
   module Features
+    autoload :ArgoRendererPackage, Project.project_filepath("features/argo_renderer_package")
+    autoload :ArgoServe, Project.project_filepath("features/argo_serve")
     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")
@@ -81,14 +85,4 @@ module Extension
 
   autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")
   autoload :ExtensionProject, Project.project_filepath("extension_project")
-
-  def self.specifications
-    @specifications ||= Models::Specifications.new(
-      fetch_specifications: Tasks::FetchSpecifications
-    )
-  end
-
-  def self.specifications=(specifications)
-    @specifications = specifications
-  end
 end

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

@@ -38,8 +38,8 @@ module Extension
             Usage: {{command:#{ShopifyCli::TOOL_NAME} create extension}}
             Options:
               {{command:--type=TYPE}} The type of extension you would like to create.
-              {{command:--name=NAME}} The name of your extension (50 characters).”
-              {{command:--api-key=KEY}} The API key of your app.”
+              {{command:--name=NAME}} The name of your extension (50 characters).
+              {{command:--api-key=KEY}} The API key of your app.
         HELP
       end
 

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

@@ -8,15 +8,19 @@ module Extension
         @project ||= ExtensionProject.current
       end
 
-      def extension_type
-        @extension_type ||= begin
-          identifier = project.extension_type_identifier
+      def specification_handler
+        @specification_handler ||= begin
+          identifier = project.specification_identifier
           Models::LazySpecificationHandler.new(identifier) do
-            unless Extension.specifications.valid?(identifier)
-              @ctx.abort(@ctx.message("errors.unknown_type", project.extension_type_identifier))
+            specifications = Models::Specifications.new(
+              fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: @ctx)
+            )
+
+            unless specifications.valid?(identifier)
+              @ctx.abort(@ctx.message("errors.unknown_type", project.specification_identifier))
             end
 
-            Extension.specifications[identifier]
+            specifications[identifier]
           end
         end
       end

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

@@ -59,8 +59,8 @@ module Extension
             context: @ctx,
             api_key: project.app.api_key,
             registration_id: project.registration_id,
-            config: extension_type.config(@ctx),
-            extension_context: extension_type.extension_context(@ctx)
+            config: specification_handler.config(@ctx),
+            extension_context: specification_handler.extension_context(@ctx)
           )
         end
       end

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

@@ -12,7 +12,7 @@ module Extension
 
           update_project_files(registration)
 
-          @ctx.puts(@ctx.message("register.success", project.title, app.title))
+          @ctx.puts(@ctx.message("register.success", project.title))
           @ctx.puts(@ctx.message("register.success_info"))
         end
       end
@@ -27,8 +27,8 @@ module Extension
       private
 
       def confirm_registration
-        @ctx.puts(@ctx.message("register.confirm_info", extension_type.name))
-        CLI::UI::Prompt.confirm(@ctx.message("register.confirm_question", app.title))
+        @ctx.puts(@ctx.message("register.confirm_info", specification_handler.name))
+        CLI::UI::Prompt.confirm(@ctx.message("register.confirm_question"))
       end
 
       def register_extension
@@ -37,10 +37,10 @@ module Extension
         Tasks::CreateExtension.call(
           context: @ctx,
           api_key: app.api_key,
-          type: extension_type.graphql_identifier,
+          type: specification_handler.graphql_identifier,
           title: project.title,
           config: {},
-          extension_context: extension_type.extension_context(@ctx)
+          extension_context: specification_handler.extension_context(@ctx)
         )
       end
 
@@ -50,6 +50,7 @@ module Extension
           api_key: app.api_key,
           api_secret: app.secret,
           registration_id: registration.id,
+          registration_uuid: registration.uuid,
           title: project.title
         )
       end

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

@@ -3,14 +3,8 @@
 module Extension
   module Commands
     class Serve < ExtensionCommand
-      YARN_SERVE_COMMAND = %w(server)
-      NPM_SERVE_COMMAND = %w(run-script server)
-
       def call(_args, _command_name)
-        CLI::UI::Frame.open(@ctx.message("serve.frame_title")) do
-          success = ShopifyCli::JsSystem.call(@ctx, yarn: YARN_SERVE_COMMAND, npm: NPM_SERVE_COMMAND)
-          @ctx.abort(@ctx.message("serve.serve_failure_message")) unless success
-        end
+        specification_handler.serve(@ctx)
       end
 
       def self.help

data/lib/project_types/extension/extension_project.rb

@@ -9,20 +9,27 @@ module Extension
           context,
           project_type: :extension,
           organization_id: nil,
-          "#{ExtensionProjectKeys::EXTENSION_TYPE_KEY}": type
+          "#{ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY}": type
         )
       end
 
-      def write_env_file(context:, title:, api_key: "", api_secret: "", registration_id: nil)
+      def write_env_file(
+        context:, title:, api_key: "", api_secret: "", registration_id: nil, registration_uuid: nil
+      )
         ShopifyCli::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
           extra: {
             ExtensionProjectKeys::TITLE_KEY => title,
             ExtensionProjectKeys::REGISTRATION_ID_KEY => registration_id,
+            ExtensionProjectKeys::REGISTRATION_UUID_KEY => registration_uuid || generate_temporary_uuid,
           }.compact
         ).write(context)
 
+        reload
+      end
+
+      def reload
         current.reload unless project_empty?
       end
 
@@ -45,8 +52,8 @@ module Extension
       get_extra_field(ExtensionProjectKeys::TITLE_KEY)
     end
 
-    def extension_type_identifier
-      config[ExtensionProjectKeys::EXTENSION_TYPE_KEY]
+    def specification_identifier
+      config[ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
     end
 
     def registration_id?
@@ -59,10 +66,18 @@ module Extension
       get_extra_field(ExtensionProjectKeys::REGISTRATION_ID_KEY).to_i
     end
 
+    def registration_uuid
+      get_extra_field(ExtensionProjectKeys::REGISTRATION_UUID_KEY)
+    end
+
     def reload
       @env = nil
     end
 
+    def self.generate_temporary_uuid
+      "dev-#{SecureRandom.uuid}"
+    end
+
     private
 
     def get_extra_field(key)

data/lib/project_types/extension/extension_project_keys.rb

@@ -4,7 +4,8 @@ require "shopify_cli"
 module Extension
   module ExtensionProjectKeys
     REGISTRATION_ID_KEY = "EXTENSION_ID"
-    EXTENSION_TYPE_KEY = "EXTENSION_TYPE"
+    REGISTRATION_UUID_KEY = "EXTENSION_UUID"
+    SPECIFICATION_IDENTIFIER_KEY = "EXTENSION_TYPE"
     TITLE_KEY = "EXTENSION_TITLE"
   end
 end

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

@@ -14,8 +14,8 @@ module Extension
       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_COMMAND = %w(list).freeze
+      NPM_LIST_PARAMETERS = %w(--prod --depth=1).freeze
       YARN_LIST_PARAMETERS = %w(--production).freeze
       private_constant :NPM_LIST_COMMAND, :YARN_LIST_COMMAND, :NPM_LIST_PARAMETERS, :YARN_LIST_PARAMETERS
 
@@ -39,7 +39,7 @@ module Extension
         context.abort(context.message("features.argo.missing_file_error")) unless File.exist?(filepath)
         begin
           {
-            renderer_version: extract_argo_renderer_version(context),
+            renderer_version: renderer_package(context).version,
             serialized_script: Base64.strict_encode64(File.read(filepath).chomp),
           }
         rescue StandardError
@@ -47,45 +47,29 @@ module Extension
         end
       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
+      def renderer_package(context)
+        Features::ArgoRendererPackage.from_package_manager(run_list_command(context))
+      rescue Extension::PackageNotFound
         context.abort(
-          context.message("features.argo.dependencies.argo_renderer_package_invalid_version_error")
+          context.message("features.argo.dependencies.argo_missing_renderer_package_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
+      private
 
       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,
+        yarn_list = YARN_LIST_COMMAND + YARN_LIST_PARAMETERS
+        npm_list = NPM_LIST_COMMAND + NPM_LIST_PARAMETERS
+
+        result, _error, _status = ShopifyCli::JsSystem.call(
+          context,
+          yarn: yarn_list,
+          npm: npm_list,
           capture_response: true
         )
-        context.abort(
-          context.message("features.argo.dependencies.argo_missing_renderer_package_error", error)
-        ) unless status.success?
+        # context.abort(
+        #   context.message("features.argo.dependencies.argo_missing_renderer_package_error", error)
+        # ) unless status.success?
         result
       end