search

ballerine-io / ballerine

Open-source infrastructure and data orchestration platform for risk decisioning
https://www.ballerine.com
Other
2.06k stars 189 forks source link

Feature/implement risk rule ( WIP ) BAL-2445 #2528

Open Blokh opened 3 months ago

Blokh commented 3 months ago

BAL-2445

Summary by CodeRabbit

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 1d56a23be0d57a285d32dbc41e5231266d444508

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates significantly enhance the risk management capabilities of the workflow service by expanding the data model with new fields, enums, and models for risk and rule processing. New services, repositories, and controllers provide comprehensive management functionality, while validation schemas ensure structured handling of operations. This structured approach promotes a robust, organized framework for managing compliance and risk assessment within the application.

Changes

File(s) Change Summary
prisma/schema.prisma, prisma/migrations/.../migration.sql Introduced new fields, enums, and models for risk management, including RiskRulesPolicy, RiskRule, and RuleSet. Updated existing models and executed migrations.
src/risk-rules/risk-rule-policy/... Added RiskRulePolicyModule, RiskRulePolicyService, and RiskRulePolicyRepository for managing risk rule policies.
src/risk-rules/risk-rule/... Created RiskRuleModule, RiskRuleService, RiskRuleRepository, and RiskRuleController for managing risk rules.
src/risk-rules/rule-set/... Developed RuleSetModule, RuleSetService, and RuleSetRepository for handling rule sets.
src/rule-engine/core/rule-engine.ts Enhanced runRuleSet and RuleEngine to support RuleSetWithChildren for nested rule processing.
src/rule-engine/risk-rule.service.ts, src/rule-engine/rule-engine.module.ts Updated findAll method for project-specific filtering and integrated RiskRulePolicyModule for expanded functionality.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RiskRulePolicyController
    participant RiskRulePolicyService
    participant RiskRulePolicyRepository
    participant Database

    Client->>+RiskRulePolicyController: Create Policy Request
    RiskRulePolicyController->>+RiskRulePolicyService: Call createRiskRulePolicy
    RiskRulePolicyService->>+RiskRulePolicyRepository: Persist new policy
    RiskRulePolicyRepository->>+Database: Insert policy record
    Database-->>-RiskRulePolicyRepository: Policy record ID
    RiskRulePolicyRepository-->>-RiskRulePolicyService: Policy record ID
    RiskRulePolicyService-->>-RiskRulePolicyController: Policy record ID
    RiskRulePolicyController-->>-Client: Response with Policy ID

    Client->>+RiskRulePolicyController: Add Risk Rule to Policy Request
    RiskRulePolicyController->>+RiskRulePolicyService: Call addRiskRuleToPolicy
    RiskRulePolicyService->>+RiskRulePolicyRepository: Associate risk rule
    RiskRulePolicyRepository->>+Database: Update policy with risk rule
    Database-->>-RiskRulePolicyRepository: Update confirmation
    RiskRulePolicyRepository-->>-RiskRulePolicyService: Association confirmation
    RiskRulePolicyService-->>-RiskRulePolicyController: Association confirmation
    RiskRulePolicyController-->>-Client: Response with association confirmation

Poem

In a garden of rules, new blooms arise,
With risks dancing 'neath the digital skies.
Policies sprout, and schemas align,
In this code-rich world, all things intertwine.
Rabbits hop through logic so bright,
Celebrating changes that feel just right!
🐰💻✨

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 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](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.