search

ballerine-io / ballerine

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

Connect statistics to DB #2561

Closed MatanYadaev closed 1 month ago

MatanYadaev commented 1 month ago

Summary by CodeRabbit

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: 529702f9ca7e8f54e66f31de9fd0d21c8da55ffc

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 1 month ago

Walkthrough

The recent changes enhance the Statistics feature by implementing a structured approach to data management and UI rendering. Key updates include the integration of custom hooks for data fetching, improved type safety through Zod schemas, and conditional loading states. These modifications create a more responsive and user-friendly experience, facilitating better visualization and analysis of risk statistics while ensuring clarity and maintainability.

Changes

Files Change Summary
apps/backoffice-v2/src/pages/Statistics/Statistics.page.tsx Enhanced the Statistics component by integrating useHomeMetricsQuery for data fetching, introducing a loading state and conditional rendering to improve user experience.
apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/PortfolioRiskStatistics.tsx Updated to accept riskIndicators and reports props, improving functionality and clarity in data handling and UI rendering.
apps/backoffice-v2/src/pages/Statistics/components/PortfolioRiskStatistics/hooks/usePortfolioRiskStatisticsLogic/usePortfolioRiskStatisticsLogic.tsx Refactored to accept typed parameters, optimize sorting logic, and improve performance with useMemo, streamlining risk indicator calculations.
apps/backoffice-v2/src/domains/metrics/hooks/queries/useHomeMetricsQuery/useHomeMetricsQuery.ts Introduced a new custom hook for fetching home metrics data with schema validation using Zod, enhancing error handling and data structure integrity.
services/workflows-service/src/metrics/metrics.controller.ts Added a new endpoint getHomeMetrics to retrieve metrics based on the current project ID, improving API capabilities and data validation.
services/workflows-service/src/metrics/repository/metrics.repository.ts Introduced methods for retrieving risk indicators and reports categorized by risk levels, enhancing data analysis capabilities within the repository.
services/workflows-service/src/metrics/schemas/home-metrics.schema.ts Established new schemas for structured data validation related to home metrics, improving the robustness of data handling.
services/workflows-service/src/metrics/service/metrics.service.ts Added getHomeMetrics method to aggregate metrics related to risk indicators and reports, enhancing service functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StatisticsPage
    participant HomeMetricsQuery
    participant PortfolioRiskStatistics

    User->>StatisticsPage: Request statistics
    StatisticsPage->>HomeMetricsQuery: Fetch home metrics
    HomeMetricsQuery->>API: Request metrics from API
    API-->>HomeMetricsQuery: Return metrics data
    HomeMetricsQuery-->>StatisticsPage: Return fetched data
    StatisticsPage->>PortfolioRiskStatistics: Render with metrics
    PortfolioRiskStatistics-->>StatisticsPage: Display metrics

🐰 Hopping through the fields so bright,
New stats and figures bring delight!
With data fetching smooth and clear,
Our risks are tamed, let’s give a cheer!
In lines of code, our joy unfolds,
A tale of stats, forever told! 🌟

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.