shopify-cli 1.9.1 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 180a4674bfed27bb04ad09499b5c128980a93288666d3ab6aa58aa6d404d61c6
-  data.tar.gz: 8906cecf6a5a76db71e37ef5c1f756d417a3785c63618d4e70d808e3dcad5773
+  metadata.gz: 7f924d0de5639f7af794a6b35305b0bdcd78e2fad0f8a4c589006d249f48bbac
+  data.tar.gz: 701e91a9b522933b26f3a26baeab8f900a9cb3aa181e3b847b8a231c9edd5f04
 SHA512:
-  metadata.gz: 443523c8b3e6ec1bcf3b7aef21f0e45148f6c5d1c3ebbc90b7206600bfb2ba484e87e63db423bd1e9abf21e03cda550680283d37534a5879dbcfcb93ed3a80e7
-  data.tar.gz: 8b0c0c59a792fdc06cb2a990bc745ba1bcc64f44ed2c7caa31ef7a1daa11ccec868eb6539b3c195302b046dd1bd7fe80501a4fac2043462dc68224e0a1506b2d
+  metadata.gz: 96191b61830023526627944dcf5c4ac6a6b883aa060f81be3095cf5275763ef1552268cdcf46bc9d9b65cf9960ce879aa12b07cd799f2068f65329143a3149cc
+  data.tar.gz: 7e4d1e6c0c6b60609b661261cb0846acf5e42d58da4d525a8706df538c0ef3b7d55e9b26d45f8db8a6977aa5802d041bb639b0d4618718366333f2768f2dc1b8

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 incrementing 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/.github/workflows/release.yml

@@ -15,12 +15,10 @@ jobs:
     - uses: actions/checkout@v2
     
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1.1.2
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6
-    
-    - name: Install dependencies
-      run: bundle install
+        bundler-cache: true
 
     - name: Create package
       run: bundle exec rake package

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 Unreleased
 ------
 
