dependabot-common 0.392.0 → 0.393.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a574e02b5e7a33f7f245c56ae3df5942505a73cee3c1f32b8a07c1b36ba13a2
-  data.tar.gz: 4ee0767b57e78681464704b7e41557692d57cf240f40f2577d0313a87f78d371
+  metadata.gz: 1a99920113509c66688f9ff8e4c3da84a054c3ce8d0f6c1d137cbdbc936ab4e9
+  data.tar.gz: 5c4de02216c87431010c69387a5ade5f4f296423e3b5e7f3e889e293743ee666
 SHA512:
-  metadata.gz: b63a271847067f6adf096dcbbd9e97e0e986defc09125f55afa8be96cb820660c76551982b46d7c613e29ff93093d87bb1c1849d99c6e7bd75fab3f9abcc3a28
-  data.tar.gz: 28753fa5c276536d7cb8e16cc7bf183796bdd968e31c0efcb92ded66fd8b07a6e05304d0da3eba70a64fc1bd990f9167a073a072791655bdeb47cfb2f8c01d14
+  metadata.gz: c84ada814badfb9efc4e7a60d67fa5a26154c9c110337bf77c0963bbb08393ffd13247508d2db349750fb26590f81dfdded077aaf74ad54bf0b4f01b769453cb
+  data.tar.gz: 1dc8a19ec787541adb136602ee00d101d7919b86c6d903c6d33ae4dedd65afd6fe677b83f4574e5c370a9e2e379093f4e5e7bf630cf95868e9bf91f0db66eccc

data/lib/dependabot/clients/azure.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "dependabot/shared_helpers"
+require "dependabot/clients/json_response_parser"
 require "excon"
 require "sorbet-runtime"
 
@@ -10,6 +11,10 @@ module Dependabot
     # rubocop:disable Metrics/ClassLength
     class Azure
       extend T::Sig
+      include JsonResponseParser
+
+      JsonObject = T.type_alias { JsonResponseParser::JsonObject }
+      JsonObjects = T.type_alias { T::Array[JsonObject] }
 
       class NotFound < StandardError; end
 
@@ -74,7 +79,9 @@ module Dependabot
 
         raise NotFound if response.status == 400
 
-        JSON.parse(response.body).fetch("commit").fetch("commitId")
+        root = parse_json_object(response.body, "branch stats")
+        commit = object_field(root, "commit", "branch stats")
+        string_field(commit, "commitId", "branch stats")
       end
 
       sig { params(_repo: String).returns(String) }
@@ -85,7 +92,8 @@ module Dependabot
                     "/_apis/git/repositories/" + source.unscoped_repo
         )
 
-        JSON.parse(response.body).fetch("defaultBranch").gsub("refs/heads/", "")
+        root = parse_json_object(response.body, "repository")
+        string_field(root, "defaultBranch", "repository").gsub("refs/heads/", "")
       end
 
       sig do
@@ -93,7 +101,7 @@ module Dependabot
           commit: T.nilable(String),
           path: T.nilable(String)
         )
-          .returns(T::Array[T::Hash[String, T.untyped]])
+          .returns(JsonObjects)
       end
       def fetch_repo_contents(commit = nil, path = nil)
         tree = fetch_repo_contents_treeroot(commit, path)
@@ -105,7 +113,8 @@ module Dependabot
                     "/trees/" + tree + "?recursive=false"
         )
 
-        JSON.parse(response.body).fetch("treeEntries")
+        root = parse_json_object(response.body, "repository tree")
+        object_array_field(root, "treeEntries", "repository tree")
       end
 
       sig { params(commit: T.nilable(String), path: T.nilable(String)).returns(String) }
@@ -125,7 +134,8 @@ module Dependabot
 
         tree_response = get(tree_url)
 
-        JSON.parse(tree_response.body).fetch("objectId")
+        root = parse_json_object(tree_response.body, "repository item")
+        string_field(root, "objectId", "repository item")
       end
 
       sig { params(commit: String, path: String).returns(String) }
@@ -142,7 +152,7 @@ module Dependabot
         response.body
       end
 
-      sig { params(branch_name: T.nilable(String)).returns(T::Array[T::Hash[String, T.untyped]]) }
+      sig { params(branch_name: T.nilable(String)).returns(JsonObjects) }
       def commits(branch_name = nil)
         commits_url = T.must(source.api_endpoint) +
                       source.organization + "/" + source.project +
@@ -153,10 +163,11 @@ module Dependabot
 
         response = get(commits_url)
 
-        JSON.parse(response.body).fetch("value")
+        root = parse_json_object(response.body, "commits")
+        object_array_field(root, "value", "commits")
       end
 
