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

chore(j-s): add gender to custody notice #17370

Merged
merged 5 commits into from
Jan 6, 2025

Conversation

thorhildurt
Copy link
Member

@thorhildurt thorhildurt commented Dec 30, 2024

What

  • Add gender to custody notice

Why

  • Currently prison staff struggles to figure out the gender of a given defendant. By adding it to the custody notice it will be easier for them to process the custody accoringly.

Screenshots / Gifs

Screenshot 2024-12-30 at 14 52 06

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 custody notice PDF generation with additional defendant details
    • Added display of defendant's residence and gender information
  • Bug Fixes

    • Corrected text for default address and gender labels
    • Minor linguistic correction in message description
  • Documentation

    • Improved clarity of personal information presentation in custody notice PDF

@thorhildurt thorhildurt requested a review from a team as a code owner December 30, 2024 15:01
@thorhildurt thorhildurt self-assigned this Dec 30, 2024
Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Walkthrough

The pull request introduces modifications to the custody notice PDF generation process in the judicial system backend. The changes focus on enhancing the PDF document's detail by adding the defendant's residence and gender information. A new import for formatting gender is introduced, and the PDF generation logic is updated to include more comprehensive personal details. The changes improve the clarity of the generated custody notice while maintaining the existing PDF generation structure.

Changes

File Change Summary
apps/judicial-system/backend/src/app/formatters/custodyNoticePdf.ts - Added formatGender import
- Updated residence line to use 'Ekki skráð' as default
- Added gender information display with 'Kyn: ' label
apps/judicial-system/backend/src/app/messages/pdfCustodyNotice.ts - Corrected wording in rulingTitle description from "vistunarselði" to "vistunarseðli"
- Minor grammatical adjustment in description text

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • unakb

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Nitpick comments (1)
apps/judicial-system/backend/src/app/formatters/custodyNoticePdf.ts (1)

84-91: Consider using translations for the fallback text.

The fallback text ("Ekki skráð") could be wrapped with the translation system (via formatMessage) for consistency with other localized strings. This ensures a unified user experience across all localized labels.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74f5c19 and d45fc55.

📒 Files selected for processing (2)
  • apps/judicial-system/backend/src/app/formatters/custodyNoticePdf.ts (2 hunks)
  • apps/judicial-system/backend/src/app/messages/pdfCustodyNotice.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/judicial-system/backend/src/app/messages/pdfCustodyNotice.ts
🧰 Additional context used
📓 Path-based instructions (1)
apps/judicial-system/backend/src/app/formatters/custodyNoticePdf.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."
🔇 Additional comments (1)
apps/judicial-system/backend/src/app/formatters/custodyNoticePdf.ts (1)

93-101: Ensure coverage with tests for the newly added gender field.

Including a new field for gender is helpful; however, please confirm that the updated PDF generation logic is covered by unit or integration tests. This will ensure that the gender fallback ("Ekki skráð") and the formatted gender from formatGender function are validated to work as expected.

Copy link

codecov bot commented Dec 30, 2024

Codecov Report

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

Project coverage is 35.68%. Comparing base (b2d789d) to head (84a286f).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...tem/backend/src/app/formatters/custodyNoticePdf.ts 0.00% 9 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17370      +/-   ##
==========================================
+ Coverage   35.67%   35.68%   +0.01%     
==========================================
  Files        6932     6930       -2     
  Lines      148870   148752     -118     
  Branches    42533    42500      -33     
==========================================
- Hits        53109    53083      -26     
+ Misses      95761    95669      -92     
Flag Coverage Δ
api 3.33% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.39% <ø> (ø)
application-system-api 38.73% <ø> (+0.01%) ⬆️
application-template-api-modules 27.67% <ø> (-0.01%) ⬇️
cms 0.39% <ø> (ø)
cms-translations 38.73% <ø> (ø)
judicial-system-api 20.20% <ø> (ø)
judicial-system-backend 55.91% <0.00%> (-0.10%) ⬇️
services-user-notification 46.47% <ø> (-0.03%) ⬇️
web 2.40% <ø> (ø)

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

Files with missing lines Coverage Δ
...ystem/backend/src/app/messages/pdfCustodyNotice.ts 100.00% <ø> (ø)
...tem/backend/src/app/formatters/custodyNoticePdf.ts 10.00% <0.00%> (-0.98%) ⬇️

... and 20 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 b2d789d...84a286f. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

Branch report: j-s/add-gender-to-custody-notice
Commit report: e27f217
Test service: judicial-system-backend

✅ 0 Failed, 21092 Passed, 0 Skipped, 18m 28.68s Total Time
➡️ Test Sessions change in coverage: 1 no change

@thorhildurt thorhildurt added the automerge Merge this PR as soon as all checks pass label Jan 6, 2025
@kodiakhq kodiakhq bot merged commit 56d6e6e into main Jan 6, 2025
64 checks passed
@kodiakhq kodiakhq bot deleted the j-s/add-gender-to-custody-notice branch January 6, 2025 12:44
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