Merge pull request #2029 from github/protected-branches

Adding indications for protected branches

Author: StanleyGoldman

src/GitHub.App/SampleData/PullRequestCheckViewModelDesigner.cs

@@ -9,6 +9,8 @@ namespace GitHub.SampleData
 {
     public sealed class PullRequestCheckViewModelDesigner : ViewModelBase, IPullRequestCheckViewModel
     {
+        public bool IsRequired { get; } = true;
+
         public string Title { get; set; } = "continuous-integration/appveyor/pr";
 
         public string Description { get; set; } = "AppVeyor build failed";

src/GitHub.App/Services/RepositoryService.cs

@@ -1,9 +1,11 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
+using System.Linq;
 using System.Threading.Tasks;
 using GitHub.Api;
 using GitHub.Extensions;
+using GitHub.Models;
 using GitHub.Primitives;
 using Octokit.GraphQL;
 using static Octokit.GraphQL.Variable;
@@ -12,9 +14,10 @@ namespace GitHub.Services
 {
     [Export(typeof(IRepositoryService))]
     [PartCreationPolicy(CreationPolicy.Shared)]
-    public class RepositoryService : IRepositoryService
+    public class RepositoryService: IRepositoryService
     {
         static ICompiledQuery<Tuple<string, string>> readParentOwnerLogin;
+        static ICompiledQuery<List<ProtectedBranch>> queryProtectedBranches;
         readonly IGraphQLClientFactory graphqlFactory;
 
         [ImportingConstructor]
@@ -45,9 +48,47 @@ public RepositoryService(IGraphQLClientFactory graphqlFactory)
                 { nameof(name), name },
             };
 
-            var graphql = await graphqlFactory.CreateConnection(address);
-            var result = await graphql.Run(readParentOwnerLogin, vars);
+            var graphql = await graphqlFactory.CreateConnection(address).ConfigureAwait(false);
+            var result = await graphql.Run(readParentOwnerLogin, vars).ConfigureAwait(false);
             return result != null ? (result.Item1, result.Item2) : ((string, string)?)null;
         }
+
+        public async Task<IList<ProtectedBranch>> GetProtectedBranches(HostAddress address, string owner, string name)
+        {
+            Guard.ArgumentNotNull(address, nameof(address));
+            Guard.ArgumentNotEmptyString(owner, nameof(owner));
+            Guard.ArgumentNotEmptyString(name, nameof(name));
+
+            if (queryProtectedBranches == null)
+            {
+                queryProtectedBranches = new Query()
+                    .Repository(Var(nameof(name)), Var(nameof(owner)))
+                    .Select(r =>
+                        r.ProtectedBranches(null, null, null, null)
+                            .AllPages()
+                            .Select(branch => new ProtectedBranch
+                            {
+                                Name = branch.Name,
+                                RequiredStatusCheckContexts = branch.RequiredStatusCheckContexts.ToArray()
+                            }).ToList()
+                        ).Compile();
+            }
+
+            var vars = new Dictionary<string, object>
+            {
+                { nameof(owner), owner },
+                { nameof(name), name },
+            };
+
+            var graphql = await graphqlFactory.CreateConnection(address).ConfigureAwait(false);
+            return await graphql.Run(queryProtectedBranches, vars).ConfigureAwait(false);
+        }
+
+        public async Task<ProtectedBranch> GetProtectedBranch(HostAddress address, string owner, string name, string branchName)
+        {
+            Guard.ArgumentNotNull(branchName, nameof(branchName));
+            var protectedBranches = await GetProtectedBranches(address, owner, name).ConfigureAwait(false);
+            return protectedBranches.FirstOrDefault(branch => branch.Name.Equals(branchName, StringComparison.InvariantCultureIgnoreCase));
+        }
     }
 }

src/GitHub.App/ViewModels/GitHubPane/PullRequestCheckViewModel.cs

@@ -53,6 +53,7 @@ public static IEnumerable<IPullRequestCheckViewModel> Build(IViewViewModelFactor
 
                 var pullRequestCheckViewModel = (PullRequestCheckViewModel) viewViewModelFactory.CreateViewModel<IPullRequestCheckViewModel>();
                 pullRequestCheckViewModel.CheckType = PullRequestCheckType.StatusApi;
+                pullRequestCheckViewModel.IsRequired = statusModel.IsRequired;
                 pullRequestCheckViewModel.Title = statusModel.Context;
                 pullRequestCheckViewModel.Description = statusModel.Description;
                 pullRequestCheckViewModel.Status = checkStatus;
@@ -102,6 +103,7 @@ public static IEnumerable<IPullRequestCheckViewModel> Build(IViewViewModelFactor
 
                     var pullRequestCheckViewModel = (PullRequestCheckViewModel)viewViewModelFactory.CreateViewModel<IPullRequestCheckViewModel>();
                     pullRequestCheckViewModel.CheckType = PullRequestCheckType.ChecksApi;
+                    pullRequestCheckViewModel.IsRequired = arg.checkRun.IsRequired;
                     pullRequestCheckViewModel.CheckRunId = arg.checkRun.Id;
                     pullRequestCheckViewModel.HasAnnotations = arg.checkRun.Annotations?.Any() ?? false;
                     pullRequestCheckViewModel.Title = arg.checkRun.Name;
@@ -147,6 +149,9 @@ private void DoOpenDetailsUrl()
             usageTracker.IncrementCounter(expression).Forget();
         }
 
+        /// <inheritdoc/>
+        public bool IsRequired { get; private set; }
+
         /// <inheritdoc/>
         public string Title { get; private set; }
 

src/GitHub.Exports.Reactive/ViewModels/GitHubPane/IPullRequestCheckViewModel.cs

@@ -10,6 +10,8 @@ namespace GitHub.ViewModels.GitHubPane
     /// </summary>
     public interface IPullRequestCheckViewModel: IViewModel
     {
+        bool IsRequired { get; }
+        
         /// <summary>
         /// The title of the Status/Check.
         /// </summary>

src/GitHub.Exports/Models/CheckRunModel.cs

@@ -58,6 +58,11 @@ public class CheckRunModel
         /// </summary>
         public string Summary { get; set; }
 
+        /// <summary>
+        /// The flag that denotes if this check is required for the pull request.
+        /// </summary>
+        public bool IsRequired { get; set; }
+
         /// <summary>
         /// The detail of a Check Run.
         /// </summary>

src/GitHub.Exports/Models/IPullRequestModel.cs

@@ -21,6 +21,16 @@ public enum PullRequestChecksState
         Failure
     }
 
+    public enum PullRequestChecksSummaryState
+    {
+        None,
+        Pending,
+        Success,
+        SuccessWithFailure,
+        SuccessWithPending,
+        Failure
+    }
+
     public interface IPullRequestModel : ICopyable<IPullRequestModel>,
         IEquatable<IPullRequestModel>, IComparable<IPullRequestModel>
     {

src/GitHub.Exports/Models/ProtectedBranch.cs

@@ -0,0 +1,8 @@
+namespace GitHub.Models
+{
+    public class ProtectedBranch
+    {
+        public string Name { get; set; }
+        public string[] RequiredStatusCheckContexts { get; set; }
+    }
+}

src/GitHub.Exports/Models/StatusModel.cs

@@ -24,5 +24,7 @@ public class StatusModel
         /// The descritption for the Status
         /// </summary>
         public string Description { get; set; }
+
+        public bool IsRequired { get; set; }
     }
 }

src/GitHub.Exports/Services/IRepositoryService.cs

@@ -1,5 +1,7 @@
 using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
+using GitHub.Models;
 using GitHub.Primitives;
 
 namespace GitHub.Services
@@ -17,5 +19,9 @@ public interface IRepositoryService
         /// otherwise null.
         /// </returns>
         Task<(string owner, string name)?> FindParent(HostAddress address, string owner, string name);
+
+        Task<IList<ProtectedBranch>> GetProtectedBranches(HostAddress address, string owner, string name);
+
+        Task<ProtectedBranch> GetProtectedBranch(HostAddress address, string owner, string name, string branchName);
     }
 }

src/GitHub.InlineReviews/Services/PullRequestSessionService.cs

@@ -49,6 +49,7 @@ public class PullRequestSessionService : IPullRequestSessionService
         readonly IDiffService diffService;
         readonly IApiClientFactory apiClientFactory;
         readonly IGraphQLClientFactory graphqlFactory;
+        readonly IRepositoryService repositoryService;
         readonly IUsageTracker usageTracker;
         readonly IDictionary<Tuple<string, string>, string> mergeBaseCache;
 
@@ -59,13 +60,15 @@ public PullRequestSessionService(
             IDiffService diffService,
             IApiClientFactory apiClientFactory,
             IGraphQLClientFactory graphqlFactory,
+            IRepositoryService repositoryService,
             IUsageTracker usageTracker)
         {
             this.gitService = gitService;
             this.gitClient = gitClient;
             this.diffService = diffService;
             this.apiClientFactory = apiClientFactory;
             this.graphqlFactory = graphqlFactory;
+            this.repositoryService = repositoryService;
             this.usageTracker = usageTracker;
 
             mergeBaseCache = new Dictionary<Tuple<string, string>, string>();
@@ -360,9 +363,12 @@ public virtual async Task<PullRequestDetailModel> ReadPullRequestDetail(HostAddr
             var connection = await graphqlFactory.CreateConnection(address);
             var result = await connection.Run(readPullRequest, vars);
 
+            var protectedBranches = await repositoryService.GetProtectedBranch(address, owner, name, result.BaseRefName);
+            var protectedContexts = protectedBranches != null ? new HashSet<string>(protectedBranches.RequiredStatusCheckContexts) : null;
+
             var apiClient = await apiClientFactory.Create(address);
             var files = await apiClient.GetPullRequestFiles(owner, name, number).ToList();
-            var lastCommitModel = await GetPullRequestLastCommitAdapter(address, owner, name, number);
+            var lastCommitModel = await GetPullRequestLastCommitAdapter(address, owner, name, number, protectedContexts);
 
             result.Statuses = (IReadOnlyList<StatusModel>) lastCommitModel.Statuses ?? Array.Empty<StatusModel>();
 
@@ -773,7 +779,8 @@ Task<IRepository> GetRepository(LocalRepositoryModel repository)
             return Task.Factory.StartNew(() => gitService.GetRepository(repository.LocalPath));
         }
 
-        async Task<LastCommitAdapter> GetPullRequestLastCommitAdapter(HostAddress address, string owner, string name, int number)
+        async Task<LastCommitAdapter> GetPullRequestLastCommitAdapter(HostAddress address, string owner, string name,
+            int number, HashSet<string> protectedContexts)
         {
             ICompiledQuery<IEnumerable<LastCommitAdapter>> query;
             if (address.IsGitHubDotCom())
@@ -867,8 +874,23 @@ async Task<LastCommitAdapter> GetPullRequestLastCommitAdapter(HostAddress addres
             };
 
             var connection = await graphqlFactory.CreateConnection(address);
-            var result = await connection.Run(query, vars);
-            return result.First();
+            var results = await connection.Run(query, vars);
+            var result = results.First();
+
+            foreach (var resultCheckSuite in result.CheckSuites)
+            {
+                foreach (var checkRunModel in resultCheckSuite.CheckRuns)
+                {
+                    checkRunModel.IsRequired = protectedContexts?.Contains(checkRunModel.Name) ?? false;
+                }
+            }
+
+            foreach (var resultStatus in result.Statuses)
+            {
+                resultStatus.IsRequired = protectedContexts?.Contains(resultStatus.Context) ?? false;
+            }
+
+            return result;
         }
 
         static void BuildPullRequestThreads(PullRequestDetailModel model)

src/GitHub.VisualStudio.UI/Views/GitHubPane/PullRequestCheckView.xaml

@@ -47,6 +47,12 @@
             <TextBlock TextTrimming="CharacterEllipsis" Text="{Binding Description}" ToolTip="{Binding DurationStatus}"/>
         </Label>
 
+        <StackPanel Grid.Column="3" Grid.Row="0" HorizontalAlignment="Right" Orientation="Horizontal">
+            <Label Visibility="{Binding IsRequired, Converter={ghfvs:BooleanToVisibilityConverter}}">
+                Required
+            </Label>
+        </StackPanel>
+
         <Label Grid.Column="2" Grid.Row="1" HorizontalContentAlignment="Stretch" Visibility="{Binding HasAnnotations, Converter={ghfvs:BooleanToVisibilityConverter}}">
             <Hyperlink ToolTip="View checks"
                            Command="{Binding Path=DataContext.ShowAnnotations, RelativeSource={RelativeSource Mode=FindAncestor,AncestorType={x:Type local:PullRequestDetailView}}}"

test/GitHub.InlineReviews.UnitTests/Services/PullRequestSessionServiceTests.cs

@@ -296,6 +296,7 @@ static PullRequestSessionService CreateTarget(IDiffService diffService)
                 diffService,
                 Substitute.For<IApiClientFactory>(),
                 Substitute.For<IGraphQLClientFactory>(),
+                Substitute.For<IRepositoryService>(),
                 Substitute.For<IUsageTracker>());
         }