feat: add graphql resource for API plugins

[pujitm]

Addresses #1350

Summary by CodeRabbit

• New Features

  • Introduced a plugin management system, allowing users to view, add, and remove plugins through the API.
  • Added the ability to control plugin installation options, including bundled installation and API restart behavior.

• Removals

  • Removed all remote access, network, and cloud-related features and settings from the API.

• Improvements

  • Enhanced API queries and mutations to focus on plugin management and metadata.

[coderabbitai]

Walkthrough

This change removes all GraphQL schema types, enums, inputs, and queries/mutations related to remote access, connect, network, and cloud features. In their place, a new plugin management system is introduced, including types, queries, and mutations for listing, adding, and removing plugins, along with supporting backend models, resolver, and service updates.

Changes

File(s)	Change Summary
api/generated-schema.graphql	Removed all remote access, connect, network, and cloud types/fields; added plugin management types, queries, and mutations.
api/src/unraid-api/plugin/plugin.model.ts	Added Plugin object type and PluginManagementInput input type for plugin management in GraphQL.
api/src/unraid-api/plugin/plugin.module.ts	Registered the new PluginResolver in the plugin module.
api/src/unraid-api/plugin/plugin.resolver.ts	Introduced PluginResolver providing queries and mutations for plugin listing, addition, and removal.
api/src/unraid-api/plugin/plugin.service.ts	Updated plugin import logic to include name/version; refactored type definitions for plugin metadata.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQL API
    participant PluginResolver
    participant PluginService
    participant LifecycleService

    Client->>GraphQL API: mutation addPlugin(input)
    GraphQL API->>PluginResolver: addPlugin(input)
    PluginResolver->>PluginService: addPlugins(names, bundled)
    PluginService-->>PluginResolver: (success)
    PluginResolver->>LifecycleService: restartApi() (if restart=true)
    LifecycleService-->>PluginResolver: (restart scheduled)
    PluginResolver-->>GraphQL API: Boolean (manual restart needed?)
    GraphQL API-->>Client: Boolean

Loading

sequenceDiagram
    participant Client
    participant GraphQL API
    participant PluginResolver
    participant PluginService

    Client->>GraphQL API: query plugins
    GraphQL API->>PluginResolver: plugins()
    PluginResolver->>PluginService: getPlugins()
    PluginService-->>PluginResolver: [Plugin]
    PluginResolver-->>GraphQL API: [Plugin]
    GraphQL API-->>Client: [Plugin]

Loading

Suggested reviewers

• mdatelle
• elibosley
• zackspear

Poem

Out with the old, remote access no more,
In comes the plugins, a bright, shiny door!
Add or remove, with a simple request,
Restart if you wish, for a system refreshed.
The schema is lighter, the codebase is clean—
Plugin power unlocked, let’s see what that means!
🚀✨

✨ 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

api/src/unraid-api/plugin/plugin.model.ts (2)

20-28: Consider validating & typing names and bundled more defensively

1. names!: string[] accepts an empty array. Down-stream services (addPlugin / removePlugin) probably expect at least one element; add a simple length check or leverage class-validator (@ArrayNotEmpty()) to fail fast.
2. bundled!: boolean; is marked non-nullable even though GraphQL supplies a default value. Using bundled?: boolean (optional) makes the TS shape match the runtime reality and avoids unsafe !.

-    names!: string[];
+    @ArrayNotEmpty()
+    names!: string[];

-    bundled!: boolean;
+    bundled?: boolean;

---

30-35: Same comment for restart flag

restart!: boolean can safely be optional because GraphQL will fill the default.
Keeping the ! forces callers in TS land to always provide it, which is at odds with the schema.

-    restart!: boolean;
+    restart?: boolean;

api/src/unraid-api/plugin/plugin.resolver.ts (2)

54-67: Edge-case: empty names silently succeeds

addPlugin returns true/false even when input.names is [], doing no work.
Given the permission requirement this is probably unintended – reject the call early to surface misuse.

+        if (input.names.length === 0) {
+            throw new Error('At least one plugin name must be provided');
+        }

---

90-95: Same empty-list guard for removePlugin

Mirror the check added to addPlugin for consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6c4ee6 and bb4dd04.

📒 Files selected for processing (5)

• api/generated-schema.graphql (5 hunks)
• api/src/unraid-api/plugin/plugin.model.ts (1 hunks)
• api/src/unraid-api/plugin/plugin.module.ts (2 hunks)
• api/src/unraid-api/plugin/plugin.resolver.ts (1 hunks)
• api/src/unraid-api/plugin/plugin.service.ts (2 hunks)

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

• GitHub Check: Build Web App
• GitHub Check: Build Unraid UI Library (Webcomponent Version)
• GitHub Check: Test API
• GitHub Check: Build API
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Cloudflare Pages

🔇 Additional comments (3)

api/src/unraid-api/plugin/plugin.module.ts (1)

26-27: LGTM – resolver wired in correctly

PluginResolver is now part of the providers array; dependency graph stays coherent and there’s no duplicate binding.

api/src/unraid-api/plugin/plugin.service.ts (1)

31-40: Throwing inside the batch worker may break partial-load guarantees

batchProcess is later inspected via errorOccured, implying it’s meant to collect errors without aborting the whole batch.
However the worker callback re-throws, so its Promise rejects – depending on batchProcess’ implementation that might short-circuit and never return the aggregated structure.

If the intent is “load what you can, skip invalid plugins”, remove the throw and just return undefined (or similar) so batchProcess can flag it.

-                await notificationService.createNotification({ ... });
-                throw error;
+                await notificationService.createNotification({ ... });
+                return undefined; // let batchProcess mark failure without bubbling

Confirm batchProcess behaviour or adjust accordingly.

api/generated-schema.graphql (1)

1575-1588: Schema ↔️ Type mismatch risk

The input fields bundled and restart are declared Boolean! with defaults.
Unless you switch to optional properties in the TS PluginManagementInput class (see earlier comment), TS callers will still be forced to pass them explicitly, defeating the purpose of defaults. Keep the two representations in sync.

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