-      sig { params(branch_name: String).returns(T.nilable(T::Hash[String, T.untyped])) }
+      sig { params(branch_name: String).returns(T.nilable(JsonObject)) }
       def branch(branch_name)
         response = get(
           T.must(source.api_endpoint) +
@@ -165,10 +176,11 @@ module Dependabot
                     "/refs?filter=heads/" + branch_name
         )
 
-        JSON.parse(response.body).fetch("value").first
+        root = parse_json_object(response.body, "branch")
+        object_array_field(root, "value", "branch").first
       end
 
-      sig { params(source_branch: String, target_branch: String).returns(T::Array[T::Hash[String, T.untyped]]) }
+      sig { params(source_branch: String, target_branch: String).returns(JsonObjects) }
       def pull_requests(source_branch, target_branch)
         response = get(
           T.must(source.api_endpoint) +
@@ -179,7 +191,8 @@ module Dependabot
                     "&searchCriteria.targetRefName=refs/heads/" + target_branch
         )
 
-        JSON.parse(response.body).fetch("value")
+        root = parse_json_object(response.body, "pull requests")
+        object_array_field(root, "value", "pull requests")
       end
 
       sig do
@@ -190,7 +203,7 @@ module Dependabot
           files: T::Array[Dependabot::DependencyFile],
           author_details: T.nilable(T::Hash[Symbol, String])
         )
-          .returns(T.untyped)
+          .returns(Excon::Response)
       end
       def create_commit(
         branch_name,
@@ -241,7 +254,7 @@ module Dependabot
           assignees: T.nilable(T::Array[String]),
           work_item: T.nilable(Integer)
         )
-          .returns(T.untyped)
+          .returns(Excon::Response)
       end
       def create_pull_request(
         pr_name,
@@ -283,7 +296,7 @@ module Dependabot
           trans_work_items: T::Boolean,
           ignore_config_ids: T::Array[String]
         )
-          .returns(T.untyped)
+          .returns(JsonObject)
       end
       def autocomplete_pull_request(
         pull_request_id,
@@ -317,10 +330,10 @@ module Dependabot
           content.to_json
         )
 
-        JSON.parse(response.body)
+        parse_json_object(response.body, "pull request autocomplete")
       end
 
-      sig { params(pull_request_id: String).returns(T::Hash[String, T.untyped]) }
+      sig { params(pull_request_id: String).returns(JsonObject) }
       def pull_request(pull_request_id)
         response = get(
           T.must(source.api_endpoint) +
@@ -328,10 +341,10 @@ module Dependabot
                     "/_apis/git/pullrequests/" + pull_request_id
         )
 
-        JSON.parse(response.body)
+        parse_json_object(response.body, "pull request")
       end
 
-      sig { params(branch_name: String, old_commit: String, new_commit: String).returns(T::Hash[String, T.untyped]) }
+      sig { params(branch_name: String, old_commit: String, new_commit: String).returns(JsonObject) }
       def update_ref(branch_name, old_commit, new_commit)
         content = [
           {
@@ -348,7 +361,8 @@ module Dependabot
           content.to_json
         )
 
-        JSON.parse(response.body).fetch("value").first
+        root = parse_json_object(response.body, "updated ref")
+        first_object_field(root, "value", "updated ref")
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -358,7 +372,7 @@ module Dependabot
           new_tag: T.nilable(String),
           type: String
         )
-          .returns(T::Array[T::Hash[String, T.untyped]])
+          .returns(JsonObjects)
       end
       def compare(previous_tag, new_tag, type)
         response = get(
@@ -371,7 +385,8 @@ module Dependabot
                                    "&searchCriteria.compareVersion.version=#{new_tag}"
         )
 
-        JSON.parse(response.body).fetch("value")
+        root = parse_json_object(response.body, "commit comparison")
+        object_array_field(root, "value", "commit comparison")
       end
 
       sig { params(url: String).returns(Excon::Response) }
@@ -472,6 +487,11 @@ module Dependabot
 
       private
 
+      sig { returns([String, String]) }
+      def response_identity
+        ["Azure", source.url]
+      end
+
       sig { params(blk: T.proc.void).void }
       def retry_connection_failures(&blk)
         retry_attempt = 0
@@ -512,7 +532,7 @@ module Dependabot
           reviewers: T.nilable(T::Array[String]),
           assignees: T.nilable(T::Array[String])
         )
-          .returns(T::Array[T::Hash[Symbol, T.untyped]])
+          .returns(T::Array[T::Hash[Symbol, Object]])
       end
       def pr_reviewers(reviewers, assignees)
         return [] unless reviewers || assignees

data/lib/dependabot/clients/bitbucket.rb

@@ -4,12 +4,17 @@
 require "excon"
 require "sorbet-runtime"
 
+require "dependabot/clients/json_response_parser"
 require "dependabot/shared_helpers"
 
 module Dependabot
   module Clients
     class Bitbucket
       extend T::Sig
+      include JsonResponseParser
+
+      JsonObject = T.type_alias { JsonResponseParser::JsonObject }
+      JsonObjects = T.type_alias { T::Array[JsonObject] }
 
       class NotFound < StandardError; end
 
@@ -54,14 +59,18 @@ module Dependabot
         path = "#{repo}/refs/branches/#{branch}"
         response = get(base_url + path)
 
-        JSON.parse(response.body).fetch("target").fetch("hash")
+        root = parse_json_object(response.body, "branch")
+        target = object_field(root, "target", "branch")
+        string_field(target, "hash", "branch")
       end
 
       sig { params(repo: String).returns(String) }
       def fetch_default_branch(repo)
         response = get(base_url + repo)
 
-        JSON.parse(response.body).fetch("mainbranch").fetch("name")
+        root = parse_json_object(response.body, "repository")
+        main_branch = object_field(root, "mainbranch", "repository")
+        string_field(main_branch, "name", "repository")
       end
 
       sig do
@@ -70,7 +79,7 @@ module Dependabot
           commit: T.nilable(String),
           path: T.nilable(String)
         )
-          .returns(T::Array[T::Hash[String, T.untyped]])
+          .returns(JsonObjects)
       end
       def fetch_repo_contents(repo, commit = nil, path = nil)
         raise "Commit is required if path provided!" if commit.nil? && path
@@ -81,7 +90,8 @@ module Dependabot
         api_path += "?pagelen=100"
         response = get(base_url + api_path)
 
-        JSON.parse(response.body).fetch("values")
+        root = parse_json_object(response.body, "repository contents")
+        object_array_field(root, "values", "repository contents")
       end
 
       sig do
@@ -104,7 +114,7 @@ module Dependabot
           repo: String,
           branch_name: T.nilable(String)
         )
-          .returns(T::Enumerator[T::Hash[String, T.untyped]])
+          .returns(T::Enumerator[JsonObject])
       end
       def commits(repo, branch_name = nil)
         commits_path = "#{repo}/commits/#{branch_name}?pagelen=100"
@@ -117,13 +127,13 @@ module Dependabot
           repo: String,
           branch_name: String
         )
-          .returns(T::Hash[String, T.untyped])
+          .returns(JsonObject)
       end
       def branch(repo, branch_name)
         branch_path = "#{repo}/refs/branches/#{branch_name}"
         response = get(base_url + branch_path)
 
-        JSON.parse(response.body)
+        parse_json_object(response.body, "branch")
       end
 
       sig do
@@ -133,7 +143,7 @@ module Dependabot
           target_branch: T.nilable(String),
           status: T::Array[String]
         )
-          .returns(T::Array[T::Hash[String, T.untyped]])
+          .returns(JsonObjects)
       end
       def pull_requests(repo, source_branch, target_branch, status = %w(OPEN MERGED DECLINED SUPERSEDED))
         pr_path = "#{repo}/pullrequests?"
@@ -148,10 +158,14 @@ module Dependabot
           if source_branch.nil?
             source_branch_matches = true
           else
-            pr_source_branch = pr.fetch("source").fetch("branch").fetch("name")
+            source = object_field(pr, "source", "pull request")
+            source_branch_details = object_field(source, "branch", "pull request")
+            pr_source_branch = string_field(source_branch_details, "name", "pull request")
             source_branch_matches = pr_source_branch == source_branch
           end
-          pr_target_branch = pr.fetch("destination").fetch("branch").fetch("name")
+          destination = object_field(pr, "destination", "pull request")
+          target_branch_details = object_field(destination, "branch", "pull request")
+          pr_target_branch = string_field(target_branch_details, "name", "pull request")
           source_branch_matches && pr_target_branch == target_branch
         end
       end
@@ -262,12 +276,13 @@ module Dependabot
       def current_user
         base_url = "https://api.bitbucket.org/2.0/user?fields=uuid"
         response = get(base_url)
-        JSON.parse(response.body).fetch("uuid")
+        root = parse_json_object(response.body, "current user")
+        string_field(root, "uuid", "current user")
       rescue Unauthorized
         nil
       end
 
-      sig { params(repo: String).returns(T::Array[T::Hash[String, String]]) }
+      sig { params(repo: String).returns(T::Array[T::Hash[Symbol, String]]) }
       def default_reviewers(repo)
         current_uuid = current_user
         path = "#{repo}/default-reviewers?pagelen=100&fields=values.uuid,next"
@@ -278,18 +293,20 @@ module Dependabot
         reviewer_data = []
 
         default_reviewers.each do |reviewer|
-          reviewer_data.append({ uuid: reviewer.fetch("uuid") }) unless current_uuid == reviewer.fetch("uuid")
+          uuid = string_field(reviewer, "uuid", "default reviewer")
+          reviewer_data.append({ uuid: uuid }) unless current_uuid == uuid
         end
 
         reviewer_data
       end
 
-      sig { params(repo: String).returns(T::Array[T::Hash[String, String]]) }
+      sig { params(repo: String).returns(JsonObjects) }
       def tags(repo)
         path = "#{repo}/refs/tags?pagelen=100"
         response = get(base_url + path)
 
-        JSON.parse(response.body).fetch("values")
+        root = parse_json_object(response.body, "tags")
+        object_array_field(root, "values", "tags")
       end
 
       sig do
@@ -298,13 +315,18 @@ module Dependabot
           previous_tag: String,
           new_tag: String
         )
-          .returns(T::Array[T::Hash[String, T.untyped]])
+          .returns(JsonObjects)
       end
       def compare(repo, previous_tag, new_tag)
         path = "#{repo}/commits/?include=#{new_tag}&exclude=#{previous_tag}"
         response = get(base_url + path)
 
-        JSON.parse(response.body).fetch("values")
+        root = parse_json_object(response.body, "commit comparison")
+        commits = object_array_field(root, "values", "commit comparison")
+        commits.each do |commit|
+          validate_string_paths(commit, "commit comparison", [%w(hash), %w(summary raw), %w(links html href)])
+        end
+        commits
       end
 
       sig { params(url: String).returns(Excon::Response) }
@@ -396,23 +418,27 @@ module Dependabot
       #     response = post(url, body)
       #     first_page = JSON.parse(response.body)
       #     paginate(first_page)
-      sig do
-        type_parameters(:T)
-          .params(page: T.all(T.type_parameter(:T), T::Hash[String, T.untyped]))
-          .returns(T::Enumerator[T.type_parameter(:T)])
-      end
+      sig { params(page: JsonObject).returns(T::Enumerator[JsonObject]) }
       def paginate(page)
         Enumerator.new do |yielder|
           loop do
-            page.fetch("values", []).each { |value| yielder << value }
-            break unless page.key?("next")
+            values = page["values"]
+            object_array(values, "paginated response").each { |value| yielder << value } if values
 
-            next_page_url = page.fetch("next")
-            page = T.cast(JSON.parse(get(next_page_url).body), T.all(T::Hash[String, T.untyped], T.type_parameter(:T)))
+            next_page = page["next"]
+            break unless next_page
+
+            next_page_url = string_value(next_page, "paginated response")
+            page = parse_json_object(get(next_page_url).body, "paginated response")
           end
         end
       end
 
+      sig { returns([String, String]) }
+      def response_identity
+        ["Bitbucket", base_url]
+      end
+
       sig { returns(T::Hash[String, String]) }
       attr_reader :auth_header
 

data/lib/dependabot/clients/bitbucket_with_retries.rb

@@ -2,12 +2,13 @@
 # frozen_string_literal: true
 
 require "sorbet-runtime"
+require "delegate"
 
 require_relative "bitbucket"
 
 module Dependabot
   module Clients
-    class BitbucketWithRetries
+    class BitbucketWithRetries < SimpleDelegator
       extend T::Sig
 
       RETRYABLE_ERRORS = T.let(
@@ -37,24 +38,22 @@ module Dependabot
       def initialize(credentials:, max_retries: 3)
         @max_retries = T.let(max_retries || 3, Integer)
         @client = T.let(Bitbucket.new(credentials: credentials), Dependabot::Clients::Bitbucket)
+        super(@client)
       end
 
       sig do
         params(
           method_name: T.any(Symbol, String),
-          args: T.untyped,
-          block: T.nilable(T.proc.returns(T.untyped))
+          args: Object,
+          block: T.nilable(Proc)
         )
-          .returns(T.untyped)
+          .returns(T.anything)
       end
       def method_missing(method_name, *args, &block)
+        original_args = args
         retry_connection_failures do
-          if @client.respond_to?(method_name)
-            mutatable_args = args.map(&:dup)
-            T.unsafe(@client).public_send(method_name, *mutatable_args, &block)
-          else
-            super
-          end
+          args = original_args.map(&:dup)
+          super
         end
       end
 
@@ -66,7 +65,7 @@ module Dependabot
           .returns(T::Boolean)
       end
       def respond_to_missing?(method_name, include_private = false)
-        @client.respond_to?(method_name) || super
+        @client.respond_to?(method_name, include_private)
       end
 
       sig do
@@ -81,7 +80,7 @@ module Dependabot
           yield
         rescue *RETRYABLE_ERRORS
           retry_attempt += 1
-          retry_attempt <= @max_retries ? retry : raise
+          retry_attempt <= @max_retries ? retry : Kernel.raise
         end
       end
     end