fix: SSO not being detected

[elibosley]

Summary by CodeRabbit

• Bug Fixes
  • Improved reliability of Single Sign-On (SSO) status detection, ensuring the SSO state is always correctly set regardless of plugin status.

[coderabbitai]

Walkthrough

The initialization of the ssoEnabled property in the ServerState class has been moved from the getMyServersCfgValues() method to the class constructor. Now, ssoEnabled is set during object construction using ApiUserConfig::isSSOEnabled(), making its value independent of the connect plugin's status.

Changes

Cohort / File(s)	Change Summary
ServerState SSO Initialization Refactor plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/state.php	Moved ssoEnabled property initialization from getMyServersCfgValues() to the constructor, ensuring it is always set via ApiUserConfig::isSSOEnabled(). No other logic was changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~6 minutes

Poem

A bunny hopped through PHP code,
Shifting SSO to lighten the load.
Now initialized from the start,
No plugin check to play its part.
With every hop, the code’s more bright—
SSO enabled, always right!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 5449e30 and 93e515d.

📒 Files selected for processing (1)

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

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: elibosley
PR: unraid/api#1063
File: web/components/SsoButton.ce.vue:5-8
Timestamp: 2025-01-27T14:31:42.305Z
Learning: In the Unraid API web components, SSO-related props are intentionally provided in both camelCase (`ssoEnabled`) and lowercase (`ssoenabled`) variants to support interchangeable usage across different contexts (e.g., HTML attributes vs Vue props).

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

Learnt from: elibosley
PR: #1063
File: web/components/SsoButton.ce.vue:5-8
Timestamp: 2025-01-27T14:31:42.305Z
Learning: In the Unraid API web components, SSO-related props are intentionally provided in both camelCase (ssoEnabled) and lowercase (ssoenabled) variants to support interchangeable usage across different contexts (e.g., HTML attributes vs Vue props).

Learnt from: pujitm
PR: #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.

🔇 Additional comments (1)

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

133-134: Excellent architectural improvement for SSO detection reliability.

Moving SSO initialization to the constructor ensures that SSO state is determined independently of the connect plugin status. This addresses the core issue where SSO wouldn't be detected if the connect plugin was disabled, as the previous initialization only occurred within getMyServersCfgValues() which required the plugin to be enabled.

The change is minimal, well-commented, and maintains the existing API contract while improving reliability.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/sso-issue-in-api

---

🪧 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 generate unit tests to generate unit tests for 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.

[claude]

Claude finished @elibosley's task —— View job

---

Pull Request Review

Reviewing PR: fix: SSO not being detected

Todo List:

• Read changed file to understand modifications
• Analyze code quality and best practices
• Check for potential bugs or issues
• Review performance considerations
• Assess security concerns
• Evaluate test coverage needs
• Provide comprehensive feedback

Changes Overview

The fix moves SSO state initialization from setConnectValues() method to the main constructor. This ensures SSO detection works even when the connect plugin is disabled.

Specific Changes:

• Moved $this->ssoEnabled = ApiUserConfig::isSSOEnabled(); from line 204 in setConnectValues() to line 134 in __construct()
• Added explanatory comment: "Initialize SSO state regardless of connect plugin status"

Review Feedback

✅ Positive Aspects

• Root Cause Fix: Addresses the core issue where SSO wasn't detected when connect plugin was disabled due to early return in setConnectValues()
• Clear Documentation: The added comment clearly explains the intent behind the change
• Logical Placement: Constructor is the appropriate place for initialization that should happen regardless of plugin status
• Minimal Impact: Small, focused change that doesn't introduce unnecessary complexity

🔍 Code Quality Assessment

• Good: Clean, readable code with clear intent
• Good: Follows existing code patterns and style
• Good: No magic numbers or unclear logic introduced

🐛 Bug Analysis

• Fixed Bug: The original bug where ssoEnabled would remain false when connect plugin was disabled
• No New Bugs: The change doesn't introduce any new potential issues
• Dependency Safety: ApiUserConfig::isSSOEnabled() is called safely in the constructor context

⚡ Performance Considerations

• Negligible Impact: Moving one method call has no meaningful performance impact
• No Regression: No additional file I/O or expensive operations introduced

🔒 Security Assessment

• No Security Issues: Change maintains existing security posture
• Authentication Logic Unchanged: Only affects detection/reporting of SSO status, not actual authentication

🧪 Test Coverage Recommendations

Consider adding tests to verify:

• SSO is detected when connect plugin is enabled
• SSO is detected when connect plugin is disabled
• ssoEnabled property is correctly set in both scenarios

Overall Assessment

✅ APPROVED - This is a well-implemented bug fix that addresses the SSO detection issue cleanly and safely. The change is minimal, well-documented, and follows good practices.

---

[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/PR1546/dynamix.unraid.net.plg