dependabot-npm_and_yarn 0.274.0 → 0.276.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe1263109daa3956820bc6977b9d31f6b372d93fac8ee628d98f4f53fdcb992
-  data.tar.gz: 9b8ce74245d5957e545fa43e2fabefb0a0987e9ea8aa0e978a97cd51c59da550
+  metadata.gz: 71f857c622a3e71c8c1e3099f585ebcc9aa7451b2d4fffc696770ed110b71405
+  data.tar.gz: 6c345e58a378ac08049a9593708f92735d565b48283a23d52233d303cb700d66
 SHA512:
-  metadata.gz: 81ead43e58c76eed9c89dbfb0fe31c23f95dc692a079e097f540ac136a464d5eeaae7d861c2b8b81de58861bb5b7630875499e2e17154989f3617f06ac3599ed
-  data.tar.gz: 6355efedf3c69ff07f21c1c7bb548045b318fafb0e7acabebdcc231e0564baead08b52fd862707d545b52be77d1dae26077b9ff86cb16592786ed81ebc2d5cd7
+  metadata.gz: ec358314a3ce776ab90fa8b9d34e5bd3ec4006bb388467e412d58042bd1bcab2803e51b3fcc816ac49e5cdb6e64fbac2bed472dbb27d36c91e527f904a44797e
+  data.tar.gz: bbbc9073fddf986810a9ca35e1800d9030c8df3743f20d8ba7802a303eb815bf650e171d55beb63cab8f31fb5d9fbe9c65b84b7f2e2ec0db018a15f08ceae1ed

data/lib/dependabot/npm_and_yarn/file_updater/npm_lockfile_updater.rb

@@ -98,6 +98,21 @@ module Dependabot
           /Couldn't find package "(?<pkg>.*)" required by "(?<dep>.*)" on the "(?<regis>.*)" registry./
         ].freeze, T::Array[Regexp])
 
+        # dependency access protocol not supported by packagemanager
+        UNSUPPORTED_PROTOCOL = /EUNSUPPORTEDPROTOCOL\n(.*?)Unsupported URL Type "(?<access_method>.*)"/
+
+        # Internal server error returned from registry
+        SERVER_ERROR_500 = /500 Internal Server Error - GET (?<regis>.*)/
+
+        # issue related when dependency url is not mentioned correctly
+        UNRESOLVED_REFERENCE = /Unable to resolve reference (?<deps>.*)/
+
+        # npm git related error for dependencies
+        GIT_CHECKOUT_ERROR_REGEX = /Command failed: git checkout (?<sha>.*)/
+
+        # Invalid version format found for dependency in package.json file
+        INVALID_VERSION = /Invalid Version: (?<ver>.*)/
+
         # TODO: look into fixing this in npm, seems like a bug in the git
         # downloader introduced in npm 7
         #
@@ -428,6 +443,18 @@ module Dependabot
             raise Dependabot::PrivateSourceAuthenticationFailure, url
           end
 
+          if error_message.match?(SERVER_ERROR_500)
+            url = T.must(URI.decode_www_form_component(error_message).split("https://").last).split("/").first
+            msg = "Server error (500) while accessing #{url}."
+            raise Dependabot::DependencyFileNotResolvable, msg
+          end
+
+          if (error_msg = error_message.match(UNRESOLVED_REFERENCE))
+            dep = error_msg.named_captures["deps"]
+            msg = "Unable to resolve reference #{dep}."
+            raise Dependabot::DependencyFileNotResolvable, msg
+          end
+
           if error_message.match?(MISSING_PACKAGE)
             package_name = T.must(error_message.match(MISSING_PACKAGE))
                             .named_captures["package_req"]
@@ -590,6 +617,20 @@ module Dependabot
             raise Dependabot::DependencyFileNotResolvable, msg
           end
 
+          if (error_msg = error_message.match(UNSUPPORTED_PROTOCOL))
+            msg = "Unsupported protocol \"#{error_msg.named_captures.fetch('access_method')}\" while accessing dependency." # rubocop:disable Layout/LineLength
+            raise Dependabot::DependencyFileNotResolvable, msg
+          end
+
+          if (error_msg = error_message.match(GIT_CHECKOUT_ERROR_REGEX))
+            raise Dependabot::DependencyFileNotResolvable, error_msg
+          end
+
+          if (error_msg = error_message.match(INVALID_VERSION))
+            msg = "Found invalid version \"#{error_msg.named_captures.fetch('ver')}\" while updating"
+            raise Dependabot::DependencyFileNotResolvable, msg
+          end
+
           raise error
         end
         # rubocop:enable Metrics/AbcSize

data/lib/dependabot/npm_and_yarn/package_manager.rb

@@ -2,20 +2,55 @@
 # frozen_string_literal: true
 
 require "dependabot/shared_helpers"
+require "dependabot/npm_and_yarn/version_selector"
 
 module Dependabot
   module NpmAndYarn
     class PackageManager
+      extend T::Sig
+      extend T::Helpers
       def initialize(package_json, lockfiles:)
         @package_json = package_json
         @lockfiles = lockfiles
         @package_manager = package_json.fetch("packageManager", nil)
+        @engines = package_json.fetch("engines", nil)
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def setup(name)
-        return unless @package_manager.nil? || @package_manager.start_with?("#{name}@")
+        # we prioritize version mentioned in "packageManager" instead of "engines"
+        # i.e. if { engines : "pnpm" : "6" } and { packageManager: "pnpm@6.0.2" },
+        # we go for the specificity mentioned in packageManager (6.0.2)
 
-        version = requested_version(name)
+        if Dependabot::Experiments.enabled?(:enable_pnpm_yarn_dynamic_engine)
+
+          unless @package_manager&.start_with?("#{name}@") || (@package_manager&.==name.to_s) || @package_manager.nil?
+            return
+          end
+
+          if @engines && @package_manager.nil?
+            # if "packageManager" doesn't exists in manifest file,
+            # we check if we can extract "engines" information
+            Dependabot.logger.info("No \"packageManager\" info found for \"#{name}\"")
+            version = check_engine_version(name)
+
+          elsif @package_manager&.==name.to_s
+            # if "packageManager" is found but no version is specified (i.e. pnpm@1.2.3),
+            # we check if we can get "engines" info to override default version
+            Dependabot.logger.info("Found \"packageManager\" : \"#{@package_manager}\"")
+            version = check_engine_version(name) if @engines
+
+          elsif @package_manager&.start_with?("#{name}@")
+            # if "packageManager" info has version specification i.e. yarn@3.3.1
+            # we go with the version in "packageManager"
+            Dependabot.logger.info("Found \"packageManager\" : \"#{@package_manager}\". Skipped checking \"engines\".")
+          end
+        else
+          return unless @package_manager.nil? || @package_manager&.start_with?("#{name}@")
+        end
+
+        version ||= requested_version(name)
 
         if version
           raise_if_unsupported!(name, version)
@@ -33,6 +68,8 @@ module Dependabot
 
         version
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       private
 
@@ -44,6 +81,8 @@ module Dependabot
       end
 
       def install(name, version)
+        Dependabot.logger.info("Installing \"#{name}@#{version}\"")
+
         SharedHelpers.run_shell_command(
           "corepack install #{name}@#{version} --global --cache-only",
           fingerprint: "corepack install <name>@<version> --global --cache-only"
@@ -53,9 +92,10 @@ module Dependabot
       def requested_version(name)
         return unless @package_manager
 
-        match = @package_manager.match(/#{name}@(?<version>\d+.\d+.\d+)/)
+        match = @package_manager.match(/^#{name}@(?<version>\d+.\d+.\d+)/)
         return unless match
 
+        Dependabot.logger.info("Requested version #{match['version']}")
         match["version"]
       end
 
@@ -63,8 +103,24 @@ module Dependabot
         lockfile = @lockfiles[name.to_sym]
         return unless lockfile
 
+        Dependabot.logger.info("Estimating version")
         Helpers.send(:"#{name}_version_numeric", lockfile)
       end
+
+      sig { params(name: T.untyped).returns(T.nilable(String)) }
+      def check_engine_version(name)
+        version_selector = VersionSelector.new
+        engine_versions = version_selector.setup(@package_json, name)
+
+        if engine_versions.empty?
+          Dependabot.logger.info("No relevant (engines) info for \"#{name}\"")
+          return
+        end
+
+        version = engine_versions[name]
+        Dependabot.logger.info("Returned (engines) info \"#{name}\" : \"#{version}\"")
+        version
+      end
     end
   end
 end

data/lib/dependabot/npm_and_yarn/registry_parser.rb

@@ -45,7 +45,8 @@ module Dependabot
                      resolved_url
                    end
 
-        T.must(T.must(url_base[/@.*/]).gsub("%2F", "/").split("/")[0..1]).join("/")
+        package_name = url_base.gsub("%2F", "/").match(%r{@.*/})
+        "#{T.must(package_name)}#{T.must(url_base.gsub('%2F', '/').split('/').last)}"
       end
 
       private

data/lib/dependabot/npm_and_yarn/update_checker/latest_version_finder.rb

@@ -17,15 +17,6 @@ module Dependabot
       class LatestVersionFinder
         extend T::Sig
 
-        class RegistryError < StandardError
-          attr_reader :status
-
-          def initialize(status, msg)
-            @status = status
-            super(msg)
-          end
-        end
-
         def initialize(dependency:, credentials:, dependency_files:,
                        ignored_versions:, security_advisories:,
                        raise_on_ignored: false)
@@ -329,6 +320,8 @@ module Dependabot
               password: password
             }
           )
+        rescue URI::InvalidURIError => e
+          raise DependencyFileNotResolvable, e.message
         end
 
         def check_npm_response(npm_response)

data/lib/dependabot/npm_and_yarn/update_checker/registry_finder.rb

@@ -90,6 +90,8 @@ module Dependabot
                    Excon::Error::Socket,
                    JSON::ParserError
               nil
+            rescue URI::InvalidURIError => e
+              raise DependencyFileNotResolvable, e.message
             end&.fetch("registry")
 
           @first_registry_with_dependency_details ||= global_registry.sub(%r{/+$}, "").sub(%r{^.*?//}, "")

data/lib/dependabot/npm_and_yarn/version_selector.rb

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "dependabot/shared_helpers"
+
+module Dependabot
+  module NpmAndYarn
+    class VersionSelector
+      extend T::Sig
+      extend T::Helpers
+
+      # For limited testing, allowing only specific versions defined in engines in package.json
+      # such as "20.8.7", "8.1.2", "8.21.2",
+      NODE_ENGINE_SUPPORTED_REGEX = /^\d+(?:\.\d+)*$/
+
+      sig { params(manifest_json: T::Hash[String, T.untyped], name: String).returns(T::Hash[Symbol, T.untyped]) }
+      def setup(manifest_json, name)
+        engine_versions = manifest_json["engines"]
+
+        if engine_versions.nil?
+          Dependabot.logger.info("No info (engines) found")
+          return {}
+        end
+
+        # logs entries for analysis purposes
+        log = engine_versions.select do |engine, _value|
+          engine.to_s.match(name)
+        end
+        Dependabot.logger.info("Found engine info #{log}") unless log.empty?
+
+        # Only keep matching specs versions i.e. "20.21.2", "7.1.2",
+        # Additional specs can be added later
+        engine_versions.delete_if { |_key, value| !valid_extracted_version?(value) }
+        version = engine_versions.select { |engine, _value| engine.to_s.match(name) }
+
+        version
+      end
+
+      sig { params(version: String).returns(T::Boolean) }
+      def valid_extracted_version?(version)
+        version.match?(NODE_ENGINE_SUPPORTED_REGEX)
+      end
+    end
+  end
+end

data/lib/dependabot/npm_and_yarn.rb

@@ -160,6 +160,14 @@ module Dependabot
       AUTH_ERROR: /YN0001:*.*Fatal Error: could not read Username for '(?<url>.*)': terminal prompts disabled/
     }.freeze, T::Hash[String, Regexp])
 
+    YN0001_REQ_NOT_FOUND_CODES = T.let({
+      REQUIREMENT_NOT_SATISFIED: /provides (?<dep>.*)(.*?)with version (?<ver>.*), which doesn't satisfy what (?<pkg>.*) requests/, # rubocop:disable Layout/LineLength
+      REQUIREMENT_NOT_PROVIDED: /(?<dep>.*)(.*?)doesn't provide (?<pkg>.*)(.*?), requested by (?<parent>.*)/
+    }.freeze, T::Hash[String, Regexp])
+
+    # registry returns malformed response
+    REGISTRY_NOT_REACHABLE = /Received malformed response from registry for "(?<ver>.*)". The registry may be down./
+
     class Utils
       extend T::Sig
 
@@ -212,6 +220,13 @@ module Dependabot
               return Dependabot::PrivateSourceAuthenticationFailure.new(url)
             end
           end
+
+          YN0001_REQ_NOT_FOUND_CODES.each do |(_yn0001_key, yn0001_regex)|
+            if (msg = message.match(yn0001_regex))
+              return Dependabot::DependencyFileNotResolvable.new(msg)
+            end
+          end
+
           Dependabot::DependabotError.new(message)
         }
       },
@@ -568,6 +583,15 @@ module Dependabot
         },
         in_usage: false,
         matchfn: nil
+      },
+      {
+        patterns: [REGISTRY_NOT_REACHABLE],
+        handler: lambda { |message, _error, _params|
+          msg = message.match(REGISTRY_NOT_REACHABLE)
+          Dependabot::DependencyFileNotResolvable.new(msg)
+        },
+        in_usage: false,
+        matchfn: nil
       }
     ].freeze, T::Array[{
       patterns: T::Array[T.any(String, Regexp)],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-npm_and_yarn
 version: !ruby/object:Gem::Version
-  version: 0.274.0
+  version: 0.276.0
 platform: ruby
 authors:
 - Dependabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dependabot-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.274.0
+        version: 0.276.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.274.0
+        version: 0.276.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -340,12 +340,13 @@ files:
 - lib/dependabot/npm_and_yarn/update_checker/version_resolver.rb
 - lib/dependabot/npm_and_yarn/update_checker/vulnerability_auditor.rb
 - lib/dependabot/npm_and_yarn/version.rb
+- lib/dependabot/npm_and_yarn/version_selector.rb
 homepage: https://github.com/dependabot/dependabot-core
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
-  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.274.0
+  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.276.0
 post_install_message: 
 rdoc_options: []
 require_paths: