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-147] chore: merge two separate page info popovers into one #6289

Merged
merged 2 commits into from
Dec 31, 2024

Conversation

aaryan610
Copy link
Collaborator

@aaryan610 aaryan610 commented Dec 30, 2024

Description

This PR merges the two separate info popovers, one with the details of users who created and last edited the page and the other with information like character, word count, etc., into one.

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

Media

image

Summary by CodeRabbit

  • New Features

    • Enhanced page information popover with detailed editor and creator details.
    • Added user profile links and avatars in page information display.
  • Refactor

    • Simplified component structure in edit information popover.
    • Updated page header extra options to pass additional page context.
  • UI Changes

    • Improved layout for document information cards.
    • Streamlined page information presentation.

Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to page-related components, focusing on simplifying and restructuring user information display. The changes primarily affect the PageEditInformationPopover and PageInfoPopover components, removing some user detail retrieval logic while adding more comprehensive page and user information display capabilities. The modifications streamline the components' structure and enhance the way page metadata is presented.

Changes

File Change Summary
web/core/components/pages/dropdowns/edit-information-popover.tsx Removed user detail retrieval logic, simplified imports, and eliminated UI elements displaying editor and creator information.
web/core/components/pages/editor/header/extra-options.tsx Added page prop to PageInfoPopover component.
web/core/components/pages/editor/header/info-popover.tsx Added new page prop, implemented user profile links, and enhanced information display with avatar and user details.

Possibly related PRs

Suggested reviewers

  • SatishGandham
  • rahulramesha

Poem

🐰 In the meadow of code, changes bloom bright,
Popovers sprout with new user insight.
Links to profiles, avatars in play,
A simpler path in the digital fray.
With each line refined, our work takes flight,
A rabbit's joy in the coding night! 🌟


📜 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 7dda6bb and 1fccb54.

📒 Files selected for processing (1)
  • web/core/components/pages/editor/header/extra-options.tsx (1 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: 0

🧹 Nitpick comments (3)
web/core/components/pages/dropdowns/edit-information-popover.tsx (1)

15-15: Consider a fallback message for missing timestamps.
If page.updated_at is empty or undefined, the expression calculateTimeAgoShort(page.updated_at ?? "") may result in an unclear time display (e.g., "Edited ago"). Consider a clearer fallback, such as "Just now" or similar.

web/core/components/pages/editor/header/info-popover.tsx (2)

37-41: User details resolution.
getUserDetails usage is neat and straightforward. Consider a fallback scenario (e.g., displaying "User not found") if a user lookup fails.


94-131: Enhanced user identification sections.
Providing detailed "Edited by" and "Created by" sections with clickable user avatars is a great addition for transparency and collaboration. Minor improvement: handle potential missing or invalid user avatar URLs.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 94f421f and 7dda6bb.

📒 Files selected for processing (3)
  • web/core/components/pages/dropdowns/edit-information-popover.tsx (2 hunks)
  • web/core/components/pages/editor/header/extra-options.tsx (1 hunks)
  • web/core/components/pages/editor/header/info-popover.tsx (2 hunks)
🔇 Additional comments (8)
web/core/components/pages/dropdowns/edit-information-popover.tsx (1)

3-4: Well-structured import usage.
No issues found with these imports, and the calculateTimeAgoShort helper is a sensible choice for handling relative timestamps.

web/core/components/pages/editor/header/extra-options.tsx (1)

87-87: Prop injection looks good.
Passing page={page} into PageInfoPopover is a clean way to make relevant page data accessible within the popover. Ensure that page is never null or undefined to prevent runtime errors.

web/core/components/pages/editor/header/info-popover.tsx (6)

2-3: Consistent routing and linking approach.
The usage of Link from "next/link" and useParams from "next/navigation" aligns with Next.js best practices for client-side navigation.


8-11: UI utility imports used appropriately.
Imports for Avatar, getFileURL, and other helpers look properly structured, keeping the external UI logic separate from component internals.


14-15: Store integration is efficient.
Using the useMember hook to retrieve user details keeps the logic clean. Just ensure that the store is ready when the component mounts.


21-25: Additional prop for page data.
The page: TPageInstance prop effectively provides the necessary data for the popover, centralizing the logic around the page object.


31-32: Workspace slug retrieval is straightforward.
Ensure workspaceSlug is defined and non-empty in all usage scenarios. Otherwise, the profile links could break.


81-93: Informative grid layout.
The structured grid for the document info cards (words, characters, paragraphs, read-time) is clear and user-friendly.

@pushya22 pushya22 merged commit ec2af13 into preview Dec 31, 2024
10 of 12 checks passed
@pushya22 pushya22 deleted the chore/pages-info branch December 31, 2024 08:31
@coderabbitai coderabbitai bot mentioned this pull request Jan 6, 2025
1 task
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