shopify-cli 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea41fa5cbfa0eb2bf575fe82111c6be56df6807ed7696e64acc741ef2fa2e6be
-  data.tar.gz: 899299251ed4b0a50b0c3a5c5ae55324ebd64e92fbb981da7d4a093df94d5596
+  metadata.gz: e1ca8221a25313b8cd908a02e4c5c68dc9f74ed38e7472804346419e45d8d9d8
+  data.tar.gz: b0658aae7cb7ca368b78aa80f3fab364867bc1d6ae36515c07f3692bb87730cb
 SHA512:
-  metadata.gz: 8b757bbf4ef686593f3fe8fdf82da6c83468f40d04bc312476e2bea614d5f75e3d63afe097c149f3de34b35631032c096799f0728b12732dfbbb5bd3e5141384
-  data.tar.gz: 2059062ef9aff95cad44d2b4bcad442e2cf82636d6733c065bb83544ac4d0b8cef2a5de3c438d5f252a251fa0cf813b03fc064db407940e3469b476a26c35e0d
+  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/CHANGELOG.md

@@ -1,8 +1,16 @@
 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

data/Gemfile.lock

@@ -76,4 +76,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

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,63 @@
+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_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
+
+      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,33 +4,62 @@ 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 renderer_package
+        specification_handler.renderer_package(context)
+      end
+
+      def required_fields
+        specification.features.argo.required_fields
+      end
+
+      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
+
+      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
 
         ShopifyCli::Shopifolk.check && ShopifyCli::Feature.enabled?(:argo_admin_beta)
 
-        required_fields = specification.features.argo.required_fields
-
         return if required_fields.none?
 
         ShopifyCli::Tasks::EnsureEnv.call(context, required: required_fields)
@@ -45,25 +74,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

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

@@ -0,0 +1,40 @@
+module Extension
+  module Features
+    class ArgoServeOptions
+      include SmartProperties
+
+      property! :argo_runtime, accepts: Features::ArgoRuntime
+      property! :context, accepts: ShopifyCli::Context
+      property  :port, accepts: Integer, default: 39351
+      property  :public_url, accepts: String, default: ""
+      property! :required_fields, accepts: Array, default: -> { [] }
+      property! :renderer_package, accepts: Models::NpmPackage
+
+      YARN_SERVE_COMMAND = %w(server)
+      NPM_SERVE_COMMAND = %w(run-script server)
+
+      def yarn_serve_command
+        YARN_SERVE_COMMAND + options
+      end
+
+      def npm_serve_command
+        NPM_SERVE_COMMAND  + ["--"] + options
+      end
+
+      private
+
+      def options
+        project = ExtensionProject.current
+
+        @serve_options ||= [].tap do |options|
+          options << "--port=#{port}" if argo_runtime.accepts_port?
+          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 argo_runtime.accepts_argo_version?
+          options << "--uuid=#{project.registration_uuid}" if argo_runtime.accepts_uuid?
+          options << "--publicUrl=#{public_url}" if argo_runtime.accepts_tunnel_url?
+        end
+      end
+    end
+  end
+end