Skip to content

Clarify crash recovery dialog #304

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.

Sign up for GitHub

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

Jump to bottom
Merged
DropSnorz merged 1 commit into from
Apr 9, 2025
Merged

Clarify crash recovery dialog #304

DropSnorz merged 1 commit into from
Apr 9, 2025

Conversation

@DropSnorz
Copy link
Owner

@DropSnorz DropSnorz commented Apr 9, 2025

No description provided.

@DropSnorz DropSnorz self-assigned this Apr 9, 2025
@coderabbitai
Copy link

coderabbitai bot commented Apr 9, 2025 •
edited
Loading

Walkthrough

This pull request introduces minor modifications in both the controller and UI/resource layers. In the Java controllers, a new logging statement is added in the main controller’s post-initialization method and the crash recovery dialog controller now retrieves dynamic URLs via a configuration property rather than hardcoding them, with an accompanying log message update. In the resource layer, a new GitHub wiki URL property is added to the properties file, and the FXML layout is adjusted with modified spacing, namespace version, and updated text for improved clarity.

Changes

File(s) Change Summary
owlplug-client/.../controllers/MainController.java Added a log statement in dispatchPostInitialize to record when a previous execution terminated unsafely before calling the crash recovery dialog.
owlplug-client/.../controllers/CrashRecoveryDialogController.java Updated action handlers for troubleshootingLink and issuesLink to retrieve URLs using getEnvProperty instead of hardcoded URLs; modified a log message in the initialize method.
owlplug-client/.../application.properties
owlplug-client/.../CrashRecoveryView.fxml		 Added a new property (owlplug.github.wiki.url); adjusted FXML layout (spacing, xmlns version) and updated labels’ text for enhanced clarity.

Sequence Diagram(s)

sequenceDiagram
    participant MC as MainController
    participant CRDC as CrashRecoveryDialogController
    participant UI as User Interface

    Note over MC: dispatchPostInitialize execution
    MC->>MC: log.info("Previous execution not terminated safely, opening crash recovery dialog")
    MC->>CRDC: show()
    CRDC->>UI: Render Crash Recovery Dialog
Loading 
sequenceDiagram
    participant User as End-User
    participant CRDC as CrashRecoveryDialogController
    participant Env as Application Defaults
    participant Browser as Web Browser

    User->>CRDC: Click troubleshootingLink / issuesLink
    CRDC->>Env: getEnvProperty(url_key)
    Env-->>CRDC: Return dynamic URL
    CRDC->>Browser: Open URL in browser
Loading
📜 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 accc809 and 2ef1053.

📒 Files selected for processing (4)
  • owlplug-client/src/main/java/com/owlplug/core/controllers/MainController.java (1 hunks)
  • owlplug-client/src/main/java/com/owlplug/core/controllers/dialogs/CrashRecoveryDialogController.java (2 hunks)
  • owlplug-client/src/main/resources/application.properties (1 hunks)
  • owlplug-client/src/main/resources/fxml/dialogs/CrashRecoveryView.fxml (3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
owlplug-client/src/main/java/com/owlplug/core/controllers/dialogs/CrashRecoveryDialogController.java (1)
owlplug-client/src/main/java/com/owlplug/core/utils/PlatformUtils.java (1)
  • PlatformUtils (30-67)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (9)
owlplug-client/src/main/resources/application.properties (1)

11-11: Good addition of externalized configuration property

Adding the GitHub wiki URL as a configurable property is a good practice. This allows for easier maintenance and updates of URLs without code changes, consistent with the other externalized URLs in the application.

owlplug-client/src/main/java/com/owlplug/core/controllers/MainController.java (1)

187-187: Informative logging enhancement

This additional log statement provides valuable context about why the crash recovery dialog is being displayed, making troubleshooting easier for both developers and users reviewing logs.

owlplug-client/src/main/java/com/owlplug/core/controllers/dialogs/CrashRecoveryDialogController.java (2)

112-117: Good refactoring to use dynamic URLs

Replacing hardcoded URLs with dynamic properties from application defaults is a significant improvement. This change increases flexibility and maintainability, aligning with the new property added in application.properties.

129-129: Clearer log messaging

The updated log message provides more accurate information about the incomplete plugin scan status, which better reflects what's actually happening with the plugins compared to the previous message.

owlplug-client/src/main/resources/fxml/dialogs/CrashRecoveryView.fxml (5)

9-9: Updated spacing and JavaFX version

The increased spacing improves visual separation between elements, and updating to JavaFX 16 ensures compatibility with newer features and improvements.

21-21: Improved crash explanation

The updated text provides a more precise explanation of potential crash causes during plugin sync, comparing it to similar behavior in DAWs which helps users better understand the issue.

28-28: Clearer instructions for incomplete plugin analysis

The revised text more clearly explains that plugins haven't been fully analyzed and provides specific guidance on how to address the issue by disabling "Native Discovery".

32-38: Improved layout and wording for scanner options

The reorganized layout with adjusted spacing and more precise wording makes the scanner implementation options more intuitive. The clear separation between the checkbox text and the combobox improves readability.

50-53: More specific help text

The updated text is more specific about "scanning plugins" and provides clearer guidance on when to report issues, helping users make better decisions about when to seek help.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 or @coderabbitai title 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.

@DropSnorz
Copy link
Owner Author

DropSnorz commented Apr 9, 2025

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Apr 9, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@DropSnorz DropSnorz merged commit fc3a75b into dev Apr 9, 2025
3 checks passed
@DropSnorz DropSnorz deleted the chore/chrash-recovery branch September 27, 2025 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@DropSnorz DropSnorz

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@DropSnorz