feat: add ups monitoring to graphql api #1526

elibosley · 2025-07-21T13:48:24Z

Summary by CodeRabbit

New Features
- Introduced UPS management capabilities, including queries and mutations for UPS device status, configuration, and live updates via GraphQL.
- Added support for configuring UPS parameters such as service state, cable type, communication protocol, shutdown thresholds, and power control options.
- Provided detailed UPS device information including battery, power, and operational status.
Tests
- Added comprehensive tests for UPS resolver and service logic, covering configuration, event publishing, killpower functionality, and error handling.

coderabbitai · 2025-07-21T13:48:31Z

Walkthrough

This change introduces a new UPS (Uninterruptible Power Supply) management feature to the GraphQL API. It adds input types, models, a resolver, a service for UPS configuration and status retrieval, and comprehensive tests for both the resolver and service. The UPS module is registered in the main resolver module.

Changes

File(s)	Change Summary
UPS GraphQL Inputs `api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts`	Adds GraphQL input type `UPSConfigInput` and enums for UPS configuration parameters with validation and documentation.
UPS GraphQL Models `api/src/unraid-api/graph/resolvers/ups/ups.model.ts`	Defines GraphQL object types for UPS battery, power, device, and configuration with detailed field descriptions.
UPS GraphQL Resolver `api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts`	Implements `UPSResolver` with queries, mutation, and subscription for UPS devices and configuration management.
UPS GraphQL Resolver Tests `api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts`	Adds tests for `UPSResolver` covering queries, mutation, and subscription behavior with mocks for service and PubSub.
UPS Service Implementation `api/src/unraid-api/graph/resolvers/ups/ups.service.ts`	Implements `UPSService` for UPS status retrieval via system command, configuration merging, validation, and system control.
UPS Service Tests `api/src/unraid-api/graph/resolvers/ups/ups.service.spec.ts`	Adds tests for `UPSService` focusing on configuration merging, validation, killpower hook management, backups, and errors.
UPS Module Declaration `api/src/unraid-api/graph/resolvers/ups/ups.module.ts`	Declares the `UPSModule` with providers for resolver, service, and PubSub instance.
Resolvers Module Update `api/src/unraid-api/graph/resolvers/resolvers.module.ts`	Registers `UPSModule` in the main resolvers module imports array.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQL API
    participant UPSResolver
    participant UPSService
    participant PubSub

    Client->>GraphQL API: Query upsDevices
    GraphQL API->>UPSResolver: upsDevices()
    UPSResolver->>UPSService: getUPSData()
    UPSService-->>UPSResolver: UPSData
    UPSResolver-->>GraphQL API: [UPSDevice]

    Client->>GraphQL API: Mutation configureUps(config)
    GraphQL API->>UPSResolver: configureUps(config)
    UPSResolver->>UPSService: configureUPS(config)
    UPSService-->>UPSResolver: (void)
    UPSResolver->>UPSService: getUPSData()
    UPSService-->>UPSResolver: UPSData
    UPSResolver->>PubSub: publish('upsUpdates', UPSDevice)
    UPSResolver-->>GraphQL API: true

    Client->>GraphQL API: Subscription upsUpdates
    GraphQL API->>UPSResolver: upsUpdates()
    UPSResolver->>PubSub: asyncIterator('upsUpdates')
    PubSub-->>GraphQL API: UPSDevice (on update)

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

feat: code first graphql #1347: Migrates the GraphQL API to code-first approach, which is foundational for the UPS module's code-first GraphQL implementation.

Poem

🐇⚡ Hopping in with power bright,
UPS commands take flight tonight!
Models, inputs, services too,
Keeping your data safe and true.
GraphQL hums, the circuits sing,
With every test, a joyful spring!
🔋🌿

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 c1f1eb8 and a0f519c.

📒 Files selected for processing (8)

api/src/unraid-api/graph/resolvers/resolvers.module.ts (2 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.model.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.module.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.service.spec.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.service.ts (1 hunks)

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

api/src/unraid-api/graph/resolvers/resolvers.module.ts
api/src/unraid-api/graph/resolvers/ups/ups.module.ts
api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts
api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts
api/src/unraid-api/graph/resolvers/ups/ups.service.spec.ts
api/src/unraid-api/graph/resolvers/ups/ups.model.ts
api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts

🧰 Additional context used

📓 Path-based instructions (2)

api/**/*

📄 CodeRabbit Inference Engine (.cursor/rules/api-rules.mdc)

api/**/*: Use pnpm as the only package manager
Always run scripts from api/package.json unless specifically requested otherwise

Files:

api/src/unraid-api/graph/resolvers/ups/ups.service.ts

api/src/unraid-api/**/*

📄 CodeRabbit Inference Engine (.cursor/rules/api-rules.mdc)

Prefer adding new files to the NestJS repository located at api/src/unraid-api/ instead of the legacy code

Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

Files:

api/src/unraid-api/graph/resolvers/ups/ups.service.ts

🧠 Learnings (2)

📓 Common learnings

Learnt from: mdatelle
PR: unraid/api#942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in `api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts`, methods like `removeRoleFromApiKey` rely on service-level error handling.

Learnt from: elibosley
PR: unraid/api#942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

Learnt from: pujitm
PR: unraid/api#1211
File: api/src/graphql/schema/types/connect/connect.graphql:142-146
Timestamp: 2025-03-14T16:10:38.562Z
Learning: The updateApiSettings mutation in api/src/unraid-api/graph/connect/connect.resolver.ts is protected with the @UsePermissions decorator that requires UPDATE permission on the CONFIG resource.

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (19)

Learnt from: pujitm
PR: #1367
File: packages/unraid-api-plugin-connect/src/pubsub/user.service.ts:44-52
Timestamp: 2025-04-23T20:19:42.542Z
Learning: The project uses a custom or extended implementation of NestJS ConfigService that includes a set() method for runtime configuration mutation, unlike the standard @nestjs/config package which only provides getter methods.

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/api-rules.mdc:0-0
Timestamp: 2025-07-21T14:00:06.258Z
Learning: Applies to api/src/unraid-api/**/* : Prefer adding new files to the NestJS repository located at api/src/unraid-api/ instead of the legacy code

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-28T15:34:24.715Z
Learning: Applies to api/src/unraid-api/**/* : Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/auth/api-key.service.ts:62-70
Timestamp: 2024-11-05T14:49:07.308Z
Learning: In api/src/unraid-api/auth/api-key.service.ts, when handling read errors in the findById method, throw a GraphQLError instead of an InternalServerErrorException.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts, methods like removeRoleFromApiKey rely on service-level error handling.

Learnt from: pujitm
PR: #1252
File: api/src/environment.ts:56-56
Timestamp: 2025-03-27T13:34:53.438Z
Learning: For critical components in the Unraid API, such as retrieving version information from package.json, failing fast (allowing crashes) is preferred over graceful degradation with fallback values.

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-07-21T14:01:04.139Z
Learning: Applies to web/test/store/**/*.ts : Verify proper error handling in store tests

Learnt from: elibosley
PR: #1063
File: api/src/unraid-api/cli/sso/validate-token.command.ts:76-81
Timestamp: 2025-01-23T21:26:17.766Z
Learning: In the unraid/api codebase, store dispatches using Redux Toolkit's unwrap() method already handle errors appropriately and don't require additional try-catch blocks.

Learnt from: pujitm
PR: #1219
File: api/src/unraid-api/main.ts:18-25
Timestamp: 2025-03-07T19:29:12.540Z
Learning: When handling type mismatches between dependencies in TypeScript (such as between NestJS and Fastify), prefer using @ts-expect-error with a detailed explanation comment instead of as any type assertions. This better documents the reason for the type bypass and makes the issue more visible for future maintenance.

Learnt from: pujitm
PR: #1352
File: api/src/unraid-api/cli/dependency.service.ts:114-117
Timestamp: 2025-04-21T18:25:16.491Z
Learning: Methods in DependencyService like npmInstall and rebuildVendorArchive intentionally propagate errors from execa calls upward rather than handling them internally, allowing callers to implement appropriate error handling. This follows the pattern documented in the rebuildVendorArchive method's docstring.

Learnt from: elibosley
PR: #1120
File: plugin/plugins/dynamix.unraid.net.plg:35-38
Timestamp: 2025-02-05T21:10:48.136Z
Learning: When providing error handling guidance for Unraid plugins, direct users to use the web GUI (Plugins > Installed Plugins) rather than suggesting command-line actions.

Learnt from: pujitm
PR: #1075
File: web/components/Notifications/Sidebar.vue:41-58
Timestamp: 2025-01-31T14:42:06.752Z
Learning: When handling errors in code that uses toast notifications, avoid using toast in the error handler itself since toast functionality might be the source of the error. Use console.error or other reliable logging mechanisms instead.

Learnt from: pujitm
PR: #1075
File: unraid-ui/src/register.ts:15-34
Timestamp: 2025-01-30T19:38:02.478Z
Learning: In the web components registration process for unraid-ui, use a soft-fail approach (logging warnings/errors) instead of throwing errors, to ensure other components can still register successfully even if one component fails.

Learnt from: elibosley
PR: #1082
File: api/src/unraid-api/unraid-file-modifier/modifications/log-rotate.modification.ts:33-37
Timestamp: 2025-01-29T16:36:04.777Z
Learning: The UnraidFileModifierService in the Unraid API provides comprehensive error handling for all FileModification implementations. It includes try/catch blocks, detailed error logging, and safe rollback mechanisms. Individual FileModification implementations (like LogRotateModification) should allow errors to propagate to this service layer rather than handling them internally.

Learnt from: pujitm
PR: #1211
File: api/src/graphql/schema/types/connect/connect.graphql:142-146
Timestamp: 2025-03-14T16:10:38.562Z
Learning: The updateApiSettings mutation in api/src/unraid-api/graph/connect/connect.resolver.ts is protected with the @UsePermissions decorator that requires UPDATE permission on the CONFIG resource.

Learnt from: elibosley
PR: #1425
File: api/dev/configs/connect.json:2-3
Timestamp: 2025-06-20T21:05:24.582Z
Learning: When reviewing configuration files in refactoring PRs, avoid suggesting field name changes that could break compatibility with existing code that references those fields, even if the naming doesn't follow ideal conventions.

Learnt from: elibosley
PR: #1082
File: api/src/unraid-api/unraid-file-modifier/modifications/log-rotate.modification.ts:39-41
Timestamp: 2025-01-29T16:35:43.699Z
Learning: The UnraidFileModifierService in the Unraid API provides comprehensive error handling for all FileModification implementations, including detailed error logging with stack traces and modification IDs. Individual FileModification implementations should focus on their core functionality without duplicating error handling.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/auth/auth.service.ts:0-0
Timestamp: 2024-11-04T20:44:46.432Z
Learning: When modifying apiKey.roles in removeRoleFromApiKey and addRoleToApiKey within api/src/unraid-api/auth/auth.service.ts, concurrency issues are not a concern because the keys are stored in the file system.

Learnt from: pujitm
PR: #1367
File: packages/unraid-api-plugin-connect/src/pubsub/user.service.ts:44-52
Timestamp: 2025-04-23T20:19:42.542Z
Learning: The project uses a custom ConfigService implementation that includes a set() method for runtime configuration mutation, unlike the standard @nestjs/config package which only provides getter methods.

🔇 Additional comments (14)

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (14)

1-40: Well-structured imports and schema definitions.

The imports are appropriate for a NestJS service, using secure command execution with execa and proper validation with Zod schemas. The optional field definitions provide good flexibility for UPS data that may vary across different UPS models.

41-46: Proper NestJS service setup with testing considerations.

Good use of NestJS patterns with @Injectable decorator, proper Logger injection, and pragmatic approach to making rc6Path non-readonly for testing flexibility.

47-64: Excellent error handling and command execution robustness.

This method properly addresses previous review feedback with:

Timeout to prevent hanging on unresponsive UPS

Validation of command output before parsing

Proper logging service usage

Comprehensive error handling with context preservation

66-90: Well-designed configuration method with atomic operations.

Excellent breakdown into logical steps with proper error handling. The atomic operation pattern (stop → configure → conditionally start) ensures system consistency, and the comprehensive error handling provides good visibility into failures.

92-114: Sound configuration merging and validation logic.

The merging strategy with sensible defaults and the validation logic correctly handling UPS type requirements (non-USB types requiring device paths) demonstrates good understanding of UPS hardware configuration needs.

116-134: Appropriate service management with context-aware error handling.

Good differentiation in error handling: warning for stop failures (service may not be running) versus errors for start failures (indicates configuration problems). Timeouts prevent hanging operations.

136-166: Comprehensive configuration preparation with proper value preservation.

Well-handled logic for custom vs standard cables, appropriate preservation of existing configuration values, and proper handling of optional override capacity settings.

168-209: Robust backup and restore implementation with defensive error handling.

Excellent atomic write pattern with proper backup/restore mechanisms. The defensive error handling (warnings for backup failures, errors for restore failures) provides appropriate safety without blocking operations unnecessarily.

211-232: Well-designed kill power configuration with environment awareness.

Good conditional logic that only configures kill power when service is enabled, and graceful handling of missing rc.6 file for testing environments. The error handling properly distinguishes between different failure types.

234-272: Excellent RC6 file modification with idempotent operations.

Well-implemented file modification that checks if changes are needed before acting, preventing unnecessary operations. The comprehensive error handling and descriptive logging address previous review feedback effectively.

274-281: Clean utility method for optional file reading.

Simple and effective pattern for reading files that may not exist, with appropriate null return for failure cases.

283-295: Clean functional parsing with proper error tolerance.

Good use of functional programming patterns to parse UPS data with appropriate filtering of malformed lines. The approach handles the apcaccess output format well.

297-313: Robust configuration reading with appropriate fallbacks.

Good error handling that allows operation to continue with empty configuration when files don't exist, while still providing comprehensive error context for actual read failures.

315-386: Comprehensive configuration parsing and generation.

Excellent handling of apcupsd configuration format with proper comment filtering, numeric conversion, quote handling, and ordered directive generation. The methods correctly preserve existing configuration while updating specified values.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feature/ups-monitoring

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

coderabbitai

Actionable comments posted: 9

🧹 Nitpick comments (1)

api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (1)
1-1: Remove unused imports.

The Int and Float imports are not used in this file.

Apply this diff to clean up the imports:
-import { Field, InputType, Int, Float } from '@nestjs/graphql';
+import { Field, InputType } from '@nestjs/graphql';

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1a8da6d and 6758778.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (7)

api/src/unraid-api/graph/resolvers/resolvers.module.ts (2 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.model.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.module.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.service.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (8)

📓 Common learnings

Learnt from: mdatelle
PR: unraid/api#942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in `api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts`, methods like `removeRoleFromApiKey` rely on service-level error handling.

Learnt from: elibosley
PR: unraid/api#942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

api/src/unraid-api/graph/resolvers/resolvers.module.ts (10)

Learnt from: elibosley
PR: #1408
File: web/components/ApiKey/PermissionCounter.vue:6-6
Timestamp: 2025-05-23T21:59:29.632Z
Learning: This codebase uses ESM (ECMAScript Modules) and requires .js extensions in import statements, even when importing from TypeScript files, as the imports refer to the compiled JavaScript output.

Learnt from: elibosley
PR: #1308
File: unraid-ui/src/components/common/loading/Error.vue:2-2
Timestamp: 2025-04-02T21:21:29.168Z
Learning: Components in the unraid-ui folder require explicit imports and are not autoloaded, unlike other parts of the project that may use Nuxt.js autoloading features.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts, methods like removeRoleFromApiKey rely on service-level error handling.

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to web/store/**/*.{ts,js} : Ensure Vue reactivity imports are added to store files (computed, ref, watchEffect)

Learnt from: pujitm
PR: #1211
File: api/src/graphql/schema/types/connect/connect.graphql:142-146
Timestamp: 2025-03-14T16:10:38.562Z
Learning: The updateApiSettings mutation in api/src/unraid-api/graph/connect/connect.resolver.ts is protected with the @UsePermissions decorator that requires UPDATE permission on the CONFIG resource.

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to api/src/unraid-api/**/* : Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:87-89
Timestamp: 2024-11-06T20:59:06.096Z
Learning: Error handling in mutations like addRoleForUser in auth.resolver.ts is performed at the service level, so additional error handling in the resolver is unnecessary.

Learnt from: pujitm
PR: #1211
File: web/composables/gql/gql.ts:17-18
Timestamp: 2025-03-12T13:48:14.850Z
Learning: In the Unraid API project, the duplicate GraphQL query and mutation strings in gql.ts files are intentionally generated by GraphQL CodeGen tool and are necessary for the type system to function properly.

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: All GraphQL under web/ must follow this naming convention (.query.ts for queries, .mutation.ts for mutations)

api/src/unraid-api/graph/resolvers/ups/ups.module.ts (5)

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to api/src/unraid-api/**/* : Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

Learnt from: pujitm
PR: #1367
File: packages/unraid-api-plugin-connect/src/pubsub/user.service.ts:44-52
Timestamp: 2025-04-23T20:19:42.542Z
Learning: The project uses a custom or extended implementation of NestJS ConfigService that includes a set() method for runtime configuration mutation, unlike the standard @nestjs/config package which only provides getter methods.

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to **/*.test.ts : Use factory functions for module mocks to avoid hoisting issues in test files

Learnt from: elibosley
PR: #1211
File: api/src/unraid-api/graph/connect/connect-settings.service.ts:48-53
Timestamp: 2025-03-13T16:17:55.820Z
Learning: In NestJS services, dynamic imports should be wrapped in try/catch blocks with proper error logging and fallback handling to prevent unhandled rejections from crashing the application.

Learnt from: elibosley
PR: #1408
File: web/components/ApiKey/PermissionCounter.vue:6-6
Timestamp: 2025-05-23T21:59:29.632Z
Learning: This codebase uses ESM (ECMAScript Modules) and requires .js extensions in import statements, even when importing from TypeScript files, as the imports refer to the compiled JavaScript output.

api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (2)

Learnt from: pujitm
PR: #1211
File: web/composables/gql/gql.ts:17-18
Timestamp: 2025-03-12T13:48:14.850Z
Learning: In the Unraid API project, the duplicate GraphQL query and mutation strings in gql.ts files are intentionally generated by GraphQL CodeGen tool and are necessary for the type system to function properly.

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts (13)

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Verify state changes by updating the store in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Test getter dependencies are properly mocked in store tests

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to api/**/*.{test,spec}.{ts,js} : Test suite is VITEST, do not use jest in the API package

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/api-rules.mdc:0-0
Timestamp: 2025-06-30T14:50:52.281Z
Learning: Applies to api/**/*.{test,spec}.{js,ts,tsx} : Test suite is VITEST, do not use jest

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Test async operations completely in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Verify state changes after actions in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Mock external dependencies appropriately in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Verify proper error handling in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Override specific action implementations when needed in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to /test/store//*.ts : Test store interactions with other stores in store tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to **/*.test.ts : Mock external services and API calls in tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to **/*.test.ts : Mock external dependencies and services in tests

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-testing-rules.mdc:0-0
Timestamp: 2025-06-30T14:52:37.535Z
Learning: Applies to **/*.test.ts : Remember that vi.mock() calls are hoisted

api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts (10)

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts, methods like removeRoleFromApiKey rely on service-level error handling.

Learnt from: pujitm
PR: #1211
File: web/composables/gql/gql.ts:17-18
Timestamp: 2025-03-12T13:48:14.850Z
Learning: In the Unraid API project, the duplicate GraphQL query and mutation strings in gql.ts files are intentionally generated by GraphQL CodeGen tool and are necessary for the type system to function properly.

Learnt from: pujitm
PR: #1211
File: api/src/graphql/schema/types/connect/connect.graphql:142-146
Timestamp: 2025-03-14T16:10:38.562Z
Learning: The updateApiSettings mutation in api/src/unraid-api/graph/connect/connect.resolver.ts is protected with the @UsePermissions decorator that requires UPDATE permission on the CONFIG resource.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:87-89
Timestamp: 2024-11-06T20:59:06.096Z
Learning: Error handling in mutations like addRoleForUser in auth.resolver.ts is performed at the service level, so additional error handling in the resolver is unnecessary.

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: All GraphQL under web/ must follow this naming convention (.query.ts for queries, .mutation.ts for mutations)

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

Learnt from: pujitm
PR: #1352
File: packages/unraid-api-plugin-connect/src/connect.resolver.ts:14-24
Timestamp: 2025-04-21T18:04:56.755Z
Learning: Error handling in GraphQL resolvers: pujitm prefers to let errors bubble up naturally to the client rather than adding explicit try/catch blocks in each resolver method.

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-graphql.mdc:0-0
Timestamp: 2025-06-30T14:51:12.348Z
Learning: Applies to web/**/*.{query.ts,mutation.ts} : All GraphQL under web/ must follow this naming convention

Learnt from: CR
PR: unraid/api#0
File: .cursor/rules/web-graphql.mdc:0-0
Timestamp: 2025-06-30T14:51:12.348Z
Learning: Applies to web/**/*.mutation.ts : GraphQL mutations must be placed in .mutation.ts files

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to web/**/*.mutation.ts : GraphQL mutations must be placed in .mutation.ts files under web/

api/src/unraid-api/graph/resolvers/ups/ups.model.ts (6)

Learnt from: pujitm
PR: #1211
File: web/composables/gql/gql.ts:17-18
Timestamp: 2025-03-12T13:48:14.850Z
Learning: In the Unraid API project, the duplicate GraphQL query and mutation strings in gql.ts files are intentionally generated by GraphQL CodeGen tool and are necessary for the type system to function properly.

Learnt from: pujitm
PR: #1211
File: api/src/graphql/schema/types/connect/connect.graphql:142-146
Timestamp: 2025-03-14T16:10:38.562Z
Learning: The updateApiSettings mutation in api/src/unraid-api/graph/connect/connect.resolver.ts is protected with the @UsePermissions decorator that requires UPDATE permission on the CONFIG resource.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts, methods like removeRoleFromApiKey rely on service-level error handling.

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to api/src/unraid-api/**/* : Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: All GraphQL under web/ must follow this naming convention (.query.ts for queries, .mutation.ts for mutations)

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (5)

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:50:43.946Z
Learning: Applies to api/src/unraid-api/**/* : Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/auth/api-key.service.ts:62-70
Timestamp: 2024-11-05T14:49:07.308Z
Learning: In api/src/unraid-api/auth/api-key.service.ts, when handling read errors in the findById method, throw a GraphQLError instead of an InternalServerErrorException.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts, methods like removeRoleFromApiKey rely on service-level error handling.

Learnt from: pujitm
PR: #1367
File: packages/unraid-api-plugin-connect/src/pubsub/user.service.ts:44-52
Timestamp: 2025-04-23T20:19:42.542Z
Learning: The project uses a custom or extended implementation of NestJS ConfigService that includes a set() method for runtime configuration mutation, unlike the standard @nestjs/config package which only provides getter methods.

Learnt from: elibosley
PR: #1211
File: api/src/unraid-api/graph/connect/connect-settings.service.ts:48-53
Timestamp: 2025-03-13T16:17:55.820Z
Learning: In NestJS services, dynamic imports should be wrapped in try/catch blocks with proper error logging and fallback handling to prevent unhandled rejections from crashing the application.

🧬 Code Graph Analysis (2)

api/src/unraid-api/graph/resolvers/ups/ups.module.ts (1)

api/src/unraid-api/graph/resolvers/resolvers.module.ts (1)

Module (39-80)

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (1)

api/src/unraid-api/cli/log.service.ts (1)

error (46-50)

⏰ 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: Test API
GitHub Check: Build Web App
GitHub Check: Build API
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (6)

api/src/unraid-api/graph/resolvers/resolvers.module.ts (1)

30-30: LGTM! Proper module integration.

The UPS module is correctly imported and added to the imports array, maintaining alphabetical order and using proper ESM .js extensions.

Also applies to: 50-50

api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (1)

3-13: Well-structured GraphQL input type.

The UPS configuration input type is properly defined with clear field mappings.

api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts (1)

20-35: Good test setup with proper mocking.

The test module configuration correctly mocks the UPS service while maintaining proper dependency injection.

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (2)

8-18: Good use of Zod schema validation.

The schema definition properly validates UPS data structure with optional fields, which is appropriate for potentially missing UPS metrics.

33-43: Parsing logic handles apcaccess format correctly.

The line-by-line parsing with colon splitting properly handles the key-value format output by apcaccess.

api/src/unraid-api/graph/resolvers/ups/ups.model.ts (1)

1-46: Well-structured GraphQL models for UPS monitoring.

The object type definitions are clean and appropriately typed. The nested structure with UPSBattery and UPSPower provides good data organization for UPS device information.

api/src/unraid-api/graph/resolvers/ups/ups.module.ts

api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts

api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts

api/src/unraid-api/graph/resolvers/ups/ups.service.ts

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (1)

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (1)

23-32: Duplicate of previous review concerns.

The issues with timeout handling, logging service usage, and error handling robustness have already been identified in previous reviews and remain unaddressed.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6758778 and 36f48d4.

📒 Files selected for processing (4)

api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts (1 hunks)
api/src/unraid-api/graph/resolvers/ups/ups.service.ts (1 hunks)

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

api/src/unraid-api/graph/resolvers/ups/ups.resolver.spec.ts
api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: mdatelle
PR: unraid/api#942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:111-113
Timestamp: 2024-11-06T20:59:25.809Z
Learning: In the Unraid API project, error handling for mutations is handled at the service level rather than in the GraphQL resolvers. Specifically, in `api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts`, methods like `removeRoleFromApiKey` rely on service-level error handling.

Learnt from: elibosley
PR: unraid/api#942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

api/src/unraid-api/graph/resolvers/ups/ups.inputs.ts (3)

Learnt from: pujitm
PR: #1211
File: web/composables/gql/gql.ts:17-18
Timestamp: 2025-03-12T13:48:14.850Z
Learning: In the Unraid API project, the duplicate GraphQL query and mutation strings in gql.ts files are intentionally generated by GraphQL CodeGen tool and are necessary for the type system to function properly.

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/graph/resolvers/auth/auth.resolver.ts:41-47
Timestamp: 2024-11-05T14:48:56.949Z
Learning: Input types for GraphQL mutations can be pulled from the GraphQL codegen types, as they are generated into the API files. Therefore, explicit typing in the resolver files may be unnecessary.

Learnt from: pujitm
PR: #1211
File: api/src/graphql/schema/types/connect/connect.graphql:142-146
Timestamp: 2025-03-14T16:10:38.562Z
Learning: The updateApiSettings mutation in api/src/unraid-api/graph/connect/connect.resolver.ts is protected with the @UsePermissions decorator that requires UPDATE permission on the CONFIG resource.

api/src/unraid-api/graph/resolvers/ups/ups.service.ts (16)