Skip to content

Commit b7cd8c8

Browse files
BillWagnerYoussef1313IEvangelistscottaddie
authored
add the What's new tool (#105)
* add the What's new tool Add the what's new tool and dependencies to the public repo. * Update WhatsNew.Cli/WhatsNew.Cli.csproj Co-authored-by: Youssef Victor <[email protected]> * Apply suggestions from code review Co-authored-by: David Pine <[email protected]> Co-authored-by: Scott Addie <[email protected]> * update prereqs * Apply suggestions from code review Co-authored-by: David Pine <[email protected]> * point the schema to the open repo. Co-authored-by: Youssef Victor <[email protected]> Co-authored-by: David Pine <[email protected]> Co-authored-by: Scott Addie <[email protected]>
1 parent fea9442 commit b7cd8c8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2750
-5
lines changed

‎DotNet.DocsTools/DotNet.DocsTools.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<TargetFramework>net7.0</TargetFramework>
55
<ImplicitUsings>enable</ImplicitUsings>
66
<Nullable>enable</Nullable>
7-
<AssemblyVersion>2.0.0.2</AssemblyVersion>
8-
<FileVersion>2.0.0.2</FileVersion>
7+
<AssemblyVersion>2.0.0.3</AssemblyVersion>
8+
<FileVersion>2.0.0.3</FileVersion>
99
</PropertyGroup>
1010

1111
<ItemGroup>

‎DotNet.DocsTools/GitHubClientServices/GitHubClient.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ async Task<string> IGitHubClient.PostMarkdownRESTRequestAsync(string markdownTex
6262
var stringResponse = await resp.Content.ReadAsStringAsync();
6363
return stringResponse;
6464
}
65-
65+
*/
6666
async Task<JsonDocument> IGitHubClient.GetReposRESTRequestAsync(params string[] restPath)
6767
{
6868
var url = RESTendpoint;
@@ -80,6 +80,7 @@ async Task<JsonDocument> IGitHubClient.GetReposRESTRequestAsync(params string[]
8080
return jsonDocument;
8181
}
8282

83+
/*
8384
async IAsyncEnumerable<string> IGitHubClient.GetContentAsync(string link)
8485
{
8586
var result = await _retryPolicy.ExecuteAndCaptureAsync(

‎DotNet.DocsTools/GitHubClientServices/IGitHubClient.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public interface IGitHubClient : IDisposable
4646
/// process the response for a success code and return the parsed
4747
/// JSONdocument.
4848
/// </remarks>
49-
// Task<JsonDocument> GetReposRESTRequestAsync(params string[] restPath);
49+
Task<JsonDocument> GetReposRESTRequestAsync(params string[] restPath);
5050

5151
/// <summary>
5252
/// Retrieve the content from a (usually raw) URL.

‎DotNet.DocsTools/GitHubObjects/PullRequest.cs

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
using DotnetDocsTools.GraphQLQueries;
2+
using System.Text.Json;
3+
4+
namespace DotnetDocsTools.GitHubObjects;
5+
6+
/// <summary>
7+
/// This encapsulates the PullRequest node from a
8+
/// GraphQL query.
9+
/// </summary>
10+
/// <remarks>
11+
/// This readonly struct provides easy access
12+
/// to the properties of the PR.
13+
/// </remarks>
14+
public readonly struct PullRequest
15+
{
16+
private readonly JsonElement node;
17+
18+
/// <summary>
19+
/// Construct the PullRequest from the Json node.
20+
/// </summary>
21+
/// <param name="pullRequestNode"></param>
22+
public PullRequest(JsonElement pullRequestNode) => this.node = pullRequestNode;
23+
24+
/// <summary>
25+
/// The node ID for the issue.
26+
/// </summary>
27+
public string Id => node.GetProperty("id").GetString() ?? throw new InvalidOperationException("Id property not found");
28+
29+
/// <summary>
30+
/// Access the PR number.
31+
/// </summary>
32+
public int Number => node.GetProperty("number").GetInt32();
33+
34+
/// <summary>
35+
/// Access the title.
36+
/// </summary>
37+
public string Title => node.GetProperty("title").GetString() ?? throw new InvalidOperationException("title Property not found");
38+
39+
/// <summary>
40+
/// Retrieve the Url property.
41+
/// </summary>
42+
public string Url => node.GetProperty("url").GetString() ?? throw new InvalidOperationException("Url property not found");
43+
44+
/// <summary>
45+
/// Access the number of changed files.
46+
/// </summary>
47+
public int ChangedFiles => node.GetProperty("changedFiles").GetInt32();
48+
49+
/// <summary>
50+
/// Access the author object for this PR.
51+
/// </summary>
52+
public Actor Author => new Actor(node.GetProperty("author"));
53+
54+
/// <summary>
55+
/// Retrun the list of labels on this issue.
56+
/// </summary>
57+
public IEnumerable<string> Labels => from label in node
58+
.Descendent("labels", "nodes")
59+
.EnumerateArray()
60+
select label.GetProperty("name").GetString();
61+
}

‎DotNet.DocsTools/GraphQLQueries/DefaultBranchQuery.cs

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
using DotnetDocsTools.GitHubCommunications;
2+
using DotnetDocsTools.GraphQLQueries;
3+
using System.Text.Json;
4+
5+
namespace DotNet.DocsTools.GraphQLQueries;
6+
7+
/// <summary>
8+
/// Query for fetching a repository's default branch name.
9+
/// </summary>
10+
public class DefaultBranchQuery
11+
{
12+
private readonly IGitHubClient _client;
13+
private readonly string _organization;
14+
private readonly string _repository;
15+
private JsonElement _rootElement;
16+
17+
private const string Query =
18+
@"query GetDefaultBranch($organization: String!, $repository: String!) {
19+
repository(owner: $organization, name: $repository) {
20+
defaultBranchRef {
21+
name
22+
}
23+
}
24+
}";
25+
26+
/// <summary>
27+
/// Constructs the GitHub GraphQL API query object.
28+
/// </summary>
29+
/// <param name="client">The GitHub client.</param>
30+
/// <param name="organization">The owner of the repository.</param>
31+
/// <param name="repository">The repository name.</param>
32+
public DefaultBranchQuery(
33+
IGitHubClient client, string organization, string repository)
34+
{
35+
_client = client ?? throw new ArgumentNullException(paramName: nameof(client), message: "Cannot be null");
36+
_organization = !string.IsNullOrWhiteSpace(organization)
37+
? organization
38+
: throw new ArgumentException(message: "must not be whitespace", paramName: nameof(organization));
39+
_repository = !string.IsNullOrWhiteSpace(repository)
40+
? repository
41+
: throw new ArgumentException(message: "must not be whitespace", paramName: nameof(repository));
42+
}
43+
44+
/// <summary>
45+
/// Perform the query.
46+
/// </summary>
47+
/// <returns>true if the label was found. False otherwise.</returns>
48+
public async Task<bool> PerformQuery()
49+
{
50+
var fileContentsPacket = new GraphQLPacket
51+
{
52+
query = Query,
53+
variables =
54+
{
55+
["organization"] = _organization,
56+
["repository"] = _repository,
57+
}
58+
};
59+
60+
_rootElement = await _client.PostGraphQLRequestAsync(fileContentsPacket);
61+
62+
return _rootElement.Descendent("repository", "defaultBranchRef").ValueKind switch
63+
{
64+
JsonValueKind.Object => true,
65+
JsonValueKind.Null => false,
66+
_ => throw new InvalidOperationException($"Unexpected result: {_rootElement}"),
67+
};
68+
}
69+
70+
/// <summary>
71+
/// Gets the repository's default branch name.
72+
/// </summary>
73+
public string DefaultBranch =>
74+
_rootElement.Descendent("repository", "defaultBranchRef", "name").GetString() ??
75+
throw new InvalidOperationException("default branch not found");
76+
}

‎DotNet.DocsTools/GraphQLQueries/PullRequestsMergedInSprint.cs

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
using DotNet.DocsTools.Utility;
2+
using DotnetDocsTools.GitHubCommunications;
3+
using DotnetDocsTools.GitHubObjects;
4+
using DotnetDocsTools.GraphQLQueries;
5+
6+
namespace DotNet.DocsTools.GraphQLQueries;
7+
8+
/// <summary>
9+
/// Retrieve all PRs merged during a sprint
10+
/// </summary>
11+
/// <remarks>
12+
/// This class encapsulates retrieving and enumerating
13+
/// all PRs merged during a given sprint for a single repository.
14+
/// The constructor sets the arguments for the query, and validates
15+
/// all arguments.
16+
/// The Perform Query method starts an iteration of (possibly)
17+
/// multiple requests that would enumerate all PRs merged to the
18+
/// specified branch during the sprint.
19+
/// </remarks>
20+
public class PullRequestsMergedInSprint
21+
{
22+
private const string PRQueryText =
23+
@"query PullRequestsMerged ($search_value: String!, $end_cursor: String) {
24+
search(query: $search_value, type: ISSUE, first: 25, after: $end_cursor) {
25+
pageInfo {
26+
hasNextPage
27+
endCursor
28+
}
29+
nodes {
30+
... on PullRequest {
31+
title
32+
number
33+
changedFiles
34+
id
35+
url
36+
labels(first: 5) {
37+
nodes {
38+
name
39+
}
40+
}
41+
author {
42+
login
43+
... on User {
44+
name
45+
}
46+
}
47+
}
48+
}
49+
}
50+
}";
51+
52+
private readonly IGitHubClient client;
53+
private readonly string search_value;
54+
55+
/// <summary>
56+
/// Construct the object for this query
57+
/// </summary>
58+
/// <param name="client">The client object</param>
59+
/// <param name="owner">The owner of this repo</param>
60+
/// <param name="repository">The repository name</param>
61+
/// <param name="branch">The name of the branch within the repository</param>
62+
/// <param name="labels">A collection of label filters to apply</param>
63+
/// <param name="dateRange">The range of dates to query</param>
64+
public PullRequestsMergedInSprint(
65+
IGitHubClient client, string owner, string repository,
66+
string branch, IEnumerable<string>? labels, DateRange dateRange)
67+
{
68+
this.client = client ?? throw new ArgumentNullException(paramName: nameof(client), message: "Cannot be null");
69+
if (string.IsNullOrWhiteSpace(owner))
70+
throw new ArgumentException(message: "Must not be whitespace", paramName: nameof(owner));
71+
if (string.IsNullOrWhiteSpace(repository))
72+
throw new ArgumentException(message: "Must not be whitespace", paramName: nameof(repository));
73+
if (string.IsNullOrWhiteSpace(branch))
74+
throw new ArgumentException(message: "Must not be whitespace", paramName: nameof(branch));
75+
76+
var labelFilter = labels != null && labels.Any() ? string.Join(" ", labels) : string.Empty;
77+
search_value = $"type:pr is:merged base:{branch} {labelFilter} " +
78+
$"repo:{owner}/{repository} " +
79+
$"closed:{dateRange.StartDate:yyyy-MM-dd}..{dateRange.EndDate:yyyy-MM-dd}";
80+
}
81+
82+
/// <summary>
83+
/// Enumerate the Pull Request results
84+
/// </summary>
85+
/// <returns>The async enumerable for these PRs</returns>
86+
/// <remarks>
87+
/// The GraphQL interface is ideally suited to paging and async
88+
/// enumeration. So, the query returns the enumerable.
89+
/// </remarks>
90+
public async IAsyncEnumerable<PullRequest> PerformQuery()
91+
{
92+
var queryText = new GraphQLPacket
93+
{
94+
query = PRQueryText,
95+
variables = { [nameof(search_value)] = search_value }
96+
};
97+
98+
var cursor = default(string);
99+
var hasMore = true;
100+
while (hasMore)
101+
{
102+
queryText.variables["end_cursor"] = cursor!;
103+
var jsonData = await client.PostGraphQLRequestAsync(queryText);
104+
105+
var searchNodes = jsonData.GetProperty("search");
106+
107+
foreach (var item in searchNodes.GetProperty("nodes").EnumerateArray())
108+
yield return new PullRequest(item);
109+
(hasMore, cursor) = searchNodes.NextPageInfo();
110+
}
111+
}
112+
}

0 commit comments

Comments
 (0)