shopify-cli 1.7.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810ed674eed1f0938f1e4fdb55703fe8bcbcf10d13293a27f7e59f28cc39d384
-  data.tar.gz: 0f7572e8d715e589bbe3cc23d6835e6256063a54b99504f3f6975b5008a0ed24
+  metadata.gz: e1ca8221a25313b8cd908a02e4c5c68dc9f74ed38e7472804346419e45d8d9d8
+  data.tar.gz: b0658aae7cb7ca368b78aa80f3fab364867bc1d6ae36515c07f3692bb87730cb
 SHA512:
-  metadata.gz: 7681161d8502e8e728bac04b339b06d84334b1ec0edfc8a58c3f8eb5d4a85ba873c79810c63d30e784508cb9b155c3f39d672e88689b53fc0dd5cff32be865ff
-  data.tar.gz: ac283b1b16d617b27c2f61dc948e77adead2910f218c0649783884ee6debc6c4135c18dccf35bf73931ded907dadab0ba9c70598238874d941107fa471970041
+  metadata.gz: 54fde8fed1098f483c817cfb0dd8d9ab291556da026dabcc7d0e0dc934fb9c2e97dd2865d72257ca75a2c5d1560759e4ece27c8acc76a8a56f299e8f004594f0
+  data.tar.gz: b193f5f389c2a03875e98d4636aa3cd16c7bfe212d798defed234233b0aad410382e3f56d83b58f63189b6f8256be762518c4439bfe732961c682db8fd81cb25

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,12 +1,37 @@
 Unreleased
 ------
 
+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
 ------
 * 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)
@@ -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/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 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,18 +84,9 @@ 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")
   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,41 +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)
-        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_area == "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 serve(runtime_configuration)
+        specification_handler.serve(
+          context: @ctx,
+          tunnel_url: runtime_configuration.tunnel_url,
+          port: runtime_configuration.port
+        )
+        runtime_configuration
       end
     end
   end