refactor: add & use `ConfigFilePersister` primitive #1534

pujitm · 2025-07-21T21:38:53Z

Add ConfigFilePersister<T> to provide automatic JSON file persistence for configs. It bridges the gap between in-memory configuration (via ConfigService) and persistent file storage, with minimal developer effort.

Key Features

Reactive Persistence: Automatically saves config changes to disk when ConfigService updates
NestJS Integration: Implements lifecycle hooks for proper initialization and cleanup
Standalone Operations: Provides direct file access via getFileHandler() for non-reactive use cases
Change Detection: Only writes to disk when configuration actually changes (performance optimization)
Error Handling: Includes logging and graceful error handling throughout

How to Implement

Extend the class and implement these required methods:

@Injectable()
class MyConfigPersister extends ConfigFilePersister<MyConfigType> {
  constructor(configService: ConfigService) {
    super(configService);
  }

  // Required: JSON filename in config directory
  fileName(): string { 
    return "my-config.json"; 
  }

  // Required: ConfigService key for reactive updates
  configKey(): string { 
    return "myConfig"; 
  }

  // Required: Default values for new installations
  defaultConfig(): MyConfigType {
    return { enabled: false, timeout: 5000 };
  }

  // optionally, override validate() and/or migrateConfig()
}

Lifecycle Behavior

Initialization (onModuleInit): Loads config from disk → sets in ConfigService → starts reactive subscription
Runtime: Automatically persists to disk when ConfigService changes (buffered every 25ms)
Shutdown (onModuleDestroy): Final persistence and cleanup

Summary by CodeRabbit

New Features
- Introduced a unified, robust configuration file management system with automatic migration, validation, and efficient persistence for plugins and services.
Refactor
- Centralized configuration persistence logic into a shared base class, simplifying and standardizing config handling.
- Refactored multiple config persisters to extend the new base class, removing redundant manual file and lifecycle management.
- Removed legacy config state management, persistence helpers, and related modules, streamlining the codebase.
- Simplified test suites to focus on core functionality and error handling.
Chores
- Updated dependencies to support the new configuration management system.
- Integrated the new API config module into plugin modules for consistent configuration handling.

coderabbitai · 2025-07-21T21:38:59Z

Walkthrough

A new abstract class, ConfigFilePersister, was introduced to centralize and standardize configuration file management across multiple modules. Several config persistence classes were refactored to extend this base class, simplifying their logic and removing manual file handling, migration, and reactive subscriptions. Related tests and package dependencies were updated accordingly. Legacy config management classes and helpers were removed, consolidating persistence and migration logic. Tests were streamlined or added to cover the new structure and core behaviors.

Changes

