Secret Scanning Alerts migration - update to new location types #1306
+370
−96
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
Unit Test Results856 tests 856 ✅ 20s ⏱️ Results for commit 5b07255. ♻️ This comment has been updated with latest results. |
| @@ -1 +1 @@ | |||
|
|
|||
| - Updated Secret Scanning Alerts migration command to match on all location types. Now includes: issues, pull requests, issues. | |||
There was a problem hiding this comment.
Suggested change
| - Updated Secret Scanning Alerts migration command to match on all location types. Now includes: issues, pull requests, issues. | |
| - Updated Secret Scanning Alerts migration (`gh gei migrate-secret-alerts`) command to match on all location types. Now includes: issues, pull requests, issues. |
Comment on lines
+124
to
+126
| //"discussion_title" => sourceLocation.DiscussionTitleUrl == targetLocation.DiscussionTitleUrl, | ||
| //"discussion_body" => sourceLocation.DiscussionBodyUrl == targetLocation.DiscussionBodyUrl, | ||
| //"discussion_comment" => sourceLocation.DiscussionCommentUrl == targetLocation.DiscussionCommentUrl, |
There was a problem hiding this comment.
Please remove the commented code
Suggested change
| //"discussion_title" => sourceLocation.DiscussionTitleUrl == targetLocation.DiscussionTitleUrl, | |
| //"discussion_body" => sourceLocation.DiscussionBodyUrl == targetLocation.DiscussionBodyUrl, | |
| //"discussion_comment" => sourceLocation.DiscussionCommentUrl == targetLocation.DiscussionCommentUrl, |
| // and value List of AlertWithLocations | ||
| // This method is used to get alerts from both source and target repositories | ||
| private async Task<Dictionary<(string SecretType, string Secret), List<AlertWithLocations>>> | ||
| GetAlertsWithLocationsDict(GithubApi api, string org, string repo) |
There was a problem hiding this comment.
nit: not a biggie but generally speaking adding a returned type suffix is discouraged in method and variable names so I would still use the previous name.
Comment on lines
+36
to
+38
| foreach (var sourceKey in sourceAlertsDict.Keys) | ||
| { | ||
| _log.LogInformation($"Processing source secret {alert.Alert.Number}"); | ||
|
|
||
| if (SecretScanningAlert.IsOpen(alert.Alert.State)) | ||
| foreach (var sourceAlert in sourceAlertsDict[sourceKey]) |
There was a problem hiding this comment.
nit: These two foreach statements can be combined into one:
foreach (var kvp in sourceAlertsDict)
{
// if you wish to use the variable names, I wish C# supported deconstruction syntax in foreach loops!
var sourceKey = kvp.Key;
var sourceAlert = kvp.Value;
}
|
6 tasks
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.
PR implements #1305
ThirdPartyNotices.txt(if applicable)Summary of code changes
src/Octoshift/Models/GithubSecretScanningAlert.csGithubSecretScanningAlertto include resolution commentGithubSecretScanningAlertLocationto include types of location and related infosrc/Octoshift/Services/GithubApi.csto work with new model definitionresolution_commentwhen updating alertsrc/Octoshift/Services/SecretScanningAlertService.csin regards to matching the locations of alerts criteria to include the new location types; and the algorithm for matching alerts between source and target repositories.Instead of iterating thru all alerts in a list to match an alert from source and target we now use dictionary for the lookup. We use this lookup to match all locations on all alerts; The criteria for matching alerts follows the similar structure as before but included couple of guards/pre-flight checks to further speed up the matching process. Performance optimization has benefits when migrating repositories with big number of alerts.