fix: replace myservers.cfg reads in UpdateFlashBackup.php

[pujitm]

Summary by CodeRabbit

• New Features

  • Added a new method for verifying user sign-in status using a dedicated configuration handler.
  • Introduced a class to manage connection configuration and status checks.

• Refactor

  • Updated logic for checking connection and registration status to use new configuration handling methods for improved clarity and reliability.

[coderabbitai]

Walkthrough

These changes refactor how user connection and registration status are determined in shell and PHP scripts. The logic now checks JSON status files and introduces a new PHP utility class for connection config management, replacing previous manual file parsing and outdated status checks.

Changes

File(s)	Change Summary
plugin/source/dynamix.unraid.net/etc/rc.d/rc.flash_backup	Refactored _connected() to use a JSON status file for connection checks; removed old minigraph logic.
plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/UpdateFlashBackup.php	Switched user registration check to use new ConnectConfig::isUserSignedIn() static method.
plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/connect-config.php	Added new ConnectConfig class with static methods for reading config and checking sign-in status.

Sequence Diagram(s)

sequenceDiagram
    participant ShellScript as rc.flash_backup
    participant StatusFile as connectStatus.json

    ShellScript->>StatusFile: Read connectionStatus
    alt StatusFile missing or not CONNECTED
        ShellScript-->>ShellScript: Return failure
    else
        ShellScript-->>ShellScript: Return success
    end

Loading

sequenceDiagram
    participant PHP as UpdateFlashBackup.php
    participant ConnectConfig as ConnectConfig class
    participant ApiConfig as ApiConfig class

    PHP->>ConnectConfig: isUserSignedIn()
    ConnectConfig->>ApiConfig: isConnectPluginEnabled()
    alt Plugin not enabled
        ConnectConfig-->>PHP: false
    else
        ConnectConfig->>ConnectConfig: getConfig()
        alt username present
            ConnectConfig-->>PHP: true
        else
            ConnectConfig-->>PHP: false
        end
    end

Loading

Possibly related PRs

• fix: flash backup integration with Unraid Connect config #1448: Also modifies _connected() in rc.flash_backup to update connection status checks using JSON and removes old config parsing.
• fix: invalid state for unraid plugin #1492: Refactors PHP code to use /var/local/emhttp/connectStatus.json, aligning with this PR's approach to status management.

Suggested reviewers

• elibosley

Poem

In scripts and PHP, the logic’s renewed,
JSON files checked, old configs eschewed.
A class now reads if you’re signed in,
While shell scripts verify status within.
Refactored and tidy, the code’s in its prime—
Connection checks modern, efficient, sublime!
🚦✨

---

📜 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 29dcb7d and 6eef898.

📒 Files selected for processing (3)

