Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(user-notification): Args null variant fix #16703

Merged
merged 14 commits into from
Nov 5, 2024

Conversation

rafnarnason
Copy link
Member

@rafnarnason rafnarnason commented Nov 4, 2024

contentful sends null instead of empty arrays for empty lists - this is to ensure declared value of dto for 0 argument templates

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced notification template handling to ensure the args property is always an array, improving consistency and reliability of notifications.
  • Bug Fixes

    • Updated methods to maintain existing error handling while ensuring templates are correctly formatted.

@rafnarnason rafnarnason requested review from a team as code owners November 4, 2024 10:22
Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes in the NotificationsService class focus on improving the handling of notification templates. The getTemplates and getTemplate methods have been modified to ensure that the args property is always an array, even when not provided. Error handling remains intact, with appropriate exceptions thrown for missing templates. Minor formatting adjustments have also been made to enhance code readability.

Changes

File Change Summary
apps/services/user-notification/src/app/modules/notifications/notifications.service.ts - Updated getTemplates method to ensure args is an array.
- Updated getTemplate method to ensure args is an array.
- Minor formatting adjustments for readability.

Possibly related PRs

  • fix(user-notification): Fix email layout for outlook client #15460: This PR involves changes to the NotificationsWorkerService class, which is part of the same notification system as the NotificationsService in the main PR, indicating a potential overlap in notification handling logic.
  • fix(j-s): Notification migration #16378: This PR updates notification types in a migration script, which may relate to the overall notification system and its structure, potentially impacting how notifications are processed in the NotificationsService.

Suggested reviewers

  • unakb
  • kksteini

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@rafnarnason rafnarnason added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Nov 4, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
apps/services/user-notification/src/app/modules/notifications/notifications.service.ts (2)

123-130: LGTM! Consider adding type assertion for better type safety.

The changes correctly handle null values from Contentful by ensuring args is always an array. This aligns with the PR objective.

Consider adding explicit type assertion for better type safety:

-      args: template.args || [], // Ensure args is an array
+      args: template.args as string[] || [], // Ensure args is an array

148-151: LGTM! Consider enhancing error handling consistency.

The changes correctly handle null values and maintain consistency with getTemplates. The error message is clear and informative.

Consider using the same error handling pattern as other methods in the service:

-      throw new NotFoundException(`Template not found for ID: ${templateId}`);
+      this.logger.warn(`Template not found for ID: ${templateId}`, { templateId });
+      throw new NotFoundException(`Template not found for ID: ${templateId}`);
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8a6d6d5 and 403f85a.

📒 Files selected for processing (1)
  • apps/services/user-notification/src/app/modules/notifications/notifications.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/services/user-notification/src/app/modules/notifications/notifications.service.ts (2)

Pattern apps/services/**/*: "Confirm that the code adheres to the following:

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (1)
apps/services/user-notification/src/app/modules/notifications/notifications.service.ts (1)

Line range hint 123-151: Verify test coverage for null args handling.

The changes to getTemplates and getTemplate affect dependent methods like validate and findMany. Please ensure test coverage includes:

  1. Handling of null args from Contentful
  2. Integration with dependent methods
  3. Error scenarios

@datadog-island-is
Copy link

datadog-island-is bot commented Nov 4, 2024

Datadog Report

All test runs 096c7b5 🔗

4 Total Test Services: 0 Failed, 4 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.01%), 6 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.34s 1 no change Link
application-system-api 0 0 0 120 2 3m 23.23s 1 no change Link
application-template-api-modules 0 0 0 123 0 2m 5.77s 1 decreased (-0.01%) Link
services-user-notification 0 0 0 51 0 1m 17.16s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-template-api-modules - jest 30.04% (-0.01%) - Details

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

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

Project coverage is 36.56%. Comparing base (8cc1852) to head (65099a2).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...app/modules/notifications/notifications.service.ts 0.00% 5 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16703      +/-   ##
==========================================
+ Coverage   36.51%   36.56%   +0.04%     
==========================================
  Files        6890     6881       -9     
  Lines      143801   143422     -379     
  Branches    40968    40849     -119     
==========================================
- Hits        52511    52439      -72     
+ Misses      91290    90983     -307     
Flag Coverage Δ
api 3.37% <ø> (ø)
application-system-api 41.12% <ø> (ø)
application-template-api-modules 27.68% <ø> (-0.03%) ⬇️
services-user-notification 46.85% <0.00%> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...app/modules/notifications/notifications.service.ts 33.83% <0.00%> (-0.52%) ⬇️

... and 14 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2da61a3...65099a2. Read the comment docs.

@kodiakhq kodiakhq bot merged commit cd92fc2 into main Nov 5, 2024
40 checks passed
@kodiakhq kodiakhq bot deleted the user-notification/empty-args-contentful branch November 5, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants