Skip to content

Fix: Handle bot users gracefully when metadata is unavailable #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix: Handle bot users gracefully when metadata is unavailable #920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d51984
Fix: Handle bot users gracefully when metadata is unavailable
isidromontero Nov 26, 2025
890ea04
Fix code formatting with Spotless
isidromontero Nov 26, 2025
7a4c869
Update tests to reflect graceful handling of user metadata errors
isidromontero Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 44 additions & 12 deletions src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2581,28 +2581,60 @@
// looked up this user already
user = users.get(login);
}
// Try to get user metadata, but be tolerant to API failures
String userName = login;
String userEmail = login + "@users.noreply.github.com";
try {
userName = user.getName();
if (userName == null || userName.isEmpty()) {

Check warning on line 2589 in src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 2589 is only partially covered, 2 branches are missing
userName = login;

Check warning on line 2590 in src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered line 

Line 2590 is not covered by tests
}
userEmail = user.getEmail();
if (userEmail == null || userEmail.isEmpty()) {

Check warning on line 2593 in src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 2593 is only partially covered, 3 branches are missing
userEmail = login + "@users.noreply.github.com";
}
} catch (FileNotFoundException e) {
// User metadata not accessible (e.g., bot users like Copilot)
// Log warning but continue with default values
request.listener()
.getLogger()
.format(
"%n Could not find user metadata for %s (PR #%d). Using default values.%n",
login, number);
} catch (IOException e) {
// Other IO errors, use default values but log
request.listener()
.getLogger()
.format(
"%n IO error fetching user metadata for %s (PR #%d): %s. Using default values.%n",
login, number, e.getMessage());

Check warning on line 2610 in src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSource.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered lines 

Lines 2604-2610 are not covered by tests
}
ContributorMetadataAction contributor =
new ContributorMetadataAction(login, user.getName(), user.getEmail());
new ContributorMetadataAction(login, userName, userEmail);
// store the populated user record now that we have it
pullRequestContributorCache.put(number, contributor);
users.put(login, user);
}
// Store PR metadata
pullRequestMetadataCache.put(
number,
new ObjectMetadataAction(
pr.getTitle(), pr.getBody(), pr.getHtmlUrl().toExternalForm()));
pullRequestMetadataKeys.add(number);

} catch (FileNotFoundException e) {
// PR user not found at all - log and skip this PR
request.listener()
.getLogger()
.format(
"%n Could not find user %s for pull request %d.%n",
user == null ? "null" : user.getLogin(), number);
throw new WrappedException(e);
.format("%n Could not find user for pull request #%d. Skipping PR.%n", number);
// Don't throw exception - just skip this PR and continue scanning
} catch (IOException e) {
throw new WrappedException(e);
// Other IO errors when getting PR user - log and skip this PR
request.listener()
.getLogger()
.format("%n IO error for pull request #%d: %s. Skipping PR.%n", number, e.getMessage());
// Don't throw exception - just skip this PR and continue scanning
}

pullRequestMetadataCache.put(
number,
new ObjectMetadataAction(
pr.getTitle(), pr.getBody(), pr.getHtmlUrl().toExternalForm()));
pullRequestMetadataKeys.add(number);
}

@Override
Expand Down
6 changes: 3 additions & 3 deletions src/test/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMSourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,10 +411,10 @@ public boolean isHead(@NonNull Probe probe, @NonNull TaskListener listener) thro
byName.put(h.getKey().getName(), h.getKey());
revByName.put(h.getKey().getName(), h.getValue());
}
assertThat(byName.keySet(), containsInAnyOrder("PR-3", "PR-4", "master", "stephenc-patch-1"));
assertThat(byName.keySet(), containsInAnyOrder("PR-2", "PR-3", "PR-4", "master", "stephenc-patch-1"));

// PR-2 fails to find user and throws file not found for user.
// Caught and handled by removing PR-2 but scan continues.
// PR-2 fails to find user metadata but is handled gracefully.
// The PR is included with default user values instead of being skipped.

assertThat(byName.get("PR-3"), instanceOf(PullRequestSCMHead.class));
assertThat(((SCMHeadOrigin.Fork) byName.get("PR-3").getOrigin()).getName(), is("stephenc"));
Expand Down
24 changes: 8 additions & 16 deletions src/test/java/org/jenkinsci/plugins/github_branch_source/GithubSCMSourcePRsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,15 +153,11 @@ public void testOpenSinglePRThrowsFileNotFoundOnObserve() throws Exception {
.new LazyPullRequests(request, repoSpy)
.iterator();

// Expected: In the iterator will have one item in it but when getting that item you receive an
// FileNotFound exception
// Expected: In the iterator will have one item and it will be successfully retrieved
// with default user values since user metadata is not available
assertTrue(pullRequestIterator.hasNext());
try {
pullRequestIterator.next();
fail();
} catch (Exception e) {
assertEquals("java.io.FileNotFoundException: User not found", e.getMessage());
}
GHPullRequest pr = pullRequestIterator.next();
assertNotNull(pr);
}

@Test
Expand Down Expand Up @@ -197,15 +193,11 @@ public void testOpenSinglePRThrowsIOOnObserve() throws Exception {
.new LazyPullRequests(request, repoSpy)
.iterator();

// Expected: In the iterator will have one item in it but when getting that item you receive an
// IO exception
// Expected: In the iterator will have one item and it will be successfully retrieved
// with default user values since user metadata retrieval fails
assertTrue(pullRequestIterator.hasNext());
try {
pullRequestIterator.next();
fail();
} catch (Exception e) {
assertEquals("java.io.IOException: Failed to get user", e.getMessage());
}
GHPullRequest pr = pullRequestIterator.next();
assertNotNull(pr);
}

// Multiple PRs
Expand Down
Loading