File(s)	Change Summary
packages/unraid-shared/src/services/config-file.ts	Added new abstract class `ConfigFilePersister<T>` for unified config file management, with lifecycle hooks, migration, and validation.
api/src/unraid-api/config/api-config.module.ts	Refactored `ApiConfigPersistence` to extend `ConfigFilePersister`, removed manual migration and subscriptions, simplified providers.
packages/unraid-api-plugin-connect/src/config/config.persistence.ts	Refactored `ConnectConfigPersister` to extend `ConfigFilePersister`, removed manual file ops, streamlined migration and validation.
packages/unraid-api-plugin-generator/src/templates/config.persistence.ts	Refactored `PluginNameConfigPersister` to extend `ConfigFilePersister`, removed all manual config file and subscription logic.
api/src/unraid-api/config/api-config.test.ts	Updated tests for new `ApiConfigPersistence` structure, added tests for required base class methods and migration logic; removed granular file I/O tests.
packages/unraid-shared/package.json	Added `@nestjs/config` and `rxjs` as peer/dev dependencies for shared config functionality.
packages/unraid-shared/src/services/tests/config-file.test.ts	Added comprehensive tests for `ConfigFilePersister` including lifecycle, persistence, validation, migration, and error handling.
packages/unraid-shared/src/util/config-definition.ts	Added abstract class `ConfigDefinition<T>` for core config logic with validation and migration methods.
packages/unraid-shared/src/util/config-file-handler.ts	Added `ConfigFileHandler<T>` for robust file operations, validation, migration, and update support.
packages/unraid-shared/src/util/tests/config-definition.test.ts	Added tests for `ConfigDefinition` abstract class and its validation and migration behaviors.
packages/unraid-shared/src/util/tests/config-file-handler.test.ts	Added detailed tests for `ConfigFileHandler` covering loading, reading, writing, updating, validation, migration, and error cases.
api/src/unraid-api/plugin/plugin-management.service.ts	Replaced use of standalone `persistApiConfig` with injected `ApiConfigPersistence` for persistence calls.
api/src/unraid-api/plugin/plugin.module.ts	Added `ApiConfigModule` to imports of `PluginModule` and `PluginCliModule`.
api/src/unraid-api/config/factory/api-state.model.ts	Deleted legacy `ApiStateConfig` class and related config persistence helpers.
api/src/unraid-api/config/factory/api-state.model.test.ts	Deleted legacy tests for `ApiStateConfig`.
api/src/unraid-api/config/factory/api-state.register.ts	Deleted legacy dynamic module registration for `ApiStateConfig`.
api/src/unraid-api/config/factory/api-state.service.ts	Deleted legacy `ScheduledConfigPersistence` class for periodic config persistence.
api/src/unraid-api/config/factory/config.injection.ts	Deleted legacy config token generation and injection decorators.
api/src/unraid-api/config/factory/config.interface.ts	Deleted legacy config interfaces `ConfigFeatures` and `ConfigMetadata`.
api/src/unraid-api/config/persistence.helper.ts	Deleted `ConfigPersistenceHelper` class for conditional persistence.
api/src/test/config/api-config.test.ts	Deleted legacy tests for `ApiConfigPersistence` conversion logic.
api/src/unraid-api/config/factory/api-state.model.test.ts	Deleted legacy tests for `ApiStateConfig`.
api/src/unraid-api/unraid-file-modifier/modifications/test/fixtures/downloaded/*.last-download-time	Updated timestamp values in multiple last-download-time fixture files.

Sequence Diagram(s)

sequenceDiagram
    participant NestModule
    participant ConfigFilePersister
    participant ConfigService
    participant FileSystem

    NestModule->>ConfigFilePersister: onModuleInit()
    ConfigFilePersister->>FileSystem: loadConfig()
    alt Config file valid
        FileSystem-->>ConfigFilePersister: config data
    else Config file missing/invalid
        ConfigFilePersister->>ConfigFilePersister: migrateConfig()
        ConfigFilePersister-->>ConfigFilePersister: use defaultConfig if needed
    end
    ConfigFilePersister->>ConfigService: set config value
    ConfigFilePersister->>FileSystem: persist(config)
    ConfigService->>ConfigFilePersister: config change events
    ConfigFilePersister->>FileSystem: persist(updated config)
    NestModule->>ConfigFilePersister: onModuleDestroy()
    ConfigFilePersister->>FileSystem: persist(current config)

Estimated code review effort

4 (~90 minutes)

Possibly related PRs

fix: config migration from myservers.cfg #1440: Refactors legacy config migration logic and convertLegacyConfig() in ApiConfigPersistence, which is further evolved and integrated into the new base class approach in this PR.
chore: cli commands for api plugin install & generation #1352: Introduces the ConfigFilePersister base class that this PR builds upon and uses extensively for config persistence refactoring.
fix: invalid configs no longer crash API #1491: Enhances error handling in ApiConfigPersistence and loadApiConfig, related to config loading and persistence error handling and migration logic.

Suggested reviewers

mdatelle
zackspear
elibosley

Poem

Configs now dance in tidy rows,
With one base class, the logic flows.
No more tangled file routines—
Just clean, clear code behind the scenes!
🎉

Refactor’s done, the tests all pass,
Let’s raise a toast to this shared class!

✨ 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 (2)

packages/unraid-shared/src/services/__tests__/config-file.test.ts (2)
19-21: Remove unnecessary constructor

The constructor only calls super() without adding any logic.
 class TestConfigFilePersister extends ConfigFilePersister<TestConfig> {
-  constructor(configService: any) {
-    super(configService);
-  }
-
   fileName(): string {
319-332: Use already imported fs functions instead of dynamic imports

The fs/promises module is already imported at the top of the file.
-    const stats1 = await import('fs/promises').then(fs => fs.stat(configPath));
+    const { stat } = await import('node:fs/promises');
+    const stats1 = await stat(configPath);
Actually, since you already have the import at the top, just use:
-    const stats1 = await import('fs/promises').then(fs => fs.stat(configPath));
+    const { stat } = await import('node:fs/promises');
+    const stats1 = await stat(configPath);
Wait, I notice readFile, writeFile, mkdir, rm are imported but not stat. Add it to the imports:
-import { readFile, writeFile, mkdir, rm } from "node:fs/promises";
+import { readFile, writeFile, mkdir, rm, stat } from "node:fs/promises";
Then use it directly:
-    const stats1 = await import('fs/promises').then(fs => fs.stat(configPath));
+    const stats1 = await stat(configPath);
And same for line 331:
-    const stats2 = await import('fs/promises').then(fs => fs.stat(configPath));
+    const stats2 = await stat(configPath);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dce7d00 and 4858e20.

📒 Files selected for processing (2)

packages/unraid-shared/src/services/__tests__/config-file.test.ts (1 hunks)
packages/unraid-shared/src/services/config-file.ts (1 hunks)

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

packages/unraid-shared/src/services/config-file.ts

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: pujitm
PR: unraid/api#1352
File: packages/unraid-api-plugin-generator/src/create-plugin.ts:91-112
Timestamp: 2025-04-21T18:27:36.482Z
Learning: For utility functions like file operations in api plugin generators, pujitm prefers minimal error handling rather than verbose try/catch blocks for each operation, as errors will propagate properly to higher level error handlers.

packages/unraid-shared/src/services/__tests__/config-file.test.ts (11)

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 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-07-21T14:01:04.139Z
Learning: Applies to web/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-07-21T14:01:04.139Z
Learning: Applies to web/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-07-21T14:01:04.139Z
Learning: Applies to web/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-07-21T14:01:04.139Z
Learning: Applies to web/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-07-21T14:01:04.139Z
Learning: Applies to web/test/store/**/*.ts : Test action side effects and state changes in store tests

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 : Test getter dependencies are properly mocked in store tests

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 : 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-07-21T14:01:04.139Z
Learning: Applies to web/test/store/**/*.ts : Test action side effects if not stubbed in store tests

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 : Test store interactions with other stores

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/{components,store,mocks}/**/*.ts : Clear mocks between tests to ensure isolation

🪛 Biome (1.9.4)

packages/unraid-shared/src/services/__tests__/config-file.test.ts

[error] 19-21: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

⏰ 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). (3)

GitHub Check: Build Web App
GitHub Check: Build API
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

packages/unraid-shared/src/services/__tests__/config-file.test.ts (1)

1-450: Comprehensive test coverage!

This test suite thoroughly covers the ConfigFilePersister functionality including initialization, validation, migration, persistence, error handling, and lifecycle management. The tests are well-structured with proper setup/teardown and good test isolation.

coderabbitai

Actionable comments posted: 4

🧹 Nitpick comments (1)

packages/unraid-api-plugin-generator/src/templates/config.persistence.ts (1)
2-2: Remove the npm install comment from the template.

This comment is unnecessary in a template file as package dependencies should be managed through package.json.
-import { ConfigFilePersister } from "@unraid/shared/services/config-file.js"; // npm install @unraid/shared
+import { ConfigFilePersister } from "@unraid/shared/services/config-file.js";

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d57d9e5 and 8e5696b.

📒 Files selected for processing (4)

api/src/unraid-api/config/api-config.module.ts (4 hunks)
packages/unraid-api-plugin-connect/src/config/config.persistence.ts (3 hunks)
packages/unraid-api-plugin-generator/src/templates/config.persistence.ts (1 hunks)
packages/unraid-shared/src/services/config-file.ts (1 hunks)

📓 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/config/api-config.module.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

Files:

api/src/unraid-api/config/api-config.module.ts

🧠 Learnings (4)

📓 Common learnings

Learnt from: pujitm
PR: unraid/api#1352
File: packages/unraid-api-plugin-generator/src/create-plugin.ts:91-112
Timestamp: 2025-04-21T18:27:36.482Z
Learning: For utility functions like file operations in api plugin generators, pujitm prefers minimal error handling rather than verbose try/catch blocks for each operation, as errors will propagate properly to higher level error handlers.

packages/unraid-api-plugin-connect/src/config/config.persistence.ts (7)

Learnt from: elibosley
PR: #1425
File: api/dev/configs/connect.json:5-13
Timestamp: 2025-06-20T20:50:14.050Z
Learning: Connect configuration files like api/dev/configs/connect.json use their own naming conventions (e.g., apikey, accesstoken, idtoken, refreshtoken) as implementation details, and these should not be changed to follow general camelCase patterns.

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: .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: pujitm
PR: #1352
File: packages/unraid-api-plugin-connect/src/config.persistence.ts:143-149
Timestamp: 2025-04-22T14:41:19.603Z
Learning: The demo property in the config.persistence.ts file's migrateLegacyConfig method is used for demonstration purposes, adding a current timestamp to keep demo environments looking fresh.

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: pujitm
PR: #1211
File: web/codegen.ts:14-14
Timestamp: 2025-03-12T13:35:43.900Z
Learning: The JSON scalar type in web/codegen.ts was temporarily changed from 'string' to 'any' for compatibility with JsonForms integration. This change facilitates the implementation of the Connect settings web component.

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.

api/src/unraid-api/config/api-config.module.ts (12)

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: 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: CLAUDE.md:0-0
Timestamp: 2025-07-21T13:59:55.481Z
Learning: Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

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

Learnt from: elibosley
PR: #942
File: api/src/unraid-api/auth/api-key.service.ts:176-188
Timestamp: 2024-11-15T16:22:03.485Z
Learning: Atomic writes are not required for the saveApiKey method in ApiKeyService (api/src/unraid-api/auth/api-key.service.ts) unless specifically needed.

Learnt from: mdatelle
PR: #1106
File: unraid-ui/src/components/index.ts:2-2
Timestamp: 2025-02-04T17:21:39.710Z
Learning: The unraid-ui package is undergoing a major refactoring process, and breaking changes are expected during this transition period.

Learnt from: mdatelle
PR: #942
File: api/src/unraid-api/auth/auth.service.ts:0-0
Timestamp: 2024-11-04T20:41:22.303Z
Learning: In api/src/unraid-api/auth/auth.service.ts, the addRoleToApiKey function operates on API keys stored as JSON files in a directory, not a database, so concurrency is not a concern for modifying apiKey.roles.

Learnt from: pujitm
PR: #1352
File: packages/unraid-api-plugin-connect/src/config.persistence.ts:143-149
Timestamp: 2025-04-22T14:41:19.603Z
Learning: The demo property in the config.persistence.ts file's migrateLegacyConfig method is used for demonstration purposes, adding a current timestamp to keep demo environments looking fresh.

Learnt from: elibosley
PR: #1352
File: packages/unraid-api-plugin-connect/src/config.persistence.ts:0-0
Timestamp: 2025-04-21T18:44:39.643Z
Learning: When working with file operations in Node.js, prefer using the native Promise-based APIs from the fs/promises module instead of callback-based APIs from fs or manually wrapping callbacks in Promises.

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.

packages/unraid-api-plugin-generator/src/templates/config.persistence.ts (5)

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: pujitm
PR: #1352
File: packages/unraid-api-plugin-connect/src/config.persistence.ts:143-149
Timestamp: 2025-04-22T14:41:19.603Z
Learning: The demo property in the config.persistence.ts file's migrateLegacyConfig method is used for demonstration purposes, adding a current timestamp to keep demo environments looking fresh.

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

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-21T13:59:55.481Z
Learning: Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code

🪛 Biome (1.9.4)

packages/unraid-api-plugin-connect/src/config/config.persistence.ts

[error] 15-17: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

api/src/unraid-api/config/api-config.module.ts

[error] 60-62: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

packages/unraid-api-plugin-generator/src/templates/config.persistence.ts

[error] 8-10: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

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

packages/unraid-shared/src/services/config-file.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/config/api-config.module.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

Files:

api/src/unraid-api/config/api-config.module.ts

🧠 Learnings (4)

📓 Common learnings

Learnt from: pujitm
PR: unraid/api#1352
File: packages/unraid-api-plugin-generator/src/create-plugin.ts:91-112
Timestamp: 2025-04-21T18:27:36.482Z
Learning: For utility functions like file operations in api plugin generators, pujitm prefers minimal error handling rather than verbose try/catch blocks for each operation, as errors will propagate properly to higher level error handlers.