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: Add polling for embedded pg start to create appsmith DB #36854

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

abhvsn
Copy link
Contributor

@abhvsn abhvsn commented Oct 14, 2024

Description

PR to add the polling for pg_isready signal for embedded postgres DB. This will fix the infinite loop where postgres refuse to come up. We have seen this failure earlier with openshift setup. Current PR will make sure when the embedded postgres fails to startup we are not copying the postgres.conf file as well so supervisor won't have to start the postgres process at all.

Ref: https://theappsmith.slack.com/archives/C0341RERY4R/p1728565913269689?thread_ts=1728544650.663739&cid=C0341RERY4R

/test Sanity

🔍 Cypress test results

Tip

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


Mon, 14 Oct 2024 08:17:55 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced database initialization process with a maximum attempts mechanism for waiting on PostgreSQL to start.
    • Improved configuration handling for APPSMITH_DB_URL based on database type.
  • Bug Fixes

    • Ensured robust error handling if PostgreSQL fails to start within the specified attempts.
  • Documentation

    • Added comments for improved clarity in the deployment script.

Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

Walkthrough

The pull request introduces modifications to the entrypoint.sh script in the Appsmith deployment process. Key enhancements include a maximum attempts mechanism for waiting on PostgreSQL to start, improving database initialization reliability. The script ensures proper configuration of the APPSMITH_DB_URL for PostgreSQL or MongoDB. Additionally, it retains MongoDB initialization while improving clarity and readability through comments and restructuring.

Changes

File Path Change Summary
deploy/docker/fs/opt/appsmith/entrypoint.sh - Added maximum attempts mechanism for PostgreSQL readiness check.
- Updated create_appsmith_pg_db function to include a loop with a maximum of 100 attempts.
- Ensured correct configuration of APPSMITH_DB_URL based on database type.
- Retained MongoDB initialization with clearer control flow.
- Added comments for clarity and restructured logic for readability.

Possibly related PRs

Suggested labels

skip-changelog, ok-to-test, Move to Postgres, DB Infrastructure Pod

Suggested reviewers

  • sharat87
  • pratapaprasanna
  • AnaghHegde

🎉 In the land of code where functions play,
A script was changed in a robust way.
With PostgreSQL waiting, a loop was spun,
Ensuring that readiness would soon be won.
MongoDB's path was clearer to see,
In the world of Appsmith, all's well, yippee! 🎉


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

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Oct 14, 2024
@abhvsn abhvsn requested a review from srix October 14, 2024 06:20
@abhvsn abhvsn added the ok-to-test Required label for CI label Oct 14, 2024
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

🧹 Outside diff range and nitpick comments (1)
deploy/docker/fs/opt/appsmith/entrypoint.sh (1)

470-478: Class, let's examine this excellent improvement to our PostgreSQL initialization!

The addition of a maximum attempts mechanism for waiting on PostgreSQL to start is a commendable enhancement. It prevents potential infinite loops and provides more informative logging. Well done!

However, I'd like to suggest a small improvement to make our code even better:

Consider extracting the max_attempts value into a configurable variable at the beginning of the script. This would allow easier adjustment of the timeout period without modifying the function itself. Here's an example:

+ # Near the top of the script
+ POSTGRES_MAX_INIT_ATTEMPTS=${POSTGRES_MAX_INIT_ATTEMPTS:-100}

# In the create_appsmith_pg_db function
- local max_attempts=100
+ local max_attempts=$POSTGRES_MAX_INIT_ATTEMPTS

This change would make our script more flexible and easier to maintain. Remember, class, good code is always evolving!

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a7bf302 and df82790.

📒 Files selected for processing (1)
  • deploy/docker/fs/opt/appsmith/entrypoint.sh (1 hunks)
🧰 Additional context used

@abhvsn abhvsn merged commit 348a58f into release Oct 14, 2024
46 checks passed
@abhvsn abhvsn deleted the chore/add-polling-for-pg-starup branch October 14, 2024 08:39
abhvsn added a commit that referenced this pull request Oct 17, 2024
## Description
PR to add the polling for `pg_isready` signal for embedded postgres DB.
This will fix the infinite loop where postgres refuse to come up. We
have seen this failure earlier with `openshift` setup. Current PR will
make sure when the embedded postgres fails to startup we are not copying
the postgres.conf file as well so supervisor won't have to start the
postgres process at all.

Ref:
https://theappsmith.slack.com/archives/C0341RERY4R/p1728565913269689?thread_ts=1728544650.663739&cid=C0341RERY4R

/test Sanity

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/11322083108>
> Commit: df82790
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11322083108&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> Spec:
> <hr>Mon, 14 Oct 2024 08:17:55 UTC
<!-- end of auto-generated comment: Cypress test results  -->

## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced database initialization process with a maximum attempts
mechanism for waiting on PostgreSQL to start.
- Improved configuration handling for `APPSMITH_DB_URL` based on
database type.

- **Bug Fixes**
- Ensured robust error handling if PostgreSQL fails to start within the
specified attempts.

- **Documentation**
	- Added comments for improved clarity in the deployment script.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

(cherry picked from commit 348a58f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants