formancehq / stack

Open Source Infrastructure for the Financial Internet
https://www.formance.com
Other
359 stars 50 forks source link

fix(ledger): prevent empty metadata #1737

Closed gfyrag closed 1 week ago

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request introduce several enhancements to command functionalities across various components, including the addition of aliases for commands and the implementation of confirmation flags for certain operations. Notably, idempotency keys are integrated into multiple wallet-related operations, improving error handling and ensuring unique identifiers for transactions. Documentation updates accompany these changes, reflecting the new fields and functionalities introduced.

Changes

File Path Change Summary
components/fctl/TODO.md Added a TODO comment suggesting the implementation of a feature for generating aliases for command names.
components/fctl/cmd/cloud/organizations/root.go Added "organization" as a new alias for the command.
components/fctl/cmd/payments/connectors/install/*.go Added a confirmation flag to various commands, requiring user confirmation before proceeding with installations.
components/fctl/cmd/profiles/root.go Added "profile" as a new alias for the profiles management command.
components/fctl/cmd/stack/create.go Introduced new error handling for region availability and HTTP response status checks.
components/fctl/cmd/wallets/create.go Enhanced wallet creation functionality by introducing an idempotency key.
components/fctl/cmd/wallets/credit.go Added an idempotency key to the credit wallet functionality.
components/fctl/cmd/wallets/debit.go Included an idempotency key in the debit wallet functionality.
components/ledger/Earthfile Updated the version of the mockgen package to v0.4.0.
components/ledger/internal/api/v1/controllers_accounts.go Added a check for empty metadata in the postAccountMetadata function, responding with NoContent if empty.
components/ledger/internal/api/v2/controllers_accounts.go Similar check for empty metadata added in the postAccountMetadata function.
components/ledger/internal/api/v2/controllers_bulk.go Updated context handling in the bulkHandler function.
components/operator/Earthfile Introduced a new target for generating mocks and updated deployment arguments.
components/payments/cmd/api/internal/storage/balances.go Modified SQL query for balance retrieval to sort by created_at instead of last_updated_at.
ee/wallets/pkg/api/handler_holds_confirm.go Updated confirmHoldHandler to include an idempotency key in the call to ConfirmHold.
ee/wallets/pkg/api/handler_wallets_create_test.go Updated test function signatures to include an idempotency key.
releases/sdks/go/docs/pkg/models/operations/*.md Added IdempotencyKey field to various request models, enhancing documentation for wallet operations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Command
    participant Confirmation
    participant Wallet

    User->>Command: Invoke Command with Parameters
    Command->>Confirmation: Request Confirmation
    Confirmation-->>User: Confirm Action
    User->>Command: Confirm
    Command->>Wallet: Process Wallet Operation
    Wallet-->>Command: Return Result
    Command-->>User: Return Operation Result

Possibly related PRs

Suggested labels

components/ledger, ee/reconciliation, ee/wallets

Suggested reviewers

Poem

🐰 In the land of code where rabbits play,
New aliases bloom, brightening the day.
With confirmations in hand, we hop with glee,
Idempotency keys, as sweet as can be!
So let us celebrate, with carrots in tow,
For every change made helps our garden grow! 🌼


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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.