Detachable Server Execution #3315
Conversation
WalkthroughThe changes adjust the post-creation behavior of the development container and update related documentation. In the development container configuration, the command that automatically starts the development server has been removed so that only setup tasks (ownership changes, dependency installation, and corepack enabling) remain. Meanwhile, documentation updates now include a new command to manually start the development server inside the Docker container and revised instructions for starting the container in “Attached Mode” or “Detached Mode” with a structured JSON output. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageTooldocs/docs/docs/getting-started/installation.md[grammar] ~310-~310: The word “output” is spelled as one word. (OUT_COMPOUNDS) 🪛 markdownlint-cli2 (0.17.2)docs/docs/docs/getting-started/installation.md310-310: Ordered list item prefix (MD029, ol-prefix) 312-312: Fenced code blocks should have a language specified (MD040, fenced-code-language) 334-334: Fenced code blocks should have a language specified (MD040, fenced-code-language) 340-340: Fenced code blocks should have a language specified (MD040, fenced-code-language) ⏰ Context from checks skipped due to timeout of 90000ms (1)
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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3315 +/- ##
=================================================
Coverage 48.57% 48.57%
=================================================
Files 458 458
Lines 34489 34489
Branches 971 971
=================================================
Hits 16752 16752
Misses 17737 17737 ☔ View full report in Codecov by Sentry. |
![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
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
.devcontainer/devcontainer.json(1 hunks)docs/docs/docs/developer-resources/testing.md(1 hunks)docs/docs/docs/getting-started/installation.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/docs/getting-started/installation.md
[grammar] ~310-~310: The word “output” is spelled as one word.
Context: ...tallation is complete, the last line of out put should look like this: ``` ... ... ......
(OUT_COMPOUNDS)
🪛 markdownlint-cli2 (0.17.2)
docs/docs/docs/getting-started/installation.md
310-310: Ordered list item prefix
Expected: 1; Actual: 12; Style: 1/1/1
(MD029, ol-prefix)
312-312: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
335-335: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
341-341: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Test Deployment to https://docs-api.talawa.io
- GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (1)
.devcontainer/devcontainer.json (1)
70-74: Deprecate Automatic Server Startup in postCreateCommand
The removal of thepnpm run start_development_servercommand from thepostCreateCommandaligns perfectly with the PR objective. This change now delegates the responsibility of starting the server to a manual invocation. Please ensure that the remaining initialization steps (ownership changes, dependency installation, and enabling corepack) fully cover the necessary setup tasks.
|
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 am sorry, I forgot to mention issue, Raising another PR with proper reference. |
Overview
Depricating pnpm run start_development_server from postCreateCommand to gain complete control how server is start.
This allows us to start server inside docker and detach cli from it safely.
Recommended cron job:
cd /home/talawa-api/talawa-api && docker compose down --rmi all --volumes && docker compose down --rmi all --volumes && git checkout --force develop-postgres && git fetch upstream && git reset upstream/develop-postgres --hard && rm -rf node_modules && pnpm install && cp -f envFiles/.env.devcontainer .env && sed -i "s|MAPPED_PORT=80|MAPPED_PORT=8080|g" .env && sed -i "s|MAPPED_PORT=443|MAPPED_PORT=8443|g" .env && devcontainer build --workspace-folder . && devcontainer up --workspace-folder . && docker exec talawa-api-1 /bin/bash -c 'nohup pnpm run start_development_server > /dev/null 2>&1 &'For sample data it remains same
Note: This ensures successful execution provided cron has access to crud operation and deamon/pnpm, also docker service is running
Screenshots
This was run with above command , we can notice that in the end it does not struck to server listening but that in run inside docker in the back and detached safely
Summary by CodeRabbit
Chores
Documentation