dependabot-common 0.382.0 → 0.383.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6b53185ee3c744622d14656ac582aaa779b5b9f3394497824d49561fe78fe2d8
4
- data.tar.gz: cd5ce58e980459603217ea2693475a224691f67149215d1fb5031472bc065507
3
+ metadata.gz: 1fb1a4d6243812d664a20067d226c2eec111080d39e7337217744a58a9d8f0b6
4
+ data.tar.gz: 609737fc8b6040222a744d58ea03f8587fec15136cb835d319c31b798f7ebf32
5
5
  SHA512:
6
- metadata.gz: 1216f4ef150d1c76b7180f780b1d67831359c9f327bf1a00cf885d3f9b3313ce354a694803de8ec91c1eebc138e922d65cde4f4e5ede88f6da7ceb23c6306026
7
- data.tar.gz: 1377f5537d8d8e637945e35d59ba58dde50ec048f29abf6e9d50c4239ce2a7ca292aa379cfd7c28af7c9efe12723bdf71d55a007ad7e4839a177472f57f7a256
6
+ metadata.gz: 5e3042cb52f78e0396e75a3c6707a6706a1e2f4f1e12fc16310079eae0ae08336f688a75a92795cc6a8ba50ba62b9d0b9168b3ca4d5780439c7bccf574ab4179
7
+ data.tar.gz: a15d7f181d2d4afd8b5bf3e72f0450827d435f8e61e98f7863bfa0c254e8e2b983bb831901f1c95d27da8abfe791bf673d6c6e7fcc29b8d5e61c0e3c631ea9e6
@@ -1,4 +1,4 @@
1
- # typed: strict
1
+ # typed: strong
2
2
  # frozen_string_literal: true
3
3
 
4
4
  require "dependabot/experiments"
@@ -28,10 +28,23 @@ module Dependabot
28
28
  sig { returns(T.nilable(String)) }
29
29
  attr_reader :group_by
30
30
 
31
+ # The following readers are parsed once from the raw rules hash so callers
32
+ # get typed access instead of repeatedly casting rules["patterns"] and
33
+ # friends at every use site. A nil value means the rule is absent (which the
34
+ # matching logic treats differently from an empty list).
35
+ sig { returns(T.nilable(T::Array[String])) }
36
+ attr_reader :patterns
37
+
38
+ sig { returns(T.nilable(T::Array[String])) }
39
+ attr_reader :exclude_patterns
40
+
41
+ sig { returns(T.nilable(T::Array[String])) }
42
+ attr_reader :update_types
43
+
31
44
  sig do
32
45
  params(
33
46
  name: String,
34
- rules: T::Hash[String, T.untyped],
47
+ rules: T::Hash[String, T.any(String, T::Array[String])],
35
48
  applies_to: T.nilable(String)
36
49
  )
37
50
  .void
@@ -41,7 +54,10 @@ module Dependabot
41
54
  # For backwards compatibility, if no applies_to is provided, default to "version-updates"
42
55
  @applies_to = T.let(applies_to || "version-updates", String)
43
56
  @rules = rules
44
- @group_by = T.let(rules["group-by"], T.nilable(String))
57
+ @group_by = T.let(string_rule(rules, "group-by"), T.nilable(String))
58
+ @patterns = T.let(string_array_rule(rules, "patterns"), T.nilable(T::Array[String]))
59
+ @exclude_patterns = T.let(string_array_rule(rules, "exclude-patterns"), T.nilable(T::Array[String]))
60
+ @update_types = T.let(string_array_rule(rules, "update-types"), T.nilable(T::Array[String]))
45
61
  @dependencies = T.let([], T::Array[Dependabot::Dependency])
46
62
  end
47
63
 
@@ -75,16 +91,18 @@ module Dependabot
75
91
 
76
92
  sig { params(dependency_name: String).returns(T::Boolean) }
77
93
  def matches_pattern?(dependency_name)
78
- return true unless rules.key?("patterns") # If no patterns are defined, we pass this check by default
94
+ patterns = self.patterns
95
+ return true if patterns.nil? # If no patterns are defined, we pass this check by default
79
96
 
80
- T.unsafe(rules["patterns"]).any? { |rule| WildcardMatcher.match?(rule, dependency_name) }
97
+ patterns.any? { |rule| WildcardMatcher.match?(rule, dependency_name) }
81
98
  end
