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

[lexical-link] Fix bug when can't remove link formatting from autolink #31

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

local-dev-korbit-ai-mentor[bot]
Copy link

@local-dev-korbit-ai-mentor local-dev-korbit-ai-mentor bot commented Aug 15, 2024

This PR fixes a bug where a user cannot remove link formatting (unlink) from links created by AutoLinkNode. However, it works for links created by LinkNode. The proposal is to add a flag property in AutoLinkNode to indicate if the link was unlinked. If so, render the link as regular text, keeping styles. The hidden auto-link can become a link again via the Toolbar Link button.

Closes #5607

Test plan

  1. Open https://playground.lexical.dev/
  2. Input to the editor "www.facebook.com".
  3. Check the auto-link is created.
  4. Focus on the link.
  5. Click the delete button on the popup.
  6. The link should transform to the regular text "www.facebook.com".

Before

Screen.Recording.2024-06-13.at.15.18.13.mov

After

Screen.Recording.2024-06-13.at.15.20.36.mov

Description by Korbit AI

What change is being made?

Fix the bug that prevents removing link formatting from autolinks by adding support for an isUnlinked attribute in the AutoLinkNode class and updating related logic and tests.

Why are these changes being made?

The changes address an issue where users could not remove link formatting from autolinks. By introducing the isUnlinked attribute, the system can now handle unlinked autolinks correctly, ensuring that the link formatting can be toggled on and off as needed. This approach maintains backward compatibility and enhances the flexibility of link management within the editor.

Copy link
Author

Clone of the PR facebook/lexical#6306

Copy link

korbit-ai bot commented Aug 15, 2024

My review is in progress 📖 - I will have feedback for you in a few minutes!

Copy link

coderabbitai bot commented Aug 15, 2024

Warning

Rate limit exceeded

@furwellness has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 56 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 4cbb85f and 45d9931.


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

Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

I have reviewed your code and found 1 potential issue.

Comment on lines +474 to +495
editor.registerCommand(
TOGGLE_LINK_COMMAND,
(payload) => {
const selection = $getSelection();
if (payload !== null || !$isRangeSelection(selection)) {
return false;
}
const nodes = selection.extract();
nodes.forEach((node) => {
const parent = node.getParent();

if ($isAutoLinkNode(parent)) {
// invert the value
parent.setIsUnlinked(!parent.getIsUnlinked());
parent.markDirty();
return true;
}
});
return false;
},
COMMAND_PRIORITY_LOW,
),
Copy link

Choose a reason for hiding this comment

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

category Functionality severity potentially major

The TOGGLE_LINK_COMMAND handler should return true after successfully toggling an AutoLinkNode's unlinked state. Currently, it returns true inside the forEach loop, which doesn't actually return from the command handler. Consider moving the return statement outside the loop to properly indicate that the command was handled.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

@furwellness
Copy link
Owner

/review

Copy link

codiumai-pr-agent-free bot commented Aug 16, 2024

PR Reviewer Guide 🔍

(Review updated until commit 45d9931)

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Key issues to review

Typo in Test Description
The test description 'AutoAutoLinkNode.constructor' seems to have a typo. It should be 'AutoLinkNode.constructor'.

Typo in Variable Name
The variable name 'actutoLinkNode' appears to be a typo. Consider renaming it to 'autoLinkNode' for clarity.

Inconsistent Type
The method 'updateDOM' in 'LinkNode' class has a parameter 'anchor' whose type was changed from 'HTMLAnchorElement' to 'LinkHTMLElementType'. This change should be verified for compatibility with existing implementations that might expect the previous type.

Missing Type Check
In the 'updateDOM' method of the 'LinkNode' class, there is no type check for 'HTMLSpanElement' when 'anchor' is an instance of 'LinkHTMLElementType'. This could lead to runtime errors if 'anchor' is a 'span' and properties specific to 'a' tags are accessed.

Copy link

Persistent review updated to latest commit 45d9931

@furwellness
Copy link
Owner

@coderabbitai review

Copy link

coderabbitai bot commented Aug 16, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@furwellness
Copy link
Owner

@coderabbitai review

Copy link

coderabbitai bot commented Aug 17, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@furwellness furwellness changed the base branch from cloned_main_fcf1a to main August 19, 2024 17:29
@furwellness
Copy link
Owner

@coderabbitai full review

Copy link

coderabbitai bot commented Aug 19, 2024

Actions performed

Full review triggered.

@furwellness
Copy link
Owner

No comment from coderabbit

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.

1 participant