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: issues with windows manager / dispose #8649

Merged
merged 4 commits into from
Dec 30, 2024

Conversation

syns2191
Copy link
Collaborator

@syns2191 syns2191 commented Dec 30, 2024

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

  • New Features

    • Added centralized splash screen closing mechanism across application components
    • Introduced a new property for database synchronization configuration
  • Chores

    • Enhanced application instance management and window initialization logic
  • Bug Fixes

    • Refined application startup process to handle multiple instances more gracefully

Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a centralized closeSplashScreen() function across multiple application components, specifically in the desktop, server-api, and server index files, to standardize the logic for closing the splash screen. Additionally, a new property DB_SYNCHRONIZE is added to the environment configuration, set to true, indicating a change in database synchronization behavior. The error handling mechanisms are refined, and the control flow for managing application instances is improved to ensure graceful application behavior when multiple instances are detected.

Changes

File Change Summary
apps/desktop/src/index.ts - Added closeSplashScreen() function
- Enhanced error handling logic
apps/server-api/src/index.ts - Added closeSplashScreen() function
- Modified getEnvApi() to include a trailing comma
apps/server/src/index.ts - Added closeSplashScreen() function
- Added DB_SYNCHRONIZE: true to environment configuration

Possibly related PRs

Suggested labels

FIX

Poem

🐰 A rabbit's tale of code so bright,
Splash screens dance with newfound might.
Synchronize, close, and handle with care,
Windows open, errors beware!
CodeRabbit's magic, clean and light! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 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 dbfdf5c and bc56804.

📒 Files selected for processing (3)
  • apps/desktop/src/index.ts (5 hunks)
  • apps/server-api/src/index.ts (3 hunks)
  • apps/server/src/index.ts (3 hunks)

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 027b1a9 and dbfdf5c.

📒 Files selected for processing (3)
  • apps/desktop/src/index.ts (5 hunks)
  • apps/server-api/src/index.ts (3 hunks)
  • apps/server/src/index.ts (3 hunks)
🔇 Additional comments (11)
apps/server-api/src/index.ts (3)

241-246: Encapsulating the closing of the splash screen is a good practice.
Centralizing all splash screen closure logic in a dedicated function enhances maintainability and readability. This approach avoids code duplication and ensures consistent behavior. Good work!


255-255: Ensure that calling closeSplashScreen() here is always valid.
While it is safe under normal flow, confirm that no race condition or overlapping calls occur when setupWindow or other windows close. If multiple steps run in parallel (e.g., in unusual error scenarios), you may want to log or track repeated calls to ensure clarity in debugging.


274-274: Good consistency in reusing closeSplashScreen().
This second invocation similarly benefits from avoiding direct references to splashScreen.close().

apps/server/src/index.ts (3)

250-255: Excellent abstraction for splash screen closure logic.
Just like in the server-api code, extracting this code into a helper function centralizes and simplifies the routine.


264-264: Validate the nature of this call within runSetup.
Check that no subsequent calls accidentally re-show or misuse the splash screen.


283-283: Second invocation of closeSplashScreen().
Ensure the splash screen was not already destroyed or replaced. The if (splashScreen) { ... } safeguard helps mitigate potential errors here.

apps/desktop/src/index.ts (5)

275-275: Confirm the impact of forcing DB_SYNCHRONIZE = 'true'.
While this can simplify migrations, be sure to handle production scenarios carefully if schema synchronization in production is undesired or risky.


406-411: Nice utility function to close the splash screen.
This is consistent with the approach in the server modules, reducing duplication and improving clarity.


497-497: Close the splash screen at the right time to avoid flicker.
Calling closeSplashScreen() here can be optimal, ensuring the user sees the setup window promptly.


512-512: Second invocation of closeSplashScreen().
Recheck that the splash screen is still present; the if (splashScreen) logic helps, but track any timing issues if user interactions occur concurrently.


728-728: Ensure consistent usage of closeSplashScreen() in before-quit logic.
If the user triggers app closure from the dock or tray while the splash is visible for any reason, this call ensures a clean exit.

apps/server-api/src/index.ts Outdated Show resolved Hide resolved
apps/server/src/index.ts Outdated Show resolved Hide resolved
Copy link

nx-cloud bot commented Dec 30, 2024

View your CI Pipeline Execution ↗ for commit bc56804.

Command Status Duration Result
nx build desktop --base-href ./ ✅ Succeeded 1m 39s View ↗
nx build desktop-api --output-path=dist/apps/de... ✅ Succeeded 25s View ↗
nx run api:desktop-api ✅ Succeeded 1m 11s View ↗
nx build gauzy -c=production --prod --verbose ✅ Succeeded 3m 53s View ↗
nx run gauzy:desktop-ui --base-href ./ ✅ Succeeded 3m 36s View ↗
nx build api -c=production --prod ✅ Succeeded 1m 7s View ↗
nx build desktop-ui-lib --configuration=develop... ✅ Succeeded 29s View ↗
nx build plugin-integration-wakatime ✅ Succeeded <1s View ↗
Additional runs (52) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2024-12-30 15:33:15 UTC

@evereq evereq marked this pull request as draft December 30, 2024 10:57
@evereq evereq marked this pull request as ready for review December 30, 2024 14:52
@evereq evereq changed the title fix: gauzy server database migration fix: issues with windows manager / dispose Dec 30, 2024
@evereq evereq merged commit 2b00ffa into develop Dec 30, 2024
11 of 14 checks passed
@evereq evereq deleted the fix/gauzy-server-database-migration branch December 30, 2024 14:53
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