diff --git a/src/main/java/org/kohsuke/github/GHIssueComment.java b/src/main/java/org/kohsuke/github/GHIssueComment.java index 51415248d6..39bfa13cba 100644 --- a/src/main/java/org/kohsuke/github/GHIssueComment.java +++ b/src/main/java/org/kohsuke/github/GHIssueComment.java @@ -39,9 +39,40 @@ */ public class GHIssueComment extends GHObject implements Reactable { - private String body, gravatarId, htmlUrl, authorAssociation; + /** + * Legacy field for gravatar ID (no longer returned by GitHub API). + */ + private String gravatarId; + + /** + * The author's association with the repository. + */ + protected String authorAssociation; - private GHUser user; // not fully populated. beware. + /** + * The comment body. + */ + protected String body; + + /** + * The comment body in HTML format. + */ + protected String bodyHtml; + + /** + * The comment body in plain text format. + */ + protected String bodyText; + + /** + * The HTML URL of the comment. + */ + protected String htmlUrl; + + /** + * The user who created the comment. Note: not fully populated, use getUser() for full details. + */ + protected GHUser user; /** The owner. */ GHIssue owner; @@ -115,6 +146,24 @@ public String getBody() { return body; } + /** + * Gets the body in HTML format. + * + * @return the body in HTML format + */ + public String getBodyHtml() { + return bodyHtml; + } + + /** + * Gets the body in plain text format. + * + * @return the body in plain text format + */ + public String getBodyText() { + return bodyText; + } + /** * Gets the html url. * diff --git a/src/main/java/org/kohsuke/github/GHPullRequestReviewComment.java b/src/main/java/org/kohsuke/github/GHPullRequestReviewComment.java index 85399cbf34..753396e73e 100644 --- a/src/main/java/org/kohsuke/github/GHPullRequestReviewComment.java +++ b/src/main/java/org/kohsuke/github/GHPullRequestReviewComment.java @@ -29,8 +29,6 @@ import java.io.IOException; import java.net.URL; -import javax.annotation.CheckForNull; - // TODO: Auto-generated Javadoc /** * Review comment to the pull request. @@ -40,10 +38,12 @@ * @see GHPullRequest#createReviewComment(String, String, String, int) GHPullRequest#createReviewComment(String, String, * String, int) */ -public class GHPullRequestReviewComment extends GHObject implements Reactable { +public class GHPullRequestReviewComment extends GHIssueComment implements Refreshable { /** - * The side of the diff to which the comment applies + * The side of the diff to which the comment applies. + * + * @see Pull Request Review Comments API */ public static enum Side { /** Left side */ @@ -66,31 +66,23 @@ public static Side from(String value) { } - private GHCommentAuthorAssociation authorAssociation; - - private String body; - private String bodyHtml; - private String bodyText; + // PR review comment specific fields (not in GHIssueComment) private String commitId; private String diffHunk; - private String htmlUrl; private long inReplyToId = -1L; private int line = -1; private String originalCommitId; private int originalLine = -1; private int originalPosition = -1; - private Integer originalStartLine = -1; + private Integer originalStartLine; private String path; private int position = -1; - private Long pullRequestReviewId = -1L; + private Long pullRequestReviewId; private String pullRequestUrl; private GHPullRequestReviewCommentReactions reactions; private String side; - private Integer startLine = -1; + private Integer startLine; private String startSide; - private GHUser user; - /** The owner. */ - GHPullRequest owner; /** * Create default GHPullRequestReviewComment instance @@ -107,6 +99,7 @@ public GHPullRequestReviewComment() { * @throws IOException * Signals that an I/O exception has occurred. */ + @Override public GHReaction createReaction(ReactionContent content) throws IOException { return owner.root() .createRequest() @@ -122,6 +115,7 @@ public GHReaction createReaction(ReactionContent content) throws IOException { * @throws IOException * the io exception */ + @Override public void delete() throws IOException { owner.root().createRequest().method("DELETE").withUrlPath(getApiRoute()).send(); } @@ -134,6 +128,7 @@ public void delete() throws IOException { * @throws IOException * Signals that an I/O exception has occurred. */ + @Override public void deleteReaction(GHReaction reaction) throws IOException { owner.root() .createRequest() @@ -142,42 +137,6 @@ public void deleteReaction(GHReaction reaction) throws IOException { .send(); } - /** - * Gets the author association to the project. - * - * @return the author association to the project - */ - public GHCommentAuthorAssociation getAuthorAssociation() { - return authorAssociation; - } - - /** - * The comment itself. - * - * @return the body - */ - public String getBody() { - return body; - } - - /** - * Gets The body in html format. - * - * @return {@link String} the body in html format - */ - public String getBodyHtml() { - return bodyHtml; - } - - /** - * Gets The body text. - * - * @return {@link String} the body text - */ - public String getBodyText() { - return bodyText; - } - /** * Gets commit id. * @@ -196,21 +155,11 @@ public String getDiffHunk() { return diffHunk; } - /** - * Gets the html url. - * - * @return the html url - */ - public URL getHtmlUrl() { - return GitHubClient.parseURL(htmlUrl); - } - /** * Gets in reply to id. * - * @return the in reply to id + * @return the in reply to id, or -1 if not a reply */ - @CheckForNull public long getInReplyToId() { return inReplyToId; } @@ -281,11 +230,12 @@ public int getOriginalStartLine() { /** * Gets the pull request to which this review comment is associated. * - * @return the parent + * @return the parent pull request */ + @Override @SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior") public GHPullRequest getParent() { - return owner; + return (GHPullRequest) owner; } /** @@ -300,9 +250,8 @@ public String getPath() { /** * Gets position. * - * @return the position + * @return the position, or -1 if not available */ - @CheckForNull public int getPosition() { return position; } @@ -387,6 +336,7 @@ public Side getStartSide() { * @throws IOException * the io exception */ + @Override public GHUser getUser() throws IOException { return owner.root().intern(user); } @@ -396,6 +346,7 @@ public GHUser getUser() throws IOException { * * @return the paged iterable */ + @Override public PagedIterable listReactions() { return owner.root() .createRequest() @@ -403,6 +354,23 @@ public PagedIterable listReactions() { .toIterable(GHReaction[].class, item -> owner.root()); } + /** + * Refreshes this comment by fetching the full data from the API. + * + *

+ * This is useful when the comment was obtained via {@link GHPullRequestReview#listReviewComments()}, which uses a + * GitHub API endpoint that does not return all fields. After calling this method, fields like {@link #getLine()}, + * {@link #getOriginalLine()}, {@link #getSide()}, etc. will return their actual values. + * + * @throws IOException + * if an I/O error occurs + * @see GHPullRequest#listReviewComments() + */ + @Override + public void refresh() throws IOException { + owner.root().createRequest().withUrlPath(getApiRoute()).fetchInto(this).wrapUp(getParent()); + } + /** * Create a new comment that replies to this comment. * @@ -419,7 +387,7 @@ public GHPullRequestReviewComment reply(String body) throws IOException { .with("body", body) .withUrlPath(getApiRoute(true) + "/replies") .fetch(GHPullRequestReviewComment.class) - .wrapUp(owner); + .wrapUp(getParent()); } /** @@ -430,6 +398,7 @@ public GHPullRequestReviewComment reply(String body) throws IOException { * @throws IOException * the io exception */ + @Override public void update(String body) throws IOException { owner.root().createRequest().method("PATCH").with("body", body).withUrlPath(getApiRoute()).fetchInto(this); this.body = body; @@ -460,12 +429,12 @@ protected String getApiRoute(boolean includePullNumber) { /** * Wrap up. * - * @param owner - * the owner + * @param pullRequest + * the pull request owner * @return the GH pull request review comment */ - GHPullRequestReviewComment wrapUp(GHPullRequest owner) { - this.owner = owner; + GHPullRequestReviewComment wrapUp(GHPullRequest pullRequest) { + this.owner = pullRequest; return this; } } diff --git a/src/test/java/org/kohsuke/github/GHPullRequestTest.java b/src/test/java/org/kohsuke/github/GHPullRequestTest.java index c451128a0b..aa1aa231f4 100644 --- a/src/test/java/org/kohsuke/github/GHPullRequestTest.java +++ b/src/test/java/org/kohsuke/github/GHPullRequestTest.java @@ -764,6 +764,9 @@ public void pullRequestReviews() throws Exception { GHPullRequestReviewComment fullComment = comments.get(0).readPullRequestReviewComment(); assertThat(fullComment.getBody(), equalTo("Some niggle")); assertThat(fullComment.getLine(), equalTo(1)); + assertThat(fullComment.getParent().getNumber(), equalTo(p.getNumber())); + fullComment.refresh(); + assertThat(fullComment.getLine(), equalTo(1)); draftReview = p.createReview().body("Some new review").comment("Some niggle", "README.md", 1).create(); draftReview.delete();