#8 fixes for logging

Ian-Webster · Feb 7, 2024 · 37ec6ae · 37ec6ae
1 parent df17af7
commit 37ec6ae
Show file tree

Hide file tree

Showing 20 changed files with 1,036 additions and 50 deletions.
diff --git a/DataAccess.Repository.Tests/Tests/Add.cs b/DataAccess.Repository.Tests/Tests/Add.cs
@@ -12,7 +12,7 @@ public async Task Should_Add_Expected_Data(Book data)
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         // act
         var result = await repo.Add(data, Token);

diff --git a/DataAccess.Repository.Tests/Tests/Exists.cs b/DataAccess.Repository.Tests/Tests/Exists.cs
@@ -16,7 +16,7 @@ public async Task Should_Return_True_When_BookExists(string bookIdString)
         var bookId = Guid.Parse(bookIdString);
 
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -36,7 +36,7 @@ public async Task Should_Return_False_When_BookDoesNotExist(string bookIdString)
         var bookId = Guid.Parse(bookIdString);
 
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 

diff --git a/DataAccess.Repository.Tests/Tests/FirstOrDefaultProjected.cs b/DataAccess.Repository.Tests/Tests/FirstOrDefaultProjected.cs
@@ -13,7 +13,7 @@ public class FirstOrDefaultProjected: RepositoryTestBase<Book>
     public async Task Should_Return_Null_When_NoDataExists()
     {
         // arrange
-        var repo = GetRepository(Logger, GetContext());
+        var repo = GetRepository(LoggerFactory, GetContext());
 
         // act
         var result = await repo.FirstOrDefaultProjected(p
@@ -29,7 +29,7 @@ public async Task Should_Return_Null_When_DataNotFound()
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -48,7 +48,7 @@ public async Task Should_Get_Expected_Item_When_MatchingItemFound(Guid bookId)
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 

diff --git a/DataAccess.Repository.Tests/Tests/List.cs b/DataAccess.Repository.Tests/Tests/List.cs
@@ -11,7 +11,7 @@ public class List: RepositoryTestBase<Book>
     public async Task Should_Return_EmptyList_When_NoDataExists()
     {
         // arrange
-        var repo = GetRepository(Logger, GetContext());
+        var repo = GetRepository(LoggerFactory, GetContext());
 
         // act
         var result = await repo.List(p => p.Name.Contains("Book"), Token);
@@ -27,7 +27,7 @@ public async Task Should_Return_EmptyList_When_NoMatchingDataFound()
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -45,7 +45,7 @@ public async Task Should_Return_Expected_Data_WhenMatchingDataFound(string searc
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -71,7 +71,7 @@ public async Task Should_Return_LimitedData_When_TakeParameterIsUsed(int take)
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         var testData = BookTestData.GetBookData();
         await InsertData(testData, context);

diff --git a/DataAccess.Repository.Tests/Tests/ListProjected.cs b/DataAccess.Repository.Tests/Tests/ListProjected.cs
@@ -14,7 +14,7 @@ public class ListProjected : RepositoryTestBase<Book>
     public async Task Should_Return_EmptyList_When_NoDataExists()
     {
         // arrange
-        var repo = GetRepository(Logger, GetContext());
+        var repo = GetRepository(LoggerFactory, GetContext());
 
         // act
         var result = await repo.ListProjected(p => 
@@ -33,7 +33,7 @@ public async Task Should_Return_EmptyList_When_NoMatchingDataFound()
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -54,7 +54,7 @@ public async Task Should_Return_Expected_Data_WhenMatchingDataFound(string searc
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -84,7 +84,7 @@ public async Task Should_Return_LimitedData_When_TakeParameterIsUsed(int take)
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         var testData = BookTestData.GetBookData();
         await InsertData(testData, context);

diff --git a/DataAccess.Repository.Tests/Tests/PageProjected.cs b/DataAccess.Repository.Tests/Tests/PageProjected.cs
@@ -15,7 +15,7 @@ public class PageProjected: RepositoryTestBase<Book>
     public async Task Should_Return_Null_When_NoDataExists()
     {
         // arrange
-        var repo = GetRepository(Logger, GetContext());
+        var repo = GetRepository(LoggerFactory, GetContext());
         var pagingRequest = new PagingRequest { PageIndex = 0, PageSize = 10 };
 
         // act
@@ -35,7 +35,7 @@ public async Task Should_Return_Null_When_NoMatchingDataFound()
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
         var pagingRequest = new PagingRequest { PageIndex = 0, PageSize = 10 };
 
         await InsertData(BookTestData.GetBookData(), context);
@@ -57,7 +57,7 @@ public async Task Should_Return_Expected_Data_WhenMatchingDataFound(string searc
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
 
         await InsertData(BookTestData.GetPagedBookData(), context);

diff --git a/DataAccess.Repository.Tests/Tests/Paged.cs b/DataAccess.Repository.Tests/Tests/Paged.cs
@@ -14,7 +14,7 @@ public class Paged : RepositoryTestBase<Book>
     public async Task Should_Return_Null_When_NoDataExists()
     {
         // arrange
-        var repo = GetRepository(Logger, GetContext());
+        var repo = GetRepository(LoggerFactory, GetContext());
         var pagingRequest = new PagingRequest { PageIndex = 0, PageSize = 10 };
 
         // act
@@ -33,7 +33,7 @@ public async Task Should_Return_Null_When_NoMatchingDataFound()
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
         var pagingRequest = new PagingRequest { PageIndex = 0, PageSize = 10 };
 
         await InsertData(BookTestData.GetBookData(), context);
@@ -54,7 +54,7 @@ public async Task Should_Return_Expected_Data_WhenMatchingDataFound(string searc
     {
         // arrange
         var context = GetContext();
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
 
         await InsertData(BookTestData.GetPagedBookData(), context);

diff --git a/DataAccess.Repository.Tests/Tests/Remove.cs b/DataAccess.Repository.Tests/Tests/Remove.cs
@@ -14,7 +14,7 @@ public async Task Should_Remove_Expected_AttachedItem(Guid bookIdToRemove)
         // arrange
         var context = GetContext();
         var dbSet = GetDbSet(context);
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -38,7 +38,7 @@ public async Task Should_Return_False_When_TryingToRemove_UnattachedItem(Book bo
         // arrange
         var context = GetContext();
         var dbSet = GetDbSet(context);
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 

diff --git a/DataAccess.Repository.Tests/Tests/RepositoryTestBase.cs b/DataAccess.Repository.Tests/Tests/RepositoryTestBase.cs
@@ -1,9 +1,9 @@
 using System.Collections;
-using System.Linq.Expressions;
 using DataAccess.Repository.Tests.Shared.DatabaseContexts;
 using DataAccess.Repository.Tests.Shared.DummyData;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
+using NSubstitute;
 using NUnit.Framework;
 
 namespace DataAccess.Repository.Tests.Tests;
@@ -12,11 +12,16 @@ public class RepositoryTestBase<TEntity> where TEntity : class
 {
     protected readonly CancellationToken Token;
     protected ILogger Logger;
+#pragma warning disable NUnit1032 // An IDisposable field/property should be Disposed in a TearDown method
+    protected ILoggerFactory LoggerFactory;
+#pragma warning restore NUnit1032 // An IDisposable field/property should be Disposed in a TearDown method
 
     [SetUp]
     protected void Setup()
     {
-        Logger = NSubstitute.Substitute.For<ILogger>();
+        LoggerFactory = Substitute.For<ILoggerFactory>();
+        Logger = Substitute.For<ILogger>();
+        LoggerFactory.CreateLogger(Arg.Any<string>()).Returns(Logger);
     }
 
     public RepositoryTestBase()
@@ -35,7 +40,7 @@ protected DbSet<TEntity> GetDbSet(DbContext context)
         return context.Set<TEntity>();
     }
 
-    protected IRepository<TEntity> GetRepository(ILogger mockLogger, LibraryDatabaseContext? context = null)
+    protected IRepository<TEntity> GetRepository(ILoggerFactory mockLogger, LibraryDatabaseContext? context = null)
     {
         return new UnitOfWork<LibraryDatabaseContext>(context ?? GetContext(), mockLogger).Repository<TEntity>();
     }

diff --git a/DataAccess.Repository.Tests/Tests/Update.cs b/DataAccess.Repository.Tests/Tests/Update.cs
@@ -14,7 +14,7 @@ public async Task Should_Update_ExpectedBook_When_BookAttached(Book bookToUpdate
         // arrange
         var context = GetContext();
         var dbSet = GetDbSet(context);
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 
@@ -42,7 +42,7 @@ public async Task Should_NotUpdate_Books_When_BookNotAttached(Book bookToUpdate)
         // arrange
         var context = GetContext();
         var dbSet = GetDbSet(context);
-        var repo = GetRepository(Logger, context);
+        var repo = GetRepository(LoggerFactory, context);
 
         await InsertData(BookTestData.GetBookData(), context);
 

diff --git a/DataAccess.Repository/UnitOfWork.cs b/DataAccess.Repository/UnitOfWork.cs
@@ -10,10 +10,10 @@ public class UnitOfWork<TContext> : IDisposable where TContext : DbContext
     private bool _disposed;
     private Dictionary<Type, object> _repositories;
 
-    public UnitOfWork(TContext context, ILogger logger)
+    public UnitOfWork(TContext context, ILoggerFactory loggerFactory)
     {
         _context = context;
-        _logger = logger;
+        _logger = loggerFactory.CreateLogger<UnitOfWork<TContext>>();
     }
 
     public IRepository<T> Repository<T>() where T : class

diff --git a/Example/DataAccess.Example.Data/DataAccess.Example.Data.csproj b/Example/DataAccess.Example.Data/DataAccess.Example.Data.csproj
@@ -4,6 +4,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Example/DataAccess.Example.Data/Models/BookNameOnly.cs b/Example/DataAccess.Example.Data/Models/BookNameOnly.cs
@@ -0,0 +1,6 @@
+namespace DataAccess.Example.Data.Models;
+
+public class BookNameOnly
+{
+    public string BookName { get; set; }
+}
diff --git a/Example/DataAccess.Example.Data/Repositories/BookRepository.cs b/Example/DataAccess.Example.Data/Repositories/BookRepository.cs
@@ -1,7 +1,9 @@
 using DataAccess.Example.Data.DatabaseContexts;
 using DataAccess.Example.Data.Entities;
+using DataAccess.Example.Data.Models;
 using DataAccess.Repository;
 using DataAccess.Repository.HotChocolate;
+using DataAccess.Repository.Models;
 using HotChocolate.Resolvers;
 using HotChocolate.Types.Pagination;
 
@@ -21,9 +23,32 @@ public BookRepository(UnitOfWork<LibraryDatabaseContext> unitOfWork)
         return await _bookRepo.FirstOrDefault(b => b.BookId == bookId, token);
     }
 
-    public async Task<IEnumerable<Book>?> GetAllBooks(CancellationToken token)
+    public async Task<IEnumerable<Book>?> GetAllBooks(CancellationToken token, int? take = null)
     {
-        return await _bookRepo.List(p => true, token);
+        return await _bookRepo.List(p => true, token, take);
+    }
+
+    public async Task<PagedResult<Book>> GetPageBooks(PagingRequest request, CancellationToken token)
+    {
+        return await _bookRepo.Paged(b => true, request, token);
+    }
+
+    public async Task<BookNameOnly?> GetBookNameOnlyById(Guid bookId, CancellationToken token)
+    {
+        return await _bookRepo.FirstOrDefaultProjected(b => b.BookId == bookId,
+            b => new BookNameOnly { BookName = b.Name }, token);
+    }
+
+    public async Task<IEnumerable<BookNameOnly>?> GetAllBookNamesOnly(CancellationToken token, int? take = null)
+    {
+        return await _bookRepo.ListProjected(b => true, 
+            b => new BookNameOnly { BookName = b.Name }, token, take);
+    }
+
+    public async Task<PagedResult<BookNameOnly>> GetPagedBookNamesOnly(PagingRequest request, CancellationToken token)
+    {
+        return await _bookRepo.PagedProjected(b => true, 
+                       b => new BookNameOnly { BookName = b.Name }, request, token);
     }
 
     public async Task<bool> AddBook(Book bookToAdd, CancellationToken token)

diff --git a/Example/DataAccess.Example.Data/Repositories/IBookRepository.cs b/Example/DataAccess.Example.Data/Repositories/IBookRepository.cs
@@ -1,4 +1,6 @@
 using DataAccess.Example.Data.Entities;
+using DataAccess.Example.Data.Models;
+using DataAccess.Repository.Models;
 using HotChocolate.Resolvers;
 using HotChocolate.Types.Pagination;
 
@@ -8,7 +10,15 @@ public interface IBookRepository
 {
     Task<Book?> GetBookById(Guid bookId, CancellationToken token);
 
-    Task<IEnumerable<Book>?> GetAllBooks(CancellationToken token);
+    Task<IEnumerable<Book>?> GetAllBooks(CancellationToken token, int? take = null);
+
+    Task<PagedResult<Book>> GetPageBooks(PagingRequest request, CancellationToken token);
+
+    Task<BookNameOnly?> GetBookNameOnlyById(Guid bookId, CancellationToken token);
+
+    Task<IEnumerable<BookNameOnly>?> GetAllBookNamesOnly(CancellationToken token, int? take = null);
+
+    Task<PagedResult<BookNameOnly>> GetPagedBookNamesOnly(PagingRequest request, CancellationToken token);
 
     Task<bool> AddBook(Book bookToAdd, CancellationToken token);
 

diff --git a/Example/DataAccess.Example.Web/Controllers/BaseController.cs b/Example/DataAccess.Example.Web/Controllers/BaseController.cs
@@ -0,0 +1,8 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace DataAccess.Example.Web.Controllers;
+
+public class BaseController: ControllerBase
+{
+    protected CancellationToken Token => HttpContext.RequestAborted;
+}