chore: replace graphql server #1875

pujitm · 2026-01-14T21:40:44Z

Summary by CodeRabbit

New Features
- Adds an Unraid Core service with startup/shutdown integration and installer support to manage core alongside the API.
- Service lifecycle script enabling start/stop/restart/status for the Unraid Phoenix application.
Behavior Changes
- GraphQL proxy now routes to the Unraid Core backend.
Bug Fixes
- Improved remote-access verification to validate configuration before enabling WAN access.
Tests
- Simplified SSO/authentication test suite by removing redundant edge cases.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-14T21:40:56Z

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 861c49d and 2a31900.

📒 Files selected for processing (10)

api/src/unraid-api/unraid-file-modifier/modifications/__test__/snapshots/rc.nginx.modified.snapshot
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patch
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
plugin/plugins/dynamix.unraid.net.plg
plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid
plugin/source/dynamix.unraid.net/etc/rc.d/rc6.d/K30unraid-core
plugin/source/dynamix.unraid.net/install/doinst.sh
plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh
web/__test__/components/SsoButton.test.ts
web/src/components/sso/useSsoAuth.ts

 __________________________________________________
< Veni, Vidi, Validavi. I came, I saw, I reviewed. >
 --------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

_{✏️ Tip: You can disable in-progress messages by setting review_status to false in your review settings. Additionally, you can disable the fortune message by setting in_progress_fortune to false in your review settings.}

Tip

You can get early access to new features in CodeRabbit.

Enable the early_access setting in your project's settings in CodeRabbit to enable early access features such as new models, tools, and more.

Walkthrough

This PR adds Unraid Core service management and packaging, routes /graphql through the core socket instead of the API socket, updates installation and shutdown scripts to manage the core, and simplifies SSO by removing client-side state token handling.

Changes

Cohort / File(s)	Summary
Core package plugin changes `plugin/plugins/dynamix.unraid.net.plg`, `plugin/source/dynamix.unraid.net/install/doinst.sh`	Adds core package metadata and installation/upgrade/uninstall logic to the PLG; applies install permissions for core shutdown script in doinst.sh; integrates core lifecycle steps with API install flow.
Core runtime scripts `plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid`, `plugin/source/dynamix.unraid.net/etc/rc.d/rc6.d/K30unraid-core`	Adds rc.unraid service script to manage the Unraid Phoenix app (start/stop/status/restart/rollback) and a shutdown symlink script to stop the core during shutdown.
Install verification updates `plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh`	Adds checks and messaging for the new core shutdown script and updates critical file/dir checks and shutdown error accounting.
Nginx rc patch / modifier `api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patch`, `api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts`, `api/src/unraid-api/unraid-file-modifier/modifications/__test__/snapshots/rc.nginx.modified.snapshot`	Changes `/graphql` proxy_pass from `unraid-api.sock` to `unraid-core.sock`; introduces `check_remote_access()` and new globals (`CONNECT_CONFIG`, `API_UTILS`); adjusts NET_FQDN iteration quoting and related logic.
SSO/client auth changes & tests `web/src/components/sso/useSsoAuth.ts`, `web/__test__/components/SsoButton.test.ts`	Removes client-side CSRF/state token generation and sessionStorage use; simplifies navigate flow to redirect to `/auth/sso/{providerId}`; reduces and simplifies related tests to expect fixed redirect behavior.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant Nginx
  participant UnraidCore
  participant UnraidAPI

  Client->>Nginx: HTTP POST /graphql
  Nginx->>UnraidCore: proxy_pass to unraid-core.sock
  UnraidCore->>UnraidAPI: (optional) internal call to API service/socket
  UnraidAPI-->>UnraidCore: API response
  UnraidCore-->>Nginx: GraphQL response
  Nginx-->>Client: HTTP response

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Poem

🐰
I hopped through sockets, patches, and plg,
Core and API now dance in a jig,
No state to stash, the flow is lean,
Shutdowns tidy, installations clean,
A little rabbit cheers the new routine.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title 'chore: replace graphql server' is vague and does not accurately capture the scope of changes, which extends far beyond just replacing a GraphQL server.	Consider a more specific title that reflects the main objectives, such as 'feat: integrate Unraid Core service alongside API' or 'chore: refactor authentication and service architecture'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2026-01-14T21:46:49Z

Codecov Report

❌ Patch coverage is 90.90909% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 46.39%. Comparing base (38a6f0c) to head (2a31900).

Files with missing lines	Patch %	Lines
...le-modifier/modifications/rc-nginx.modification.ts	85.71%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1875      +/-   ##
==========================================
- Coverage   46.40%   46.39%   -0.02%     
==========================================
  Files         954      954              
  Lines       59791    59770      -21     
  Branches     5538     5530       -8     
