airqo-platform / AirQo-api

This repo contains API definitions for the AirQo platform
MIT License
22 stars 20 forks source link

adding the token name in the email alert #3252

Closed Baalmart closed 3 months ago

Baalmart commented 3 months ago

WHAT DOES THIS PR DO?

HOW DO I TEST OUT THIS PR?

WHICH ENDPOINTS SHOULD BE READY FOR TESTING?:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The recent changes aim to enhance token handling functionalities in the `auth-service` module. Specifically, the `isIPBlacklistedHelper` function now includes token logging for expired AirQo Analytics Access Tokens. Additionally, the `tokenExpired` and `expiredToken` functions now accept a `token` parameter, improving email content and token management functionalities. ## Changes | File Path | Change Summary | |-------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | `src/.../utils/control-access.js` | Modified `isIPBlacklistedHelper` function to include `token` in the destructuring assignment from `tokenDetails`. | | `src/.../utils/email.msgs.js` | Updated `tokenExpired` function signature to include a `token` parameter. | | `src/.../utils/mailer.js` | Added a `token` parameter with a default value to the `expiredToken` function and included it in the email content. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant AuthService participant Logger participant EmailService Client ->> AuthService: Request with token AuthService ->> Logger: Log token details AuthService ->> EmailService: Send email if token expired EmailService ->> Client: Notification Email ``` ## Poem > Tokens expire, like winds that cease, > With code updates, we find new peace. > Logs now hold the tokens dear, > Emails sent, no need to fear. > Step by step, we move ahead, > In the code, where dreams are bred.

[!TIP]

AI model upgrade ## `gpt-4o` model for reviews and chat is now live OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide any feedback or to report any issues.

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.
codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 30.26%. Comparing base (4dcfc5a) to head (55a6ce9). Report is 10 commits behind head on staging.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3252/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/3252?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 #3252 +/- ## ======================================== Coverage 30.26% 30.26% ======================================== Files 184 184 Lines 24522 24522 Branches 3209 3209 ======================================== Hits 7421 7421 Misses 16987 16987 Partials 114 114 ``` | [Files](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3252?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/mailer.js](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3252?src=pr&el=tree&filepath=src%2Fauth-service%2Futils%2Fmailer.js&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform#diff-c3JjL2F1dGgtc2VydmljZS91dGlscy9tYWlsZXIuanM=) | `2.47% <ø> (ø)` | | | [src/auth-service/utils/email.msgs.js](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3252?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.57% <0.00%> (ø)` | |
github-actions[bot] commented 3 months ago

Auth-service changes in this PR available for preview here