Sync: master to preview

[pushya22]

• regression: image aspect ratio fix

• fix: name of variables changed for clarity

Summary by CodeRabbit

• New Features
  • Enhanced image handling with improved resizing logic and aspect ratio calculations for better responsiveness.
• Bug Fixes
  • Resolved issues related to image attribute updates and rendering based on aspect ratio changes.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the CustomImageBlock component within image-block.tsx. Key modifications include renaming variables for better clarity, adjusting the logic for image attributes and resizing behavior, and updating the state initialization to use these new variable names. The aspect ratio calculation logic has been revised to derive from the image's natural dimensions. Additionally, hooks have been modified to ensure correct responsiveness to image dimension changes, enhancing the overall clarity and maintainability of the code.

Changes

File	Change Summary
packages/editor/src/core/extensions/custom-image/components/image-block.tsx	- Renamed variables: width, height, aspectRatio to nodeWidth, nodeHeight, nodeAspectRatio. - Updated logic for aspect ratio calculation using aspectRatioCalculated. - Adjusted resizing logic based on new aspect ratio. - Modified useLayoutEffect and useEffect hooks for new variable names. - Enhanced rendering logic for responsiveness based on aspect ratio.

Possibly related PRs

• [WEB-2450] fix: image resize component #5623: Modifies the CustomImageBlock component, enhancing image resizing functionality and updating the logic for determining image size.
• [WEB-2509] fix: image fullscreen size #5686: Updates how the height and width properties are assigned in the CustomImageBlock, shifting to a size object.
• regression: Show the full screen toolbar option of images in read only instances as well #5746: Refines the logic for displaying image utilities and resizing functionality in the CustomImageBlock.

Suggested labels

🐛bug, 🌐frontend, ✍️editor

Suggested reviewers

• SatishGandham
• aaryan610

🐇 In the garden, images bloom,
With widths and heights, they find their room.
Aspect ratios dance in delight,
Resizing magic, a wondrous sight!
Clarity shines, the code is neat,
Hopping forward, our work's complete! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 07402ef and c68658d.

📒 Files selected for processing (1)

• packages/editor/src/core/extensions/custom-image/components/image-block.tsx (6 hunks)

🧰 Additional context used

🔇 Additional comments (7)

packages/editor/src/core/extensions/custom-image/components/image-block.tsx (7)

60-65: Improved variable naming enhances code clarity.

The renaming of variables from width, height, and aspectRatio to nodeWidth, nodeHeight, and nodeAspectRatio respectively, along with the corresponding updates in the size state initialization, enhances code clarity by clearly distinguishing between node attributes and local state. This change aligns well with the PR objective of improving variable naming.

---

105-115: Improved aspect ratio calculation addresses regression.

The introduction of aspectRatioCalculated, derived from the image's natural dimensions, ensures more accurate and reliable aspect ratio handling. This change directly addresses the PR objective of fixing the image aspect ratio regression. The updated initial size computation using this calculated aspect ratio should prevent aspect ratio issues and improve the overall image rendering accuracy.

---

125-128: Enhanced consistency in aspect ratio handling.

The updated condition for attribute updates ensures that the stored aspect ratio is always accurate and consistent with the image's actual dimensions. By checking for missing or inconsistent aspect ratios, this change addresses potential discrepancies and improves the overall reliability of the image rendering process. This implementation aligns well with the PR objectives and enhances the component's robustness.

---

138-147: Improved consistency and reactivity in useLayoutEffect.

The updates to the useLayoutEffect hook, including the addition of nodeAspectRatio to the dependency array and the use of renamed variables nodeWidth and nodeHeight, enhance the component's consistency and reactivity. These changes ensure that the effect runs appropriately when the aspect ratio changes and maintain clarity through consistent variable naming. This implementation aligns well with the overall improvements in the PR.

---

219-219: Enhanced robustness with conditional aspect ratio styling.

The conditional inclusion of the aspect ratio in the style object is a well-implemented defensive programming approach. By only applying the aspect ratio when it exists, this change prevents potential rendering issues that could arise from undefined or null values. This small but significant improvement enhances the overall robustness of the component.

---

245-245: Consistent and robust aspect ratio handling for img element.

The conditional application of the aspect ratio to the img element's style mirrors the earlier change to the container element. This consistency in approach ensures that undefined or null aspect ratios are not applied to the img element, preventing potential rendering issues. This change further reinforces the component's robustness and reliability in handling various image scenarios.

---

Line range hint 1-290: Overall improvements enhance image handling and code clarity.

The changes in this file successfully address the PR objectives by:

1. Fixing the image aspect ratio regression through improved calculation and consistent application.
2. Enhancing code clarity with better variable naming.
3. Implementing defensive programming techniques for robust aspect ratio handling.

The modifications are consistent throughout the file and follow best practices. These improvements contribute to a more reliable and maintainable CustomImageBlock component.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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