• plugin/source/dynamix.unraid.net/etc/rc.d/rc.flash_backup (1 hunks)
• plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/UpdateFlashBackup.php (1 hunks)
• plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/connect-config.php (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: pujitm
PR: unraid/api#1352
File: packages/unraid-api-plugin-generator/src/create-plugin.ts:91-112
Timestamp: 2025-04-21T18:27:36.482Z
Learning: For utility functions like file operations in api plugin generators, pujitm prefers minimal error handling rather than verbose try/catch blocks for each operation, as errors will propagate properly to higher level error handlers.

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/UpdateFlashBackup.php (3)

Learnt from: elibosley
PR: unraid/api#1381
File: plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh:11-16
Timestamp: 2025-05-08T19:31:52.417Z
Learning: The `dynamix.my.servers` namespace is still valid and should not be changed to `dynamix.unraid.net` in file paths, as both namespaces coexist in the codebase.

Learnt from: pujitm
PR: unraid/api#1415
File: plugin/plugins/dynamix.unraid.net.plg:234-236
Timestamp: 2025-06-11T14:14:30.348Z
Learning: For the Unraid Connect plugin, the script `/etc/rc.d/rc.unraid-api` is bundled with the plugin package itself, so its presence on the target system is guaranteed during installation.

Learnt from: elibosley
PR: unraid/api#1381
File: plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh:19-24
Timestamp: 2025-05-08T19:28:54.365Z
Learning: The directory `/usr/local/emhttp/plugins/dynamix.my.servers` is a valid directory that exists as part of the Unraid API plugin installation and should be included in verification checks.

plugin/source/dynamix.unraid.net/etc/rc.d/rc.flash_backup (3)

Learnt from: pujitm
PR: unraid/api#1415
File: plugin/plugins/dynamix.unraid.net.plg:234-236
Timestamp: 2025-06-11T14:14:30.348Z
Learning: For the Unraid Connect plugin, the script `/etc/rc.d/rc.unraid-api` is bundled with the plugin package itself, so its presence on the target system is guaranteed during installation.

Learnt from: elibosley
PR: unraid/api#1381
File: plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh:11-16
Timestamp: 2025-05-08T19:31:52.417Z
Learning: The `dynamix.my.servers` namespace is still valid and should not be changed to `dynamix.unraid.net` in file paths, as both namespaces coexist in the codebase.

Learnt from: elibosley
PR: unraid/api#969
File: web/justfile:7-9
Timestamp: 2024-11-27T15:30:02.252Z
Learning: In the Unraid Connect project, the different implementations of the `setup` commands in `web/justfile` and `api/justfile` are intentional and correct behavior.

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/connect-config.php (2)

Learnt from: elibosley
PR: unraid/api#1425
File: api/dev/configs/connect.json:5-13
Timestamp: 2025-06-20T20:50:14.050Z
Learning: Connect configuration files like api/dev/configs/connect.json use their own naming conventions (e.g., apikey, accesstoken, idtoken, refreshtoken) as implementation details, and these should not be changed to follow general camelCase patterns.

Learnt from: pujitm
PR: unraid/api#1415
File: plugin/plugins/dynamix.unraid.net.plg:234-236
Timestamp: 2025-06-11T14:14:30.348Z
Learning: For the Unraid Connect plugin, the script `/etc/rc.d/rc.unraid-api` is bundled with the plugin package itself, so its presence on the target system is guaranteed during installation.

🧬 Code Graph Analysis (2)

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/UpdateFlashBackup.php (1)

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/connect-config.php (2)

• ConnectConfig (8-26)
• isUserSignedIn (21-25)

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/connect-config.php (1)

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/api-config.php (1)

• isConnectPluginEnabled (70-73)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Build API
• GitHub Check: Build Web App
• GitHub Check: Test API
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (3)

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/UpdateFlashBackup.php (1)

21-23: Clean refactoring to centralize connect configuration management.

The replacement of manual myservers.cfg parsing with the new ConnectConfig::isUserSignedIn() method improves code maintainability and reduces duplication. The approach properly encapsulates the logic for determining user sign-in status.

plugin/source/dynamix.unraid.net/etc/rc.d/rc.flash_backup (1)

169-186: Improved connection verification logic with better variable naming.

The refactoring enhances code clarity by:

• Using descriptive variable names (connect_config instead of CFG)
• Properly declaring local variables
• Separating user sign-in check from connection status verification
• Using dedicated status file for connection status validation

The explicit check against /var/local/emhttp/connectStatus.json provides more reliable connection status determination.

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/connect-config.php (1)

8-26: Well-designed utility class for connect configuration management.

The ConnectConfig class provides a clean abstraction with:

• Proper constant definition for configuration path
• Robust error handling in getConfig() that gracefully handles file read failures
• Logical combination of plugin enablement and username validation in isUserSignedIn()
• Appropriate use of static methods for utility functions

The implementation follows good practices for configuration management and error handling.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

[github-actions]

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL:

https://preview.dl.unraid.net/unraid-api/tag/PR1517/dynamix.unraid.net.plg