Add functionality for new events by Leo-Send · Pull Request #33 · se-sic/GitHubWrapper

Leo-Send · 2025-08-26T10:38:17Z

Adds functionality for the following events:

issue_type_added
issue_type_changed
issue_type_removed
connected
reopened
parent_issue_added
parent_issue_removed
sub_issue_added
sub_issue_removed

Leo-Send · 2025-08-26T10:43:37Z

I have a few open questions/issues regarding this PR:

the 'connected' and 'subissue'/'parentissue' events do not contain any data on which issue the current issue is connected/related to. We could calculate this using timestamps, since both event types generate a counterpart in the connected/related issue. If we want to do this, I can look further into this.
Until now, I was unable to generate the 'sub_issue_changed' and 'parent_issue_changed' events. It seems to me that the only allowed interaction with subissues is adding or removing them. Should I still keep those events?
I am not sure about what I should do for the copyright headers, considering I only authored a change in one file so far.

Edit:
upon further investigation, all 'sub_issue' or 'parent_issue' event types do not appear in the REST api documentation. They do, however, appear in the graphQL api documentation and seem to behave the same in the REST api. But the 'sub_issue_changed' and 'parent_issue_changed' events do not exist there either.

Leo-Send · 2025-09-05T11:20:42Z

Quick update regarding connected events:
It is trivial to save the event id in the output json. Since this event id is the same for the connected events in both issues, it is then possible to find the related issue. The question in where we want to do that - in our toolchain, I think it would be sensible to do it in codeface-extraction or coronet. Adding this functionality to the GitHubWrapper would require a lot of work and I also do not think it fits here. It should be by far easiest in coronet, assuming we save the event id during the codeface-extraction issue processing, for example in event-info 1 or 2. If we do not want this id in the issues.list file, it can also be done in codeface-extraction.

bockthom · 2025-09-08T03:03:41Z

Good idea!

I agree, it does not fit into the GitHubWrapper. So, just store it in the json file and we will find the related issue later.
While both codeface-extraction and coronet would be suitable for doing that, I'd prefer to do that in codeface-extraction, for two reasons:

(1) We do all the other processing in codeface-extraction. Why should we leave this one post-processing step to coronet? Would be inconsistent, I guess.
(2) When we would do this in coronet, we would need to recompute the connected issues every time we read issue data. Why should we do this every time and spend additional compute resources on that? If we do that in codeface-extraction, we do it only once, and the issues.list files contain already the correct linkage.

So, I'd suggest to compute the connected issue in codeface-extraction.

Leo-Send · 2025-09-25T11:08:51Z

This PR is ready for review, but should be merged after PR #31 is merged.

src/de/uni_passau/fim/gitwrapper/EventDataProcessor.java

src/de/uni_passau/fim/gitwrapper/IssueTypeChangeEvent.java

src/de/uni_passau/fim/gitwrapper/StateReason.java

Copilot

Pull Request Overview

This PR adds support for handling new GitHub event types related to issue management, specifically: issue type changes, state changes (reopened), parent/sub-issue relationships, and connected events. The changes enhance the existing GitHub API wrapper to capture and process these additional event types.

Key changes include:

New data models for issue types (TypeData) and state reasons (StateReason)
Support for tracking sub-issues and external commits
Enhanced event processing for the newly supported event types
Improved commit hash extraction by filtering out code blocks

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`TypeData.java`	New data model for issue type information from GitHub's API
`StateReason.java`	New enum for issue/PR state reasons (completed, reopened, not_planned, duplicate)
`IssueDataProcessor.java`	Added sub-issue parsing, external commit tracking, and code block filtering in hash extraction
`IssueData.java`	Added type field and sub-issues list to issue data model
`GitHubRepository.java`	Added external commit URL fetching and registered new event processors
`GitHubCommit.java`	Added external commit tracking flag
`EventDataProcessor.java`	Added processors for state change, issue type change, and connected events
`EventData.java`	Added new event data classes for state changes, issue type changes, parent/sub-issue changes, and connected events
`README.md`	Added documentation about referenced events and data processing

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/de/uni_passau/fim/gitwrapper/GitHubCommit.java

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java

bockthom · 2025-10-21T01:05:13Z

I am satisfied with the changes in this PR. However, we also need to satisfy Copilot in this and the previous PR.
If the previous PR is updated, I can merge that one right away, such that this one can be rebased on top of the other one.

bockthom · 2025-10-21T01:29:28Z

And please add you copyright header to StateReason.java, since you have modified it yourself now.

external commits that reference an issue can now be fetched. They will be marked with 'commitReferencesIssueExternal'. To that end, this commit adds an 'external' field to each commit and a new method to extract commits using the full url instead of just the relative one within the repo. Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

references to issues are now only found if they are ouside a code environment (starting and ending with three '`'). This mirrors GitHubs behaviour. Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Add paragraph that documents intended and unintended behaviour for 'referenced' events Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

reformat README and nested if statement Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

change BE words for consistency Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Getter previously did not use method parameter. Also renamed and added docs to match existing methods. Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

using stringbuilder instead of appending, which would result in copying the string Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

introduce new state reason and type data classes Signed-off-by: Shiraz Jafri <shirazjafri@outlook.com>

Add new event data subclass for state changed events Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

Add new enum and eventdata subclasses to track changes in issue types Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

no longer serializing change_type field in IssueTypeChangedEventData Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

Introduce new subclasses for parent and subissue events Signed-off-by: Shiraz jarfi <shirazJafri@outlook.com>

Introduce new event data subclass for connected events Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

key was duplicated with different values, overwriting previous entry Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

also add event ids and subissue numbers to data SHA-1 extraction now only recognises hexadecimal strings length 7 and above (previously 5) Issue and Event data are extended by simple fields to hold event ids and subissue numbers Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

also fix copyright headers in new files Signed-off-by: Leo Sendelbach

Parernt- and Subissues can not have a 'changed' event None and Any state reasons were not achievable Also removed the state reason field from issue data StateChangedEvents can now have a commit (issues can be closed by a commit) Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

instead of assigning completed as default case, now throw an error. If new state reasons are added later on githubs side, the occurence of this error should prevent us from not noticing that change. Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

suggestions contain a codeblock using the suggestion keyword after opening the block. Add a field to reviewCommentData and result json for this boolean Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

src/de/uni_passau/fim/gitwrapper/ReferencedLinkProcessor.java

Copilot

Pull Request Overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 10 comments.

Comments suppressed due to low confidence (2)

src/de/uni_passau/fim/gitwrapper/EventDataProcessor.java:1

The inner class StateChangedEventData is declared as public class inside EventData.java, but should be declared as public static class to match the pattern of other inner event classes like ReferencedEventData and LabeledEventData in the same file.

/**

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java:431

Variable 'String stateReasonValue' is never read.

        String stateReasonValue = (stateReasonElement != null && !stateReasonElement.isJsonNull()) 
            ? stateReasonElement.getAsString() 
            : null;

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/de/uni_passau/fim/gitwrapper/ReferencedLinkProcessor.java

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java

src/de/uni_passau/fim/gitwrapper/StateReason.java

src/de/uni_passau/fim/gitwrapper/GitHubRepository.java

src/de/uni_passau/fim/gitwrapper/EventData.java

Fixes: - case sensitive check for suggestion - minor spelling issue - artifact from state reasons in issue data - debug comment - copyright headers Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

If no userdata is found except for the username, initialize the dummy with that username Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

src/de/uni_passau/fim/gitwrapper/UserDataProcessor.java

Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

This allows us to extract the reason for locking a conversation Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 12 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/de/uni_passau/fim/gitwrapper/GitHubRepository.java

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java

src/de/uni_passau/fim/gitwrapper/EventData.java

src/de/uni_passau/fim/gitwrapper/UserDataProcessor.java

src/de/uni_passau/fim/gitwrapper/StateReason.java

src/de/uni_passau/fim/gitwrapper/IssueData.java

src/de/uni_passau/fim/gitwrapper/EventData.java

src/de/uni_passau/fim/gitwrapper/IssueData.java

src/de/uni_passau/fim/gitwrapper/GitHubRepository.java

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java

- update documentation, fix spelling - add new fields to 'freeze' method - use stringbuilder instead of concatenation - fix deserialization of new event type - change state change event to inherit from referenced event Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-10T17:46:22Z

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java

        // Parse commits from referenced commits
        Stream<ReferencedLink<List<String>>> referencedCommits = issue.getEventsList().stream()
-                .filter(eventData -> eventData instanceof EventData.ReferencedEventData)
+                .filter(eventData -> eventData instanceof EventData.ReferencedEventData || eventData instanceof EventData.StateChangedEventData)


The || eventData instanceof EventData.StateChangedEventData check is redundant because StateChangedEventData extends ReferencedEventData, so the first instanceof check already covers it. This can be simplified to just eventData instanceof EventData.ReferencedEventData.

Suggested change

.filter(eventData -> eventData instanceof EventData.ReferencedEventData || eventData instanceof EventData.StateChangedEventData)

.filter(eventData -> eventData instanceof EventData.ReferencedEventData)

Copilot · 2026-03-10T17:46:22Z

src/de/uni_passau/fim/gitwrapper/UserDataProcessor.java

-            return DUMMY_USER;
+            if (username == null || username.isEmpty()) {
+                LOG.warning("Could not get information about unknown user!");
+                (guess ? guessedUsersByUsername : strictUsersByUsername).put(username, DUMMY_USER);


When username is null, calling .put(username, DUMMY_USER) on a ConcurrentHashMap will throw a NullPointerException, since ConcurrentHashMap does not allow null keys. You should either skip the cache insertion when username is null, or return DUMMY_USER immediately without caching.

Suggested change

(guess ? guessedUsersByUsername : strictUsersByUsername).put(username, DUMMY_USER);

I agree with copilot here. We should not put null or "" into the dicct.

Copilot · 2026-03-10T17:46:23Z

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java

+        // filter out everything in code block
+        String[] texts = text.split("```");
+        StringBuilder sb = new StringBuilder();
+        for (int i = 0; i < texts.length; i++) {
+            if (i % 2 == 0) {
+                sb.append(texts[i]);
+            }
+        }
+        text = sb.toString();


The code block filtering logic (splitting on ``` and keeping even-indexed segments) is duplicated here and in extractHashtags (lines 306-314). Consider extracting this into a private helper method (e.g., stripCodeBlocks(String text)) to avoid duplication and make future changes easier.

Copilot · 2026-03-10T17:46:23Z

src/de/uni_passau/fim/gitwrapper/GitHubRepository.java

+                 * JSON String, as it is not needed for further processing.
+                 */
+                LOG.info("Malformed JSON String when querying data for commit " + url + ". Neglect files element.");
+                String jsonStringFromURL = getJSONStringFromURL(url).get();


