shopify-cli 1.8.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30e766112b0e09d6de0e907ecf7e002377fe8a0ecb6776bf0975ec1677a5858a
-  data.tar.gz: 3fbcc004481a0b06c8ccfcd0fb5890d7ab4bf6ee778a6b4dc43c773508376a05
+  metadata.gz: 45acefe059ce1e83e77f20be8ee3b7815c5be28f834ef7697dd9000175884c4f
+  data.tar.gz: a1abb2765725c6a1d593f869c323f179429b7c21d25de9bfa8649e5817dc9d6e
 SHA512:
-  metadata.gz: d3b9f2da8984619e58cb73a5a066bd67b7b0e3f050a82f794b36079d3f0850d8c57e4e346e7f6ae0c0ea01601d07e26d54359cced3e132d23246ad88bbed314f
-  data.tar.gz: 1ec7d262e39e6b112cf25a35b85788faeb77fce56febdeb46e0f8630608ca19ec0eb032b668302515e23fbfa0831ad25492439cc8cb35e5fb376c6e2277e4596
+  metadata.gz: 5f73366ea4f16f7d5615fe6ae62edd58692f85288b7f6056be61a4cbcbf72c94a1979cc806255fe55c82504f42433c1264ca9b479203639dbaf209273189cccc
+  data.tar.gz: 556ef6bdc6338c156d1ef6c9f9971e37d687cd7c1c8c93f6dc609a053f2303cde7d03b968e2e0e2336e59bc5b89539e8fb3a12f38e3427bbddb29bf448d7f130

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -29,3 +29,4 @@ Fixes #0000 <!-- link to issue if one exists -->
 -->
 - [ ] I've added a CHANGELOG entry for this PR (if the change is public-facing)
 - [ ] I've considered possible cross-platform impacts (Mac, Linux, Windows).
+- [ ] I've left the version number as is (we'll handle incrmenting this when releasing).

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,9 +1,32 @@
 Unreleased
 ------
 
