Pinelab-studio / pinelab-vendure-plugins

Monorepo for different Vendure plugins developed by Pinelab
111 stars 49 forks source link

feat(metrics): Updates, fixes and Revenue metric #528

Closed martijnvdbrug closed 1 month ago

martijnvdbrug commented 1 month ago

1.4.0 (2024-10-31)

Screenshots

image

image

image

Checklist

📌 Always:

👍 Most of the time:

📦 For publishable packages:

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@martijnvdbrug has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 27 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 Reviewing files that changed from the base of the PR and between b533f85f5233dd6351f4fd7eb822d7b481e3ddff and f36afc2c97107106bfd984833a82c947f2dc9b6f.

Walkthrough

The pull request updates the vendure-plugin-metrics package, introducing new features such as revenue per variant metrics, tax-inclusive calculations, and a maximum cache age for metrics. It modifies existing metrics to enhance data representation and updates the caching mechanism to include entry creation timestamps. Additionally, it refines the AverageOrderValueMetric and SalesPerProductMetric classes, while replacing the latter with the new RevenuePerProduct class. The changes also include updates to the component styles and test suite adjustments to reflect the new metric functionalities.

Changes

File Path Change Summary
packages/vendure-plugin-metrics/CHANGELOG.md Updated to version 1.4.0; added revenue per variant metric, tax calculation options, sales-per-product formatting changes, and max cache age feature.
packages/vendure-plugin-metrics/src/api/cache.ts Added EntryDate interface; updated Cache class to include maxAgeInSeconds for cache expiration and modified set and get methods for cache handling.
packages/vendure-plugin-metrics/src/api/metrics/average-order-value.ts Simplified getTitle, changed pagination method, updated calculateDataPoints for clarity and tax inclusion.
packages/vendure-plugin-metrics/src/api/metrics/revenue-per-product.ts Introduced RevenuePerProduct class for calculating revenue metrics by product variant.
packages/vendure-plugin-metrics/src/api/metrics/sales-per-product.ts Changed metricType from Currency to Number; updated getTitle method.
packages/vendure-plugin-metrics/src/index.ts Removed export for sales-per-product, added export for revenue-per-product.
packages/vendure-plugin-metrics/src/metrics.plugin.ts Replaced SalesPerProductMetric with RevenuePerProduct in MetricsPlugin options.
packages/vendure-plugin-metrics/src/ui/chartist/chartist.component.scss Updated $ct-area-opacity from 0.5 to 0.2.
packages/vendure-plugin-metrics/src/ui/chartist/chartist.component.ts Added showArea property, updated event handling, modified animation parameters, and introduced a gradient for the chart.
packages/vendure-plugin-metrics/src/ui/metrics-widget.ts Added imports for ViewChild and ElementRef, modified template styles, and updated loadChartData method logic.
packages/vendure-plugin-metrics/test/metrics.spec.ts Enhanced test suite with new imports, updated assertions for metrics, and renamed variables for consistency.

Possibly related PRs


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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.