Change subscribe clause for compulsory emails

BenjaminSsempala commented 2 months ago

WHAT DOES THIS PR DO?

[ ] Change subscribe clause for compulsory emails

HOW DO I TEST OUT THIS PR?

[ ] Auth Service: Link to Auth Service README

Summary by CodeRabbit

New Features
- Enhanced email templates with optional unsubscribe clause.
- Introduced new function for handling unsubscribe logic in email templates.
Refactor
- Updated email template functions to use object parameter destructuring for improved readability.
Bug Fixes
- Ensured consistent handling of optional parameters in email templates.

coderabbitai[bot] commented 2 months ago

Walkthrough

## Walkthrough The modifications to the `auth-service` module enhance email template handling by introducing object parameter destructuring, improving readability and maintaining consistency. Functions now accept parameters as objects, and the `EMAIL_FOOTER_TEMPLATE` function includes an `optional` parameter for conditional unsubscribe clauses. These changes simplify the code and make it more maintainable. ## Changes | File | Change Summary | | ----------------------- | -------------- | | `src/auth-service/config/global/email-templates.js` | Updated `EMAIL_GREETINGS`, `EMAIL_FOOTER_TEMPLATE`, and `EMAIL_BODY` to use object parameter destructuring. Added `EMAIL_UNSUBSCRIBE_CLAUSE` function for handling unsubscribe clauses. | | `src/auth-service/utils/email.msgs.js` | Converted calls to `constants.EMAIL_BODY()` to use object destructuring for parameters. | | `src/auth-service/utils/email.templates.js` | Modified functions (`forgotPasswordReset`, `acceptInvitation`, `afterEmailVerification`, etc.) to use object parameter destructuring. | > 📜 In the realm of code, so bright and clear, > Email templates morph, bringing cheer. > Parameters now in objects dwell, > Readability and ease, they spell. > Unsubscribe clauses, optional delight, > In emails crafted through the night. > A cleaner path, we now embark, > With changes sparking a brighter arc. 🚀

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

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 0% with 37 lines in your changes missing coverage. Please review.

Project coverage is 30.25%. Comparing base (8892d37) to head (e3d119a).

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3264/graphs/tree.svg?width=650&height=150&src=pr&token=HHq3qS3cL6&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform)](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3264?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform) ```diff @@ Coverage Diff @@ ## staging #3264 +/- ## =========================================== - Coverage 30.26% 30.25% -0.01% =========================================== Files 184 184 Lines 24523 24528 +5 Branches 3209 3210 +1 =========================================== Hits 7421 7421 - Misses 16988 16993 +5 Partials 114 114 ``` | [Files](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3264?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform) | Coverage Δ | | |---|---|---| | [src/auth-service/utils/email.templates.js](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3264?src=pr&el=tree&filepath=src%2Fauth-service%2Futils%2Femail.templates.js&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform#diff-c3JjL2F1dGgtc2VydmljZS91dGlscy9lbWFpbC50ZW1wbGF0ZXMuanM=) | `9.37% <0.00%> (ø)` | | | [src/auth-service/config/global/email-templates.js](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3264?src=pr&el=tree&filepath=src%2Fauth-service%2Fconfig%2Fglobal%2Femail-templates.js&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform#diff-c3JjL2F1dGgtc2VydmljZS9jb25maWcvZ2xvYmFsL2VtYWlsLXRlbXBsYXRlcy5qcw==) | `15.62% <0.00%> (-2.24%)` | :arrow_down: | | [src/auth-service/utils/email.msgs.js](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3264?src=pr&el=tree&filepath=src%2Fauth-service%2Futils%2Femail.msgs.js&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform#diff-c3JjL2F1dGgtc2VydmljZS91dGlscy9lbWFpbC5tc2dzLmpz) | `3.53% <0.00%> (-0.04%)` | :arrow_down: |