search

ballerine-io / ballerine

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

bal 2254 rule engine v2 #2470

Closed liorzam closed 2 weeks ago

liorzam commented 2 weeks ago
image

Summary by CodeRabbit

changeset-bot[bot] commented 2 weeks ago

⚠️ No Changeset found

Latest commit: dc70519aaaa6f3b926b5e725ae18ae32b52087d9

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 2 weeks ago

Walkthrough

The changes enhance the rule engine within the workflows-service by introducing extensive new functionality and structure. Key modifications include the integration of the RuleEngineModule into the application's core module, the creation of custom error classes, and the development of various helper classes, schemas, enums, and type definitions. Together, these additions facilitate improved rule validation and error handling, laying a robust foundation for complex rule-based operations.

Changes

Files Change Summary
services/.../src/app.module.ts Imported and included RuleEngineModule for initialization.
services/.../src/rule-engine/core/errors.ts Introduced custom error classes: OperationNotFoundError, DataValueNotFoundError, MissingKeyError, and ValidationFailedError. Added EngineErrors type for handling specific errors.
services/.../src/rule-engine/core/operators/constants.ts Added operationHelpers object mapping operations to helper functions.
services/.../src/rule-engine/core/operators/enums.ts Introduced constants for operations and operators in the rule engine.
services/.../src/rule-engine/core/operators/helpers.ts Defined various comparison operator classes extending BaseOperator, including Equals, GreaterThan, LessThan, and others.
services/.../src/rule-engine/core/operators/schemas.ts Introduced schemas for different operations, such as PrimitiveSchema, BetweenSchema, LastYearsSchema, and ruleSchema.
services/.../src/rule-engine/core/operators/types.ts Added type definitions for operators, like primitive, BetweenParams, and LastYearsParams, and detailed condition function types and mappings.
services/.../src/rule-engine/core/rule-engine.ts Introduced functions validateRule and validateRuleSet for validating rules and rule sets.
services/.../src/rule-engine/core/rule-engine.unit.test.ts Added tests for validating rule sets using mock data, covering different rules and expected outcomes.
services/.../src/rule-engine/core/types.ts Introduced type definitions for operations, rules, rule sets, and validation results, such as TOperation, TOperator, Rule, and RuleSet.
services/.../src/rule-engine/rule-engine.module.ts Created RuleEngineModule for providing and exporting RuleEngineService and RuleStoreService.
services/.../src/rule-engine/rule-store.service.ts Added RuleStoreService class with a method findAll to retrieve RuleSet based on given parameters.

Poem

In the world of code, a rabbit hops,
Bringing rules and constants to the crops.
With errors caught and schemas clear,
The logic flows without a fear.
Operators dance, comparisons cheer,
The rule engine's power now holds dear.
So code and dream, my friend, let's gear!

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.