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

chore(server): enable to set visualizer db name by .env #1345

Merged
merged 4 commits into from
Jan 10, 2025

Conversation

soneda-yuya
Copy link
Contributor

@soneda-yuya soneda-yuya commented Jan 10, 2025

Overview

There are problem we can't set database of mongo db by env file.

What I've done

  • if you set value on REEARTH_DB_VIS variable of .env, you can switch visualizer database defined on .env value.

What I haven't done

How I tested

Which point I want you to review particularly

Memo

  • if you set value on REEARTH_DB_ACCOUNT variable of .env, you can switch account database defined on .env value.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added configuration support for database visualization.
    • Introduced new environment variables for Reearth database configuration.
  • Refactor

    • Enhanced database handling with separate account and visualizer database configurations.
    • Renamed database-related constant for improved clarity.
    • Updated database selection logic to support more flexible configuration.

@soneda-yuya soneda-yuya requested a review from pyshx as a code owner January 10, 2025 10:20
Copy link

coderabbitai bot commented Jan 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces configuration enhancements for database management in the application. A new configuration field DB_Vis has been added to the Config struct, allowing more flexible database selection. The code has been updated to handle database naming more explicitly, replacing the constant databaseName with defaultVisDatabase and introducing a separate constant for the account database. Additionally, new environment variables have been added to clarify the database configuration options.

Changes

File Change Summary
server/internal/app/config/config.go Added DB_Vis field to Config struct with pp:",omitempty" annotation
server/internal/app/repo.go Replaced databaseName constant with defaultVisDatabase and added defaultAccountDatabase constant; updated logic for selecting account and visualizer databases
server/.env.example Added REEARTH_DB_ACCOUNT and REEARTH_DB_VIS variables; updated REEARTH_DB with comments

Possibly related PRs

Suggested reviewers

  • mkumbobeaty
  • pyshx

Poem

🐰 A Rabbit's Database Delight

In config's realm, a field takes flight
Visualizer's path, now clear and bright
Databases dance with newfound grace
Reearth's default, in every space
Code hops forward, with config's might! 🗄️


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55dfe84 and 8fa074a.

📒 Files selected for processing (3)
  • server/.env.example (1 hunks)
  • server/internal/app/config/config.go (1 hunks)
  • server/internal/app/repo.go (3 hunks)

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

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

netlify bot commented Jan 10, 2025

Deploy Preview for reearth-web canceled.

Name Link
🔨 Latest commit 8fa074a
🔍 Latest deploy log https://app.netlify.com/sites/reearth-web/deploys/6780fdc22a384400086a4241

Copy link

@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)
server/internal/app/repo.go (1)

69-73: Consider adding debug logging for database fallback.

While the fallback logic is correct, adding debug logging when falling back to the default database would help with troubleshooting configuration issues.

 visualizerDatabase := conf.DB_Visualizer
 if visualizerDatabase == "" {
+    log.Debugf("Visualizer database not configured, using default database: %s", defaultDatabase)
     visualizerDatabase = defaultDatabase
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 887173f and 55dfe84.

📒 Files selected for processing (2)
  • server/internal/app/config/config.go (1 hunks)
  • server/internal/app/repo.go (3 hunks)
🔇 Additional comments (4)
server/internal/app/config/config.go (1)

33-33: LGTM! Configuration field added correctly.

The new DB_Visualizer field follows the existing naming convention and is properly tagged with omitempty.

server/internal/app/repo.go (3)

28-28: LGTM! Improved constant naming.

The rename from databaseName to defaultDatabase better reflects its purpose as a fallback value.


45-51: LGTM! Account database fallback logic is correct.

The code properly handles the account database configuration with appropriate fallback to the default database.


75-75: LGTM! Repository initialization uses correct database.

The repository is properly initialized with the configured visualizer database.

@@ -1,6 +1,8 @@
# General
PORT=8080
REEARTH_DB=mongodb://localhost
REEARTH_DB_ACCOUNT=reearth # for account database
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't need these comments.

server/internal/app/config/config.go Outdated Show resolved Hide resolved
server/internal/app/repo.go Outdated Show resolved Hide resolved
@soneda-yuya soneda-yuya merged commit 52f66e4 into main Jan 10, 2025
17 checks passed
@soneda-yuya soneda-yuya deleted the chore/enable_set_databasename branch January 10, 2025 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants