Skip to content
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.

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

1092: /backport commit command does not validate non existing repos #1192

Closed

Conversation

erikj79
Copy link
Member

@erikj79 erikj79 commented Jun 23, 2021

This patch fixes inconsistencies with how Forge.repository(String) behaves for GitHub and GitLab.

From what I can tell, this method is expected to return an Optional.empty() if the repository does not exist, and in the Gitlab case, this is what it does. For Github there is no actual check. In both cases, they call the hosted repository constructor (GitlabRepository and GithubRepository respectively) and expect an exception if it doesn't exist. In the case of Gitlab, the constructor will make a rest call to get information about the repository, while the Github variant does not. It seems this was changed for GitHub a long while back as an optimization, using lazy initialization: #296

I have rewritten this logic and aligned the behavior of Forge.repository(String) between GitHub and GitLab. Now they both will only return Optional.empty() if the rest call to get repository info returns 404. Any other RuntimeException or Error is just let through, as it should be. There are other ways a hosted repository can be created, where Optional is not used in the return value. In these cases we now have consistent throwing of a RuntimeException with the message "Project/Repository not found" (in the GitLab case directly as it's needed for constructing the object, and in the GitHub case when a method is called that triggers the lazy initialization). The assumption is that in these other code paths, the repository name does not originate from human input, but rather other query results, so a 404 is truly unexpected and should result in an exception.


Progress

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

Issue

  • SKARA-1092: /backport commit command does not validate non existing repos

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1192

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

Using diff file

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Jun 23, 2021

👋 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.

@openjdk openjdk bot changed the title SKARA-1092 1092: /backport commit command does not validate non existing repos Jun 23, 2021
@openjdk openjdk bot added the rfr label Jun 23, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Jun 23, 2021

Webrevs

Copy link
Member

@kevinrushforth kevinrushforth left a comment

Looks fine. Do you think it is worth adding additional tests to make sure a 404 correctly returns an empty optional, whereas any other error throws an exception?

@openjdk
Copy link

@openjdk openjdk bot commented Jun 24, 2021

@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:

1092: /backport commit command does not validate non existing repos

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.

@openjdk openjdk bot added the ready label Jun 24, 2021
@erikj79
Copy link
Member Author

@erikj79 erikj79 commented Jun 24, 2021

Do you think it is worth adding additional tests to make sure a 404 correctly returns an empty optional, whereas any other error throws an exception?

Skara doesn't currently have any tests that verifies the interaction with other services, like Github or Jira. I don't know where to start writing such tests. Creating a framework for that is certainly bigger than this fix.

@erikj79
Copy link
Member Author

@erikj79 erikj79 commented Jun 24, 2021

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Jun 24, 2021

Going to push as commit 8801187.

@openjdk openjdk bot closed this Jun 24, 2021
@openjdk openjdk bot added integrated and removed ready labels Jun 24, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jun 24, 2021

@erikj79 Pushed as commit 8801187.

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

@openjdk openjdk bot removed the rfr label Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants