search

ballerine-io / ballerine

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

Dispatch Event Plugin #2425

Closed tomer-shvadron closed 4 months ago

tomer-shvadron commented 4 months ago

Summary by CodeRabbit

changeset-bot[bot] commented 4 months ago

⚠️ No Changeset found

Latest commit: 04d9e3847d46b26dfc0a6f2929d5e6ddf3d3d625

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 4 months ago

[!WARNING]

Rate limit exceeded

@tomer-shvadron has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 32 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between adb7e32721d2ccf08ff070ea3a25f32737659a6b and 04d9e3847d46b26dfc0a6f2929d5e6ddf3d3d625.

Walkthrough

This update primarily focuses on version bumps and dependency updates across multiple packages and applications within the @ballerine ecosystem. Notably, @ballerine/workflow-browser-sdk and @ballerine/workflow-node-sdk have been incremented to version 0.6.11. Additionally, new features and refinements have been introduced in the workflow-core package, including the addition of DispatchEventPlugin and improvements to event handling and subscription mechanisms.

Changes

Files/Directories Change Summary
apps/backoffice-v2/CHANGELOG.md, apps/kyb-app/CHANGELOG.md, examples/headless-example/CHANGELOG.md Updated changelog entries for version increments and dependency updates.
apps/backoffice-v2/package.json, apps/kyb-app/package.json, examples/headless-example/package.json Incremented versions and updated dependencies to @ballerine/workflow-browser-sdk and @ballerine/workflow-node-sdk to 0.6.11.
packages/workflow-core/CHANGELOG.md, packages/workflow-core/package.json Version bump to 0.6.11 with no functional changes.
packages/workflow-core/src/index.ts, packages/workflow-core/src/lib/index.ts, packages/workflow-core/src/lib/plugins/external-plugin/index.ts Added exports for WorkflowEvents and DispatchEventPlugin.
packages/workflow-core/src/lib/plugins/external-plugin/api-plugin.test.ts Converted createWorkflowRunner to an arrow function and added displayName to apiPluginsSchemas.
packages/workflow-core/src/lib/plugins/external-plugin/dispatch-event-plugin.ts Introduced DispatchEventPlugin class with methods for event handling and transformation.
packages/workflow-core/src/lib/plugins/external-plugin/types.ts Added and modified types and interfaces related to plugins and event handling.
packages/workflow-core/src/lib/utils/deep-merge-with-options.ts Refactored array merging logic and improved type declarations.
packages/workflow-core/src/lib/workflow-runner.test.ts, packages/workflow-core/src/lib/workflow-runner.test.unit.ts Updated tests to reflect changes in event handling and subscription mechanisms.
packages/workflow-core/src/lib/workflow-runner.ts Enhanced WorkflowRunner class with new methods for event dispatching and subscription management.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant WorkflowRunner
    participant DispatchEventPlugin
    participant Transformer

    Client->>WorkflowRunner: initiateWorkflow()
    WorkflowRunner->>DispatchEventPlugin: initiateDispatchEventPlugins()
    DispatchEventPlugin->>Transformer: transformData()
    Transformer-->>DispatchEventPlugin: transformedData
    DispatchEventPlugin-->>WorkflowRunner: dispatchEvent()
    WorkflowRunner-->>Client: workflowInitiated()

Poem

In the code's deep warren, where changes flow, A rabbit hops with joy, in the know. Version bumps and plugins new, Events transformed, a brighter hue. Dependencies aligned, all systems go, In Ballerine's garden, progress does 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 .` - `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.