Skip to content

Only create DB directory if using embedded DB #267

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

Merged
merged 2 commits into from
Apr 11, 2025

Conversation

jerrykan
Copy link
Contributor

@jerrykan jerrykan commented Apr 10, 2025

If an external database is being used there is no need to create the local database files. This prevents the database files from being created unless the embedded database is being used.

Summary by CodeRabbit

  • Refactor
    • Streamlined the database initialization and startup process by centralizing configuration checks, ensuring more consistent handling of embedded database settings.

If an external database is being used there is no need to create the
local database files. This prevents the database files from being
created unless the embedded database is being used.
Copy link

coderabbitai bot commented Apr 10, 2025

Walkthrough

The changes update the entrypoint.sh script to introduce a new conditional check that sets the DATABASE_EMBEDDED variable based on whether DATABASE_URL matches a specified PostgreSQL connection string. The script then uses this variable to determine the initialization of the database directory and the startup of the PostgreSQL database, ensuring that these operations occur only when the embedded database configuration is intended.

Changes

File Change Summary
entrypoint.sh - Added a conditional block to set DATABASE_EMBEDDED when DATABASE_URL matches a specific PostgreSQL connection string.
- Modified the check for DATABASE_DATA_DIR to proceed only if DATABASE_EMBEDDED is true.
- Updated the database startup condition to rely on DATABASE_EMBEDDED instead of directly on DATABASE_URL.

Sequence Diagram(s)

sequenceDiagram
    participant S as Entrypoint.sh
    participant DB as PostgreSQL Database

    S->>S: Evaluate DATABASE_URL against connection string
    alt Match Found
        S->>S: Set DATABASE_EMBEDDED = true
    else No Match
        S->>S: DATABASE_EMBEDDED remains unset
    end
    S->>S: Check if DATABASE_DATA_DIR exists 
    alt DATABASE_DATA_DIR missing & DATABASE_EMBEDDED true
        S->>S: Initialize database directory
    end
    S->>S: Check DATABASE_EMBEDDED condition for startup
    alt DATABASE_EMBEDDED true
        S->>DB: Start PostgreSQL Database
    end
Loading

Poem

I'm a bunny coding in the night,
Hoping for logic so clean and bright.
DATABASE_EMBEDDED now leads the way 🥕,
Guiding the startup without delay.
PostgreSQL wakes with a gentle cheer—
A rabbit's code dance, light and clear!
Hop along to the rhythm of our new day!

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 plan to trigger planning for file edits and PR creation.
  • @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

@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 (3)
entrypoint.sh (3)

4-6: Set DATABASE_EMBEDDED Based on DATABASE_URL
The new conditional block correctly sets DATABASE_EMBEDDED when DATABASE_URL exactly matches the embedded connection string. To improve clarity and avoid any future surprises, consider explicitly setting DATABASE_EMBEDDED to "false" in an else clause so that its value is defined regardless of the DATABASE_URL value.


37-41: Initialization of DATABASE_DATA_DIR with Embedded DB
The condition now ensures that the database directory is only initialized when using the embedded database. However, in the mkdir -p command, the $DATABASE_DATA_DIR variable is not quoted while it is quoted in the subsequent chown command. To maintain consistency and avoid issues with paths that might include spaces, please quote $DATABASE_DATA_DIR in the mkdir command.

Proposed diff:

-    mkdir -p $DATABASE_DATA_DIR && chown -R postgres:postgres "$DATABASE_DATA_DIR"
+    mkdir -p "$DATABASE_DATA_DIR" && chown -R postgres:postgres "$DATABASE_DATA_DIR"
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 38-38: In POSIX sh, echo flags are undefined.

(SC3037)


136-142: Conditional Startup for Embedded PostgreSQL
The revised block correctly restricts the PostgreSQL startup to scenarios where DATABASE_EMBEDDED is "true". As a minor improvement, consider quoting $DATABASE_DATA_DIR in the command used by su postgres -c "postgres -D $DATABASE_DATA_DIR" to handle potential spaces in the path.

Proposed diff:

-    su postgres -c "postgres -D $DATABASE_DATA_DIR" &
+    su postgres -c "postgres -D \"$DATABASE_DATA_DIR\"" &
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 139-139: In POSIX sh, echo flags are undefined.

(SC3037)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d67f0e5 and 220dcc3.

📒 Files selected for processing (1)
  • entrypoint.sh (3 hunks)

@msukkari
Copy link
Contributor

Thanks! Will merge tmwr when I get the chance to sanity check repro

@msukkari msukkari merged commit d83ef38 into sourcebot-dev:main Apr 11, 2025
4 checks passed
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