talent-connect / connect

Mentor-mentee and jobseeker-company matchmaking platform used by ReDI School of Digital Integration, in Berlin, Munich and Düsseldorf, Germany.
https://connect.berlin.redi-school.org
19 stars 8 forks source link

Con Reminder Emails (Continued) #924

Open helloanil opened 1 week ago

helloanil commented 1 week ago

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

712

What should the reviewer know?

Adding a new endpoint sendUnmatchedMenteesReminder to the ReminderEmailsController in reminder-emails.controller.ts. It retrieves a list of unmatched mentees for 45 days and sends reminder emails to each mentee. The email includes the mentee's email and first name.

Also includeing a return message indicating the number of reminder emails sent.

And adding a new endpoint in the ReminderEmailsController to send reminder emails to mentors with pending mentorship applications. The sendPendingMentorshipsReminder function retrieves the pending mentorship matches and sends reminder emails to the corresponding mentors. The number of reminder emails sent is included in the response message.

Screenshots

CleanShot 2024-06-27 at 22 25 02

CleanShot 2024-06-27 at 22 23 07

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The recent updates introduce clearer messaging and refined logic to the ReminderEmailsController in the NestJS API. New functionalities for handling reminders about unmatched mentees and pending mentorships have been added, while existing methods and logic in related services have been updated for consistency and precision.

Changes

File Path Change Summary
apps/nestjs-api/src/reminder-emails/reminder-emails.controller.ts Updated messages for clarity. Modified sendUnmatchedMenteesReminder to handle unmatched mentees for 45 days. Added sendPendingMentorshipsReminder method.
apps/nestjs-api/src/reminder-emails/reminder-emails.service.ts Introduced new functions getUnmatchedMenteesFor45Days and getPendingMenteeApplications. Added constants for sender info. Adjusted email sending logic.
apps/nestjs-api/src/con-mentorship-matches/con-mentorship-matches.service.ts Renamed variables and method calls for consistency (e.g., menteePendingMentorshipMatches to menteependingMenteeApplications).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ReminderEmailsController
    participant ReminderEmailsService
    participant ConMentorshipMatchesService
    participant EmailService

    User ->> ReminderEmailsController: sendUnmatchedMenteesReminder()
    ReminderEmailsController ->> ReminderEmailsService: getUnmatchedMenteesFor45Days()
    ReminderEmailsService ->> ConMentorshipMatchesService: retrieveUnmatchedMenteesData()
    ConMentorshipMatchesService -->> ReminderEmailsService: unmatchedMenteesData
    ReminderEmailsService ->> EmailService: sendReminderEmails(unmatchedMenteesData)
    EmailService -->> ReminderEmailsService: status
    ReminderEmailsService -->> ReminderEmailsController: unmatchedMenteesData.length
    ReminderEmailsController -->> User: Platform Update Reminder Emails Sent to Mentees: ${unmatchedMenteesData.length}

    User ->> ReminderEmailsController: sendPendingMentorshipsReminder()
    ReminderEmailsController ->> ReminderEmailsService: getPendingMenteeApplications()
    ReminderEmailsService ->> ConMentorshipMatchesService: retrievePendingMenteeApplicationsData()
    ConMentorshipMatchesService -->> ReminderEmailsService: pendingMenteeApplicationsData
    ReminderEmailsService ->> EmailService: sendReminderEmails(pendingMenteeApplicationsData)
    EmailService -->> ReminderEmailsService: status
    ReminderEmailsService -->> ReminderEmailsController: pendingMenteeApplicationsData.length
    ReminderEmailsController -->> User: Pending Mentorship Reminder emails sent to Mentors: ${pendingMenteeApplicationsData.length}

Poem

From service lines and data streams,
To unmatched dreams and mentor beams,
New reminders now take flight,
Bringing clarity to the night.
Emails sent with joy and cheer,
Until our next update is near.
🐇✨📧


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.
astkhikatredi commented 1 week ago

Hi @helloanil , thank you! Do you know why the text on the first one is purple?

helloanil commented 1 week ago

Hi @helloanil , thank you!

Do you know why the text on the first one is purple?

Hi @astkhikatredi, it's because of Gmail. When the same email is received many times, Gmail stacks them and show some of them in purple. It won't happen to users.