82
99
 
83
100
  sig { params(dependency_name: String).returns(T::Boolean) }
84
101
  def matches_excluded_pattern?(dependency_name)
85
- return false unless rules.key?("exclude-patterns") # If there are no exclusions, fail by default
102
+ exclude_patterns = self.exclude_patterns
103
+ return false if exclude_patterns.nil? # If there are no exclusions, fail by default
86
104
 
87
- T.unsafe(rules["exclude-patterns"]).any? { |rule| WildcardMatcher.match?(rule, dependency_name) }
105
+ exclude_patterns.any? { |rule| WildcardMatcher.match?(rule, dependency_name) }
88
106
  end
89
107
 
90
108
  sig { params(dependency: Dependabot::Dependency).returns(T::Boolean) }
@@ -102,5 +120,42 @@ module Dependabot
102
120
  def experimental_rules_enabled?
103
121
  Dependabot::Experiments.enabled?(:grouped_updates_experimental_rules)
104
122
  end
123
+
124
+ # Reads a rule whose value is expected to be a single string (e.g.
125
+ # "group-by"), returning nil when the key is absent or the value is not a
126
+ # string.
127
+ sig do
128
+ params(
129
+ rules: T::Hash[String, T.any(String, T::Array[String])],
130
+ key: String
131
+ )
132
+ .returns(T.nilable(String))
133
+ end
134
+ def string_rule(rules, key)
135
+ value = rules[key]
136
+ value.is_a?(String) ? value : nil
137
+ end
138
+
139
+ # Reads a rule whose value is expected to be a list of strings (e.g.
140
+ # "patterns", "exclude-patterns", "update-types"). Returns nil when the key
141
+ # is absent so callers can distinguish "rule not set" from "empty list", and
142
+ # coerces a lone string into a single-element list.
143
+ sig do
144
+ params(
145
+ rules: T::Hash[String, T.any(String, T::Array[String])],
146
+ key: String
147
+ )
148
+ .returns(T.nilable(T::Array[String]))
149
+ end
150
+ def string_array_rule(rules, key)
151
+ return nil unless rules.key?(key)
152
+
153
+ value = rules[key]
154
+ case value
155
+ when Array then value.grep(String)
156
+ when String then [value]
157
+ else []
158
+ end
159
+ end
105
160
  end
106
161
  end
@@ -97,6 +97,11 @@ module Dependabot
97
97
  "error-type": "path_dependencies_not_reachable",
98
98
  "error-detail": { dependencies: error.dependencies }
99
99
  }
100
+ when Dependabot::PrivateRegistryConfigNotFound
101
+ {
102
+ "error-type": "private_registry_config_not_found",
103
+ "error-detail": { source: error.source }
104
+ }
100
105
  when Dependabot::PrivateSourceAuthenticationFailure
101
106
  {
102
107
  "error-type": "private_source_authentication_failure",
@@ -238,6 +243,16 @@ module Dependabot
238
243
  "error-type": "dependency_file_not_resolvable",
239
244
  "error-detail": { message: error.message }
240
245
  }
246
+ when Dependabot::BlockedDependencyVersion
247
+ {
248
+ "error-type": "blocked_dependency_version",
249
+ "error-detail": {
250
+ "dependency-name": error.dependency_name,
251
+ "blocked-version": error.blocked_version,
252
+ "version-requirement": error.version_requirement,
253
+ reason: error.reason
254
+ }.compact
255
+ }
241
256
  when Dependabot::DependencyFileNotEvaluatable
242
257
  {
243
258
  "error-type": "dependency_file_not_evaluatable",
@@ -687,6 +702,22 @@ module Dependabot
687
702
  # Source level errors #
688
703
  #######################
689
704
 
705
+ class PrivateRegistryConfigNotFound < DependabotError
706
+ extend T::Sig
707
+
708
+ sig { returns(String) }
709
+ attr_reader :source
710
+
711
+ sig { params(source: String).void }
712
+ def initialize(source)
713
+ @source = T.let(sanitize_source(source), String)
714
+ msg = "Private npm registries require either a .npmrc file in your repository, " \
715
+ "or explicit `scope`/`replaces-base` configuration in dependabot.yml. " \
716
+ "Registry: #{@source}"
717
+ super(msg)
718
+ end
719
+ end
720
+
690
721
  class PrivateSourceAuthenticationFailure < DependabotError
691
722
  extend T::Sig
692
723
 
@@ -709,10 +740,10 @@ module Dependabot
709
740
  sig { returns(String) }
710
741
  attr_reader :source
711
742
 
712
- sig { params(source: T.nilable(String)).void }
713
- def initialize(source)
743
+ sig { params(source: T.nilable(String), error_message: T.nilable(String)).void }
744
+ def initialize(source, error_message = nil)
714
745
  @source = T.let(sanitize_source(T.must(source)), String)
715
- msg = "Bad response error while accessing source: #{@source}"
746
+ msg = error_message ? sanitize_source(error_message) : "Bad response error while accessing source: #{@source}"
716
747
  super(msg)
717
748
  end
718
749
  end
@@ -901,6 +932,46 @@ module Dependabot
901
932
  # Raised by UpdateChecker if all candidate updates are ignored
902
933
  class AllVersionsIgnored < DependabotError; end
903
934
 
935
+ # Raised when regenerating a lockfile would introduce or change a transitive
936
+ # (indirect) dependency to a version that matches a configured blocked version.
937
+ # The offending change is rejected so the blocked version is never shipped,
938
+ # while other dependencies are still allowed to update.
939
+ class BlockedDependencyVersion < DependabotError
940
+ extend T::Sig
941
+
942
+ sig { returns(String) }
943
+ attr_reader :dependency_name
944
+
945
+ sig { returns(String) }
946
+ attr_reader :blocked_version
947
+
948
+ sig { returns(String) }
949
+ attr_reader :version_requirement
950
+
951
+ sig { returns(T.nilable(String)) }
952
+ attr_reader :reason
953
+
954
+ sig do
955
+ params(
956
+ dependency_name: String,
957
+ blocked_version: String,
958
+ version_requirement: String,
959
+ reason: T.nilable(String)
960
+ ).void
961
+ end
962
+ def initialize(dependency_name:, blocked_version:, version_requirement:, reason: nil)
963
+ @dependency_name = dependency_name
964
+ @blocked_version = blocked_version
965
+ @version_requirement = version_requirement
966
+ @reason = reason
967
+
968
+ msg = "Update blocked: transitive dependency #{dependency_name} #{blocked_version} " \
969
+ "matches blocked version requirement '#{version_requirement}'"
970
+ msg += " (reason: #{reason})" if reason && !reason.empty?
971
+ super(msg)
972
+ end
973
+ end
974
+
904
975
  # Raised by FileParser if processing may execute external code in the update context
905
976
  class UnexpectedExternalCode < DependabotError; end
906
977
 
@@ -0,0 +1,114 @@
1
+ # typed: strict
2
+ # frozen_string_literal: true
3
+
4
+ require "sorbet-runtime"
5
+ require "dependabot/clients/github_with_retries"
6
+ require "dependabot/shared_helpers"
7
+ require "dependabot/source"
8
+
9
+ module Dependabot
10
+ # Shared logic for resolving release dates from git-based sources for cooldown
11
+ # purposes. Used by ecosystems that rely on git tags (pre-commit, GitHub Actions)
12
+ # rather than package registries.
13
+ #
14
+ # Priority: GitHub Release published_at > tag creation date (for-each-ref) > commit date.
15
+ #
16
+ # Including classes must implement:
17
+ # - `cooldown_source_url` — returns the git source URL
18
+ # - `cooldown_credentials` — returns the credentials array
19
+ module GitCooldownDateResolver
20
+ extend T::Sig
21
+ extend T::Helpers
22
+
23
+ abstract!
24
+
25
+ # The git source URL for the dependency (e.g. "https://github.com/owner/repo")
26
+ sig { abstract.returns(T.nilable(String)) }
27
+ def cooldown_source_url; end
28
+
29
+ # Credentials for GitHub API access
30
+ sig { abstract.returns(T::Array[Dependabot::Credential]) }
31
+ def cooldown_credentials; end
32
+
33
+ # Strips the `tags/` prefix that GitCommitChecker may add when the pinned
34
+ # ref starts with `tags/`, preventing construction of invalid refs like
35
+ # `refs/tags/tags/v1.0.0`.
36
+ sig { params(tag_name: String).returns(String) }
37
+ def normalize_tag_name(tag_name)
38
+ tag_name.delete_prefix("tags/")
39
+ end
40
+
41
+ # Resolves the best available date for a candidate tag.
42
+ # Priority: GitHub Release published_at > tag creation date > commit date.
43
+ sig { params(tag_name: String, commit_sha: String).returns(Time) }
44
+ def resolve_candidate_date(tag_name, commit_sha)
45
+ releases = cached_github_releases
46
+ unless releases.empty?
47
+ release = releases.find { |r| r.tag_name == tag_name }
48
+ return release.published_at if release&.published_at
49
+ end
50
+
51
+ tag_creation_date(tag_name, commit_sha)
52
+ end
53
+
54
+ # Looks up the GitHub Release published_at date for a given tag name.
55
+ # Returns nil if no release exists for this tag.
56
+ sig { params(tag_name: String).returns(T.nilable(Time)) }
57
+ def github_release_published_at(tag_name)
58
+ releases = cached_github_releases
59
+ return nil if releases.empty?
60
+
61
+ release = releases.find { |r| r.tag_name == tag_name }
62
+ return nil unless release&.published_at
63
+
64
+ release.published_at
65
+ rescue StandardError => e
66
+ Dependabot.logger.debug("Error fetching GitHub release date for #{tag_name}: #{e.message}")
67
+ nil
68
+ end
69
+
70
+ # Returns the tag creation date for cooldown purposes (used inside bare clone).
71
+ # Priority: tag creation date from for-each-ref > commit date fallback.
72
+ sig { params(tag_name: String, commit_sha: String).returns(Time) }
73
+ def tag_creation_date(tag_name, commit_sha)
74
+ tag_date_str = SharedHelpers.run_shell_command(
75
+ "git for-each-ref --format=\"%(creatordate:iso)\" \"refs/tags/#{tag_name}\"",
76
+ fingerprint: "git for-each-ref --format=\"%(creatordate:iso)\" \"refs/tags/<tag_name>\""
77
+ ).strip
78
+
79
+ if tag_date_str.empty?
80
+ tag_date_str = SharedHelpers.run_shell_command(
81
+ "git show --no-patch --format=\"%cd\" --date=iso #{commit_sha}",
82
+ fingerprint: "git show --no-patch --format=\"%cd\" --date=iso <commit_sha>"
83
+ ).strip
84
+ end
85
+
86
+ Time.parse(tag_date_str)
87
+ end
88
+
89
+ # Fetches and caches GitHub releases for the dependency source.
90
+ # Returns an empty array for non-GitHub sources.
91
+ sig { returns(T::Array[T.untyped]) } # rubocop:disable Sorbet/ForbidTUntyped
92
+ def cached_github_releases
93
+ @cached_github_releases ||= T.let(
94
+ begin
95
+ url = cooldown_source_url
96
+ source = Source.from_url(url)
97
+ if source&.provider == "github"
98
+ client = Dependabot::Clients::GithubWithRetries.for_source(
99
+ source: T.must(source),
100
+ credentials: cooldown_credentials
101
+ )
102
+ client.releases(T.must(source).repo, per_page: 100)
103
+ else
104
+ []
105
+ end
106
+ rescue StandardError => e
107
+ Dependabot.logger.debug("Error fetching GitHub releases: #{e.message}")
108
+ []
109
+ end,
110
+ T.nilable(T::Array[T.untyped]) # rubocop:disable Sorbet/ForbidTUntyped
111
+ )
112
+ end
113
+ end
114
+ end
@@ -60,7 +60,7 @@ module Dependabot
60
60
  # Converts the Notice object to a hash.
61
61
  # @return [Hash] The hash representation of the notice.
62
62
  sig { returns(T::Hash[Symbol, T.any(String, T::Boolean)]) }
63
- def to_hash
63
+ def to_h
64
64
  {
65
65
  mode: @mode,
66
66
  type: @type,
@@ -1,6 +1,7 @@
1
1
  # typed: strong
2
2
  # frozen_string_literal: true
3
3
 
4
+ require "digest"
4
5
  require "sorbet-runtime"
5
6
 
6
7
  module Dependabot
@@ -70,9 +71,10 @@ module Dependabot
70
71
  sanitized_name = sanitized_name.gsub("/", separator)
71
72
 
72
73
  # Shorten the ref in case users refs have length limits
73
- if max_length && (sanitized_name.length > T.must(max_length))
74
- sha = T.must(Digest::SHA1.hexdigest(sanitized_name)[0, T.must(max_length)])
75
- sanitized_name[[T.must(max_length) - sha.size, 0].max..] = sha
74
+ branch_name_max_length = max_length
75
+ if branch_name_max_length && (sanitized_name.length > branch_name_max_length)
76
+ sha = T.must(Digest::SHA1.hexdigest(sanitized_name)[0, branch_name_max_length])
77
+ sanitized_name[[branch_name_max_length - sha.size, 0].max..] = sha
76
78
  end
77
79
 
78
80
  sanitized_name
@@ -197,7 +197,7 @@ module Dependabot
197
197
  milestone: nil,
198
198
  branch_name_separator: "/",
199
199
  branch_name_prefix: "dependabot",
200
- branch_name_max_length: nil,
200
+ branch_name_max_length: 100,
201
201
  label_language: false,
202
202
  automerge_candidate: false,
203
203
  github_redirection_service: DEFAULT_GITHUB_REDIRECTION_SERVICE,
@@ -40,7 +40,7 @@ module Dependabot
40
40
  sig { returns(T.nilable(String)) }
41
41
  attr_reader :commit_message
42
42
 
43
- sig { returns(T::Hash[Symbol, T.untyped]) }
43
+ sig { returns(T::Hash[Symbol, Integer]) }
44
44
  attr_reader :provider_metadata
45
45
 
46
46
  sig do
@@ -54,7 +54,7 @@ module Dependabot
54
54
  author_details: T.nilable(T::Hash[Symbol, String]),
55
55
  signature_key: T.nilable(String),
56
56
  commit_message: T.nilable(String),
57
- provider_metadata: T::Hash[Symbol, T.untyped]
57
+ provider_metadata: T::Hash[Symbol, Integer]
58
58
  )
59
59
  .void
60
60
  end
@@ -84,7 +84,7 @@ module Dependabot
84
84
 
85
85
  # TODO: Each implementation returns a client-specific type.
86
86
  # We should standardise this to return a `Dependabot::Branch` type instead.
87
- sig { returns(T.untyped) }
87
+ sig { returns(T.untyped) } # rubocop:disable Sorbet/ForbidTUntyped
88
88
  def update
89
89
  case source.provider
90
90
  when "github" then github_updater.update
@@ -120,7 +120,7 @@ module Dependabot
120
120
  files: files,
121
121
  credentials: credentials,
122
122
  pull_request_number: pull_request_number,
123
- target_project_id: T.cast(provider_metadata[:target_project_id], T.nilable(Integer))
123
+ target_project_id: provider_metadata[:target_project_id]
124
124
  )
125
125
  end
126
126
 
@@ -3,6 +3,8 @@
3
3
 
4
4
  require "sorbet-runtime"
5
5
 
6
+ require "dependabot/dependency_requirement"
7
+
6
8
  module Dependabot
7
9
  module RequirementsUpdater
8
10
  module Base
@@ -15,7 +17,7 @@ module Dependabot
15
17
 
16
18
  interface!
17
19
 
18
- sig { abstract.returns(T::Array[T::Hash[Symbol, T.untyped]]) }
20
+ sig { abstract.returns(T::Array[Dependabot::DependencyRequirement]) }
19
21
  def updated_requirements; end
20
22
 
21
23
  private
data/lib/dependabot.rb CHANGED
@@ -2,5 +2,5 @@
2
2
  # frozen_string_literal: true
3
3
 
4
4
  module Dependabot
5
- VERSION = "0.382.0"
5
+ VERSION = "0.383.0"
6
6
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dependabot-common
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.382.0
4
+ version: 0.383.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dependabot
@@ -552,6 +552,7 @@ files:
552
552
  - lib/dependabot/file_updaters/base.rb
553
553
  - lib/dependabot/file_updaters/vendor_updater.rb
554
554
  - lib/dependabot/git_commit_checker.rb
555
+ - lib/dependabot/git_cooldown_date_resolver.rb
555
556
  - lib/dependabot/git_metadata_fetcher.rb
556
557
  - lib/dependabot/git_ref.rb
557
558
  - lib/dependabot/git_tag_details.rb
@@ -619,7 +620,7 @@ licenses:
619
620
  - MIT
620
621
  metadata:
621
622
  bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
622
- changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.382.0
623
+ changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.383.0
623
624
  rdoc_options: []
624
625
  require_paths:
625
626
  - lib