Fix target repo existence check in GHES migrations so it doesn't explode if the target repo used to exist, but has been renamed #1084
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ode if the target repo used to exist, but has been renamed When migrating from GHES with `migrate-repo`, we perform a quick validation check before starting the export to ensure that the target repo doesn't already exist. If it does already exist, we can fail fast and not run the export at all. If the repo used to exist but has been renamed, then this causes the CLI to error, because the REST API returns `301 Moved Permanently` and that's not something we handle or expect. This updates our code to handle `301 Moved Permanently` and treat it correctly as "the repo doesn't exist". Fixes #1074.
timrogers
commented
Jul 25, 2023
| @@ -158,6 +158,10 @@ public virtual async Task<bool> DoesRepoExist(string org, string repo) | |||
| { | |||
| return true; | |||
| } | |||
| catch (HttpRequestException ex) when (ex.StatusCode == HttpStatusCode.MovedPermanently) | |||
There was a problem hiding this comment.
An alternative approach would have been to update GetNonSuccessAsync (see lines above) to allow multiple "allowed HTTP statuses". But that turned out to be reasonably complex, and I'm not sure how likely it is that we'll need this again, so I took the easy way out.
|
I considered covering this in the tests for |
|
hfishback01
approved these changes
Jul 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When migrating from GHES with
migrate-repo, we perform a quick validation check before starting the export to ensure that the target repo doesn't already exist. If it does already exist, we can fail fast and not run the export at all.If the repo used to exist but has been renamed, then this causes the CLI to error, because the REST API returns
301 Moved Permanentlyand that's not something we handle or expect.This updates our code to handle
301 Moved Permanentlyand treat it correctly as "the repo doesn't exist".Fixes #1074.
ThirdPartyNotices.txt(if applicable)