[PE-272] fix: prevent error on reload when page version history panel is open

[anmolsinghbhatia]

Description

This PR fixes an issue where the app throws an error on reload when the version history panel is open. The error occurred because editor was potentially undefined, and calling editor.getJSON() directly resulted in a crash.

Changes:

Updated the assignment of documentJSON to safely access editor using optional chaining (editor?.getJSON()), preventing the error when editor is undefined.

Type of Change

• Bug fix (non-breaking change which fixes an issue)

Test Scenarios

• Reload the app with the version history panel open and verify that no error occurs.
• Ensure that the version history functionality remains unaffected.

References

[PE-272]

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling in editor content retrieval by adding optional chaining to prevent potential runtime errors when accessing editor methods.

[coderabbitai]

Walkthrough

The pull request introduces a minor modification to the useEditor hook in the packages/editor/src/core/hooks/use-editor.ts file. The change involves adding optional chaining to the getJSON() method call when retrieving the document JSON. This ensures safer access to the editor object by preventing potential errors if the editor is null or undefined.

Changes

File	Change Summary
packages/editor/src/core/hooks/use-editor.ts	Added optional chaining (editor?.getJSON()) to safely retrieve document JSON

Possibly related PRs

• [WEB-2486] Fix: archive page break issue resolved #5644: Modifies variable handling using optional chaining
• [PE-265] fix: adding link to editor via floating toolbar #6517: Enhances error handling for input validation

Suggested reviewers

• sriramveeraghanta
• SatishGandham

Poem

🐰 Optional chaining, a rabbit's delight,
Safely hopping through code, day and night
No more errors that make developers fret
With ?. we dodge the null threat!
A small change, but oh so bright! 🔧

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ddad176 and 2758f8f.

📒 Files selected for processing (1)

• packages/editor/src/core/hooks/use-editor.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (1)

packages/editor/src/core/hooks/use-editor.ts (1)

205-205: LGTM! Good defensive programming practice.

The addition of optional chaining (?.) is a good safeguard against potential undefined editor states during page reloads, preventing runtime errors. This change aligns well with how the code already handles similar cases, such as editor?.getHTML() on line 204.

Let's verify that this pattern is consistently applied throughout the codebase for other editor method calls:

✅ Verification successful

Optional chaining usage is correctly applied throughout the codebase

The codebase demonstrates a consistent pattern where optional chaining is used in scenarios where the editor instance might be undefined (like in hooks and cleanup), while direct method calls are used in controlled contexts where the editor is guaranteed to exist (like in component methods and event handlers). The change aligns with the existing patterns in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistency in handling potential undefined editor states
# Look for direct method calls on editor that might need optional chaining

# Search for direct editor method calls without optional chaining
rg 'editor\.[a-zA-Z]+\(' --type ts

# Search for method calls with optional chaining for comparison
rg 'editor\?\.[a-zA-Z]+\(' --type ts

Length of output: 19723

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.