getJSONStringFromURL(url).get() is called without first checking isPresent(). If the URL fails to return data (e.g., the server responds with an error or the resource was deleted), this will throw a NoSuchElementException. While the same pattern exists in the original getGithubCommit method, it's still risky here—especially since this method is specifically designed for external/fallback commit lookups that are more likely to fail. Consider handling the empty Optional case gracefully.

Suggested change

String jsonStringFromURL = getJSONStringFromURL(url).get();

Optional<String> jsonStringOptional = getJSONStringFromURL(url);

if (!jsonStringOptional.isPresent()) {

LOG.warning("Could not retrieve JSON String when querying data for commit " + url + " after malformed response.");

Optional<GitHubCommit> res = Optional.empty();

checkedHashes.put(hash, res);

return res;

}

String jsonStringFromURL = jsonStringOptional.get();

While the other comments of @copilot make sense to me, I am not sure about this one.
@Leo-Send What do you think? Is this something that makes sense? I have the feeling that this is nonsense. The printed log warning seems to be unrelated to the isPresent call that Copilot suggests. Or do you perceive it differently?

The case described by copilot can only happen if the api returns null (since every other return should be castable to a string), which I believe would be an indicator of the api being completely unavailable. I do not think we should continue the execution in this case.

Copilot · 2026-03-10T17:46:23Z

src/de/uni_passau/fim/gitwrapper/IssueData.java

+    * Gets the type of the issue.
+    *
+    * @return the type
+    */


The Javadoc comment has inconsistent indentation—the * characters are indented one space less than the rest of the Javadoc comments in this file (4 spaces instead of 5). See the surrounding methods like getState() at line 193 for the correct format.

Suggested change

* Gets the type of the issue.

*

* @return the type

*/

* Gets the type of the issue.

*

* @return the type

*/

Remove unnecessary type check, refactor into new helperfunction, and formatting Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

bockthom reviewed Sep 30, 2025

View reviewed changes

bockthom requested a review from Copilot October 21, 2025 00:56

Copilot AI reviewed Oct 21, 2025

View reviewed changes

src/de/uni_passau/fim/gitwrapper/GitHubCommit.java Outdated Show resolved Hide resolved

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java Show resolved Hide resolved

src/de/uni_passau/fim/gitwrapper/IssueDataProcessor.java Show resolved Hide resolved

Leo-Send added 7 commits October 28, 2025 14:06

Change 'extractHashtags' to ignore codeblocks

f198a6e

references to issues are now only found if they are ouside a code environment (starting and ending with three '`'). This mirrors GitHubs behaviour. Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Document findings in 'README.md'

e537267

Add paragraph that documents intended and unintended behaviour for 'referenced' events Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Add Section to README.md

2f33e8b

reformat README and nested if statement Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Fix spelling in 'README.md'

443dcdc

change BE words for consistency Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Update Copyright headers

038bbf7

Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Rename field and setter for external commits

55828ff

Getter previously did not use method parameter. Also renamed and added docs to match existing methods. Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Leo-Send force-pushed the newpr branch from d5e8c4c to bdb44ba Compare October 28, 2025 13:49

Leo-Send and others added 12 commits October 31, 2025 15:44

Improve performance for extracting hashtags

de8b9b7

using stringbuilder instead of appending, which would result in copying the string Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Add state reason and type to issues data

526df21

introduce new state reason and type data classes Signed-off-by: Shiraz Jafri <shirazjafri@outlook.com>

Add event tracking for state changes

560420f

Add new event data subclass for state changed events Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

Add events tracking for issue type changed

55b63d7

Add new enum and eventdata subclasses to track changes in issue types Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

Change change_type field to not appear in result

a9395e4

no longer serializing change_type field in IssueTypeChangedEventData Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

Add events for parent and sub issues

1d03eb8

Introduce new subclasses for parent and subissue events Signed-off-by: Shiraz jarfi <shirazJafri@outlook.com>

Add tracking for connected events

ec47c5a

Introduce new event data subclass for connected events Signed-off-by: Shiraz Jafri <shirazJafri@outlook.com>

Remove unnecessary map entry

98e4e6d

key was duplicated with different values, overwriting previous entry Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Update copyright headers

6925ad8

also fix copyright headers in new files Signed-off-by: Leo Sendelbach

Leo-Send force-pushed the newpr branch from bdb44ba to efe5fec Compare October 31, 2025 14:48

Add functionality to detect suggestions

d3dd80e

suggestions contain a codeblock using the suggestion keyword after opening the block. Add a field to reviewCommentData and result json for this boolean Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

bockthom reviewed Nov 4, 2025

View reviewed changes

src/de/uni_passau/fim/gitwrapper/ReferencedLinkProcessor.java Outdated Show resolved Hide resolved

bockthom reviewed Nov 4, 2025

View reviewed changes

src/de/uni_passau/fim/gitwrapper/ReferencedLinkProcessor.java Outdated Show resolved Hide resolved

bockthom requested a review from Copilot November 4, 2025 07:57

Copilot AI reviewed Nov 4, 2025

View reviewed changes

Resolve issues pointed out in review

4371458

Fixes: - case sensitive check for suggestion - minor spelling issue - artifact from state reasons in issue data - debug comment - copyright headers Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

bockthom mentioned this pull request Nov 17, 2025

Update gradle to version 9.2.0 and migrate to java 25 #34

Open

Add additional information to dummy user

e16d751

If no userdata is found except for the username, initialize the dummy with that username Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

bockthom reviewed Feb 2, 2026

View reviewed changes

src/de/uni_passau/fim/gitwrapper/UserDataProcessor.java Show resolved Hide resolved

Leo-Send added 2 commits February 3, 2026 14:48

Update copyright header

0c0f8ae

Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

Add support for locked events

e0ea7ff

This allows us to extract the reason for locking a conversation Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

bockthom requested a review from Copilot March 10, 2026 14:04

Copilot started reviewing on behalf of bockthom March 10, 2026 14:05 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

bockthom requested a review from Copilot March 10, 2026 17:38

Copilot started reviewing on behalf of bockthom March 10, 2026 17:38 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Integrate requested changes

7730ba6

Remove unnecessary type check, refactor into new helperfunction, and formatting Signed-off-by: Leo Sendelbach <s8lesend@stud.uni-saarland.de>

	.filter(eventData -> eventData instanceof EventData.ReferencedEventData \|\| eventData instanceof EventData.StateChangedEventData)
	.filter(eventData -> eventData instanceof EventData.ReferencedEventData)

-                String jsonStringFromURL = getJSONStringFromURL(url).get();
+                Optional<String> jsonStringOptional = getJSONStringFromURL(url);
+                if (!jsonStringOptional.isPresent()) {
+                    LOG.warning("Could not retrieve JSON String when querying data for commit " + url + " after malformed response.");
+                    Optional<GitHubCommit> res = Optional.empty();
+                    checkedHashes.put(hash, res);
+                    return res;
+                }
+                String jsonStringFromURL = jsonStringOptional.get();

Conversation

Leo-Send commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Leo-Send commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Leo-Send commented Sep 5, 2025

Uh oh!

bockthom commented Sep 8, 2025

Uh oh!

Leo-Send commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bockthom commented Oct 21, 2025

Uh oh!

bockthom commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

bockthom Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Leo-Send commented Aug 26, 2025 •

edited

Loading

Leo-Send commented Aug 26, 2025 •

edited

Loading

Leo-Send commented Sep 25, 2025 •

edited

Loading

bockthom Mar 10, 2026 •

edited

Loading