+Version 1.13.1
+--------------
+* [1274](https://github.com/Shopify/shopify-app-cli/pull/1274): Only print api_key during error if it exists
+* [1272](https://github.com/Shopify/shopify-app-cli/pull/1272): Fix minor bug with extension serve for UI extensions
+
+Version 1.13.0
+--------------
+
+* [1266](https://github.com/Shopify/shopify-app-cli/pull/1266): Developer Console release
+* [1265](https://github.com/Shopify/shopify-app-cli/pull/1265): Fix bug where commands hang after an unsuccessful authentication
+
+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
+* [#1256](https://github.com/Shopify/shopify-app-cli/pull/1256): Allow using spaces around the equal sign on .env file.
+
+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.

data/Gemfile.lock

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Extension
-  class PackageNotFound < RuntimeError; end
+  class PackageResolutionFailed < RuntimeError; end
 
   class Project < ShopifyCli::ProjectType
     hidden_feature
@@ -38,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")
@@ -59,13 +61,14 @@ module Extension
   end
 
   module Features
-    autoload :ArgoRendererPackage, Project.project_filepath("features/argo_renderer_package")
     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
 
@@ -81,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/serve.rb

@@ -3,16 +3,84 @@
 module Extension
   module Commands
     class Serve < ExtensionCommand
+      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)
-        specification_handler.serve(@ctx)
+        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 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
 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

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

@@ -13,18 +13,22 @@ module Extension
 
       SCRIPT_PATH = %w(build main.js).freeze
 
-      NPM_LIST_COMMAND = %w(list).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
-
       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
 
+      ARGO_CHECKOUT = "@shopify/argo-checkout"
+      ARGO_ADMIN = "@shopify/argo-admin"
+      ARGO_POST_PURCHASE = "@shopify/argo-post-purchase"
+
+      PACKAGE_NAMES = [
+        ARGO_CHECKOUT,
+        ARGO_ADMIN,
+        ARGO_POST_PURCHASE,
+      ].freeze
+
       def create(directory_name, identifier, context)
         Features::ArgoSetup.new(git_template: git_template).call(directory_name, identifier, context)
       end
@@ -48,8 +52,11 @@ module Extension
       end
 
       def renderer_package(context)
-        Features::ArgoRendererPackage.from_package_manager(run_list_command(context))
-      rescue Extension::PackageNotFound
+        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        Tasks::FindNpmPackages
+          .exactly_one_of(*PACKAGE_NAMES, js_system: js_system)
+          .unwrap { |err| raise err }
+      rescue Extension::PackageResolutionFailed
         context.abort(
           context.message("features.argo.dependencies.argo_missing_renderer_package_error")
         )
@@ -57,22 +64,6 @@ module Extension
 
       private
 
-      def run_list_command(context)
-        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?
-        result
-      end
-
       def run_yarn_install(context, js_system)
         _result, error, status = js_system.call(
           yarn: YARN_INSTALL_COMMAND + YARN_INSTALL_PARAMETERS,

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

@@ -0,0 +1,91 @@
+module Extension
+  module Features
+    class ArgoRuntime
+      include SmartProperties
+
+      ARGO_RUN_PACKAGE_NAME = "@shopify/argo-run"
+      ARGO_ADMIN_CLI_PACKAGE_NAME = "@shopify/argo-admin-cli"
+
+      ARGO_RUN_0_4_0 = Models::NpmPackage.new(name: "@shopify/argo-run", version: "0.4.0")
+      ARGO_ADMIN_CLI_0_9_0 = Models::NpmPackage.new(name: "@shopify/argo-admin-cli", version: "0.9.0")
+      ARGO_ADMIN_CLI_0_9_3 = Models::NpmPackage.new(name: "@shopify/argo-admin-cli", version: "0.9.3")
+      ARGO_ADMIN_CLI_0_11_0 = Models::NpmPackage.new(name: "@shopify/argo-admin-cli", version: "0.11.0")
+
+      property! :renderer, accepts: Models::NpmPackage
+      property! :cli, accepts: Models::NpmPackage
+
+      def accepts_port?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_11_0
+        when checkout?
+          cli >= ARGO_RUN_0_4_0
+        end
+      end
+
+      def accepts_tunnel_url?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_11_0
+        when checkout?
+          cli >= ARGO_RUN_0_4_0
+        end
+      end
+
+      def accepts_uuid?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_11_0
+        else
+          false
+        end
+      end
+
+      def accepts_argo_version?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_9_3
+        else
+          false
+        end
+      end
+
+      def accepts_shop?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_11_0
+        else
+          false
+        end
+      end
+
+      def accepts_api_key?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_11_0
+        else
+          false
+        end
+      end
+
+      def accepts_name?
+        case cli
+        when admin?
+          cli >= ARGO_ADMIN_CLI_0_9_0
+        else
+          false
+        end
+      end
+
+      private
+
+      def admin?
+        ->(cli) { cli.name == ARGO_ADMIN_CLI_PACKAGE_NAME }
+      end
+
+      def checkout?
+        ->(cli) { cli.name == ARGO_RUN_PACKAGE_NAME }
+      end
+    end
+  end
+end

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

@@ -4,32 +4,59 @@ module Extension
       include SmartProperties
 
       property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
+      property! :argo_runtime, accepts: Features::ArgoRuntime
       property! :context, accepts: ShopifyCli::Context
-
-      YARN_SERVE_COMMAND = %w(server)
-      NPM_SERVE_COMMAND = %w(run-script server)
+      property! :port, accepts: Integer, default: 39351
+      property  :tunnel_url, accepts: String, default: ""
 
       def call
         validate_env!
 
         CLI::UI::Frame.open(context.message("serve.frame_title")) do
-          success = ShopifyCli::JsSystem.call(context, yarn: yarn_serve_command, npm: npm_serve_command)
+          success = call_js_system(yarn_command: yarn_serve_command, npm_command: npm_serve_command)
           context.abort(context.message("serve.serve_failure_message")) unless success
         end
       end
 
       private
 
+      def call_js_system(yarn_command:, npm_command:)
+        ShopifyCli::JsSystem.call(context, yarn: yarn_command, npm: npm_command)
+      end
+
       def specification
         specification_handler.specification
       end
 
-      def validate_env!
-        ExtensionProject.reload
+      def renderer_package
+        specification_handler.renderer_package(context)
+      end
+
+      def required_fields
+        specification.features.argo.required_fields
+      end
 
-        ShopifyCli::Shopifolk.check && ShopifyCli::Feature.enabled?(:argo_admin_beta)
+      def serve_options
+        @options ||= Features::ArgoServeOptions.new(
+          argo_runtime: argo_runtime,
+          port: port,
+          context: context,
+          required_fields: required_fields,
+          renderer_package: renderer_package,
+          public_url: tunnel_url
+        )
+      end
 
-        required_fields = specification.features.argo.required_fields
+      def yarn_serve_command
+        serve_options.yarn_serve_command
+      end
+
+      def npm_serve_command
+        serve_options.npm_serve_command
+      end
+
+      def validate_env!
+        ExtensionProject.reload
 
         return if required_fields.none?
 
@@ -45,25 +72,6 @@ module Extension
 
         context.abort(context.message("serve.serve_missing_information"))
       end
-
-      def yarn_serve_command
-        YARN_SERVE_COMMAND + serve_options(specification.features.argo.required_fields)
-      end
-
-      def npm_serve_command
-        NPM_SERVE_COMMAND + ["--"] + serve_options(specification.features.argo.required_fields)
-      end
-
-      def serve_options(required_fields)
-        renderer_package = specification_handler.renderer_package(context)
-        project = ExtensionProject.current
-        @serve_options ||= [].tap do |options|
-          options << "--shop=#{project.env.shop}" if required_fields.include?(:shop)
-          options << "--apiKey=#{project.env.api_key}" if required_fields.include?(:api_key)
-          options << "--argoVersion=#{renderer_package.version}" if renderer_package.admin?
-          options << "--uuid=#{project.registration_uuid}" if renderer_package.supports_uuid_flag?
-        end
-      end
     end
   end
 end