feat: admin activation metrics

[ephraimduncan]

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
prd-app	🔄 Building (Inspect)	Visit Preview		May 21, 2024 11:00pm
stg-app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 11:00pm
stg-docs	🛑 Canceled (Inspect)			May 21, 2024 11:00pm
stg-marketing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 11:00pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
prd-marketing	⬜️ Ignored (Inspect)			May 21, 2024 11:00pm

[coderabbitai]

Important

Review Skipped

Auto reviews are limited to the following labels: coderabbit. Please add one of these labels to enable auto reviews.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update enhances the admin stats page by introducing new components and functions for in-depth user statistics and document interaction analysis. It focuses on better data fetching, visualization through charts, and a more intuitive layout. Notably, two new chart components provide insights into monthly user growth and document activities, leveraging the Recharts library for visual representation. Additionally, backend enhancements support these frontend improvements, and a new CSS variable adds to the theme's versatility.

Changes

File(s)	Summary
apps/web/.../admin/stats/page.tsx	Enhanced user statistics calculations, introduced new chart components, updated data fetching and rendering, improved user and document metrics visualization, and refined the layout and presentation of the admin stats page.
apps/web/.../admin/stats/user-with-document-cummulative.tsx	Added UserWithDocumentCummulativeChart component for displaying cumulative user statistics related to document activities over time using the Recharts library.
apps/web/.../admin/stats/user-with-document.tsx	Introduced UserWithDocumentChart component to show monthly growth in user activity with documents, including total user counts and statuses of documents.
packages/lib/server-only/admin/get-users-stats.ts	Enhanced backend with new functions for user and document activity statistics, added new types for monthly growth data, and updated imports to support these changes.
packages/ui/styles/theme.css	Added a new CSS variable --gold to both light and dark themes for enhanced styling flexibility.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

🚨 @dephraiim has 5 pull requests awaiting review. Please consider reviewing them when possible. 🚨

[github-actions]

🚨 @ephraimduncan has 5 pull requests awaiting review. Please consider reviewing them when possible. 🚨

[coderabbitai]

Actionable comments posted: 3

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between fc70f78 and 32348dd.

Files selected for processing (5)

• apps/web/src/app/(dashboard)/admin/stats/page.tsx (4 hunks)
• apps/web/src/app/(dashboard)/admin/stats/user-with-document-cummulative.tsx (1 hunks)
• apps/web/src/app/(dashboard)/admin/stats/user-with-document.tsx (1 hunks)
• packages/lib/server-only/admin/get-users-stats.ts (2 hunks)
• packages/ui/styles/theme.css (2 hunks)

Additional comments not posted (8)

apps/web/src/app/(dashboard)/admin/stats/user-with-document.tsx (1)

14-20: Consider using map directly on data without reversing it first.

Reversing the data array before mapping over it might not be necessary if the chart library or the chart itself can handle the order of data points. If the reverse order is required for visual representation, consider if this can be achieved through chart configuration options instead.

apps/web/src/app/(dashboard)/admin/stats/user-with-document-cummulative.tsx (2)

17-25: Ensure consistent date formatting and data handling.

The approach to formatting dates and handling data is consistent with the previous file. However, consider centralizing this logic if similar patterns are used across multiple components to improve maintainability and reduce code duplication.

---

31-31: Clarify chart title for cumulative data.

The title "Total Activity (Cummulative)" could be more descriptive to clearly indicate what the cumulative metric represents. Consider specifying whether it's cumulative over time, users, documents, etc., to provide clearer context to the administrators.

packages/lib/server-only/admin/get-users-stats.ts (2)

22-33: Optimize database query for fetching monthly document statistics.

The current implementation fetches the count of users with at least one document in the past month. Consider optimizing the query to account for scalability and performance, especially with a growing dataset. Utilizing indexed fields and possibly caching results could improve performance.

---

69-89: Validate date formatting and aggregation logic.

The SQL query for getUserWithSignedDocumentMonthlyGrowth uses complex window functions and date truncation. Verify the correctness of the date formatting and aggregation logic, especially the cumulative counts, to ensure accurate statistics are generated.

packages/ui/styles/theme.css (1)

48-48: Validate the usage of the new --gold CSS variable.

Ensure that the new --gold CSS variable is used consistently across the admin stats page and that it aligns with the overall design system of the application. Consider documenting its intended use cases to maintain design consistency.

apps/web/src/app/(dashboard)/admin/stats/page.tsx (2)

17-45: Ensure efficient data fetching and error handling.

The parallel data fetching with Promise.all is efficient, but ensure that error handling is implemented for each asynchronous operation. Consider using try...catch blocks or chaining .catch() to handle potential errors gracefully and provide feedback to the administrator.

---

110-112: Verify data passed to chart components.

Confirm that the MONTHLY_USERS_SIGNED data passed to both UserWithDocumentChart and UserWithDocumentCummulativeChart components is correctly formatted and contains the expected data structure for accurate chart rendering.

[ElTimuro]

renamed for clarity