chore: Add host explicitly for pg_isready signal at the startup

[abhvsn]

Description

PR to add the host explicitly for the pg_isready check at the startup. In the current implementation we haven't provided a host which can create issues if custom unix port is configured in the postgres.conf. Possible issue that we have observed here:

1. Misconfigured unix socket directory: This happens if the PostgreSQL server is not using the default Unix socket directory (usually /tmp or /var/run/postgresql), and we don't specify the correct socket directory with the --host parameter, pg_isready will fail to connect.
2. postgres DB is manually deleted by the user by stopping the postgres procedure, but the possibility is lower.

/test Sanity

🔍 Cypress test results

Tip

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

---

Thu, 24 Oct 2024 13:04:29 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

Summary by CodeRabbit

• Bug Fixes
  • Enhanced PostgreSQL readiness check for more reliable connections by extending the timeout duration to 300 seconds.
• Chores
  • Minor formatting and comment updates for improved clarity in the script.

[coderabbitai]

Walkthrough

The pull request modifies the create_appsmith_pg_db function in the deploy/docker/fs/opt/appsmith/entrypoint.sh script. The key change is in the command used to check PostgreSQL readiness, updating it from pg_isready -d postgres to pg_isready -h 127.0.0.1. This adjustment specifies the host explicitly, increasing the maximum number of readiness check attempts from 100 to 300, which extends the timeout duration. Minor formatting changes and comments were also added for clarity, but no alterations were made to exported or public entity declarations.

Changes

File Path	Change Summary
deploy/docker/fs/opt/appsmith/entrypoint.sh	Modified PostgreSQL readiness check command and increased timeout; added comments and formatting changes

Possibly related PRs

• chore: Create appsmith postgres DB to be used by internal processes #36670: This PR introduces the create_appsmith_pg_db function in the entrypoint.sh script, which is directly related to the changes made in the main PR that also modifies this function to enhance PostgreSQL readiness checks.
• chore: Add polling for embedded pg start to create appsmith DB #36854: This PR modifies the create_appsmith_pg_db function to implement polling for PostgreSQL readiness, which aligns with the changes in the main PR that update the readiness check command and increase the maximum attempts.
• chore: Add postgres dependency for server to startup #36585: This PR adds a waitForPostgresAvailability function that checks PostgreSQL availability using pg_isready, which is relevant to the changes in the main PR that also focus on PostgreSQL readiness checks.
• chore: create appsmith schema for postgres #36591: This PR introduces the init_pg_db function, which is related to the overall management of PostgreSQL databases and complements the changes made in the main PR regarding database initialization and readiness.
• chore: Add grants for appsmith user for embedded postgres #36664: This PR enhances the pg-utils.sh script with a new function for granting permissions, which is relevant to the overall management of PostgreSQL databases as discussed in the main PR.
• fix: use password while creating extension #36936: This PR updates the pg-utils.sh script to ensure that the password is used when creating extensions, which relates to the overall handling of PostgreSQL connections and database management in the main PR.

Suggested labels

Task

Suggested reviewers

• sharat87
• pratapaprasanna

🌟 In the realm of code, a change was made,
To check PostgreSQL, a new path laid.
With comments and clarity, the script now shines,
Ready for connections, in all the right lines!
🚀 Let's deploy with joy, let the data flow,
For in this code journey, we're set to grow! 🌱

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 298da9c and ab0e1f4.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

• deploy/docker/fs/opt/appsmith/entrypoint.sh

---

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.