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

[Fix] Prevent errors by checking if the browser window is destroyed #8684

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

adkif
Copy link
Contributor

@adkif adkif commented Jan 2, 2025

PR

Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.


Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling for window management
    • Added safety checks to prevent operations on destroyed windows
    • Enhanced window state management to avoid potential runtime errors

…fore hiding or closing.

This update adds checks to ensure that `hide()` and `close()` do not attempt actions on an already destroyed window, improving stability in window management.
@adkif adkif requested review from evereq and rahul-rocket January 2, 2025 11:46
Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request modifies the DefaultWindow class in the desktop core library to improve error handling and state management for browser windows. The changes focus on preventing potential errors when interacting with browser windows that may have been destroyed. Key modifications include adding checks for window destruction status in the hide() and close() methods, and updating the get browserWindow() method to return null when the window is in an invalid state.

Changes

File Change Summary
packages/desktop-core/src/lib/concretes/default-window.ts - Added _browserWindow.isDestroyed() checks in hide() and close() methods
- Modified close() method to call this.hide() before destroying the window
- Updated get browserWindow() to return null if window is destroyed or undefined

Possibly related PRs

Suggested reviewers

  • evereq
  • rahul-rocket

Poem

🐰 A Window's Tale of Careful Grace 🪟

In code where windows dance and sway,
Destruction's path we now allay,
With checks so wise and logic neat,
No broken panes shall we now meet!

  • A Rabbit's Refactoring Rhyme 🛠️

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

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: 0

🧹 Nitpick comments (1)
packages/desktop-core/src/lib/concretes/default-window.ts (1)

51-53: Ensure the hide() and destroy() sequence cannot introduce redundant checks or race conditions.

The current approach—returning early if destroyed, then calling hide(), and finally destroying the window—works fine for single-threaded Electron code. However, if there are external calls triggered before or after close(), confirm that they cannot lead to unexpected re-creation or repeated destruction.

Also applies to: 55-55

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 56e55bb and e9b6025.

📒 Files selected for processing (1)
  • packages/desktop-core/src/lib/concretes/default-window.ts (1 hunks)
🔇 Additional comments (1)
packages/desktop-core/src/lib/concretes/default-window.ts (1)

43-45: Well done adding a destruction check to avoid errors.

These lines effectively prevent a call to hide() on a destroyed BrowserWindow, which is a good safeguard against runtime errors.

@rahul-rocket rahul-rocket merged commit 2f0ed17 into develop Jan 2, 2025
15 of 16 checks passed
@rahul-rocket rahul-rocket deleted the fix/default-window-bug branch January 2, 2025 11:58
Copy link

nx-cloud bot commented Jan 2, 2025

View your CI Pipeline Execution ↗ for commit e9b6025.

Command Status Duration Result
nx build desktop --base-href ./ ✅ Succeeded 1m 45s View ↗
nx build desktop-api --output-path=dist/apps/de... ✅ Succeeded 26s View ↗
nx run api:desktop-api ✅ Succeeded 1m 13s View ↗
nx run gauzy:desktop-ui --base-href ./ ✅ Succeeded 3m 30s View ↗
nx build gauzy -c=production --prod --verbose ✅ Succeeded 3m 56s View ↗
nx build api -c=production --prod ✅ Succeeded 1m 6s View ↗
nx build desktop-ui-lib --configuration=production ✅ Succeeded 28s View ↗
nx build plugin-integration-wakatime ✅ Succeeded <1s View ↗
Additional runs (53) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-01-02 12:29:10 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants