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(j-s): Prison admin indictment notifications #17097

Merged
merged 3 commits into from
Dec 2, 2024

Conversation

unakb
Copy link
Member

@unakb unakb commented Dec 2, 2024

Notifications weren't getting sent due to a bug in the defendant model that returned an undefined value for defendant.caseId

Senda tilkynningu til FMST - fullnusta

What

Fix indictment sent and withdrawn from prison admin notifications

Why

Because they weren't sending

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 message handling for defendants in court cases by allowing direct use of caseId for message creation.
    • Improved clarity in method signatures related to indictment case updates.
  • Bug Fixes

    • Updated foreign key reference for the case property in the Defendant model to ensure consistency with naming conventions.

Notifications weren't getting sent due to a bug in the defendant model that returned an undefined value for defendant.caseId
@unakb unakb requested a review from a team as a code owner December 2, 2024 10:54
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes in this pull request involve modifications to the DefendantService and Defendant model within the judicial system application. The DefendantService class now includes a new caseId parameter in the getMessagesForIndictmentToPrisonAdminChanges method, enhancing message handling for defendants. In the Defendant model, the foreign key reference for the case property has been updated to align with naming conventions. These updates aim to improve clarity and maintainability in the codebase.

Changes

File Change Summary
apps/judicial-system/backend/src/app/modules/defendant/defendant.service.ts Updated method signature for getMessagesForIndictmentToPrisonAdminChanges to include caseId.
apps/judicial-system/backend/src/app/modules/defendant/models/defendant.model.ts Changed foreign key reference from 'case_id' to 'caseId' in the Defendant class.

Possibly related PRs

Suggested labels

automerge


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.

@gudjong gudjong added the automerge Merge this PR as soon as all checks pass label Dec 2, 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: 1

🧹 Outside diff range and nitpick comments (1)
apps/judicial-system/backend/src/app/modules/defendant/defendant.service.ts (1)

Line range hint 78-95: Consider splitting notification logic

The method handles both sending and withdrawing notifications based on a boolean flag. Consider splitting this into two separate methods for better clarity:

  • getMessageForIndictmentSentToPrisonAdmin
  • getMessageForIndictmentWithdrawnFromPrisonAdmin

Also, consider using an enum instead of a boolean for isSentToPrisonAdmin to make the state more explicit.

Example refactor:

-private getMessagesForIndictmentToPrisonAdminChanges(
-  defendant: Defendant,
-  caseId: string,
-): Message {
-  const messageType =
-    defendant.isSentToPrisonAdmin === true
-      ? DefendantNotificationType.INDICTMENT_SENT_TO_PRISON_ADMIN
-      : DefendantNotificationType.INDICTMENT_WITHDRAWN_FROM_PRISON_ADMIN
-
-  const message = {
-    type: MessageType.DEFENDANT_NOTIFICATION,
-    caseId,
-    elementId: defendant.id,
-    body: {
-      type: messageType,
-    },
-  }
-
-  return message
-}
+private getMessageForIndictmentSentToPrisonAdmin(
+  defendant: Defendant,
+  caseId: string,
+): Message {
+  return {
+    type: MessageType.DEFENDANT_NOTIFICATION,
+    caseId,
+    elementId: defendant.id,
+    body: {
+      type: DefendantNotificationType.INDICTMENT_SENT_TO_PRISON_ADMIN,
+    },
+  }
+}
+
+private getMessageForIndictmentWithdrawnFromPrisonAdmin(
+  defendant: Defendant,
+  caseId: string,
+): Message {
+  return {
+    type: MessageType.DEFENDANT_NOTIFICATION,
+    caseId,
+    elementId: defendant.id,
+    body: {
+      type: DefendantNotificationType.INDICTMENT_WITHDRAWN_FROM_PRISON_ADMIN,
+    },
+  }
+}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 71774d0 and 486f7cd.

📒 Files selected for processing (2)
  • apps/judicial-system/backend/src/app/modules/defendant/defendant.service.ts (3 hunks)
  • apps/judicial-system/backend/src/app/modules/defendant/models/defendant.model.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/judicial-system/backend/src/app/modules/defendant/models/defendant.model.ts (1)

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."
apps/judicial-system/backend/src/app/modules/defendant/defendant.service.ts (1)

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."
📓 Learnings (1)
apps/judicial-system/backend/src/app/modules/defendant/models/defendant.model.ts (1)
Learnt from: oddsson
PR: island-is/island.is#16831
File: apps/judicial-system/backend/src/app/modules/defendant/models/defendant.model.ts:0-0
Timestamp: 2024-11-19T09:04:44.520Z
Learning: Additional documentation is not required when the code is clear and self-explanatory.
🔇 Additional comments (3)
apps/judicial-system/backend/src/app/modules/defendant/defendant.service.ts (3)

78-80: LGTM! Improved parameter passing

Adding the explicit caseId parameter instead of relying on defendant.caseId makes the code more robust and fixes the notification dispatch issue.


87-89: LGTM! Using explicit caseId

Using the explicitly passed caseId instead of defendant.caseId ensures the message will always have a valid case identifier.


200-203: LGTM! Proper method invocation

The method call is updated to pass theCase.id explicitly, which is guaranteed to be defined at this point since we check for courtCaseNumber earlier in the method.

Copy link

codecov bot commented Dec 2, 2024

Codecov Report

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

Project coverage is 35.68%. Comparing base (4137b1f) to head (d919626).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...rc/app/modules/defendant/models/defendant.model.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17097   +/-   ##
=======================================
  Coverage   35.68%   35.68%           
=======================================
  Files        6946     6946           
  Lines      147391   147377   -14     
  Branches    41897    41892    -5     
=======================================
  Hits        52595    52595           
+ Misses      94796    94782   -14     
Flag Coverage Δ
judicial-system-backend 55.66% <50.00%> (ø)

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

Files with missing lines Coverage Δ
...end/src/app/modules/defendant/defendant.service.ts 90.27% <100.00%> (ø)
...rc/app/modules/defendant/models/defendant.model.ts 87.27% <0.00%> (ø)

... and 2 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 4137b1f...d919626. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

Branch report: j-s/fix-prison-admin-messages
Commit report: 2022f07
Test service: judicial-system-backend

✅ 0 Failed, 21324 Passed, 0 Skipped, 23m 12.86s Total Time
⬆️ Test Sessions change in coverage: 1 increased (+0.01%)

@kodiakhq kodiakhq bot merged commit 6ca2d70 into main Dec 2, 2024
27 checks passed
@kodiakhq kodiakhq bot deleted the j-s/fix-prison-admin-messages branch December 2, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants