Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: show database backend in about modal #1576

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

melinoix
Copy link
Contributor

@melinoix melinoix commented Feb 28, 2025

The user can now know if the instance is based on SQLite or on Postgres.

Summary by CodeRabbit

  • New Features
    • The build details now include the detected database type (e.g., PostgreSQL, SQLite, or Unknown) for enhanced system configuration visibility.
    • Added localization support for "Infrastructure" and "Build" in both English and French.

Copy link
Contributor

coderabbitai bot commented Feb 28, 2025

Walkthrough

The pull request enhances the get_build function in both backend/core/views.py and enterprise/backend/enterprise_core/views.py. It introduces logic to identify the database engine configured in the settings by checking for substrings "postgresql" and "sqlite". Based on this check, it sets a new database_type variable to "P-FS", "S-FS", or "Unknown" and adds it to the response alongside the existing version, build, and disk_response values. Additionally, localization files for English and French are updated to include new keys for "infrastructure" and "build".

Changes

File Path Change Summary
backend/core/views.py Modified get_build to determine the database type from the configured engine; adds a new database_type field ("P-FS", "S-FS", or "Unknown") to the response.
enterprise/backend/enterprise_core/views.py Modified get_build to determine the database type from the configured engine; adds a new database_type field ("P-FS", "S-FS", or "Unknown") to the response.
frontend/messages/en.json Added new keys: "infrastructure": "Infrastructure" and "build": "Build" to support localization; adjusted formatting for JSON compliance.
frontend/messages/fr.json Added new keys: "infrastructure": "Infrastructure" and "build": "Build" for French localization; adjusted formatting for JSON compliance.

Possibly related PRs

  • feat: Show database backend in About #1535: The changes in the main PR and the retrieved PR are directly related as both modify the get_build function in backend/core/views.py to include logic for determining the database type and updating the response accordingly.

📜 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 802946b and a8486ed.

📒 Files selected for processing (4)
  • backend/core/views.py (2 hunks)
  • enterprise/backend/enterprise_core/views.py (2 hunks)
  • frontend/messages/en.json (1 hunks)
  • frontend/messages/fr.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • frontend/messages/fr.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • backend/core/views.py
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: startup-functional-test (3.12)
  • GitHub Check: startup-docker-compose-test
  • GitHub Check: test (3.12)
  • GitHub Check: functional-tests (3.12, chromium)
  • GitHub Check: Analyze (python)
  • GitHub Check: enterprise-startup-functional-test (3.12)
  • GitHub Check: build (3.12)
  • GitHub Check: enterprise-functional-tests (3.12, chromium)
  • GitHub Check: enterprise-startup-docker-compose-test
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
frontend/messages/en.json (1)

1191-1192: Looking good! The new localization keys are properly added.

These two new keys for "infrastructure" and "build" are correctly added to support displaying the database type in the about modal, which aligns with the PR objective.

enterprise/backend/enterprise_core/views.py (2)

270-276: Database type detection logic looks good.

The implementation to detect the database type based on the engine configuration is straightforward and effective. It correctly identifies PostgreSQL and SQLite databases.


303-303: Properly exposing the database type in the API response.

The database type is correctly added to the response under the "infrastructure" key, which will allow the frontend to display this information.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
backend/core/views.py (1)

4254-4261: Appropriate database detection logic with a minor consideration

The implementation correctly detects the database engine by checking for substrings in the engine configuration. Using single-letter codes ("P", "S", "Unknown") is concise but might be less clear to API consumers unfamiliar with the codebase.

Consider using more descriptive values like "PostgreSQL", "SQLite", and "Unknown" for better clarity, unless there's a specific reason to keep these brief:

if "postgresql" in default_db_engine:
-    database_type = "P"
+    database_type = "PostgreSQL"
elif "sqlite" in default_db_engine:
-    database_type = "S"
+    database_type = "SQLite"
else:
    database_type = "Unknown"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ec5f222 and 802946b.

📒 Files selected for processing (1)
  • backend/core/views.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: startup-functional-test (3.12)
  • GitHub Check: startup-docker-compose-test
  • GitHub Check: functional-tests (3.12, chromium)
  • GitHub Check: enterprise-startup-functional-test (3.12)
  • GitHub Check: ruff (3.12)
  • GitHub Check: enterprise-functional-tests (3.12, chromium)
  • GitHub Check: enterprise-startup-docker-compose-test
  • GitHub Check: test (3.12)
  • GitHub Check: build (3.12)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
backend/core/views.py (1)

4275-4277: Successfully implemented database type information in the response

The modification properly includes the database type in the API response, aligning with the PR objective to enhance transparency by showing whether the instance is running on SQLite or PostgreSQL.

@nas-tabchiche nas-tabchiche changed the title feat: Show database backend in About feat: show database backend in about modal Feb 28, 2025
Copy link
Contributor

@nas-tabchiche nas-tabchiche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me on the CE part, this can be merged once these changes are also made on enterprise_core.views.get_build.

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.

2 participants