refactored out projectusers to its own controller

Author: chrisK00

BugLab.API/Controllers/ProjectUsersController.cs

@@ -0,0 +1,53 @@
+using BugLab.Business.Commands.Projects;
+using BugLab.Business.Interfaces;
+using BugLab.Business.Queries.Projects;
+using BugLab.Data.Extensions;
+using BugLab.Shared.Responses;
+using MediatR;
+using Microsoft.AspNetCore.Mvc;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace BugLab.API.Controllers
+{
+    [Route("api/projects/{projectId}/[controller]")]
+    public class ProjectUsersController : BaseApiController
+    {
+        private readonly IAuthService _authService;
+
+        public ProjectUsersController(IMediator mediator, IAuthService authService) : base(mediator)
+        {
+            _authService = authService;
+        }
+
+        [HttpGet]
+        public async Task<ActionResult<IEnumerable<UserResponse>>> GetProjectUsers(int projectId, CancellationToken cancellationToken)
+        {
+            var users = await _mediator.Send(new GetProjectUsersQuery(projectId), cancellationToken);
+
+            return Ok(users);
+        }
+
+        [HttpPost]
+        public async Task<IActionResult> AddUsersToProject(int projectId, [FromQuery] IEnumerable<string> userIds, CancellationToken cancellationToken)
+        {
+            if (!userIds.Any()) return NoContent();
+
+            await _authService.HasAccessToProject(User.UserId(), projectId);
+            await _mediator.Send(new AddProjectUsersCommand(projectId, userIds), cancellationToken);
+
+            return NoContent();
+        }
+
+        [HttpDelete("{id}")]
+        public async Task<IActionResult> DeleteProjectUser(int projectId, string id, CancellationToken cancellationToken)
+        {
+            await _authService.HasAccessToProject(User.UserId(), projectId);
+            await _mediator.Send(new DeleteProjectUserCommand(projectId, id), cancellationToken);
+
+            return NoContent();
+        }
+    }
+}

BugLab.API/Controllers/ProjectsController.cs

@@ -61,17 +61,6 @@ public async Task<IActionResult> UpdateProject(int id, UpdateProjectRequest requ
             return NoContent();
         }
 
-        [HttpPost("{id}/users")]
-        public async Task<IActionResult> AddUsersToProject(int id, [FromQuery] IEnumerable<string> userIds, CancellationToken cancellationToken)
-        {
-            if (!userIds.Any()) return NoContent();
-
-            await _authService.HasAccessToProject(User.UserId(), id);
-            await _mediator.Send(new AddProjectUsersCommand(id, userIds), cancellationToken);
-
-            return NoContent();
-        }
-
         [HttpDelete("{id}")]
         public async Task<IActionResult> DeleteProject(int id, CancellationToken cancellationToken)
         {
@@ -80,15 +69,5 @@ public async Task<IActionResult> DeleteProject(int id, CancellationToken cancell
 
             return NoContent();
         }
-
-        [HttpDelete("{id}/users/{userId}")]
-        public async Task<IActionResult> DeleteProjectUser(int id, string userId, CancellationToken cancellationToken)
-        {
-            await _authService.HasAccessToProject(User.UserId(), id);
-            await _mediator.Send(new DeleteProjectUserCommand(id, userId), cancellationToken);
-
-            return NoContent();
-        }
-
     }
 }

BugLab.Blazor/Components/Projects/ProjectMembersListComponent.razor

@@ -26,12 +26,7 @@
     {
         if (Members.Count() == 1) { Snackbar.Add("Removing the last user on the project gives no one access to it", Severity.Error); return; }
 
-        var uri = new StringBuilder()
-        .Append(Endpoints.Projects).Append('/').Append(ProjectId).Append('/')
-        .Append(nameof(Endpoints.Users)).Append('/').Append(id).ToString();
-
-        await Client.DeleteAsync(uri);
-
+        await Client.DeleteAsync($"{Endpoints.ProjectUsers(ProjectId)}/{id}");
         Members = Members.Where(u => u.Id != id).ToList();
     }
 

BugLab.Blazor/Dialogs/AddProjectMemberDialog.razor

@@ -62,7 +62,7 @@
 
     private async Task AddUsersToProject()
     {
-        var request = QueryBuilder.Use($"{Endpoints.Projects}/{ProjectId}/users");
+        var request = QueryBuilder.Use(Endpoints.ProjectUsers(ProjectId));
         foreach (var user in _selectedUsers)
         {
             request.WithParam("userIds", user.Id);

BugLab.Blazor/Helpers/Endpoints.cs

@@ -16,5 +16,10 @@ public static string BugTypes(int projectId)
         {
             return $"{Projects}/{projectId}/bugTypes";
         }
+
+        public static string ProjectUsers(int projectId)
+        {
+            return $"{Projects}/{projectId}/projectUsers";
+        }
     }
 }

BugLab.Blazor/Pages/ProjectsList.razor

@@ -26,7 +26,7 @@
         <MudTh></MudTh>
     </HeaderContent>
     <RowTemplate>
-        <MudTd DataLabel="Title" id="title"><MudButton @onclick="() => SelectedProjectChanged(context)">@context.Title</MudButton></MudTd>
+        <MudTd DataLabel="Title" id="title"><MudButton @onclick="async () => await SelectedProjectChanged(context)">@context.Title</MudButton></MudTd>
         <MudTd DataLabel="High prioritized bugs">@context.TotalHighPriorityBugs</MudTd>
         <MudTd DataLabel="Total bugs">@context.TotalBugs</MudTd>
         <MudTd>
@@ -52,7 +52,7 @@
             @if (_showMembers)
             {
                 <MudButton Class="ml-5" OnClick="OpenAddMemberDialog">Add a new member</MudButton>
-                <ProjectMembersListComponent ProjectId="_selectedProject.Id" Members="@_selectedProject.Users" />
+                <ProjectMembersListComponent ProjectId="_selectedProject.Id" Members="@_selectedProjectMembers" />
             }
         </MudItem>
     </MudContainer>
@@ -64,6 +64,7 @@
     private bool _showAddProject;
     private bool _showMembers = true;
     private ProjectResponse _selectedProject;
+    private IEnumerable<UserResponse> _selectedProjectMembers = new List<UserResponse>();
 
     public async Task<TableData<ProjectResponse>> GetProjects(TableState state)
     {
@@ -93,9 +94,11 @@
         };
     }
 
-    public void SelectedProjectChanged(ProjectResponse projectResponse)
+    public async Task SelectedProjectChanged(ProjectResponse projectResponse)
     {
         _selectedProject = projectResponse;
+        var projectMembers = await Client.GetFromJsonAsync<IEnumerable<UserResponse>>(Endpoints.ProjectUsers(_selectedProject.Id));
+        _selectedProjectMembers = projectMembers ?? new List<UserResponse>();
     }
 
     public void OnProjectClick(string projectTitle, int projectId)

BugLab.Business/Queries/Projects/GetProjectUsersQuery.cs

@@ -0,0 +1,16 @@
+using BugLab.Shared.Responses;
+using MediatR;
+using System.Collections.Generic;
+
+namespace BugLab.Business.Queries.Projects
+{
+    public class GetProjectUsersQuery : IRequest<IEnumerable<UserResponse>>
+    {
+        public GetProjectUsersQuery(int projectId)
+        {
+            ProjectId = projectId;
+        }
+
+        public int ProjectId { get; }
+    }
+}

BugLab.Business/QueryHandlers/Projects/GetProjectUsersHandler.cs

@@ -0,0 +1,29 @@
+using BugLab.Business.Queries.Projects;
+using BugLab.Data;
+using BugLab.Shared.Responses;
+using MediatR;
+using Microsoft.EntityFrameworkCore;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace BugLab.Business.QueryHandlers.Projects
+{
+    public class GetProjectUsersHandler : IRequestHandler<GetProjectUsersQuery, IEnumerable<UserResponse>>
+    {
+        private readonly AppDbContext _context;
+
+        public GetProjectUsersHandler(AppDbContext context)
+        {
+            _context = context;
+        }
+
+        public async Task<IEnumerable<UserResponse>> Handle(GetProjectUsersQuery request, CancellationToken cancellationToken)
+        {
+            return await _context.Projects.AsNoTracking().Where(p => p.Id == request.ProjectId)
+                .Select(p => p.Users.Select(u => new UserResponse { Email = u.Email, Id = u.Id }))
+                .FirstOrDefaultAsync(cancellationToken);
+        }
+    }
+}

BugLab.Shared/Responses/ProjectResponse.cs

@@ -1,6 +1,4 @@
-using System.Collections.Generic;
-
-namespace BugLab.Shared.Responses
+namespace BugLab.Shared.Responses
 {
     public class ProjectResponse
     {
@@ -9,6 +7,5 @@ public class ProjectResponse
         public string Description { get; init; }
         public int TotalBugs { get; set; }
         public int TotalHighPriorityBugs { get; set; }
-        public IEnumerable<UserResponse> Users { get; set; } = new List<UserResponse>();
     }
 }

README.md

@@ -63,5 +63,5 @@ Give a user access to a project [![msedge-s-Rxd-ELn30-T.png](https://i.postimg.c
 - Attachments (f.e image, gif)
 - Home page can have a dashboard
 - Background service that sends a weekly stats mail regarding for example the project with most completed bugs, the project with most high prioritized bugs, how many bugs you have completed
-- Using the users nav entity on the projects can be tricky due to EF does not have support for including many to many unidirectional relationships. I could not find many code benefits with manually creating a join table and then do Include().ThenInclude() (alt make use of reference by id and then the Project entity wont even need to directly have a list of Users/ProjectUsers). It seems to be something that is coming soon for EF6 though: https://github.com/dotnet/efcore/issues/3864 . This issue will require a lot of refactoring existing code but if you would like to give it a try and convince me that it improves the app code significally (I'm aware of it having a little readability improvment and that there is a small performance boost because we don't have to do a join sometimes but at the same time it requires more code, management and performance is not an issue right now)
+- Using the users nav entity on the projects can be tricky due to EF does not have support for including many to many unidirectional relationships. An alternative is to  manually create a join table and then do Include().ThenInclude() (or make use of reference by id and then the Project entity wont even need to directly have a list of Users/ProjectUsers). It seems to be something that is coming soon for EF6 though: https://github.com/dotnet/efcore/issues/3864 . This issue will require a lot of refactoring existing code but will improve readability and performance.
 - The idea is that we give all users in a project read/write permissions to all items. If you are a performance freak you could change our urls to almost always start with projects/projectId f.e getting a comment would then be projects/projectId/bugs/bugId/comments/id, not the fanciest but since we don't need to fetch the bug in order to get the projectId to see if the user is in it we boost performance a bit but as i said there's no point in changing the code base for a little performance boost unless necessary. One great point is that it makes accessing items in the Api consistent but it also means that we need two endpoints for getting bugs. right now: api/bugs - my bugs and api/bugs?projectId=1 - project's bugs VS api/users/1/bugs and api/projects/1/bugs