docs: Refactor repositories to return IReadOnlyList<T> results

BoBoBaSs84 · BoBoBaSs84 · commit 63caf7a65452 · 2026-03-22T10:44:29.000+01:00
Updated repository interfaces and implementations to return IReadOnlyList&lt;T&gt; instead of IEnumerable&lt;T&gt; for collection-returning methods. This clarifies intent by indicating returned collections are read-only, reducing risk of unintended modification and improving API expressiveness. Affected methods include GetAll, GetAllAsync, GetActiveProductsAsync, and SearchProductsAsync.
diff --git a/README.md b/README.md
@@ -271,8 +271,8 @@ public interface IGenericRepository<TEntity> where TEntity : class
     Task CreateAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default);
 
     // Read operations
-    IEnumerable<TEntity> GetAll(bool ignoreQueryFilters = false, bool trackChanges = false);
-    Task<IEnumerable<TEntity>> GetAllAsync(bool ignoreQueryFilters = false, bool trackChanges = false, CancellationToken token = default);
+    IReadOnlyList<TEntity> GetAll(bool ignoreQueryFilters = false, bool trackChanges = false);
+    Task<IReadOnlyList<TEntity>> GetAllAsync(bool ignoreQueryFilters = false, bool trackChanges = false, CancellationToken token = default);
 
     // Update operations
     void Update(TEntity entity);
@@ -436,7 +436,7 @@ public interface IUserRepository : IIdentityRepository<User>
 
 public interface IProductRepository : IIdentityRepository<Product>
 {
-    Task<IEnumerable<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default);
+    Task<IReadOnlyList<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default);
 }
 ```
 
@@ -457,7 +457,7 @@ public class ProductRepository : IdentityRepository<Product>, IProductRepository
 {
     public ProductRepository(IDbContext dbContext) : base(dbContext) { }
 
-    public async Task<IEnumerable<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default)
     {
         return await GetManyByConditionAsync(p => !p.IsDeleted, token: cancellationToken);
     }
@@ -586,7 +586,7 @@ public class ProductService
         _productRepository = productRepository;
     }
 
-    public async Task<IEnumerable<Product>> SearchProductsAsync(string searchTerm, decimal? minPrice = null)
+    public async Task<IReadOnlyList<Product>> SearchProductsAsync(string searchTerm, decimal? minPrice = null)
     {
         return await _productRepository.GetManyByConditionAsync(p =>
             !p.IsDeleted &&

Original file line number	Diff line number	Diff line change
`@@ -271,8 +271,8 @@ public interface IGenericRepository<TEntity> where TEntity : class`
`271`	`271`	`Task CreateAsync(IEnumerable<TEntity> entities, CancellationToken cancellationToken = default);`
`272`	`272`
`273`	`273`	`// Read operations`
`274`		`- IEnumerable<TEntity> GetAll(bool ignoreQueryFilters = false, bool trackChanges = false);`
`275`		`- Task<IEnumerable<TEntity>> GetAllAsync(bool ignoreQueryFilters = false, bool trackChanges = false, CancellationToken token = default);`
	`274`	`+ IReadOnlyList<TEntity> GetAll(bool ignoreQueryFilters = false, bool trackChanges = false);`
	`275`	`+ Task<IReadOnlyList<TEntity>> GetAllAsync(bool ignoreQueryFilters = false, bool trackChanges = false, CancellationToken token = default);`
`276`	`276`
`277`	`277`	`// Update operations`
`278`	`278`	`void Update(TEntity entity);`
`@@ -436,7 +436,7 @@ public interface IUserRepository : IIdentityRepository<User>`
`436`	`436`
`437`	`437`	`public interface IProductRepository : IIdentityRepository<Product>`
`438`	`438`	`{`
`439`		`- Task<IEnumerable<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default);`
	`439`	`+ Task<IReadOnlyList<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default);`
`440`	`440`	`}`
`441`	`441`	```
`442`	`442`
`@@ -457,7 +457,7 @@ public class ProductRepository : IdentityRepository<Product>, IProductRepository`
`457`	`457`	`{`
`458`	`458`	`public ProductRepository(IDbContext dbContext) : base(dbContext) { }`
`459`	`459`
`460`		`- public async Task<IEnumerable<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default)`
	`460`	`+ public async Task<IReadOnlyList<Product>> GetActiveProductsAsync(CancellationToken cancellationToken = default)`
`461`	`461`	`{`
`462`	`462`	`return await GetManyByConditionAsync(p => !p.IsDeleted, token: cancellationToken);`
`463`	`463`	`}`
`@@ -586,7 +586,7 @@ public class ProductService`
`586`	`586`	`_productRepository = productRepository;`
`587`	`587`	`}`
`588`	`588`
`589`		`- public async Task<IEnumerable<Product>> SearchProductsAsync(string searchTerm, decimal? minPrice = null)`
	`589`	`+ public async Task<IReadOnlyList<Product>> SearchProductsAsync(string searchTerm, decimal? minPrice = null)`
`590`	`590`	`{`
`591`	`591`	`return await _productRepository.GetManyByConditionAsync(p =>`
`592`	`592`	`!p.IsDeleted &&`