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

PCH Smart Linking: Prevent Smart Linking from running on Freeform (Classic) blocks #2570

Merged
merged 4 commits into from
Jun 17, 2024

Conversation

vaurdan
Copy link
Contributor

@vaurdan vaurdan commented Jun 17, 2024

Description

Due to the way the Freeform blocks (aka Classic Editor blocks) works, the parsing and injection of Smart Links do not work properly on this type of block.

This PR checks if the current block (if "Selected Block" is selected) or if the content contains any freeform block (if "All Blocks" is selected), and throws a Snack Bar error if so.

Motivation and context

Prevent issues when running the Smart Linking on posts with Freeform blocks.

How has this been tested?

Tested locally

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability of Smart Links by handling cases where they don't work with Freeform blocks.
    • Added error messages for better user feedback when Smart Links cannot be applied.

@vaurdan vaurdan added this to the 3.16.0 milestone Jun 17, 2024
@vaurdan vaurdan self-assigned this Jun 17, 2024
@vaurdan vaurdan requested a review from a team as a code owner June 17, 2024 09:21
Copy link
Contributor

coderabbitai bot commented Jun 17, 2024

Warning

Rate limit exceeded

@vaurdan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 42 minutes and 37 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 138c024 and 00f97d7.

Walkthrough

This update introduces handling for cases where Smart Links are applied to Freeform blocks or the entire content in the component.tsx file of the smart-linking component. When such scenarios are detected, an error message is displayed, Smart Linking is not applied, and the function exits early with loading set to false.

Changes

File Path Change Summary
src/content-helper/editor-sidebar/smart-linking/component.tsx Added logic to handle unsupported cases for Smart Links with Freeform blocks, displaying an error message, setting loading to false, and returning early.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI as User Interface
    participant Component as SmartLinkComponent
    participant Logic as SmartLinkLogic

    User ->> UI: Attempts to apply Smart Links
    UI ->> Component: Trigger applySmartLinks()
    Component ->> Logic: Check if content is Freeform
    Logic -->> Component: Return Freeform check result
    alt Content is Freeform
        Component ->> UI: Display error message
        Component ->> Component: Set loading to false
        Component ->> Component: Return early
    else Content is not Freeform
        Component ->> Logic: Apply Smart Links
        Logic -->> Component: Smart Links applied
        Component -->> UI: Reflect updated content
    end
Loading

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0e1c95 and 138c024.

Files ignored due to path filters (2)
  • build/content-helper/editor-sidebar.asset.php is excluded by !build/**
  • build/content-helper/editor-sidebar.js is excluded by !build/**
Files selected for processing (1)
  • src/content-helper/editor-sidebar/smart-linking/component.tsx (1 hunks)
Additional context used
Path-based instructions (1)
src/content-helper/editor-sidebar/smart-linking/component.tsx (1)

Pattern **/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:

  • Review the code to ensure it is well-structured and adheres to best practices.
  • Verify compliance with WordPress coding standards.
  • Ensure the code is well-documented.
  • Check for security vulnerabilities and confirm the code is secure.
  • Optimize the code for performance, removing any unnecessary elements.
  • Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
  • Ensure each line comment concludes with a period.
  • Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
  • Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."

vaurdan added 2 commits June 17, 2024 10:29
# Conflicts:
#	build/content-helper/editor-sidebar.asset.php
#	build/content-helper/editor-sidebar.js
@acicovic
Copy link
Collaborator

acicovic commented Jun 17, 2024

So, the existence of a single Freeform block can break things for other blocks as well, even if the selected block is not Freeform. Am I understanding this correctly?

@vaurdan
Copy link
Contributor Author

vaurdan commented Jun 17, 2024

@acicovic exactly. If you are generating smart links for all blocks, and you get a smart link that is to be inserted into a freeform block, there's a high likelihood that either the block editor crashes, or the block content becomes empty. If there is at least one freeform block, only the "Selected Block" option will actually work, and only if you don't select the freeform block

@vaurdan vaurdan merged commit 4461ad7 into develop Jun 17, 2024
36 checks passed
@vaurdan vaurdan deleted the update/smart-links-freeform-block branch June 17, 2024 09:51
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.

2 participants