Missing GHIssueCommentChanges

[matusfaro]

Missing GHIssueCommentChanges similar to GHIssueChanges as per issues_comment GitHub API.

Thanks!

[ReyhanPatria]

Hi! I'd like to work on this if you'd assign me to it @bitwiseman, thanks!

[willtsai]

Hello! Full disclosure here: I'm working on this issue as well for my Software Engineering course project, so even if my eventual code changes become redundant, I can at least provide additional perspective on implementing this feature.

Thanks,
-Will

[willtsai]

Hi @bitwiseman - I'm trying to use mvn install -Dtest.github.takeSnapshot -Dtest.github.org=false -Dtest=YourTestClassName per the contribution guide to run my unit test and take a json snapshot for the stub data so that I may convert it to a Wiremock test before I submit a PR.

However, I have run mvn install -Dtest.github.takeSnapshot -Dtest.github.org=false -Dtest=GHEventPayloadTest#issue_comment_edited several times against the unit test below, but it's never been able to produce stub data stored in the src/test/resources/org/kohsuhke/github/YourTestClassName/wiremock path as described in the contributor guide. I'm running this on JDK 11, think that might be the issue? I haven't been able to get JDK 8 installed on my ARM64 Mac so have not tried this on Java 8.

    @Test
    public void issue_comment_edited() throws Exception {
        GHIssueComment comment = getGitHubBuilder().withOAuthToken(System.getenv("GITHUB_OAUTH"))
                .build()
                .getRepository("willtsai/githubapi-testrepo")
                .getIssue(1)
                .getComments()
                .get(0);
        comment.update("comment one");
        String lastCommentBody = comment.getBody();
        comment.update("comment two");
        assertThat(comment.getBody(), is("comment two"));
    }

[bitwiseman]

Not sure why this would not work for you. I'll invite you to the hub4j test org. It might be a bug in the non-test-org feature.

[willtsai]

ok thanks! I will try another unit test using getTempRepository() targeting the test org repo

[willtsai]

Update: that seems to have unblocked me, thank you @bitwiseman! Seems like there might indeed be a bug in the non-test-org feature. Should I log an issue for this?

[willtsai]

@bitwiseman - after looking at this more today, it seems that I didn't need to use Snapshot to generate the test data stubs after all given that this issue deals with GHEventPayload so I was able to get the event data json stub from a test webhook I added a test repo of mine.

That being said, I did notice that the comment changes object in the event payloads look the same for both issue comments and PR comments (maybe other types of comments as well).

Thus, I'm wondering if you prefer that I add a generic GHCommentChanges wrapper that can then be used for all sorts of comments (GHIssueComments , GHPullRequestReviewComment, etc.) or should I keep the wrapper specialized for each type of comment (e.g. GHIssueCommentChanges , GHPullRequestReviewCommentChanges , etc.) even though they will be identical?

  "changes": {
    "body": {
      "from": "pull request comment BEFORE edit"
    }
  },