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

[WEB-1116] fix: current version not displaying the latest content #5573

Merged
merged 2 commits into from
Sep 10, 2024

Conversation

aaryan610
Copy link
Collaborator

@aaryan610 aaryan610 commented Sep 10, 2024

Problem:

When checking the current version from the version history list, the content is always outdated. It always displays the initial content that renders on the first page load.

Solution:

Updated the editor to display the content from editorRef, which always has the latest data, instead of reading from the store.

Summary by CodeRabbit

  • New Features

    • Enhanced the PageRoot component to dynamically display the current version's description based on editability.
    • Updated the PagesVersionEditor component to manage and display the current version's description more effectively.
    • Improved the PageVersionsMainContent and PageVersionsOverlay components to utilize the current version's description, streamlining data flow and enhancing clarity.
  • Bug Fixes

    • Resolved issues related to the retrieval of version descriptions, ensuring accurate display based on the active version state.

@aaryan610 aaryan610 added 🐛bug Something isn't working 🌐frontend labels Sep 10, 2024
@aaryan610 aaryan610 added this to the v0.23-dev milestone Sep 10, 2024
Copy link
Contributor

coderabbitai bot commented Sep 10, 2024

Walkthrough

The changes involve modifications to several components within the web application, primarily focusing on the introduction of a new variable, currentVersionDescription, which enhances the handling of version descriptions based on the editability state. The Props types across multiple components have been updated to include this new property, and existing properties have been refined or removed to streamline data flow. The overall structure of the components has been adjusted to improve type safety and clarity in prop management.

Changes

Files Change Summary
web/core/components/pages/editor/page-root.tsx Introduced currentVersionDescription to dynamically retrieve HTML content based on isContentEditable.
web/core/components/pages/version/editor.tsx Renamed Props type to TVersionEditorProps, added currentVersionDescription, and updated destructuring to simplify logic for rendering version descriptions.
web/core/components/pages/version/main-content.tsx Modified Props type to include currentVersionDescription and changed editorComponent to use TVersionEditorProps for improved type clarity and prop management.
web/core/components/pages/version/root.tsx Updated Props type in PageVersionsOverlay to include currentVersionDescription and changed editorComponent to utilize TVersionEditorProps, enhancing type safety and clarity in the component's interface.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PageRoot
    participant PageVersionsOverlay
    participant PagesVersionEditor

    User->>PageRoot: Interacts with editor
    PageRoot->>PageVersionsOverlay: Passes currentVersionDescription
    PageVersionsOverlay->>PagesVersionEditor: Passes currentVersionDescription
    PagesVersionEditor->>PagesVersionEditor: Renders description based on currentVersionDescription
Loading

Poem

🐰 In the garden where pages bloom,
A new version's light dispels the gloom.
With descriptions bright, we hop with cheer,
Each change a dance, each line sincere.
So let us edit, let us play,
In the world of code, we find our way! 🌼

Tip

Announcements
  • The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
  • We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17d9881 and 6338c4b.

Files selected for processing (1)
  • web/core/components/pages/editor/page-root.tsx (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • web/core/components/pages/editor/page-root.tsx

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

@pushya22 pushya22 merged commit 8acb60b into preview Sep 10, 2024
12 of 14 checks passed
@SatishGandham SatishGandham deleted the fix/current-version-sync branch September 10, 2024 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants