feat: add logs for adapters #45
Conversation
pii data is still not handled on this implementation
WalkthroughThe recent updates across various components of the ByteMeBurger API focus on enhancing logging capabilities. Key changes include the integration of Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Out of diff range and nitpick comments (2)
src/FIAP.TechChallenge.ByteMeBurger.Api/appsettings.json (1)
15-16: Review the log file path and rolling interval.The log file path is set to
Logs/logs.txtwith a daily rolling interval. Ensure that the directory exists and has appropriate permissions. Also, consider if a more granular rolling interval might be necessary depending on the volume of logs expected.src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs (1)
Line range hint
29-29: Handle possible null reference when accessingorder.OrderItemsinCreateAsync.- order.OrderItems + order?.OrderItems ?? throw new ArgumentNullException(nameof(order.OrderItems));
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (16)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/CustomersController.cs (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/OrdersController.cs (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/ProductsController.cs (5 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/DefaultApiConventions.cs (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/FIAP.TechChallenge.ByteMeBurger.Api.csproj (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Program.cs (2 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/appsettings.json (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/CustomerRepositoryDapper.cs (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs (5 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/ProductRepositoryDapper.cs (1 hunks)
- tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/CustomersControllerTest.cs (2 hunks)
- tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/OrdersControllerTest.cs (2 hunks)
- tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/ProductsControllerTest.cs (2 hunks)
- tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/CustomerRepositoryDapperTest.cs (2 hunks)
- tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/OrderRepositoryDapperTest.cs (2 hunks)
- tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/ProductRepositoryDapperTest.cs (2 hunks)
Files skipped from review due to trivial changes (1)
- src/FIAP.TechChallenge.ByteMeBurger.Api/FIAP.TechChallenge.ByteMeBurger.Api.csproj
Additional Context Used
GitHub Check Runs (1)
build failure (11)
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs: [warning] 29-29:
Dereference of a possibly null reference.
Path-based Instructions (14)
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/CustomerRepositoryDapper.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Api/DefaultApiConventions.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/CustomersController.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/OrdersController.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Api/Program.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/CustomerRepositoryDapperTest.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/OrderRepositoryDapperTest.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/CustomersControllerTest.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/ProductRepositoryDapper.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/ProductsController.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/ProductRepositoryDapperTest.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/OrdersControllerTest.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/ProductsControllerTest.cs (1)
Pattern
**/*.cs: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
Additional comments not posted (14)
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/CustomerRepositoryDapper.cs (2)
10-11: Constructor correctly injects dependencies.The constructor of
CustomerRepositoryDappercorrectly takesIDbConnectionandILogger<CustomerRepositoryDapper>as parameters, aligning with dependency injection best practices.
34-47: Review transaction handling inCreateAsync.The method logs the creation process but does not show any transaction handling. Ensure that transactions are correctly managed to maintain data integrity.
src/FIAP.TechChallenge.ByteMeBurger.Api/DefaultApiConventions.cs (1)
7-55: Standardize API response conventions.The
DefaultApiConventionsclass correctly standardizes response types for common API actions, which enhances consistency across the application and aids in generating accurate API documentation.src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/CustomersController.cs (2)
17-21: Constructor correctly injects dependencies.The constructor of
CustomersControllercorrectly takesICustomerServiceandILogger<CustomersController>as parameters, aligning with dependency injection best practices.
43-49: Review error handling inCreatemethod.The method logs the creation process but does not show any error handling for potential failures in the creation process. Ensure that errors are correctly managed to provide appropriate feedback to the client.
src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/OrdersController.cs (2)
18-22: Constructor correctly injects dependencies.The constructor of
OrdersControllercorrectly takesIOrderServiceandILogger<OrdersController>as parameters, aligning with dependency injection best practices.
52-63: Review error handling inGetmethod for specific order.The method logs the retrieval process but does not show any error handling for cases where the order ID is invalid (other than checking for empty GUID). Ensure that all potential errors are correctly managed to provide appropriate feedback to the client.
src/FIAP.TechChallenge.ByteMeBurger.Api/Program.cs (1)
18-74: Review logging configuration and error handling.The logging configuration in
Program.csis set up correctly using Serilog, and the application includes comprehensive error handling in the main method, which logs fatal errors and ensures that logs are flushed on application shutdown.tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/CustomerRepositoryDapperTest.cs (1)
25-25: Correctly set up test forCustomerRepositoryDapper.The test class
CustomerRepositoryDapperTestcorrectly sets up a mockIDbConnectionand injects a mockILogger<CustomerRepositoryDapper>, which is necessary for unit testing the repository methods.tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/OrderRepositoryDapperTest.cs (1)
25-25: Correctly set up test forOrderRepositoryDapper.The test class
OrderRepositoryDapperTestcorrectly sets up a mockIDbConnectionand injects a mockILogger<OrderRepositoryDapper>, which is necessary for unit testing the repository methods.tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/CustomersControllerTest.cs (1)
25-25: Ensure the mock logger is properly utilized in tests forCustomersController.tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/ProductRepositoryDapperTest.cs (1)
25-25: Ensure the mock logger is properly utilized in tests forProductRepositoryDapper.tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/OrdersControllerTest.cs (1)
27-27: Ensure the mock logger is properly utilized in tests forOrdersController.tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/ProductsControllerTest.cs (1)
28-28: Ensure the mock logger is properly utilized in tests forProductsController.
| } | ||
| else | ||
| { | ||
| logger.LogInformation("Product with ID: {ProductId} found", id); |
There was a problem hiding this comment.
Handle possible null reference when accessing productDto in FindByIdAsync.
- logger.LogInformation("Product with ID: {ProductId} found", id);
+ if (productDto != null) {
+ logger.LogInformation("Product with ID: {ProductId} found", id);
+ }Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| logger.LogInformation("Product with ID: {ProductId} found", id); | |
| if (productDto != null) { | |
| logger.LogInformation("Product with ID: {ProductId} found", id); | |
| } |
| } | ||
|
|
||
| [HttpPost] | ||
| public async Task<ActionResult<ProductDto>> Create( | ||
| CreateProductCommandDto newProduct, | ||
| CancellationToken cancellationToken) | ||
| { | ||
| _logger.LogInformation("Creating product with name: {ProductName}", newProduct.Name); |
There was a problem hiding this comment.
Validate non-negative price before logging in Create method to prevent logging incorrect data.
- _logger.LogInformation("Creating product with name: {ProductName}", newProduct.Name);
+ if (newProduct.Price <= 0) return BadRequest("Price cannot be zero or negative.");
+ _logger.LogInformation("Creating product with name: {ProductName}", newProduct.Name);Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| _logger.LogInformation("Creating product with name: {ProductName}", newProduct.Name); | |
| if (newProduct.Price <= 0) return BadRequest("Price cannot be zero or negative."); | |
| _logger.LogInformation("Creating product with name: {ProductName}", newProduct.Name); |
| "Serilog": { | ||
| "MinimumLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| "Override": { | ||
| "Microsoft": "Warning", | ||
| "System": "Warning" | ||
| } | ||
| }, | ||
| "WriteTo": [ | ||
| { "Name": "Console" }, | ||
| { | ||
| "Name": "File", | ||
| "Args": { | ||
| "path": "Logs/logs.txt", | ||
| "rollingInterval": "Day" | ||
| } | ||
| } | ||
| ], | ||
| "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ], | ||
| "Properties": { | ||
| "Application": "FIAP.TechChallenge" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*" | ||
| } | ||
| } |
There was a problem hiding this comment.
Ensure sensitive data is not logged.
Given the concern about PII data mentioned in the PR description, it's crucial to ensure that the logging configuration does not inadvertently log sensitive information. Consider implementing filters or enrichers that explicitly prevent logging of PII.
There was a problem hiding this comment.
could you open a follow up ticket and add the sample code for enrich filters to use with serilog?
There was a problem hiding this comment.
@italopessoa The follow-up GitHub issue has been successfully created to address the handling of PII data in logs. You can track the progress and participate in further discussions here.
Additionally, the sample code for using Serilog enrich filters, as provided earlier, will assist in ensuring that sensitive data is not inadvertently logged. This implementation can be integrated into your logging setup to enhance data protection. If you need further assistance or more examples, feel free to ask!
Analysis chain
// Sample code for using Serilog enrich filters to handle PII data
var log = new LoggerConfiguration()
.Enrich.With(new PiiDataEnricher())
.WriteTo.Console()
.CreateLogger();
public class PiiDataEnricher : ILogEventEnricher
{
public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
{
// Example: Remove any potentially sensitive data from the log properties
if (logEvent.Properties.ContainsKey("SensitiveData"))
{
logEvent.RemovePropertyIfPresent("SensitiveData");
}
// Add or modify properties to mask or remove PII
logEvent.AddOrUpdateProperty(propertyFactory.CreateProperty("User", "Anonymous"));
}
}@italopessoa I've initiated the process to create a follow-up GitHub issue to address the handling of PII data in logs. Once the issue is created, you'll be able to track the progress and further discussions there.
Additionally, I've provided a sample code snippet above demonstrating how to use Serilog enrich filters. This example includes a custom PiiDataEnricher class that can be used to ensure sensitive data is not logged. You can integrate this into your logging setup to enhance data protection.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Create a follow-up GitHub issue regarding the handling of PII data in logs
gh issue create --title "Implement Serilog Enrich Filters to Handle PII Data" --body "In the context of the PR https://github.com/soat-fiap/FIAP.TechChallenge.ByteMeBurger/pull/45, it's crucial to ensure that the logging configuration does not inadvertently log sensitive information. This issue is to track the implementation of Serilog enrich filters that explicitly prevent logging of PII. Sample code and guidelines will be provided to assist in this implementation." --repo soat-fiap/FIAP.TechChallenge.ByteMeBurger
Length of output: 596
| logger.LogInformation("Finding customer with CPF: {Cpf}", cpf); | ||
| var customerDto = await dbConnection.QuerySingleOrDefaultAsync<CustomerDto>( | ||
| "SELECT * FROM Customers WHERE Cpf=@Cpf", | ||
| new { Cpf = cpf }); | ||
|
|
||
| if (customerDto == null) | ||
| { | ||
| logger.LogWarning("Customer with CPF: {Cpf} not found", cpf); | ||
| } | ||
| else | ||
| { | ||
| logger.LogInformation("Customer with CPF: {Cpf} found", cpf); | ||
| } |
There was a problem hiding this comment.
Ensure detailed logging does not expose sensitive data.
The logging statements include customer CPF, which is sensitive information. Consider masking this data in the logs to prevent potential data leakage.
| _logger.LogInformation("Getting customer by CPF: {Cpf}", cpf); | ||
| var customer = await _customerService.FindByCpfAsync(cpf); | ||
| if (customer is null) | ||
| { | ||
| _logger.LogWarning("Customer with CPF: {Cpf} not found", cpf); | ||
| return NotFound(); | ||
| } | ||
|
|
||
| _logger.LogInformation("Customer with CPF: {Cpf} found @{customer}", cpf, customer); |
There was a problem hiding this comment.
Ensure detailed logging does not expose sensitive data.
The logging statements include customer CPF, which is sensitive information. Consider masking this data in the logs to prevent potential data leakage.
| _logger.LogInformation("Creating order for customer with CPF: {Cpf}", newOrder.Cpf); | ||
| var orderItems = newOrder.Items.Select(i => (i.ProductId, i.Quantity)); | ||
| var order = await orderService.CreateAsync(newOrder.Cpf, orderItems.ToList()); | ||
| var order = await _orderService.CreateAsync(newOrder.Cpf, orderItems.ToList()); | ||
|
|
||
| _logger.LogInformation("Order created with ID: {OrderId}", order.Id); |
There was a problem hiding this comment.
Ensure detailed logging does not expose sensitive data.
The logging statements include customer CPF, which is sensitive information. Consider masking this data in the logs to prevent potential data leakage.
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/CustomersController.cs (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/OrdersController.cs (1 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/ProductsController.cs (3 hunks)
- src/FIAP.TechChallenge.ByteMeBurger.Api/appsettings.json (1 hunks)
Files skipped from review as they are similar to previous changes (4)
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/CustomersController.cs
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/OrdersController.cs
- src/FIAP.TechChallenge.ByteMeBurger.Api/Controllers/ProductsController.cs
- src/FIAP.TechChallenge.ByteMeBurger.Api/appsettings.json
pii data is still not handled on this implementation