1058: The mlbridge bot occasionally posts the same comments twice on Github

[erikj79]

This patch (hopefully) fixes an issue where sometimes the mlbridge bot would post the same email as comment twice in a PR. This happens because two instances of the CommentPosterWorkItem are running at the same time for the same PullRequest.

This is supposed to be protected by the method "concurrentWith(WorkItem other)". In this particular case, the check is faulty. It checks if the PullRequest object in this WorkItem is equal to the object in the other WorkItem. This is default Object equality, and there is definitely no guarantee that they both contain the exact same object.

Looking around in other implementations of this method, there is mix of how stringent the checks are, some only check if the PullRequest.id() field is the same, but most also check something about the HostedRepository to which the PR belongs (either name or url). I think calculating the url seems a bit expensive for an equals check.

I propose a new method on the PullRequest interface: "isSame(PullRequest other)". This isn't trying to be an equals, as that's a bit hard to define (and I don't want to get into implementing hashCode at this time), but will just return true if both PullRequest instances are logically referring to the same hosted pull request. I have replaced all uses of PullRequest.equals() and PullRequest.id().equals() with this new method for consistency.

---

Progress

• Change must not contain extraneous whitespace
• Change must be properly reviewed

Issue

• SKARA-1058: The mlbridge bot occasionally posts the same comments twice on Github

Reviewers

• Kevin Rushforth (@kevinrushforth - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/skara pull/1202/head:pull/1202
$ git checkout pull/1202

Update a local copy of the PR:
$ git checkout pull/1202
$ git pull https://git.openjdk.java.net/skara pull/1202/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1202

View PR using the GUI difftool:
$ git pr show -t 1202

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/skara/pull/1202.diff

[bridgekeeper]

👋 Welcome back erikj! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[mlbridge]

Webrevs

• 00: Full (363a7730)

[kevinrushforth]

Looks good.

[openjdk]

@erikj79 This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

🔍 One or more changes in this pull request modifies files in areas of the source code that often require two reviewers. Please consider if this is the case for this pull request, and if so, await a second reviewer to approve this pull request before you integrate it.

🌎 Applicable reviewers for one or more changes in this pull request are spread across multiple different time zones. Please consider waiting with integrating this pull request until it has been out for review for at least 24 hours to give all reviewers a chance to review the pull request.

After integration, the commit message for the final commit will be:

1058: The mlbridge bot occasionally posts the same comments twice on Github

Reviewed-by: kcr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[erikj79]

/integrate

[openjdk]

Going to push as commit fd42d90.
Since your change was applied there have been 3 commits pushed to the master branch:

• a9de6a6: 1091: "PR body must not be empty" check pointless for clean backports
• 9b0ca38: 1050: Gitlab MR stuck on missing issue when unbreakable space in PR title
• db61a39: 1040: Crash in webrev command

Your commit was automatically rebased without conflicts.

[openjdk]

@erikj79 Pushed as commit fd42d90.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.