==========================================
- Hits        27749    27731      -18     
+ Misses      31923    31920       -3     
  Partials      119      119

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coderabbitai

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@plugin/plugins/dynamix.unraid.net.plg`:
- Around line 333-346: Replace the broad glob "unraid-*" used when setting
core_pkg_installed with a version-specific pattern or filter to avoid matching
unrelated packages: update the ls/grep invocation that assigns
core_pkg_installed to only match names like "unraid-" followed by a digit (e.g.,
use "unraid-[0-9]*" or pipe through grep -E '^unraid-[0-9]') so
core_pkg_installed and core_pkg_basename resolve to the actual core package name
and removepkg --terse is invoked only for that package.

In `@plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid`:
- Around line 67-79: The rollback() function currently does rm -rf
/usr/local/unraid then mv /usr/local/unraid.prev /usr/local/unraid which is not
atomic and can leave the system without an installation if mv fails; change to a
safer three-step swap: rename the current dir to a temp backup (e.g., mv
/usr/local/unraid /usr/local/unraid.tmp), then mv /usr/local/unraid.prev to
/usr/local/unraid, and only after verifying that succeeds remove the temp
backup; ensure each mv is checked for failure and on any error attempt to
restore from the temp backup and return a non-zero exit code so rollback is
atomic and recoverable, updating the rollback() function and its error handling
accordingly.

🧹 Nitpick comments (5)

web/src/components/sso/useSsoAuth.ts (1)
91-93: Guard placement has no effect - consider moving to function start.

This guard at the end of the try block is a no-op: if a token or error exists, the function already returned at lines 76 or 88. If neither exists, there's no code after this guard anyway.

If the intent is to restrict OAuth callback processing to the login page only, move this guard to the beginning of handleOAuthCallback:
♻️ Suggested refactor
 const handleOAuthCallback = async () => {
+  if (window.location.pathname !== '/login') {
+    return;
+  }
+
   try {
     // First check hash parameters (for token and error - keeps them out of server logs)
     const hashParams = new URLSearchParams(window.location.hash.slice(1));
     ...
-    if (window.location.pathname !== '/login') {
-      return;
-    }
   } catch (err) {
plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid (2)
25-26: Minor: Simplify command substitution.

Line 26 uses an unnecessary cat pipe. Consider simplifying:
 export SECRET_KEY_BASE=$(cat "$CONFIG_DIR/secret_key_base")
-export RELEASE_COOKIE=$(cat "$CONFIG_DIR/secret_key_base" | head -c 20)
+export RELEASE_COOKIE=$(head -c 20 "$CONFIG_DIR/secret_key_base")
81-88: Unknown commands should exit with non-zero status.

When an invalid command is passed, the script shows usage but exits with status 0 (implicit). Consider exiting with non-zero for unknown commands:
 case "${1:-}" in
     start)    start ;;
     stop)     stop ;;
     restart)  restart ;;
     status)   status ;;
     rollback) rollback ;;
-    *)        echo "Usage: $0 {start|stop|restart|status|rollback}" ;;
+    *)        echo "Usage: $0 {start|stop|restart|status|rollback}"; exit 1 ;;
 esac
plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh (1)
219-219: Trailing whitespace.

Line 219 has trailing whitespace after fi. Consider removing it for consistency.
-fi 
+fi
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts (1)
98-105: Clarify why OS version check is disabled.

The change to pass { checkOsVersion: false } removes version gating for this modification. Consider adding a brief comment explaining why this modification should apply to all versions, given the class docstring mentions "< Unraid 7.2.0".
  async shouldApply(): Promise<ShouldApplyWithReason> {
+       // Apply to all versions as core socket routing is needed regardless of OS version
        const { shouldApply, reason } = await super.shouldApply({ checkOsVersion: false });

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 230e0cd and 861c49d.

📒 Files selected for processing (10)

api/src/unraid-api/unraid-file-modifier/modifications/__test__/snapshots/rc.nginx.modified.snapshot
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patch
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
plugin/plugins/dynamix.unraid.net.plg
plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid
plugin/source/dynamix.unraid.net/etc/rc.d/rc6.d/K30unraid-core
plugin/source/dynamix.unraid.net/install/doinst.sh
plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh
web/__test__/components/SsoButton.test.ts
web/src/components/sso/useSsoAuth.ts

🚧 Files skipped from review as they are similar to previous changes (4)

web/test/components/SsoButton.test.ts
plugin/source/dynamix.unraid.net/install/doinst.sh
plugin/source/dynamix.unraid.net/etc/rc.d/rc6.d/K30unraid-core
api/src/unraid-api/unraid-file-modifier/modifications/test/snapshots/rc.nginx.modified.snapshot

🧰 Additional context used

📓 Path-based instructions (7)

**/*

📄 CodeRabbit inference engine (.cursor/rules/default.mdc)

Never add comments unless they are needed for clarity of function

Files:

plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid
web/src/components/sso/useSsoAuth.ts
plugin/plugins/dynamix.unraid.net.plg
plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/verify_install.sh
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patch

**/*.{ts,tsx,js,jsx}