fix: use async for primary file read/writes #1531

elibosley · 2025-07-21T18:05:27Z

Summary by CodeRabbit

Refactor
- Improved application performance and responsiveness by converting all synchronous file system operations to asynchronous ones throughout the application.
- Enhanced reliability of file checks and file writing, ensuring non-blocking behavior during configuration, notification handling, and service operations.

coderabbitai · 2025-07-21T18:05:34Z

Walkthrough

This update refactors several modules to replace synchronous file system operations with asynchronous equivalents. Synchronous methods like writeFileSync, statSync, and existsSync are replaced with writeFile, stat from fs/promises, or a custom fileExists utility. Imports and internal logic are updated accordingly, with no changes to public APIs.

Changes

File(s)	Change Summary
api/src/store/listeners/config-listener.ts, api/src/store/modules/config.ts	Replaced `writeFileSync` with async `writeFile`; updated imports and made effect functions async.
api/src/unraid-api/cli/pm2.service.ts	Replaced `existsSync` with async `fileExists` utility in PM2 home deletion logic.
api/src/unraid-api/graph/resolvers/display/display.service.ts	Switched `existsSync` to async `fileExists` for config file existence check.
api/src/unraid-api/graph/resolvers/notifications/notifications.service.ts	Replaced `statSync` with async `stat` and refactored file listing to be fully asynchronous.
api/src/unraid-api/graph/resolvers/rclone/rclone-api.service.ts	Replaced all `existsSync` checks with async `fileExists` utility.
api/src/unraid-api/unraid-file-modifier/modifications/auth-request.modification.ts, api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts	Switched `existsSync` to async `fileExists` in patch generation logic.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant FileSystem

    Caller->>FileSystem: await fileExists(path)
    alt File exists
        FileSystem-->>Caller: true
        Caller->>FileSystem: await writeFile(path, data)
        FileSystem-->>Caller: success
    else File does not exist
        FileSystem-->>Caller: false
        Caller->>Caller: throw error
    end

Estimated code review effort

3 (~40 minutes)

Suggested reviewers

mdatelle
zackspear
pujitm

Poem

Async writes and checks abound,
Synchronous calls are no longer found.
File systems hum with non-blocking delight,
Awaiting their futures, all through the night.
Reviewers, rejoice—no more thread stall,
Asynchronous upgrades now serve us all! 🚀

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

api/src/unraid-api/cli/pm2.service.ts (1)
93-93: Async file existence checks properly implemented.

The conversion from existsSync to await fileExists is correct for both the PM2_HOME directory and pm2.log file checks.

Consider simplifying the existence check.

Since rm is called with { force: true }, the existence check is technically redundant for the removal operation. However, it serves the purpose of providing different log messages, so the current approach is acceptable.

If you want to simplify, you could remove the existence check and always attempt removal:
-    if ((await fileExists(PM2_HOME)) && (await fileExists(join(PM2_HOME, 'pm2.log')))) {
-        await rm(PM2_HOME, { recursive: true, force: true });
-        this.logger.trace('PM2 home directory cleared.');
-    } else {
-        this.logger.trace('PM2 home directory does not exist.');
-    }
+    await rm(PM2_HOME, { recursive: true, force: true });
+    this.logger.trace('PM2 home directory removal attempted.');

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a74d935 and 5bdec40.

📒 Files selected for processing (8)

api/src/store/listeners/config-listener.ts (2 hunks)
api/src/store/modules/config.ts (2 hunks)
api/src/unraid-api/cli/pm2.service.ts (2 hunks)
api/src/unraid-api/graph/resolvers/display/display.service.ts (2 hunks)
api/src/unraid-api/graph/resolvers/notifications/notifications.service.ts (2 hunks)
api/src/unraid-api/graph/resolvers/rclone/rclone-api.service.ts (4 hunks)
api/src/unraid-api/unraid-file-modifier/modifications/auth-request.modification.ts (2 hunks)
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts (2 hunks)

🧰 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/store/modules/config.ts
api/src/store/listeners/config-listener.ts
api/src/unraid-api/unraid-file-modifier/modifications/auth-request.modification.ts
api/src/unraid-api/graph/resolvers/display/display.service.ts
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
api/src/unraid-api/graph/resolvers/rclone/rclone-api.service.ts
api/src/unraid-api/graph/resolvers/notifications/notifications.service.ts
api/src/unraid-api/cli/pm2.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

Files:

api/src/unraid-api/unraid-file-modifier/modifications/auth-request.modification.ts
api/src/unraid-api/graph/resolvers/display/display.service.ts
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
api/src/unraid-api/graph/resolvers/rclone/rclone-api.service.ts
api/src/unraid-api/graph/resolvers/notifications/notifications.service.ts
api/src/unraid-api/cli/pm2.service.ts

🧠 Learnings (9)

📓 Common learnings

Learnt from: elibosley
PR: unraid/api#1352
File: packages/unraid-api-plugin-connect/src/config.persistence.ts:0-0
Timestamp: 2025-04-21T18:44:39.643Z
Learning: Use Promise-based file writing instead of callback-based approaches for better error handling and to allow proper propagation of success/failure states to callers.

Learnt from: elibosley
PR: unraid/api#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: 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: pujitm
PR: unraid/api#1145
File: api/src/unraid-api/unraid-file-modifier/modifications/log-rotate.modification.ts:57-60
Timestamp: 2025-02-18T21:39:10.313Z
Learning: When using Node.js `rm` with `{ force: true }` option or Unix/Linux `rm -f`, existence checks are redundant as the command continues silently if the file doesn't exist.

Learnt from: elibosley
PR: unraid/api#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/store/modules/config.ts (15)

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: 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: 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 state changes after actions in store tests

Learnt from: CR
PR: unraid/api#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-21T13:59:55.481Z
Learning: Applies to web/**/*.ts : Ensure Vue reactivity imports are added to store files (computed, ref, watchEffect)

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 and state changes in store tests

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: Use Promise-based file writing instead of callback-based approaches for better error handling and to allow proper propagation of success/failure states to callers.

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: 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 : Always await async operations before making assertions

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 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 : Verify actions are called with the right parameters 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 actions are called with correct parameters in store tests

Learnt from: elibosley
PR: #1068
File: api/src/unraid-api/auth/api-key.service.ts:122-137
Timestamp: 2025-01-22T18:34:06.925Z
Learning: The store in @app/store is implemented using Redux's configureStore, where dispatch operations for config updates are synchronous in-memory state updates that cannot fail, making transaction-like patterns unnecessary.

api/src/store/listeners/config-listener.ts (10)