Fix for InvalidGitRepositoryError under certain conditions #15735
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
|
AlanCoding
reviewed
Jan 10, 2025
| else: | ||
| original_branch = git_repo.active_branch | ||
| except git.exc.InvalidGitRepositoryError: | ||
| logger.error(f"Invalid git repository at {project_path}. Removing directory and continuing.") |
There was a problem hiding this comment.
This log would lose too much information. I'd prefer convert logger.error to logger.exception. Because, diving into questions about what this fixes, the answers were too broad. It could be because the entire directory contents were deleted, but it could be due to a ratelimiting error leaving corrupted data. Not having the specific error pinned down in the planning of this, we definitely need to at absolute minimum have that information in the logs when this happens.
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.
SUMMARY
Catch InvalidGitRepositoryError errors and remove the project directory in order to successfully clone the project and proceed.
ISSUE TYPE
COMPONENT NAME
AWX VERSION
ADDITIONAL INFORMATION
In some rare occurrences job runs can fail due to InvalidGitRepositryError. This has been observed particularly when git requests are being rate limited where either just an empty project directory is created, an empty .git directory, or a malformed/corrupt .git directory exists inside of the project when using the
Source Control Branchoption at the job level.This change will catch the InvalidGitRepositoryError and remove the empty or corrupt project directory to successfully clone the git repo.