workflow which ensures that talawa Api app starts in docker #2759
Conversation
WalkthroughThis pull request introduces a new Changes
Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Outside diff range and nitpick comments (2)
.github/workflows/pull-request.yml (2)
366-372: Use environment variable for health check URLThe health check URL is hardcoded. Consider using the
HEALTH_CHECK_URLenvironment variable:-until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf "http://talawa-api-dev:4000/health" 2>&1 || [ $timeout -eq 0 ]; do +until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf "${HEALTH_CHECK_URL}/health" 2>&1 || [ $timeout -eq 0 ]; do🧰 Tools
🪛 actionlint (1.7.4)
372-372: could not parse as YAML: yaml: line 372: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
[error] 366-366: trailing spaces
(trailing-spaces)
392-407: Fix environment variables indentationThe
env:section should be at the same level assteps::- env: - HEALTH_CHECK_URL: http://localhost:4000 - COMPOSE_PROJECT_NAME: pr-${{ github.event.pull_request.number }} + env: + HEALTH_CHECK_URL: http://localhost:4000 + COMPOSE_PROJECT_NAME: pr-${{ github.event.pull_request.number }}🧰 Tools
🪛 yamllint (1.35.1)
[error] 407-407: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/pull-request.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/pull-request.yml
372-372: could not parse as YAML: yaml: line 372: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 323-323: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 407-407: trailing spaces
(trailing-spaces)
[error] 374-374: syntax error: could not find expected ':'
(syntax)
.github/workflows/pull-request.yml
Outdated
| with: | ||
| node-version: '22.x' | ||
|
|
||
| - name: Cache Node.js dependencies | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: | | ||
| ~/.npm | ||
| node_modules | ||
| key: ${{ runner.os }}-docker-check-${{ hashFiles('**/package-lock.json') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-docker-check- | ||
|
|
||
| - name: Check if Talawa API starts in Docker | ||
| run : | | ||
| # Ensure no containers are running | ||
| docker-compose -f docker-compose.dev.yaml down -v || true | ||
|
|
||
| # Verify docker-compose file exists | ||
| if [! -f "docker-compose.dev.yaml"]; then | ||
| echo "Error: docker-compose.dev.yaml not found" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Start containers | ||
| if ! docker-compose -f docker-compose.dev.yaml up -d --build; then | ||
| echo "Failed to start containers" | ||
| docker-compose -f docker-compose.dev.yaml logs | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Wait for MongoDB and Redis to be ready | ||
| echo "Waiting for MongoDB..." | ||
| timeout=30 | ||
| until docker-compose -f docker-compose.dev.yaml exec -T mongodb mongo --eval "db.runCommand('ping').ok">/dev/null 2>&1 || [ $timeout -eq 0]; do | ||
| sleep 1 | ||
| ((timeout--)) | ||
| done | ||
| if [ $timeout -eq 0 ]; then | ||
| echo "Error: MongoDB failed to start within timeout" | ||
| docker-compose -f docker-compose.dev.yaml logs mongodb | ||
| docker-compose -f docker-compose.dev.yaml down -v | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Waiting for Redis..." | ||
| timeout=30 | ||
| until docker-compose -f docker-compose.dev.yaml exec -T redis-stack-server redis-cli ping >dev/null 2>&1 || [ $timemout -eq 0]; do | ||
| sleep 1 | ||
| ((timeout--)) | ||
| done | ||
| if[ $timeout -eq 0 ]; then | ||
| echo "Error: Redis failed to start within timeout" | ||
| docker-compose -f docker-compose.dev.yaml logs redis-stack-server | ||
| docker-compose -f docker-compose.dev.yaml down -v | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Wait for TALAWA API to be healthy | ||
| timeout=60 | ||
| until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf "http://talawa-api-dev:4000/health" 2>&1 || [ $timeout -eq 0 ]; do | ||
| echo "Waiting for API to start... ($timeout seconds remaining)" | ||
| sleep 1 | ||
| ((timeout--)) | ||
| done | ||
|
|
||
| if [ $timeout -eq 0 ]; then | ||
| echo "Error: API failed to start within timeout" | ||
| docker-compose -f docker-compose.dev.yaml logs | ||
| docker-compose -f docker-compose.dev.yaml down -v | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "API started successfully" | ||
|
|
||
| # Ensure cleanup runs even if the script fails | ||
| cleanup() { | ||
| echo "Cleaning up containers..." | ||
| if ! docker-compose -f docker-compose.dev.yaml down -v; then | ||
| echo "Warning: Failed to cleanup containers" | ||
| fi | ||
| } | ||
|
|
||
| trap cleanup EXIT | ||
| env: | ||
| HEALTH_CHECK_URL: http://localhost:4000 | ||
| COMPOSE_PROJECT_NAME: pr-${{ github.event.pull_request.number }} | ||
| MONGO_DB_URL: mongodb://mongodb:27017/talawa-test-db | ||
| REDIS_HOST: redis-stack-server | ||
| REDIS_PORT: 6379 | ||
| ACCESS_TOKEN_SECRET: ${{ github.event.repository.name }}_access_${{ github.sha }} | ||
| REFRESH_TOKEN_SECRET: ${{ github.event.repository.name }}_refresh_${{ github.sha }} | ||
| LAST_RESORT_SUPERADMIN_EMAIL: "[email protected]" | ||
| COLORIZE_LOGS: "true" | ||
| LOG_LEVEL: "info" | ||
| RECAPTCHA_SITE_KEY: ${{secrets.RECAPTCHA_SITE_KEY}} | ||
| RECAPTCHA_SECRET_KEY: ${{secrets.RECAPTCHA_SECRET_KEY}} | ||
| MAIL_USERNAME: ${{secrets.MAIL_USERNAME}} | ||
| MAIL_PASSWORD: ${{secrets.MAIL_PASSWORD}} | ||
|
|
There was a problem hiding this comment.
💡 Codebase verification
Docker configuration needs adjustments for health checks and environment variables
The workflow implementation has a few mismatches with the actual docker-compose.dev.yaml configuration:
- The health check URL in the workflow uses port 4000, but the docker-compose file doesn't expose this port for talawa-api-dev service
- Some environment variables set in the workflow (like ACCESS_TOKEN_SECRET, MAIL_USERNAME) are not configured in the docker-compose file
- The MongoDB URL format differs between workflow (talawa-test-db) and docker-compose configuration
Required changes:
- Add port mapping for talawa-api-dev service:
- "4000:4000" - Add missing environment variables to talawa-api-dev service configuration
- Align MongoDB URL format between workflow and docker-compose
🔗 Analysis chain
Overall implementation looks good with minor improvements needed
The Docker check implementation is well-structured with proper error handling, timeouts, and cleanup. It successfully addresses the PR objective of ensuring the Talawa API starts in Docker. The suggested fixes are primarily syntax-related and should be addressed for better reliability.
Let's verify the docker-compose file existence and content:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify docker-compose file and its configuration
if [ -f "docker-compose.dev.yaml" ]; then
echo "docker-compose.dev.yaml exists"
# Check for required services
yq e '.services | keys' docker-compose.dev.yaml
# Check for required environment variables
yq e '.services.*.environment[]' docker-compose.dev.yaml
else
echo "docker-compose.dev.yaml not found"
exit 1
fi
Length of output: 402
Script:
#!/bin/bash
# Let's verify the docker-compose file content directly using cat
if [ -f "docker-compose.dev.yaml" ]; then
echo "docker-compose.dev.yaml exists"
cat docker-compose.dev.yaml
else
echo "docker-compose.dev.yaml not found"
exit 1
fi
Length of output: 1570
🧰 Tools
🪛 actionlint (1.7.4)
372-372: could not parse as YAML: yaml: line 372: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 323-323: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 407-407: trailing spaces
(trailing-spaces)
[error] 374-374: syntax error: could not find expected ':'
(syntax)
|
making changes as suggested |
…ansh-talawa-api into api_fail_docker merge# Please enter a commit message to explain why this merge is necessary,
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
.github/workflows/pull-request.yml (2)
311-320: Optimize cache configurationConsider adding package-lock.json to the cache key for better cache hits.
- name: Cache Node.js dependencies uses: actions/cache@v4 with: path: | ~/.npm node_modules - key: ${{ runner.os }}-docker-check-${{ hashFiles('**/package-lock.json') }} + key: ${{ runner.os }}-docker-check-node-${{ hashFiles('package-lock.json') }} restore-keys: | - ${{ runner.os }}-docker-check- + ${{ runner.os }}-docker-check-node-
333-337: Improve error handling in container startupConsider capturing and displaying the exit code for better debugging.
-if ! timeout 300 docker-compose -f docker-compose.dev.yaml up -d --build; then +if ! timeout 300 docker-compose -f docker-compose.dev.yaml up -d --build; then + exit_code=$? echo "Failed to start containers" + echo "Exit code: $exit_code" docker-compose -f docker-compose.dev.yaml logs exit 1 fi
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/pull-request.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/pull-request.yml
372-372: could not parse as YAML: yaml: line 372: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 323-323: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 407-407: trailing spaces
(trailing-spaces)
[error] 374-374: syntax error: could not find expected ':'
(syntax)
🔇 Additional comments (2)
.github/workflows/pull-request.yml (2)
307-307: Fix action step configuration syntax
The Node.js setup step has incorrect syntax.
-- uses: actions/setup-node@v4
+ - uses: actions/setup-node@v4392-407: Verify environment variable configuration
Please verify that these environment variables match the ones in docker-compose.dev.yaml.
🧰 Tools
🪛 yamllint (1.35.1)
[error] 407-407: trailing spaces
(trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Outside diff range and nitpick comments (2)
.github/workflows/pull-request.yml (2)
393-407: LGTM: Environment variables are well configuredThe environment variables are properly set with appropriate use of secrets. Just remove trailing spaces at line 407.
- MAIL_PASSWORD: ${{secrets.MAIL_PASSWORD}} - + MAIL_PASSWORD: ${{secrets.MAIL_PASSWORD}}
299-407: Consider enhancing the Docker health check implementationSome suggestions to improve the implementation:
- Consider using Docker's built-in HEALTHCHECK instruction in Dockerfile instead of shell-based health checks
- Consider implementing exponential backoff for health checks instead of fixed intervals
- Consider adding container resource limits to prevent resource exhaustion
These changes would make the health checks more robust and maintainable.
🧰 Tools
🪛 actionlint (1.7.4)
372-372: could not parse as YAML: yaml: line 372: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 323-323: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 374-374: syntax error: could not find expected ':'
(syntax)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/pull-request.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/pull-request.yml
372-372: could not parse as YAML: yaml: line 372: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 323-323: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 408-408: trailing spaces
(trailing-spaces)
[error] 374-374: syntax error: could not find expected ':'
(syntax)
🔇 Additional comments (2)
.github/workflows/pull-request.yml (2)
299-320: LGTM: Job configuration follows best practices
The job configuration is well-structured with proper dependency management and caching strategy.
353-364:
Fix Redis health check syntax
There's a syntax error in the if condition:
- if[ $timeout -eq 0 ]; then
+ if [ $timeout -eq 0 ]; thenLikely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
.github/workflows/pull-request.yml (2)
321-337: Fix formatting and enhance error logging.
- Remove trailing spaces after
run :and in the if condition- Add container logs to the error message when docker-compose file is not found
- run : | + run: | # Ensure no containers are running docker-compose -f docker-compose.dev.yaml down -v || true # Verify docker-compose file exists - if [ ! -f "docker-compose.dev.yaml" ]; then + if [ ! -f "docker-compose.dev.yaml" ]; then echo "Error: docker-compose.dev.yaml not found" + docker-compose -f docker-compose.dev.yaml logs exit 1 fi🧰 Tools
🪛 yamllint (1.35.1)
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
366-382: Enhance API health check implementation.Consider adding additional health check parameters to ensure comprehensive API readiness:
- Add request timeout to curl command
- Check for specific health check response content
- until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf "http://localhost:4000/health" 2>&1 || [ $timeout -eq 0 ]; do + until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf --max-time 5 "http://localhost:4000/health" 2>&1 | grep -q '"status":"healthy"' || [ $timeout -eq 0 ]; do🧰 Tools
🪛 yamllint (1.35.1)
[error] 366-366: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/pull-request.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/pull-request.yml
384-384: could not parse as YAML: yaml: line 384: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 409-409: trailing spaces
(trailing-spaces)
[error] 388-388: syntax error: could not find expected ':'
(syntax)
🔇 Additional comments (2)
.github/workflows/pull-request.yml (2)
299-320: LGTM! Job configuration follows best practices.
The job configuration is well-structured with proper dependency setup, Node.js configuration, and dependency caching.
299-409: Overall implementation achieves the PR objective.
The Docker check implementation successfully verifies that the Talawa API starts correctly in a Docker environment. It includes proper health checks, timeouts, and cleanup procedures. The remaining issues are mostly syntax and formatting related, which have been addressed in previous comments.
🧰 Tools
🪛 actionlint (1.7.4)
384-384: could not parse as YAML: yaml: line 384: could not find expected ':'
(syntax-check)
🪛 yamllint (1.35.1)
[error] 322-322: trailing spaces
(trailing-spaces)
[error] 327-327: trailing spaces
(trailing-spaces)
[error] 366-366: trailing spaces
(trailing-spaces)
[error] 409-409: trailing spaces
(trailing-spaces)
[error] 388-388: syntax error: could not find expected ':'
(syntax)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
.github/workflows/pull-request.yml (2)
367-380: Fix indentation in API health check.The indentation is inconsistent in this section, which affects readability.
- # Wait for TALAWA API to be healthy - until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf "http://localhost:4000/health" 2>&1 || [ $timeout -eq 0 ]; do - echo "Waiting for API to start... ($timeout seconds remaining)" - sleep 1 - ((timeout--)) - done + # Wait for TALAWA API to be healthy + until docker-compose -f docker-compose.dev.yaml exec -T talawa-api-dev curl -sf "http://localhost:4000/health" 2>&1 || [ $timeout -eq 0 ]; do + echo "Waiting for API to start... ($timeout seconds remaining)" + sleep 1 + ((timeout--)) + done🧰 Tools
🪛 yamllint (1.35.1)
[error] 367-367: trailing spaces
(trailing-spaces)
394-409: Fix trailing spaces in environment variables section.Remove trailing spaces to maintain consistent formatting.
- MAIL_PASSWORD: ${{secrets.MAIL_PASSWORD}} - + MAIL_PASSWORD: ${{secrets.MAIL_PASSWORD}} +🧰 Tools
🪛 yamllint (1.35.1)
[warning] 395-395: wrong indentation: expected 6 but found 8
(indentation)
[error] 409-409: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/pull-request.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/pull-request.yml
322-322: shellcheck reported issue in this script: SC1069:error:38:3: You need a space before the [
(shellcheck)
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml
[error] 367-367: trailing spaces
(trailing-spaces)
[warning] 395-395: wrong indentation: expected 6 but found 8
(indentation)
[error] 409-409: trailing spaces
(trailing-spaces)
🔇 Additional comments (5)
.github/workflows/pull-request.yml (5)
299-320: LGTM! Job configuration follows best practices.
The job configuration is well-structured with proper dependency management, Node.js setup, and dependency caching.
321-338: LGTM! Docker startup implementation is robust.
The implementation includes proper error handling, timeouts, and cleanup of existing containers.
🧰 Tools
🪛 actionlint (1.7.4)
322-322: shellcheck reported issue in this script: SC1069:error:38:3: You need a space before the [
(shellcheck)
343-343: Fix MongoDB health check syntax.
There's a syntax error in the until condition that needs to be fixed.
-until docker-compose -f docker-compose.dev.yaml exec -T mongodb mongo --eval "db.runCommand('ping').ok">/dev/null 2>&1 || [ $timeout -eq 0]; do
+until docker-compose -f docker-compose.dev.yaml exec -T mongodb mongo --eval "db.runCommand('ping').ok" >/dev/null 2>&1 || [ $timeout -eq 0 ]; do360-365: Fix Redis health check syntax and indentation.
There are syntax errors in the Redis health check implementation.
-if[ $timeout -eq 0 ]; then
+if [ $timeout -eq 0 ]; then384-393: LGTM! Cleanup implementation follows best practices.
The cleanup function correctly preserves the exit code and uses trap for proper cleanup on script exit.
|
There isn’t an issue assigned to you for this PR. Please follow the guidelines in our PR_GUIDELINES.md file. We have the procedures in place so that everyone has a fair chance of contributing. I will be closing this pull request. Please follow the procedures and resubmit when ready. |
|
@Cioppolo14 I accidently tagged the wrong issue, but I am assigned to this issue: #2638..please re-open this |
|
Please make sure all tests pass and coderabbit.ai approves the PR |
What kind of change does this PR introduce?
Changing workflow to ensure that talawa api starts in docker
Issue Number:
#2638
Fixes #
Did you add tests for your changes?
No
Snapshots/Videos:
If relevant, did you update the documentation?
Summary
Does this PR introduce a breaking change?
Other information
Have you read the contributing guide?
Summary by CodeRabbit
New Features
Docker-Checkjob in the CI/CD workflow to ensure the Talawa API functions correctly within a Docker container.Bug Fixes
Docker-Checkjob configuration.