shopify-cli 1.6.0 → 1.9.1

data/lib/project_types/extension/extension_project.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   class ExtensionProject < ShopifyCli::Project
@@ -9,20 +9,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
 
@@ -34,19 +41,19 @@ module Extension
     end
 
     def app
-      Models::App.new(api_key: env['api_key'], secret: env['secret'])
+      Models::App.new(api_key: env["api_key"], secret: env["secret"])
     end
 
     def registered?
-      property_present?('api_key') && property_present?('secret') && registration_id?
+      property_present?("api_key") && property_present?("secret") && registration_id?
     end
 
     def title
       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 +66,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

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module ExtensionProjectKeys
-    REGISTRATION_ID_KEY = 'EXTENSION_ID'
-    EXTENSION_TYPE_KEY = 'EXTENSION_TYPE'
-    TITLE_KEY = 'EXTENSION_TITLE'
+    REGISTRATION_ID_KEY = "EXTENSION_ID"
+    REGISTRATION_UUID_KEY = "EXTENSION_UUID"
+    SPECIFICATION_IDENTIFIER_KEY = "EXTENSION_TYPE"
+    TITLE_KEY = "EXTENSION_TITLE"
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'base64'
-require 'shopify_cli'
-require 'semantic/semantic'
+require "base64"
+require "shopify_cli"
+require "semantic/semantic"
 
 module Extension
   module Features
@@ -14,8 +14,8 @@ 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_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
 
@@ -31,61 +31,45 @@ module Extension
 
       def config(context)
         js_system = ShopifyCli::JsSystem.new(ctx: context)
-        if js_system.package_manager == 'yarn'
+        if js_system.package_manager == "yarn"
           run_yarn_install(context, js_system)
           run_yarn_run_script(context, js_system)
         end
         filepath = File.join(context.root, SCRIPT_PATH)
-        context.abort(context.message('features.argo.missing_file_error')) unless File.exist?(filepath)
+        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
-          context.abort(context.message('features.argo.script_prepare_error'))
+          context.abort(context.message("features.argo.script_prepare_error"))
         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)
+        Features::ArgoRendererPackage.from_package_manager(run_list_command(context))
+      rescue Extension::PackageNotFound
         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
+      private
 
       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,
+        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?
+        # context.abort(
+        #   context.message("features.argo.dependencies.argo_missing_renderer_package_error", error)
+        # ) unless status.success?
         result
       end
 
@@ -97,7 +81,7 @@ module Extension
         )
 
         context.abort(
-          context.message('features.argo.dependencies.yarn_install_error', error)
+          context.message("features.argo.dependencies.yarn_install_error", error)
         ) unless status.success?
       end
 
@@ -109,7 +93,7 @@ module Extension
         )
 
         context.abort(
-          context.message('features.argo.dependencies.yarn_run_script_error', error)
+          context.message("features.argo.dependencies.yarn_run_script_error", error)
         ) unless status.success?
       end
     end

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

@@ -3,7 +3,7 @@
 module Extension
   module Features
     class ArgoConfig
-      CONFIG_FILE_NAME = 'extension.config.yml'
+      CONFIG_FILE_NAME = "extension.config.yml"
 
       class << self
         def parse_yaml(context, permitted_keys = [])
@@ -11,7 +11,7 @@ module Extension
 
           return {} unless File.size?(file_name)
 
-          require 'yaml' # takes 20ms, so deferred as late as possible.
+          require "yaml" # takes 20ms, so deferred as late as possible.
           begin
             config = YAML.load_file(file_name)
 
@@ -21,7 +21,7 @@ module Extension
             return {} if config.nil?
 
             unless config.is_a?(Hash)
-              raise ShopifyCli::Abort, ShopifyCli::Context.message('core.yaml.error.not_hash', CONFIG_FILE_NAME)
+              raise ShopifyCli::Abort, ShopifyCli::Context.message("core.yaml.error.not_hash", CONFIG_FILE_NAME)
             end
 
             config.transform_keys!(&:to_sym)
@@ -31,7 +31,7 @@ module Extension
           rescue Psych::SyntaxError => e
             raise(
               ShopifyCli::Abort,
-              ShopifyCli::Context.message('core.yaml.error.invalid', CONFIG_FILE_NAME, e.message)
+              ShopifyCli::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
             )
           end
         end
@@ -47,7 +47,7 @@ module Extension
             raise(
               ShopifyCli::Abort,
               ShopifyCli::Context.message(
-                'features.argo.config.unpermitted_keys',
+                "features.argo.config.unpermitted_keys",
                 CONFIG_FILE_NAME,
                 unpermitted_keys.map { |k| "\n- #{k}" }.join
               )

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

@@ -5,21 +5,21 @@ module Extension
     class ArgoDependencies
       def self.node_installed(min_major:, min_minor: nil)
         -> (context) do
-          out, status = CLI::Kit::System.capture2('node', '-v')
-          context.abort(context.message('features.argo.dependencies.node.node_not_installed')) unless status.success?
+          out, status = CLI::Kit::System.capture2("node", "-v")
+          context.abort(context.message("features.argo.dependencies.node.node_not_installed")) unless status.success?
 
-          min_version = 'v' + min_major .to_s + '.' + (min_minor.nil? ? 'x' : min_minor.to_s) + '.x'
+          min_version = "v" + min_major .to_s + "." + (min_minor.nil? ? "x" : min_minor.to_s) + ".x"
           version = out.strip
           parsed_version = version.match(/v(?<major>\d+).(?<minor>\d+).(?<patch>\d+)/)
 
           unless min_major.nil? || parsed_version[:major].to_i >= min_major
-            context.abort(context.message('features.argo.dependencies.node.version_too_low', version, min_version))
+            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
           end
 
           return if parsed_version[:major].to_i > min_major
 
           unless min_minor.nil? || parsed_version[:minor].to_i >= min_minor
-            context.abort(context.message('features.argo.dependencies.node.version_too_low', version, min_version))
+            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
           end
         end
       end

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

@@ -0,0 +1,47 @@
+module Extension
+  module Features
+    class ArgoRendererPackage
+      include SmartProperties
+
+      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
+      MINIMUM_ARGO_VERSION = "0.9.3".freeze
+
+      property! :package_name, accepts: PACKAGE_NAMES
+      property! :version, accepts: String
+
+      class << self
+        def from_package_manager(package_manager_output)
+          pattern = /(?<name>#{PACKAGE_NAMES.join("|")})@(?<version>\d.*)$/
+          match = package_manager_output.match(pattern)
+          raise PackageNotFound, package_manager_output if match.nil?
+          return new(package_name: match[:name], version: match[:version].strip)
+        end
+      end
+
+      def checkout?
+        package_name == ARGO_CHECKOUT
+      end
+
+      def admin?
+        package_name == ARGO_ADMIN
+      end
+
+      ##
+      # Temporarily returns false in all cases as the argo webpack server is
+      # unable to handle the UUID flag.
+      def supports_uuid_flag?
+        return false
+        # return false if checkout?
+        # Gem::Version.new(version) > Gem::Version.new(MINIMUM_ARGO_VERSION)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Extension
+  module Features
+    class ArgoServe
+      include SmartProperties
+
+      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
+      property! :context, accepts: ShopifyCli::Context
+
+      YARN_SERVE_COMMAND = %w(server)
+      NPM_SERVE_COMMAND = %w(run-script server)
+
+      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)
+          context.abort(context.message("serve.serve_failure_message")) unless success
+        end
+      end
+
+      private
+
+      def specification
+        specification_handler.specification
+      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)
+        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
+
+      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_setup.rb

@@ -5,11 +5,11 @@ module Extension
     class ArgoSetup
       include SmartProperties
 
-      GIT_DIRECTORY = '.git'
-      SCRIPTS_DIRECTORY = 'scripts'
+      GIT_DIRECTORY = ".git"
+      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/features/argo_setup_steps.rb

@@ -5,7 +5,7 @@ module Extension
     module ArgoSetupSteps
       YARN_INITIALIZE_COMMAND = %w(generate).freeze
       NPM_INITIALIZE_COMMAND = %w(run generate --).freeze
-      INITIALIZE_TYPE_PARAMETER = '--type=%s'
+      INITIALIZE_TYPE_PARAMETER = "--type=%s"
 
       def self.check_dependencies(dependency_checks)
         ArgoSetupStep.always_successful do |context, _identifier, _directory_name, _js_system|
@@ -21,7 +21,7 @@ module Extension
             ShopifyCli::Git.clone(git_template, directory_name, ctx: context)
             context.root = File.join(context.root, directory_name)
           rescue StandardError
-            context.puts('{{x}} Unable to clone the repository.')
+            context.puts("{{x}} Unable to clone the repository.")
           end
         end
       end
@@ -34,8 +34,8 @@ module Extension
 
       def self.initialize_project
         ArgoSetupStep.default do |context, identifier, _directory_name, js_system|
-          frame_title = context.message('create.setup_project_frame_title')
-          failure_message = context.message('features.argo.initialization_error')
+          frame_title = context.message("create.setup_project_frame_title")
+          failure_message = context.message("features.argo.initialization_error")
 
           result = true
           CLI::UI::Frame.open(frame_title, failure_text: failure_message) do