Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PE-248] refactor: recents widget for scalability #6453

Merged
merged 2 commits into from
Jan 24, 2025

Conversation

aaryan610
Copy link
Collaborator

@aaryan610 aaryan610 commented Jan 24, 2025

Description

This PR refactors the recents widgets component for scalability.

Type of Change

  • Code refactoring

Summary by CodeRabbit

  • New Features

    • Enhanced recent activity widget with new "workspace page" filter option.
    • Added support for preset filters and optional filter selection UI.
  • Improvements

    • Updated type definitions to support workspace page activities.
    • Refined URL navigation and page link generation in recent activities component.
    • Improved component flexibility and type safety.

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a new "workspace_page" type to the recent activity system across multiple files. The changes extend type definitions in home.d.ts to include the new activity type, update the RecentActivityWidget component to support the new filter, and modify the RecentPage component to handle workspace page activities. These modifications enhance the flexibility of the recent activities feature by adding support for workspace page-related entries.

Changes

File Change Summary
packages/types/src/home.d.ts Added "workspace_page" to TRecentActivityFilterKeys and TActivityEntityData type definitions
web/core/components/home/widgets/recents/index.tsx Updated component props, added TRecentWidgetProps, modified filters and rendering logic
web/core/components/home/widgets/recents/page.tsx Added new imports, improved page link generation and navigation logic

Possibly related PRs

Suggested labels

🧹chore, 🌟improvement, pages

Suggested reviewers

  • SatishGandham
  • sriramveeraghanta
  • rahulramesha

Poem

🐰 A rabbit's tale of types so bright,
Workspace pages now in sight!
Types expand with graceful ease,
New filters dance with playful breeze
Code evolves, our rabbit cheers! 🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6a2e499 and 275a966.

📒 Files selected for processing (1)
  • web/core/components/home/widgets/recents/index.tsx (4 hunks)

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
🪧 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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
packages/types/src/home.d.ts (1)

4-4: Consider renaming "all item" for clarity.
Using "all item" as a filter key is potentially confusing and inconsistent with the other keys. Consider using something like "all" or "all_items" to make the intent clearer.

web/core/components/home/widgets/recents/index.tsx (1)

26-29: Use a distinct icon if needed for clarity.
Since "workspace_page" and "page" currently share the same icon, consider providing a unique icon if they differ semantically or visually. This helps users distinguish at a glance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b53912 and 6a2e499.

📒 Files selected for processing (3)
  • packages/types/src/home.d.ts (2 hunks)
  • web/core/components/home/widgets/recents/index.tsx (4 hunks)
  • web/core/components/home/widgets/recents/page.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (2)
packages/types/src/home.d.ts (1)

42-42: Addition of "workspace_page" looks good.
This addition is consistent with the PR objective of supporting workspace pages in the recent activity system.

web/core/components/home/widgets/recents/index.tsx (1)

32-35: Prop extension approach is well done.
Defining TRecentWidgetProps to extend THomeWidgetProps with optional properties presetFilter and showFilterSelect is a neat, flexible design.

Comment on lines +29 to +33
const pageDetails = activity.entity_data as TPageEntityData;
const ownerDetails = getUserDetails(pageDetails?.owned_by);
const pageLink = pageDetails.project_id
? `/${workspaceSlug}/projects/${pageDetails.project_id}/pages/${pageDetails.id}`
: `/${workspaceSlug}/pages/${pageDetails.id}`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Unsafe type casting confirmed for workspace pages
The TPageEntityData type incorrectly requires project_id and project_identifier fields, but workspace pages in the backend don't have project associations. This forced casting will cause runtime errors.

  • packages/types/src/home.d.ts: Update TPageEntityData to make project fields optional
  • web/core/components/home/widgets/recents/page.tsx: Add type guard before casting to TPageEntityData
🔗 Analysis chain

Confirm handling of workspace_page data.
When entity_name is "workspace_page", verify that the entity_data still conforms to TPageEntityData (e.g., having project_id, etc.). Otherwise, this forced casting may cause runtime issues.

Use this script to scan the codebase for "workspace_page" references, checking whether the entity data structure is consistent:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Look for workflow around "workspace_page" usage to ensure it always contains page fields
rg -A 5 '"workspace_page"'

Length of output: 2869


Script:

#!/bin/bash
# Look for TPageEntityData type definition and usage
ast-grep --pattern 'type TPageEntityData = {
  $$$
}'

# Also search for any references to this type
rg "TPageEntityData"

Length of output: 889


Script:

#!/bin/bash
# Look for workspace page API handling and data structure
rg -A 5 "workspace_page.*data" --type ts
rg -A 5 "workspace_page.*response" --type ts

# Also check Python API implementation
rg -A 10 "workspace_page" --type py

Length of output: 7380

@pushya22 pushya22 merged commit c429ca7 into preview Jan 24, 2025
4 of 5 checks passed
@pushya22 pushya22 deleted the refactor/recents-widgets branch January 24, 2025 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants