chore: Create appsmith postgres DB to be used by internal processes

[abhvsn]

Description

With the migration to postgres as Appsmith's persistent database we wanted to have central DB to be consumed by internal services. Currently all the services try to create the same DB and may end up in a race condition, so we are moving this task to entrypoint.sh.

Steps:

1. Initialise data directory for pg
2. Run the upgrade migration if necessary
3. Start the pg server
4. Create appsmith db with postgres user
5. Stop the pg server

/test Sanity

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11212147481
Commit: e384076
Cypress dashboard.
Tags: @tag.Sanity
Spec:

---

Mon, 07 Oct 2024 09:31:39 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features

  • Improved database initialization logic for the Appsmith application.
  • Automatically creates the Appsmith database if it does not already exist during startup.

• Bug Fixes

  • Enhanced robustness of the database setup process with existence checks before creation.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the entrypoint.sh script for the Appsmith application. A new environment variable, APPSMITH_PG_DATABASE, is introduced, and a function named create_appsmith_pg_db is added to manage the PostgreSQL database initialization. This function ensures the database is created if it doesn't exist, and it is invoked within the existing init_postgres function after the PostgreSQL data directory is initialized. The updates enhance the robustness of the database setup process.

Changes

File Path	Change Summary
deploy/docker/fs/opt/appsmith/entrypoint.sh	- Added environment variable APPSMITH_PG_DATABASE="appsmith"
	- Introduced function create_appsmith_pg_db() for PostgreSQL service management and database creation
	- Modified init_postgres to call create_appsmith_pg_db() after initializing the data directory

Possibly related PRs

• chore: Add postgres dependency for server to startup #36585: This PR adds functions for managing PostgreSQL connections, including a retry mechanism for database availability, which relates to the new create_appsmith_pg_db function in the main PR that initializes the PostgreSQL database.
• chore: create appsmith schema for postgres #36591: This PR introduces a function to initialize a PostgreSQL database and schema, which is directly related to the changes in the main PR that also involve database initialization and checks for existence.
• chore: Add grants for appsmith user for embedded postgres #36664: This PR enhances PostgreSQL management by adding permissions for the appsmith user, which complements the database initialization process described in the main PR, ensuring that the necessary permissions are set after the database is created.

Suggested labels

Task, Move to Postgres, DB Infrastructure Pod

Suggested reviewers

• sharat87
• pratapaprasanna
• AnaghHegde

🎉 In the script where databases dwell,
A new variable rings the bell.
With functions that create and check,
Appsmith’s PostgreSQL is now a deck!
Initialization flows with grace,
In this code, we find our place! 🚀

---

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0e5f5f7 and 95e3886.

📒 Files selected for processing (1)

• deploy/docker/fs/opt/appsmith/entrypoint.sh (3 hunks)

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 95e3886 and c1ef99a.

📒 Files selected for processing (1)

• deploy/docker/fs/opt/appsmith/entrypoint.sh (3 hunks)

🔇 Additional comments (2)

deploy/docker/fs/opt/appsmith/entrypoint.sh (2)

9-9: Well done, class! This new variable is a great addition.

The new environment variable APPSMITH_PG_DATABASE is set correctly to "appsmith". This aligns perfectly with our lesson on establishing a centralized PostgreSQL database. Keep up the good work!

---

436-436: A+ for integrating our new function!

Excellent job incorporating the create_appsmith_pg_db function into the init_postgres function. This addition ensures that our Appsmith database is created right after the PostgreSQL data folder is initialized. It's like adding the final piece to complete our database setup puzzle!

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c1ef99a and e384076.

📒 Files selected for processing (1)

• deploy/docker/fs/opt/appsmith/entrypoint.sh (3 hunks)

🧰 Additional context used

🔇 Additional comments (1)

deploy/docker/fs/opt/appsmith/entrypoint.sh (1)

436-436: Well done on integrating the new function, class!

You've successfully incorporated the create_appsmith_pg_db function into the init_postgres function. This is a great example of modular programming, where we break down complex tasks into smaller, manageable pieces.

The change on line 436 correctly calls the new function with the POSTGRES_DB_PATH argument. This ensures that our Appsmith database is created during the PostgreSQL initialization process.

Keep up the excellent work in organizing and structuring your code!