support mergeable and minimize API calls

Author: jtarchie

assets/lib/filters/all.rb

@@ -11,7 +11,7 @@ def initialize(pull_requests: [], input: Input.instance)
 
     def pull_requests
       @pull_requests ||= Octokit.pulls(input.source.repo, pull_options).map do |pr|
-        PullRequest.new(pr: Octokit.pull_request(input.source.repo, pr['number'], pull_options))
+        PullRequest.new(pr: pr) # keep this lazy, specific filters should pull data if they need to
       end
     end
 

assets/lib/filters/approval.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Filters
   class Approval
     def initialize(pull_requests:, input: Input.instance)

assets/lib/filters/mergeable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Filters
   class Mergeable
     def initialize(pull_requests:, input: Input.instance)
@@ -7,7 +9,11 @@ def initialize(pull_requests:, input: Input.instance)
 
     def pull_requests
       if @input.source.only_mergeable
-        @memoized ||= @pull_requests.delete_if { |x| !x.mergeable? }
+
+        @memoized ||= @pull_requests.delete_if do |pr|
+          response = Octokit.pull_request(@input.source.repo, pr.id)
+          !response['mergeable']
+        end
       else
         @pull_requests
       end

assets/lib/pull_request.rb

@@ -16,10 +16,6 @@ def from_fork?
     base_repo != head_repo
   end
 
-  def mergeable?
-    @pr['mergeable']
-  end
-
   def review_approved?
     Octokit.pull_request_reviews(base_repo, id).any? { |r| r['state'] == 'APPROVED' }
   end

spec/commands/check_spec.rb

@@ -17,17 +17,10 @@ def stub_json(uri, body)
       .to_return(headers: { 'Content-Type' => 'application/json' }, body: body.to_json)
   end
 
-  def stub_prs(uri, body)
-    stub_json(uri, body)
-    body.each do |pr|
-      stub_json(uri.sub('pulls', 'pulls/' + pr[:number].to_s).sub('&per_page=100', ''), pr)
-    end
-  end
-
   context 'when targetting a base branch other than master' do
     before do
       stub_json('https://api.github.com/repos/jtarchie/test/statuses/abcdef', [])
-      stub_prs('https://api.github.com:443/repos/jtarchie/test/pulls?base=my-base-branch&direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
+      stub_json('https://api.github.com:443/repos/jtarchie/test/pulls?base=my-base-branch&direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
     end
 
     it 'retrieves pull requests for the specified base branch' do
@@ -55,7 +48,7 @@ def stub_prs(uri, body)
 
   context 'when there is an open pull request' do
     before do
-      stub_prs('https://api.github.com:443/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
+      stub_json('https://api.github.com:443/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
     end
 
     it 'returns SHA of the pull request' do
@@ -86,10 +79,10 @@ def stub_prs(uri, body)
 
   context 'when there is more than one open pull request' do
     before do
-      stub_prs('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [
-                 { number: 1, head: { sha: 'abcdef', repo: { full_name: 'jtarchie/test' } }, base: { repo: { full_name: 'jtarchie/test' } } },
-                 { number: 2, head: { sha: 'zyxwvu', repo: { full_name: 'someotherowner/repo' } }, base: { repo: { full_name: 'jtarchie/test' } } }
-               ])
+      stub_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [
+                  { number: 1, head: { sha: 'abcdef', repo: { full_name: 'jtarchie/test' } }, base: { repo: { full_name: 'jtarchie/test' } } },
+                  { number: 2, head: { sha: 'zyxwvu', repo: { full_name: 'someotherowner/repo' } }, base: { repo: { full_name: 'jtarchie/test' } } }
+                ])
     end
 
     it 'returns all PRs oldest to newest last' do
@@ -126,9 +119,7 @@ def stub_cache_json(uri)
       end
 
       stub_body_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', pull_requests[0..49], 'Link' => '<https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open&page=2>; rel="next"')
-      stub_prs('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&sort=updated&state=open', pull_requests[0..49])
       stub_body_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open&page=2', pull_requests[50..99])
-      stub_prs('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&sort=updated&state=open', pull_requests[50..99])
 
       first_prs = check('source' => { 'repo' => 'jtarchie/test' })
       expect(first_prs.length).to eq 100

spec/filters/approval_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../assets/lib/filters/approval'
 require_relative '../../assets/lib/pull_request'
 require_relative '../../assets/lib/input'

spec/filters/mergeable_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../assets/lib/filters/mergeable'
 require_relative '../../assets/lib/pull_request'
 require_relative '../../assets/lib/input'
@@ -37,11 +39,11 @@ def stub_json(uri, body)
 
   context 'when the mergeable filtering is enabled' do
     before do
-      stub_json(%r{https://api.github.com/repos/user/repo/pulls/1/reviews}, [{ 'state' => 'CHANGES_REQUESTED' }])
-      stub_json(%r{https://api.github.com/repos/user/repo/pulls/2/reviews}, [{ 'state' => 'APPROVED' }])
+      stub_json(%r{https://api.github.com/repos/user/repo/pulls/1}, 'mergeable' => false)
+      stub_json(%r{https://api.github.com/repos/user/repo/pulls/2}, 'mergeable' => true)
     end
 
-    it 'only returns PRs with that label' do
+    it 'only returns PRs with that are mergeable' do
       payload = { 'source' => { 'repo' => 'user/repo', 'only_mergeable' => true } }
       filter = described_class.new(pull_requests: pull_requests, input: Input.instance(payload: payload))