CodeOwnersParser Team/User lookup #6366
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace Azure.Sdk.Tools.CodeOwnersParser | ||
| { | ||
| public class DefaultStorageConstants | ||
| { | ||
| public const string DefaultStorageURI = "https://azuresdkartifacts.blob.core.windows.net/azure-sdk-write-teams/azure-sdk-write-teams-blob"; | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Text.Json; | ||
| using System.Text.Json.Serialization; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace Azure.Sdk.Tools.CodeOwnersParser | ||
| { | ||
| public class TeamUserHolder | ||
| { | ||
| private string TeamUserStorageURI { get; set; } = DefaultStorageConstants.DefaultStorageURI; | ||
| private Dictionary<string, List<string>>? _teamUserDict = null; | ||
|
|
||
| public Dictionary<string, List<string>> TeamUserDict | ||
| { | ||
| get | ||
| { | ||
| if (_teamUserDict == null) | ||
| { | ||
| _teamUserDict = GetTeamUserData(); | ||
| } | ||
| return _teamUserDict; | ||
| } | ||
| set | ||
| { | ||
| _teamUserDict = value; | ||
| } | ||
| } | ||
|
|
||
| public TeamUserHolder(string? teamUserStorageURI) | ||
| { | ||
| if (!string.IsNullOrWhiteSpace(teamUserStorageURI)) | ||
| { | ||
| TeamUserStorageURI = teamUserStorageURI; | ||
| } | ||
| } | ||
|
|
||
| private Dictionary<string, List<string>> GetTeamUserData() | ||
| { | ||
| if (null == _teamUserDict) | ||
| { | ||
| string rawJson = FileHelpers.GetFileOrUrlContents(TeamUserStorageURI); | ||
| var list = JsonSerializer.Deserialize<List<KeyValuePair<string, List<string>>>>(rawJson); | ||
| if (null != list) | ||
| { | ||
| return list.ToDictionary((keyItem) => keyItem.Key, (valueItem) => valueItem.Value); | ||
| } | ||
| Console.WriteLine($"Error! Unable to deserialize json team/user data from {TeamUserStorageURI}. rawJson={rawJson}"); | ||
| return new Dictionary<string, List<string>>(); | ||
| } | ||
| return _teamUserDict; | ||
| } | ||
|
|
||
| public List<string> GetUsersForTeam(string teamName) | ||
| { | ||
| // The teamName in the codeowners file should be in the form <org>/<team>. | ||
| // The dictionary's team names do not contain the org so the org needs to | ||
| // be stripped off. Handle the case where the teamName passed in does and | ||
| // does not being with @org/ | ||
| string teamWithoutOrg = teamName.Trim(); | ||
| if (teamWithoutOrg.Contains('/')) | ||
| { | ||
| teamWithoutOrg = teamWithoutOrg.Split("/")[1]; | ||
| } | ||
| if (TeamUserDict != null) | ||
| { | ||
| if (TeamUserDict.ContainsKey(teamWithoutOrg)) | ||
| { | ||
| Console.WriteLine($"Found team entry for {teamWithoutOrg}"); | ||
|
There was a problem hiding this comment. We might want to think about making this logging configurable or use a logging interface at some point as generally it isn't great for shared libraries to have a bunch of logging. There was a problem hiding this comment. That won't be part of this PR. I created a new issue to track this. |
||
| return TeamUserDict[teamWithoutOrg]; | ||
| } | ||
| Console.WriteLine($"Warning: TeamUserDictionary did not contain a team entry for {teamWithoutOrg}"); | ||
| } | ||
| return new List<string>(); | ||
| } | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@weshaggard, I had to add another command line option to RetrieveCodeOwners to allow writing the json output to the file. The fact is, the get-codeowners.lib.ps1 was incorrectly assuming any/all output from the executable was nothing more than a json codeowner entry. Using CodeOwnersParser FileHelper GetUrlContents to fetch the blob, will cause output that'll break this assumption. The correct fix for this is the add the option to write the entry to a file. The problem here is because of locked version in the eng/common/get-codeowners.lib.ps1 script, I can't make the changes, to use the file instead of output, to the script until this is checked in and another version has been published.
@konrad-jamrozik and I already chatted about this and both agreed this was the correct way to fix this.