[WEB-1980] feat: user recent visited entities

[NarayanBavisetti]

Issue Link: WEB-1980

• New Features

  • Enhanced tracking of user interactions across various entities, including cycles, issues, modules, pages, and projects. Users' recent visits are now recorded asynchronously to improve analytics.

• Bug Fixes

  • Addressed minor formatting issues in import statements for improved code clarity.

• Chores

  • Added new background task functionality to manage user visit records, ensuring efficient data handling and maintaining a cap on stored records.

[coderabbitai[bot]]

Walkthrough

The recent updates enhance user interaction tracking across various views in the application. By introducing asynchronous task calls to the recent_visited_task.delay function, the system now logs user visits to cycles, issues, modules, pages, and projects. This improvement allows for better analytics and insights into user behavior, significantly enriching the user experience and enabling data management.

Changes

Files	Change Summary
apiserver/plane/app/views/cycle/base.py	Added asynchronous logging of user visits to cycles in the retrieve method.
apiserver/plane/app/views/issue/base.py	Integrated user visit logging in get, list, and retrieve methods for issues.
apiserver/plane/app/views/module/base.py	Enhanced retrieve method to log user visits for modules.
apiserver/plane/app/views/page/base.py	Updated retrieve method to track visits to pages.
apiserver/plane/app/views/project/base.py	Added logging of user visits in the retrieve method for projects.
apiserver/plane/app/views/view/base.py	Introduced two retrieve methods to log user interactions more specifically, including one with project_id.
apiserver/plane/bgtasks/recent_visited_task.py	New file created with a Celery task to manage user recent visit records.
apiserver/plane/db/models/__init__.py	Minor formatting change in import statements; no functional alterations made.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant TaskQueue
    participant Database

    User->>API: Request to view a cycle/issue/module/page/project
    API->>Database: Retrieve entity data
    Database-->>API: Return entity information
    API->>TaskQueue: recent_visited_task.delay(...)
    TaskQueue->>Database: Log user visit
    Database-->>TaskQueue: Confirm visit logged
    TaskQueue-->>API: Acknowledge logging
    API-->>User: Return entity data

🐇 Hop along, oh code so bright,
With logs of visits, what a sight!
Each click and scroll, a tale to tell,
Enhancing user joy, oh so well!
Adventures tracked in the digital glade,
Let's celebrate this charming upgrade!
🐇

---

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.
  • @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 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.