feat(api): Reading port Dynamically

[Animesh7853]

User description

Description

Made the port dynamic in the api as instructed in the issue

Fixes #134

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

@rajdip-b

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

Type

enhancement

---

Description

• Dynamically set the API port in the main application file using the API_PORT environment variable, with a fallback to 4200 if not set.
• Added an example for the API_PORT environment variable in the .env.example file.
• Modified the Dockerfile to expose the port defined by the API_PORT environment variable, with a fallback to 4200.

---

Changes walkthrough

	Relevant files
Enhancement	main.ts Dynamically Set API Port from Environment Variable              apps/api/src/main.ts Dynamically set the API port using environment variable API_PORT, with a fallback to 4200 if not set. +1/-1
Configuration changes	.env.example Added API_PORT Environment Variable Example                            .env.example Added API_PORT environment variable example. +2/-0      Dockerfile Use API_PORT Environment Variable in Dockerfile                    apps/api/Dockerfile Modified EXPOSE to use API_PORT environment variable with a fallback to 4200. +1/-1

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Description updated to latest commit (5630320)

[codiumai-pr-agent-free]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and localized to a few files. The logic for dynamically setting the port is simple and follows common practices. However, the reviewer should verify the correct handling of environment variables and ensure that the Dockerfile changes will work as expected.
🧪 Relevant tests	No
🔍 Possible issues	Environment Variable Handling: Ensure that the process.env.API_PORT is always a valid number and consider adding a check to ensure it falls within an acceptable range of port numbers.
	Dockerfile EXPOSE Instruction: The use of a variable in the EXPOSE instruction is not standard and might not work as expected. Docker's EXPOSE does not support variables; it requires a static port number. This might necessitate a different approach to dynamically exposing ports in Docker.
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, require_can_be_split_review, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Code Suggestions

Category	Suggestions
Enhancement	Parse the API_PORT environment variable as an integer. Consider parsing the API_PORT environment variable as an integer before using it. This ensures that the port variable is always of the correct type, as environment variables are read as strings. apps/api/src/main.ts [95] -const port = process.env.API_PORT || 4200 +const port = parseInt(process.env.API_PORT, 10) || 4200
	Validate the API_PORT value and handle invalid numbers gracefully. Ensure that the application gracefully handles the scenario where API_PORT is not a valid number by either logging an error or setting a default port. apps/api/src/main.ts [95] -const port = parseInt(process.env.API_PORT, 10) || 4200 +const rawPort = process.env.API_PORT; +const port = Number.isInteger(parseInt(rawPort, 10)) ? parseInt(rawPort, 10) : 4200; +if (port !== parseInt(rawPort, 10)) { + console.error(`Invalid port number "${rawPort}", using default port 4200.`); +}
Best practice	Add a default value for API_PORT in the .env.example. Provide a default value for API_PORT in the .env.example file to guide developers on the expected format and to offer a sensible default configuration. .env.example [8] -API_PORT= +API_PORT=4200
	Use a direct port number in the EXPOSE instruction for clarity. Ensure that the EXPOSE instruction uses a default port directly in the Dockerfile for better readability and to avoid potential issues with default values not being applied correctly when the environment variable is not set. apps/api/Dockerfile [30] -EXPOSE ${API_PORT:-4200} +EXPOSE 4200
	Document the use of API_PORT environment variable in Docker. Consider documenting the use of the API_PORT environment variable in the Dockerfile or an associated README to inform users about how to set the port via an environment variable. apps/api/Dockerfile [30] +# To set a custom port, pass the API_PORT environment variable to docker run EXPOSE ${API_PORT:-4200}

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[rajdip-b]

Would you please update the docs for this page? You can find the relevant docs in the docs folder!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.80%. Comparing base (7bb3d21) to head (5630320).
Report is 31 commits behind head on develop.

❗ Current head 5630320 differs from pull request most recent head 2e4f605. Consider uploading reports for the commit 2e4f605 to get more accurate results

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #170       +/-   ##
============================================
+ Coverage    62.20%   94.80%   +32.59%     
============================================
  Files           76       91       +15     
  Lines         1503     2001      +498     
  Branches       260      394      +134     
============================================
+ Hits           935     1897      +962     
+ Misses         568      104      -464     

Flag	Coverage Δ
api-e2e-tests	94.80% <ø> (+32.59%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Animesh7853]

Would you please update the docs for this page? You can find the relevant docs in the docs folder!

Okay I'll do

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[rajdip-b]

LGTM! @Animesh7853

[rajdip-b]

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