fix(web): avoid redundant queries for unchanged comment values

[caichi-t]

Overview

This PR fixes to not throw a query if the new comment value is the same as before.

Summary by CodeRabbit

• New Features

  • Enhanced comment submission logic to prevent unnecessary updates when the content remains unchanged.

• Bug Fixes

  • Improved efficiency of comment updates by ensuring the update function is only called when the content has changed.

[coderabbitai]

Walkthrough

The changes involve modifications to the handleSubmit function in two components: Comment.tsx and Details/Comment.tsx. Both updates introduce a conditional check to prevent unnecessary comment updates when the new content is the same as the existing content. This is achieved by comparing comment.content with the new value before invoking the update function. Additionally, the dependency array for handleSubmit has been updated to include comment.content, ensuring the function reacts to content changes.

Changes

File Path	Change Summary
web/src/components/molecules/Common/CommentsPanel/Comment.tsx	Updated handleSubmit to prevent updates if the content hasn't changed; modified dependency array.
web/src/components/molecules/Request/Details/Comment.tsx	Similar update to handleSubmit to prevent unnecessary updates; modified dependency array.

Possibly related PRs

• fix(web): add some missing styling #1279: This PR modifies the handleSubmit function in a similar manner to the main PR, adding a conditional check to prevent unnecessary updates when the comment content has not changed.

Suggested labels

web

Suggested reviewers

• nourbalaha

Poem

🐇 In the meadow where comments play,
A check was added to save the day.
If words are the same, no need to send,
A smarter update, our new best friend!
Hopping along with joy we say,
"Let’s keep our code clean, hip-hip-hooray!" 🌼

---

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.

[netlify]

✅ Deploy Preview for reearth-cms ready!

Name	Link
🔨 Latest commit	9379c60
🔍 Latest deploy log	https://app.netlify.com/sites/reearth-cms/deploys/6744020b340c470008a7648a
😎 Deploy Preview	https://deploy-preview-1317--reearth-cms.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

web/src/components/molecules/Common/CommentsPanel/Comment.tsx (1)

47-56: Consider enhancing error handling

The current error handling only logs to console, which might not be sufficient for production. Consider adding user feedback for failed comment updates.

  const handleSubmit = useCallback(async () => {
    try {
      if (comment.content !== value) {
        await onCommentUpdate?.(comment.id, value);
      }
    } catch (info) {
-     console.log("Validate Failed:", info);
+     console.error("Comment update failed:", info);
+     // Consider adding a notification system
+     notification.error({
+       message: "Failed to update comment",
+       description: "Please try again later"
+     });
    } finally {
      setShowEditor(false);
    }
  }, [comment.content, comment.id, value, onCommentUpdate]);

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 44e60cb and 0cd8ddc.

📒 Files selected for processing (2)

• web/src/components/molecules/Common/CommentsPanel/Comment.tsx (1 hunks)
• web/src/components/molecules/Request/Details/Comment.tsx (1 hunks)

🔇 Additional comments (4)

web/src/components/molecules/Common/CommentsPanel/Comment.tsx (2)

48-50: LGTM! Optimization prevents unnecessary comment updates

The conditional check effectively prevents unnecessary API calls when the comment content hasn't changed, aligning with the PR's objective to optimize performance.

---

56-56: LGTM! Correct dependency array update

The addition of comment.content to the dependency array is necessary as it's used within the handleSubmit callback.

web/src/components/molecules/Request/Details/Comment.tsx (2)

46-48: LGTM! Optimization prevents unnecessary API calls

The added condition effectively prevents redundant comment updates when the content hasn't changed, aligning with the PR's objective.

Consider adding a debug log when skipping the update to help with troubleshooting.

---

54-54: LGTM! Proper dependency management

The dependency array correctly includes comment.content which is required for the comparison logic in the callback.