helloanil commented 2 months ago

What Github issue does this PR relate to? Insert link.

712

What should the reviewer know?

This PR is focusing only on the top 3 priority emails from the reminders list:

Send Email Reminders to Users who have not completed their Profile
Automatically Remind Approved Mentees Without Mentor Applications to Apply
Reminder To Mentors To Follow Up On Long-Term (3+ months) Mentorship
Reminder To Mentees To Follow Up On Long-Term (3+ months) Mentorship

The automation part will be done in parallel, by writing a service script either directly in the server, or using a service like val.town

Summary by CodeRabbit

New Features
- Introduced ReminderEmailsModule to manage reminder emails for mentorship activities.
- Added CronjobAuthGuard to secure routes based on authorization tokens.
- Implemented services and controllers to handle various reminder emails for mentors and mentees.
- Integrated Salesforce API to fetch email templates.
Tests
- Added test suites for ReminderEmailsController and ReminderEmailsService.
Chores
- Updated .gitignore to exclude specific infrastructure and script files.

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent update to the NestJS API introduces a new ReminderEmailsModule that handles sending reminder emails to mentors and mentees. This includes adding controllers, services, and guards for the new module. Additionally, the .gitignore file has been updated to exclude specific directories, and new test files have been added to ensure the functionality of the reminder email features.

Changes

File Path	Change Summary
`.gitignore`	Added exclusions for `infrastructure/.terraform` and `/reminder-email-scripts/*`.
`apps/nestjs-api/src/app/app.module.ts`	Imported and added `ReminderEmailsModule` to the modules list.
`apps/nestjs-api/src/auth/cronjob-auth.guard.ts`	Introduced `CronjobAuthGuard` class for route guarding based on authorization token.
`apps/nestjs-api/src/reminder-emails/...`	Added `ReminderEmailsController`, `ReminderEmailsService`, and their respective test files.
`apps/nestjs-api/src/salesforce-api/...`	Added `SfApiEmailTemplatesService` for retrieving email templates from Salesforce and updated `SfApiModule` to include the new service.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant ReminderEmailsController
    participant ReminderEmailsService
    participant SfApiEmailTemplatesService
    participant AWS SES

    Client->>+ReminderEmailsController: Request to send reminder email
    ReminderEmailsController->>+ReminderEmailsService: Process request
    ReminderEmailsService->>+SfApiEmailTemplatesService: Retrieve email template
    SfApiEmailTemplatesService-->>-ReminderEmailsService: Email template
    ReminderEmailsService->>+AWS SES: Send email
    AWS SES-->>-ReminderEmailsService: Confirmation
    ReminderEmailsService-->>-ReminderEmailsController: Email sent
    ReminderEmailsController-->>-Client: Response

Poem

In the code where emails fly,
A module built to reach the sky,
Reminders sent with gentle cheer,
To mentors, mentees far and near.
Salesforce whispers templates sweet,
While guards ensure the code's elite.
A rabbit hops with joyful glee,
For changes made so splendidly. 🐇

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

ericbolikowski commented 2 months ago

Ready for review?

helloanil commented 2 months ago

Ready for review?

@ericbolikowski Yes. Please go ahead and review 🙏

helloanil commented 1 month ago

Hey @ericbolikowski and @katamatata, here are the latest news on this task and I need your help:

I decided to move script file to gitignore for two reasons. I'll create this file manually on the server, alongside the background service that will take care of the automation. I will send you the script code on Slack so you can review it there.

It's not gonna be useful in anyone's local, yet it can be even dangerous
It includes some stuff that's better not be public

I will start testing this task with two reminders only, which is the top priority ones. (Mentors and Mentees to complete their profile). There are few more reminders ready but I haven't tested them properly yet. They are commented out (see the last commit). Please let's focus on only the first two reminders for now.