shopify-cli 1.7.1 → 1.11.0

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,20 +10,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 +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?
@@ -59,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)

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

@@ -13,18 +13,22 @@ 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_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
@@ -39,7 +43,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,47 +51,18 @@ 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)
+        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_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
-
-      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,
-          capture_response: true
-        )
-        context.abort(
-          context.message("features.argo.dependencies.argo_missing_renderer_package_error", error)
-        ) unless status.success?
-        result
-      end
+      private
 
       def run_yarn_install(context, js_system)
         _result, error, status = js_system.call(

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

@@ -0,0 +1,79 @@
+module Extension
+  module Features
+    class ArgoServe
+      include SmartProperties
+
+      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
+      property! :argo_runtime, accepts: Features::ArgoRuntime
+      property! :context, accepts: ShopifyCli::Context
+      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 = 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)
+
+        return if required_fields.none?
+
+        ShopifyCli::Tasks::EnsureEnv.call(context, required: required_fields)
+        ShopifyCli::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
+
+        project = ExtensionProject.current
+
+        return if required_fields.all? do |field|
+          value = project.env.public_send(field)
+          value && !value.strip.empty?
+        end
+
+        context.abort(context.message("serve.serve_missing_information"))
+      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

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

@@ -9,7 +9,7 @@ module Extension
       SCRIPTS_DIRECTORY = "scripts"
 
       property! :git_template, accepts: String
-      property! :dependency_checks, default: []
+      property! :dependency_checks, default: -> { [] }
 
       def call(directory_name, identifier, context)
         steps = [

data/lib/project_types/extension/forms/questions/ask_type.rb

@@ -11,25 +11,36 @@ module Extension
           default: -> { CLI::UI::Prompt.method(:ask) }
 
         def call(project_details)
+          specifications = Models::Specifications.new(
+            fetch_specifications: Tasks::FetchSpecifications.new(context: ctx, api_key: project_details.app.api_key)
+          )
+
           project_details.tap do |p|
-            p.type = type.nil? ? choose_type : validate_given_type(type)
+            p.type = type.nil? ? choose_type(specifications) : validate_given_type(specifications, type)
           end
         end
 
         private
 
-        def validate_given_type(type)
-          return Extension.specifications[type] if Extension.specifications.valid?(type)
+        def validate_given_type(specifications, type)
+          return specifications[type] if specifications.valid?(type)
           ctx.abort(ctx.message("create.invalid_type")) unless type.nil?
         end
 
-        def choose_type
+        def choose_type(specifications)
+          abort_due_to_missing_specifications if specifications.none?
+
           prompt.call(ctx.message("create.ask_type")) do |handler|
-            Extension.specifications.each do |type|
+            specifications.each do |type|
               handler.option("#{type.name} #{type.tagline}") { type }
             end
           end
         end
+
+        def abort_due_to_missing_specifications
+          ctx.puts(@ctx.message("create.no_available_extensions"))
+          raise ShopifyCli::AbortSilent
+        end
       end
     end
   end

data/lib/project_types/extension/messages/message_loading.rb

@@ -16,7 +16,9 @@ module Extension
 
       def self.load_current_type_messages
         return unless ShopifyCli::Project.has_current?
-        messages_for_type(ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::EXTENSION_TYPE_KEY])
+        messages_for_type(
+          ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
+        )
       end
 
       def self.messages_for_type(type_identifier)

data/lib/project_types/extension/messages/messages.rb

@@ -30,6 +30,7 @@ module Extension
         learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/concepts/apps>, " \
           "or try creating a new app using {{command:shopify create}}.",
         loading_apps: "Loading your apps...",
+        no_available_extensions: "{{x}} There are no available extensions for this app.",
       },
       build: {
         frame_title: "Building extension with: %s...",
@@ -40,9 +41,9 @@ module Extension
         waiting_text: "Registering with Shopify...",
         already_registered: "Extension is already registered.",
         confirm_info: "This will create a new extension registration for %s, which can’t be undone.",
-        confirm_question: "Would you like to register this extension with {{green:%s}}? (y/n)",
+        confirm_question: "Would you like to register this extension? (y/n)",
         confirm_abort: "Extension was not registered.",
-        success: "{{v}} Registered {{green:%s}} with {{green:%s}}.",
+        success: "{{v}} Registered {{green:%s}}.",
         success_info: "{{*}} Run {{command:shopify push}} to push your extension to Shopify.",
       },
       push: {
@@ -55,7 +56,10 @@ module Extension
       },
       serve: {
         frame_title: "Serving extension...",
+        no_available_ports_found: "No available ports found to run extension.",
         serve_failure_message: "Failed to run extension code.",
+        serve_missing_information: "Missing shop or api_key.",
+        tunnel_already_running: "A tunnel running on another port has been detected. Close the tunnel and try again.",
       },
       tunnel: {
         missing_token: "{{x}} {{red:auth requires a token argument}}. "\
@@ -96,10 +100,8 @@ module Extension
               node_not_installed: "Node must be installed to create this extension.",
               version_too_low: "Your node version %s does not meet the minimum required version %s",
             },
-            argo_missing_renderer_package_error: "%s Install the missing package and try again.",
-            argo_renderer_package_invalid_version_error: <<~MESSAGE,
-              The renderer package version is not a valid SemVer Version (http://semver.org)
-            MESSAGE
+            argo_missing_renderer_package_error: "Extension template references invalid renderer package "\
+              "please contact Shopify for help.",
             yarn_install_error: "Something went wrong while running 'yarn install'. %s.",
             yarn_run_script_error: "Something went wrong while running script. %s.",
           },
@@ -115,6 +117,7 @@ module Extension
       },
       errors: {
         unknown_type: "Unknown extension type %s",
+        package_not_found: "`%s` package not found.",
       },
     }