fix: patch version override logic incorrect

[elibosley]

Summary by CodeRabbit

• Bug Fixes
  • Improved the system’s version update mechanism so that updates are applied only when the current system version matches the expected version. This enhancement ensures more consistent and reliable version checks during the update process.

[coderabbitai]

Walkthrough

The changes update the logic for determining the patch version in two plugin files. Both the ServerState class constructor in dynamix.my.servers/include/state.php and the patcher check in dynamix.plugin.manager/include/UnraidCheck.php now perform a conditional comparison. They first read the desired unraid version from a JSON file and then check it against the unraid version provided by an INI file. The combined version is assigned to the patcher version only if the versions match. No alterations were made to public entity declarations.

Changes

Files	Change Summary
plugin/source/dynamix.unraid.net/.../dynamix.my.servers/include/state.php plugin/source/dynamix.unraid.net/.../dynamix.plugin.manager/include/UnraidCheck.php	Updated the logic for setting patcherVersion: both files now compare the unraidVersion from the JSON (or patches.json) against the version from the INI file, assigning the combined version only when the versions match.

Sequence Diagram(s)

sequenceDiagram
  participant C as ServerState Constructor
  participant J as JSON Data
  participant I as INI File
  C->>J: Read JSON data (unraidVersion, combinedVersion)
  C->>I: Retrieve current unraid version
  alt Versions match
      C->>C: Set patcherVersion = combinedVersion
      C->>C: Assign patcherVersion to version property
  else Versions mismatch
      C->>C: Skip version update
  end

Loading

sequenceDiagram
  participant U as UnraidCheck Flow
  participant J as JSON Data (patches.json)
  participant I as INI File
  U->>I: Get current unraid version
  U->>J: Read JSON data (unraidVersion, combinedVersion)
  alt Versions match
      U->>U: Assign patcherVersion = combinedVersion
  else Versions mismatch
      U->>U: Do not update patcherVersion
  end

Loading

Possibly related PRs

• unraid/webgui-patches#280: Alters the patcherVersion assignment logic under similar conditions in the web GUI patches.
• feat: use patch version if needed on update check #1227: Adjusts the logic for setting patcherVersion based on version compatibility, directly relating to similar checks in these changes.

Suggested reviewers

• zackspear
• pujitm

Poem

In lines of code a change is born,
Where versions meet the check at dawn,
A JSON call, an INI reply,
Together they validate and fly, 🚀
A patcher’s tune in perfect form.

Cheers to logic sharply spun!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 78cfe9a and 5f5855b.

📒 Files selected for processing (2)

• plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/state.php (1 hunks)
• plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.plugin.manager/include/UnraidCheck.php (1 hunks)

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

• GitHub Check: Build and Deploy Plugin
• GitHub Check: Cloudflare Pages

🔇 Additional comments (2)

plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.plugin.manager/include/UnraidCheck.php (1)

122-125: Good enhancement to version validation logic

The change properly verifies that the patcher version is only used when the unraid version from patches.json matches the actual installed version from the INI file. This prevents incorrect version overrides that could lead to update check issues.

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

99-110: Proper fix for patch version override logic

This implementation correctly validates the patcher version before using it. The code now:

1. Initializes patcherVersion to null
2. Reads both version sources
3. Only uses the combinedVersion when there's a version match
4. Includes a helpful comment explaining the purpose

The fix ensures consistent version handling across the application and prevents incorrect version reporting.

---

🪧 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 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 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/PR1275/dynamix.unraid.net.plg