search

ballerine-io / ballerine

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

feature/ruleset_plugin - Design review - (WIP) #2459

Closed Blokh closed 2 months ago

Blokh commented 3 months ago

Snippet code for workflow ruleset

Summary by CodeRabbit

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 3864379751260ad52a160209a8b7b71517a8fe84

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 primarily introduce new functionalities, dependencies, and module integrations across the rules-engine and workflow-core packages. This includes adding new types, constants, and helper functions for rule evaluation, refactoring existing exports, and developing services that interact with external APIs like Notion. Additionally, improvements include structuring risk calculations and integrating a new Notion module for data retrieval and validation within the workflows-service.

Changes

File/Path Change Summary
packages/rules-engine/package.json Added dependencies @types/jmespath, safe-eval, and @types/lodash.get; updated versions of existing dependencies.
packages/rules-engine/src/index.ts Refactored export to use createRuleEngine from lib/index and restructured type exports.
packages/rules-engine/src/lib/custom-rule-engine/consts/default-context-paths.ts Introduced DefaultContextPath constant.
packages/rules-engine/src/lib/custom-rule-engine/helpers/cast-compare-value.ts Added castCompareWithEval function for handling and evaluating values with special handling for JavaScript expressions.
packages/rules-engine/src/lib/custom-rule-engine/helpers/cast-value.ts Introduced castValue function to convert strings based on specified casting options.
packages/rules-engine/src/lib/custom-rule-engine/index.ts Added custom rule engine logic, including invokeRule function to evaluate rules.
packages/rules-engine/src/lib/custom-rule-engine/operations/evaluate.ts Introduced evaluate function for custom rule evaluation.
packages/rules-engine/src/lib/custom-rule-engine/operations/ubo-has-warning.ts Added uboHasWarning function to check warnings in context fields.
packages/rules-engine/src/lib/custom-rule-engine/types/custom-rule-input/index.ts Defined CustomRuleInput type specifying rule input characteristics.
packages/rules-engine/src/lib/custom-rule-engine/types/custom-rule-set/index.ts Introduced CustomRuleSet type defining rule set structure with operator and rules fields.
packages/rules-engine/src/lib/custom-rule-engine/types/custom-rule/index.ts Added CustomRule interface for rule evaluation function signature.
packages/rules-engine/src/lib/index.ts Introduced createRuleEngine, dynamically creating rule engines based on provider type.
packages/rules-engine/src/lib/jmespath-rule-engine/index.ts Introduced JMESPathRuleEngine for evaluating JMESPath rules against context objects.
packages/rules-engine/src/lib/custom-rule-engine/consts/custom-rule-cast-options.ts Added CustomRuleCastOptions constant with predefined casting options.
packages/rules-engine/src/lib/custom-rule-engine/consts/custom-rule-operations.ts Introduced CustomRuleOperations with various rule operation strings.
packages/rules-engine/src/lib/custom-rule-engine/consts/custom-rule-type.ts Added CustomRulesTypes constant with values 'evaluate' and 'uboHasWarning'.
packages/workflow-core/src/index.ts Exported RiskCalculationInput type.
packages/workflow-core/src/lib/index.ts Exported RiskCalculationInput type from types module.
packages/workflow-core/src/lib/types.ts Reordered imports, added TNotionTableRiskCalculation type, and included in RiskCalculationInput definition.
packages/workflow-core/src/lib/workflow-runner.ts Renamed Error enum to ErrorEnum, added invokeRiskCalculation method to ChildCallabackable interface.
services/workflows-service/package.json Updated and added dependencies, including @ballerine/rules-engine-lib, @notionhq/client, and string-ts.
services/workflows-service/src/integrations/notion/notion.module.ts Introduced NotionService class for interaction with the Notion API.
services/workflows-service/src/integrations/notion/notion.service.ts Added NotionModule for NestJS module configuration.
services/workflows-service/src/workflow/helpers/format-rule-violations.ts Introduced formatRuleViolations function for processing and formatting rule violations.
services/workflows-service/src/workflow/schemas/ruleset-input-schema.ts Defined schema for custom rule violations and risk score options.
services/workflows-service/src/workflow/types/rule-set-with-violation.ts Added RuleSetWithViolation type extending rule set group with additional properties.
services/workflows-service/src/workflow/types/ruleset-group.ts Defined TCustomRulesetGroup and TRulesetGroup types for rule set structures.
services/workflows-service/src/workflow/workflow.module.ts Imported NotionModule in @Module decorator.
services/workflows-service/src/workflow/workflow.service.ts Added risk calculation logic and integrated NotionService, formatRuleViolations, and createRuleEngine.

Sequence Diagram(s)

sequenceDiagram
    participant Service as WorkflowService
    participant Notion as NotionService
    participant Rules as createRuleEngine
    participant NotionAPI as Notion API

    Service->>Notion: getAllDatabaseRecordsValues(databaseId, schema)
    Notion->>NotionAPI: Request database records
    NotionAPI-->>Notion: Return records
    Notion->>Service: Transform and return values

    Service->>Rules: createRuleEngine(rules)
    Rules-->>Service: Return rule engine instance

    Service->>Service: invokeRiskCalculation()
    Service->>Service: process rule violations

Poem

In the code of day and night, 🌙
Rules were crafted, shining bright, ✨
With engines new and updates fine, 🔧
Risks calculated, through the line.
Notion's wisdom brought on board, 📚
To ensure rules scored and stored.
Let the workflows smoothly flow, 🌊
Into the future, let us go! 🚀

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.