feat: hpm encrypted db

[JarbasAl]

replaces JarbasHiveMind/HiveMind-core#20

Summary by CodeRabbit

• New Features

  • Added optional password-based encryption for database storage.
  • Enhanced security with conditional encrypted storage initialization.

• Improvements

  • Flexible database storage mechanism supporting both encrypted and unencrypted modes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces an optional password attribute to the JsonDB class in the hpm.py file. This attribute allows for conditional instantiation of either EncryptedJsonStorageXDG or JsonStorageXDG based on the presence of a password. If a password is provided, encrypted storage is utilized; otherwise, standard storage is used. The import statements have also been updated to accommodate these changes.

Changes

File	Change Summary
json_database/hpm.py	- Added password: Optional[str] = None attribute to JsonDB class - Updated __post_init__ method to conditionally select storage type - Added Optional import from typing and EncryptedJsonStorageXD import

Possibly related PRs

• feat: hpm encrypted db #11: This PR directly introduces the same optional password attribute to the JsonDB class and modifies the __post_init__ method to conditionally instantiate either EncryptedJsonStorageXDG or JsonStorageXDG, which aligns perfectly with the changes made in the main PR.

Poem

🐰 In the burrow where data hides,
A password now, our secret guides!
Encrypted paths for treasures dear,
JSON's safety, we hold near.
With every hop, our data's bright,
Securely stored, in day and night! 🔒

---

📜 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 a6d47c0 and 5b33cc1.

📒 Files selected for processing (1)

• json_database/hpm.py (2 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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: 2

🧹 Nitpick comments (1)

json_database/hpm.py (1)

23-25: Consider matching method arguments for consistency

Here you instantiate JsonStorageXDG with (self.name, subfolder=self.subfolder, xdg_folder=xdg_data_home()). Verify that the parameters match your usage in EncryptedJsonStorageXDG and ensure both calls share consistent pattern usage (e.g., named parameters) if they accept the same arguments.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 822d455 and a6d47c0.

📒 Files selected for processing (1)

• json_database/hpm.py (1 hunks)

🧰 Additional context used

🪛 Ruff (0.8.2)

json_database/hpm.py

14-14: Undefined name Optional

(F821)

---

18-18: Undefined name EncryptedJsonStorageXDG

(F821)

🔇 Additional comments (1)

json_database/hpm.py (1)

17-21: Validate or sanitize empty passwords

You’re assuming that a non-empty password will always be provided if encryption is desired. Consider checking for empty or invalid passwords to avoid inadvertently creating an unencrypted or weakly encrypted database.

🧰 Tools

🪛 Ruff (0.8.2)

18-18: Undefined name EncryptedJsonStorageXDG

(F821)