Skip to content

Conversation

@pujitm
Copy link
Member

@pujitm pujitm commented Jul 14, 2025

Summary by CodeRabbit

  • New Features

    • Added new utility functions to improve file writing reliability by ensuring parent directories exist before writing.
    • Introduced a new watch command for easier development workflow in the shared package.
  • Bug Fixes

    • Improved startup behavior by logging warnings for missing configuration keys instead of crashing, allowing initialization to proceed.
  • Chores

    • Updated configuration version number and reformatted plugin list for clarity.
    • Relocated certain GraphQL schema type and enum declarations without changing their content.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

Walkthrough

This update introduces directory-safe file writing utilities, applies them in store synchronization, and adjusts error handling during module initialization. It also reorganizes GraphQL schema type placements, updates a configuration file's version and formatting, and adds a Justfile for development automation in the shared package.

Changes

File(s) Change Summary
api/dev/configs/api.json Updated version number and reformatted the "plugins" array to multi-line.
api/generated-schema.graphql Relocated several type and enum definitions within the schema; no content changes.
api/src/store/store-sync.ts Replaced writeFileSync with new ensureWriteSync for safer file writing.
packages/unraid-api-plugin-connect/src/mothership-proxy/connection.service.ts Changed startup config check: now logs warnings for missing keys instead of throwing errors and halting execution.
packages/unraid-shared/justfile Added Justfile with default and watch recipes for development automation.
packages/unraid-shared/src/util/file.ts Added ensureWrite and ensureWriteSync utility functions for directory-safe file writing; improved documentation.

Sequence Diagram(s)

sequenceDiagram
    participant StoreSync
    participant FileUtil

    StoreSync->>FileUtil: ensureWriteSync(path, data)
    FileUtil->>FileUtil: mkdir -p (parent directories)
    FileUtil->>FileUtil: writeFileSync(path, data)
    FileUtil-->>StoreSync: (operation complete)
Loading
sequenceDiagram
    participant ConnectionService
    participant Logger

    ConnectionService->>ConnectionService: Check config keys
    alt Any keys missing
        ConnectionService->>Logger: Log warning with missing keys
    end
    ConnectionService->>ConnectionService: Continue initialization
Loading

Suggested reviewers

  • mdatelle

Poem

In shared code’s heart, new tools reside,
Writing files with folders supplied.
Warnings now, not crashes, greet
When configs at startup aren’t complete.
Justfile joins the dev parade,
And schema types have been relaid.
Progress marches, neat and fleet! 🚀


📜 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 d69d628 and 7ab903d.

📒 Files selected for processing (6)
  • api/dev/configs/api.json (1 hunks)
  • api/generated-schema.graphql (3 hunks)
  • api/src/store/store-sync.ts (2 hunks)
  • packages/unraid-api-plugin-connect/src/mothership-proxy/connection.service.ts (1 hunks)
  • packages/unraid-shared/justfile (1 hunks)
  • packages/unraid-shared/src/util/file.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/unraid-shared/justfile
🚧 Files skipped from review as they are similar to previous changes (5)
  • api/dev/configs/api.json
  • api/src/store/store-sync.ts
  • packages/unraid-api-plugin-connect/src/mothership-proxy/connection.service.ts
  • api/generated-schema.graphql
  • packages/unraid-shared/src/util/file.ts
⏰ 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: Test API
✨ 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.

@pujitm pujitm force-pushed the fix/state-interop branch from d69d628 to 7ab903d Compare July 14, 2025 17:49
@github-actions
Copy link
Contributor

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

@pujitm pujitm marked this pull request as ready for review July 15, 2025 13:35
@elibosley elibosley merged commit 1a7d35d into main Jul 15, 2025
11 checks passed
@elibosley elibosley deleted the fix/state-interop branch July 15, 2025 13:48
elibosley pushed a commit that referenced this pull request Jul 15, 2025
🤖 I have created a release *beep* *boop*
---


## [4.10.0](v4.9.5...v4.10.0)
(2025-07-15)


### Features

* trial extension allowed within 5 days of expiration
([#1490](#1490))
([f34a33b](f34a33b))


### Bug Fixes

* delay `nginx:reload` file mod effect by 10 seconds
([#1512](#1512))
([af33e99](af33e99))
* **deps:** update all non-major dependencies
([#1489](#1489))
([53b05eb](53b05eb))
* ensure no crash if emhttp state configs are missing
([#1514](#1514))
([1a7d35d](1a7d35d))
* **my.servers:** improve DNS resolution robustness for backup server
([#1518](#1518))
([eecd9b1](eecd9b1))
* over-eager cloud query from web components
([#1506](#1506))
([074370c](074370c))
* replace myservers.cfg reads in UpdateFlashBackup.php
([#1517](#1517))
([441e180](441e180))
* rm short-circuit in `rc.unraid-api` if plugin config dir is absent
([#1515](#1515))
([29dcb7d](29dcb7d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants