soat-fiap / FIAP.TechChallenge.ByteMeBurger

Repository for FIAP SOAT post degree Tech Challenge
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Refactor order domain model #107

Closed italopessoa closed 1 week ago

italopessoa commented 1 week ago

simplify order status

coderabbitai[bot] commented 1 week ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The updates mainly consist of enhancements and refactoring across multiple files and modules. Key changes include improved logging, updated order and payment status handling, better environment variable management, and new service registrations. Significant improvements were made in status synchronization between the application and payment gateways, along with refined entity status tracking. Test cases were also updated to reflect the modified business logic.

Changes

File/Path Summary
docker-compose.yml Added new environment variables for MercadoPago API configuration.
.../MercadoPagoMessageAuthorizationFilter.cs Enhanced logging of query parameters and request body information.
.../WebhookController.cs Added new imports, logging of MercadoPago events, and synchronization calls for payment status with the gateway.
.../OrderStatusDto.cs Renumbered enum values in OrderStatusDto.
.../Program.cs Enriched log context before reading configuration in the Main method.
.../ServiceCollectionsExtensions.cs Registered new service IUpdatePaymentStatusUseCase.
.../PaymentService.cs Added new dependencies and method for synchronizing payment status.
.../UpdateOrderStatusUseCase.cs Altered handling of order status, changed action associated with OrderStatus.InPreparation.
.../UseCases/Payment/IUpdatePaymentStatusUseCase.cs Introduced new interface IUpdatePaymentStatusUseCase.
.../UseCases/Payment/UpdatePaymentStatusUseCase.cs Added class UpdatePaymentStatusUseCase for updating payment status.
.../Base/Entity.cs Added Created and Updated properties to Entity class for timestamp tracking.
.../Entities/Order.cs Updated logic for initializing and transitioning order statuses.
.../Entities/Payment.cs Removed Created property from Payment class.
.../Interfaces/IPaymentGateway.cs Added new method GetPaymentStatusAsync to IPaymentGateway interface.
.../Interfaces/IPaymentRepository.cs Added method UpdatePaymentStatusAsync to IPaymentRepository interface.
.../Interfaces/IPaymentService.cs Added method SyncPaymentStatusWithGatewayAsync to IPaymentService.
.../Domain/ValueObjects/OrderStatus.cs Modified the values assigned to OrderStatus enum members.
.../MercadoPago.Gateway/MercadoPagoService.cs Added logging and new method GetPaymentStatusAsync for MercadoPagoService class.
.../MercadoPago.Gateway/Model/MercadoPagoWebhookEvent.cs Improved readability by splitting attribute lines within JSON property annotations.
.../Security/MercadoPagoHmacSignatureValidator.cs Adjusted the indentation of if statement within TryToValidate method.
.../Persistence/Constants.cs Revised UpdateOrderStatusQuery and added UpdatePaymentStatusQuery.
tests/.../OrderTests.cs Updated logic and method names in unit tests for order status transitions.

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.