-Version 1.8.0
+Version 1.12.0
+--------------
+* [1255](https://github.com/Shopify/shopify-app-cli/pull/1255): Fix beta flag checks when running `shopify serve`
+
+Version 1.11.0
+--------------
+* [#1221](https://github.com/Shopify/shopify-app-cli/pull/1221): Prioritizes returning an HTTPS URL over HTTP from `shopify tunnel status`.
+* [#1223](https://github.com/Shopify/shopify-app-cli/pull/1233): Running `shopify serve` in an extension project now automatically runs `shopify tunnel`.
+* [#1225](https://github.com/Shopify/shopify-app-cli/pull/1225): Improved handling of "account not found" scenario, plus improvements to related tests and UX messaging
+* [#1229](https://github.com/Shopify/shopify-app-cli/pull/1229): Allows Checkout Extensions to specify configuration attributes in their extension.config.yml file.
+* [#1238](https://github.com/Shopify/shopify-app-cli/pull/1238): Auto Tunnel Support for Checkout Extension
+
+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

data/Gemfile.lock

@@ -22,7 +22,7 @@ GEM
       ruby-progressbar
     mocha (1.11.2)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -34,8 +34,8 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rubocop (1.11.0)
+    rexml (3.2.5)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -76,4 +76,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

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/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/project_types/extension/cli.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Extension
+  class PackageResolutionFailed < RuntimeError; end
+
   class Project < ShopifyCli::ProjectType
     hidden_feature
     title("App Extension")
@@ -36,6 +38,8 @@ module Extension
     autoload :UpdateDraft, Project.project_filepath("tasks/update_draft")
     autoload :FetchSpecifications, Project.project_filepath("tasks/fetch_specifications")
     autoload :ConfigureFeatures, Project.project_filepath("tasks/configure_features")
+    autoload :ChooseNextAvailablePort, Project.project_filepath("tasks/choose_next_available_port")
+    autoload :FindNpmPackages, Project.project_filepath("tasks/find_npm_packages")
 
     module Converters
       autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
@@ -57,11 +61,14 @@ module Extension
   end
 
   module Features
+    autoload :ArgoServe, Project.project_filepath("features/argo_serve")
+    autoload :ArgoServeOptions, Project.project_filepath("features/argo_serve_options")
     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")
+    autoload :ArgoRuntime, Project.project_filepath("features/argo_runtime")
     autoload :Argo, Project.project_filepath("features/argo")
   end
 
@@ -77,6 +84,7 @@ module Extension
     autoload :Specification, Project.project_filepath("models/specification")
     autoload :Specifications, Project.project_filepath("models/specifications")
     autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
+    autoload :NpmPackage, Project.project_filepath("models/npm_package")
   end
 
   autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")

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

@@ -8,16 +8,16 @@ 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
             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.extension_type_identifier))
+              @ctx.abort(@ctx.message("errors.unknown_type", project.specification_identifier))
             end
 
             specifications[identifier]

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

@@ -27,7 +27,7 @@ module Extension
       private
 
       def confirm_registration
-        @ctx.puts(@ctx.message("register.confirm_info", extension_type.name))
+        @ctx.puts(@ctx.message("register.confirm_info", specification_handler.name))
         CLI::UI::Prompt.confirm(@ctx.message("register.confirm_question"))
       end
 
@@ -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,49 +3,83 @@
 module Extension
   module Commands
     class Serve < ExtensionCommand
-      YARN_SERVE_COMMAND = %w(server)
-      NPM_SERVE_COMMAND = %w(run-script server)
+      DEFAULT_PORT = 39351
+
+      options do |parser, flags|
+        parser.on("-t", "--[no-]tunnel", "Establish an ngrok tunnel") { |tunnel| flags[:tunnel] = tunnel }
+      end
+
+      class RuntimeConfiguration
+        include SmartProperties
+
+        property! :tunnel_url, accepts: String, default: ""
+        property! :tunnel_requested, accepts: [true, false], reader: :tunnel_requested?, default: true
+        property! :port, accepts: (1...(2**16)), default: DEFAULT_PORT
+      end
 
       def call(_args, _command_name)
-        if argo_admin?
-          ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
-          ShopifyCli::Tasks::EnsureDevStore.call(@ctx)
-          validate_env
-        end
-
-        CLI::UI::Frame.open(@ctx.message("serve.frame_title")) do
-          yarn_serve_command = YARN_SERVE_COMMAND
-          npm_serve_command = NPM_SERVE_COMMAND
-          if argo_admin?
-            serve_args = %W(--shop=#{project.env.shop} --apiKey=#{project.env.api_key})
-            yarn_serve_command += serve_args
-            npm_serve_command += %w(--) + serve_args
-          end
-          success = ShopifyCli::JsSystem.call(@ctx, yarn: yarn_serve_command, npm: npm_serve_command)
-          @ctx.abort(@ctx.message("serve.serve_failure_message")) unless success
-        end
+        config = RuntimeConfiguration.new(
+          tunnel_requested: tunnel_requested?
+        )
+
+        ShopifyCli::Result
+          .success(config)
+          .then(&method(:find_available_port))
+          .then(&method(:start_tunnel_if_required))
+          .then(&method(:serve))
+          .unwrap { |error| raise error }
       end
 
       def self.help
         <<~HELP
           Serve your extension in a local simulator for development.
             Usage: {{command:#{ShopifyCli::TOOL_NAME} serve}}
+            Options:
+            {{command:--tunnel=TUNNEL}} Establish an ngrok tunnel (default: false)
         HELP
       end
 
       private
 
-      def argo_admin?
-        ShopifyCli::Shopifolk.check &&
-          ShopifyCli::Feature.enabled?(:argo_admin_beta) &&
-          extension_type.specification.features&.argo&.surface == "admin"
+      def tunnel_requested?
+        tunnel = options.flags[:tunnel]
+        tunnel.nil? || !!tunnel
+      end
+
+      def find_available_port(runtime_configuration)
+        return runtime_configuration unless specification_handler.choose_port?(@ctx)
+
+        chosen_port = Tasks::ChooseNextAvailablePort
+          .call(from: runtime_configuration.port)
+          .unwrap { |_error| @ctx.abort(@ctx.message("serve.no_available_ports_found")) }
+        runtime_configuration.tap { |c| c.port = chosen_port }
+      end
+
+      def start_tunnel_if_required(runtime_configuration)
+        return runtime_configuration unless specification_handler.establish_tunnel?(@ctx)
+        return runtime_configuration unless runtime_configuration.tunnel_requested?
+
+        return start_tunnel(runtime_configuration) if can_start_tunnel?(runtime_configuration)
+        @ctx.abort(@ctx.message("serve.tunnel_already_running"))
+      end
+
+      def can_start_tunnel?(runtime_configuration)
+        return true if ShopifyCli::Tunnel.urls.empty?
+        ShopifyCli::Tunnel.running_on?(runtime_configuration.port)
+      end
+
+      def start_tunnel(runtime_configuration)
+        tunnel_url = ShopifyCli::Tunnel.start(@ctx, port: runtime_configuration.port)
+        runtime_configuration.tap { |c| c.tunnel_url = tunnel_url }
       end
 
-      def validate_env
-        ExtensionProject.reload
-        @ctx.abort(@ctx.message("serve.serve_missing_information")) if
-          project.env.shop.nil? || project.env.api_key.nil? ||
-          project.env.shop.strip.empty? || project.env.api_key.strip.empty?
+      def serve(runtime_configuration)
+        specification_handler.serve(
+          context: @ctx,
+          tunnel_url: runtime_configuration.tunnel_url,
+          port: runtime_configuration.port
+        )
+        runtime_configuration
       end
     end
   end

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

@@ -37,7 +37,9 @@ module Extension
       private
 
       def status
-        tunnel_url = ShopifyCli::Tunnel.urls.first
+        tunnel_urls = ShopifyCli::Tunnel.urls
+        tunnel_url = tunnel_urls.find { |url| url.start_with?("https://") }
+        tunnel_url = tunnel_urls.first if tunnel_url.nil?
 
         if tunnel_url.nil?
           @ctx.puts(@ctx.message("tunnel.no_tunnel_running"))

data/lib/project_types/extension/extension_project.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "shopify_cli"
+require "securerandom"
 
 module Extension
   class ExtensionProject < ShopifyCli::Project
@@ -9,17 +10,20 @@ 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)
 
@@ -49,8 +53,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?
@@ -63,10 +67,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)