feat: AutoCreate Admin On Startup

[HarshPatel5940]

User description

Description

This pull request adds a new feature to create an admin user. It includes the following commits:

• feat: add admin user creation
• needs to be tested and resolve todos
• chore: code cleanup

The changes include adding a new method adminUserCreateEmail to the MailService class, updating the UserService class to check if an admin user exists and create one if not, and updating the .gitignore file to exclude certain directories.

Fixes #94

Future Improvements

we can plausibly improve the template of emails we send.

Mentions

@rajdip-b

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work
• 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
• 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

This PR introduces a new feature to create an admin user on application startup if one does not exist. The main changes include:

• Addition of a new method adminUserCreateEmail in the IMailService interface, MailService and MockMailService classes to handle sending an email when an admin user is created.
• Addition of methods onApplicationBootstrap, checkIfAdminExistsOrCreate and createAdminUser in the UserService class to check if an admin user exists on application startup and create one if not.
• Addition of a new environment variable ADMIN_EMAIL in the .env.example file.
• Update to the list of included files in tsconfig.json.

---

Changes walkthrough

	Relevant files
Enhancement	interface.service.ts Addition of `adminUserCreateEmail` method to `IMailService` interface apps/api/src/mail/services/interface.service.ts Added a new method adminUserCreateEmail to the IMailService interface. +3/-3      mail.service.ts Reformatted `accountLoginEmail` and added `adminUserCreateEmail` method apps/api/src/mail/services/mail.service.ts Reformatted the accountLoginEmail method. Added a new method adminUserCreateEmail to send an email when an admin user is created. +20/-3    mock.service.ts Addition of `adminUserCreateEmail` method to `MockMailService`      apps/api/src/mail/services/mock.service.ts Added a new method adminUserCreateEmail to log the creation of an admin user. +4/-0      user.service.ts Addition of methods for admin user creation in `UserService`          apps/api/src/user/service/user.service.ts Added a new method onApplicationBootstrap to check if an admin user exists or create one. Added methods checkIfAdminExistsOrCreate and createAdminUser to handle admin user creation. +38/-1
Configuration changes	.env.example Addition of `ADMIN_EMAIL` environment variable                                      .env.example Added a new environment variable ADMIN_EMAIL. +1/-0      tsconfig.json Update to included files in `tsconfig.json`                                            apps/web/tsconfig.json Updated the list of included files. +2/-1

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. 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 describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

Utilizing extra instructions The describe tool can be configured with extra instructions, 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. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: [pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

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 describe usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Description updated to latest commit (083d645)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Adding functionality to automatically create an admin user on application startup if one does not exist.
• 📝 PR summary: This PR introduces a new feature that checks for an admin user on application startup and creates one if it doesn't exist. This is achieved by adding new methods in the UserService and MailService classes. Additionally, the .env.example and tsconfig.json files have been updated.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 3, because the PR involves changes in multiple files and introduces new functionality. However, the code is well-structured and follows good practices, making it easier to understand.
• 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The code changes look good overall. However, it would be beneficial to add error handling for the case where the admin user creation fails. Also, consider adding tests for the new functionality to ensure it works as expected.

---

✨ 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 'general suggestions' 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, and more.

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

	Suggestions
maintainability	Replace hardcoded email address with a variable.                              Instead of hardcoding the email address '[email protected]' in the adminUserCreateEmail method, consider using a variable or a constant. This would make the code more maintainable and flexible. apps/api/src/mail/services/mail.service.ts [121-137] async adminUserCreateEmail(email: string): Promise<void> { ... - await this.sendEmail('[email protected]', subject, body) + await this.sendEmail(email, subject, body) } Replace hardcoded default admin email with a constant.                        Consider using a constant for the default admin email '[email protected]' in the createAdminUser method. This would make the code more maintainable and flexible. apps/api/src/user/service/user.service.ts [195-211] private async createAdminUser() { ... - email: process.env.ADMIN_EMAIL || '[email protected]', + const DEFAULT_ADMIN_EMAIL = '[email protected]'; + email: process.env.ADMIN_EMAIL || DEFAULT_ADMIN_EMAIL, ... }
enhancement	Add functionality to the mock method for creating an admin user email.        Consider adding some functionality to the adminUserCreateEmail method in the MockMailService class. Currently, it only logs the email, which might not be sufficient for testing purposes. apps/api/src/mail/services/mock.service.ts [33-35] async adminUserCreateEmail(email: string): Promise<void> { this.log.log(`Create pAdmin User Email: ${email}`) + // Add some mock functionality here } Add error handling for admin user creation.                                   Consider handling the case where the admin user creation fails in the createAdminUser method. Currently, if the creation fails, the error is not caught and handled. apps/api/src/user/service/user.service.ts [195-211] private async createAdminUser() { ... - const adminUser = await this.prisma.user.create({ - data: { - ... - } - }) - ... + try { + const adminUser = await this.prisma.user.create({ + data: { + ... + } + }) + ... + } catch (error) { + this.log.error('Failed to create admin user', error) + } }

---

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

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

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

See analysis details on SonarCloud

[rajdip-b]

🎉 This PR is included in version 1.0.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[rajdip-b]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