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

feat(j-s): Add modal when revoking send to prison admin #17110

Merged
merged 5 commits into from
Dec 9, 2024

Conversation

oddsson
Copy link
Member

@oddsson oddsson commented Dec 3, 2024

Add modal when revoking send to prison admin

Asana

What

When users at the public prosecutor's office revoke a case from prisons, they now see a modal window asking if they are sure.

Why

So that it's less likely that someone revokes a case by accident.

Screenshots / Gifs

Screen.Recording.2024-12-03.at.11.42.54.mov

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

    • Introduced new messages for the "cancel" action and revocation processes in the judicial system's user interface.
    • Added modal functionality for revoking actions related to prison administration, enhancing user interaction.
  • Bug Fixes

    • Updated modal text identifier for versioning clarity.

These changes improve localization support and user experience within the application.

@oddsson oddsson requested a review from a team as a code owner December 3, 2024 11:43
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The pull request introduces new localization messages and updates existing strings within the judicial system's user interface. A new "cancel" message is added for case management, while additional messages related to revoking actions in the prison administration context are defined. Modifications to the BlueBoxWithDate component enhance its functionality by managing modal visibility for the revoke action. Additionally, a versioning update is made to the modalText string in the SendToPrisonAdmin module.

Changes

File Change Summary
apps/judicial-system/web/messages/Core/index.ts Added new message: cancel with ID judicial.system.core:cancel, default message 'Hætta við'.
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts Added new messages: revokeSendToPrisonAdminModalTitle, revokeSendToPrisonAdminModalText, revoke.
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx Introduced VisibleModal type, modalVisible state, updated handleRevokeSendToPrisonAdmin, and added modal component.
apps/judicial-system/web/src/routes/PublicProsecutor/Indictments/SendToPrisonAdmin/SendToPrisonAdmin.strings.ts Updated modalText ID from judicial.system.core:send_to_prison_admin.modal_text to judicial.system.core:send_to_prison_admin.modal_text_v1.
apps/judicial-system/web/src/utils/hooks/useCaseList/index.tsx Updated openCase callback to include features in the dependency array and modified handleOpenCase for limitedAccess.

Possibly related PRs

Suggested labels

high priority

Suggested reviewers

  • unakb
  • gudjong

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. (Experiment)
  • @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

codecov bot commented Dec 3, 2024

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 35.70%. Comparing base (5f9b084) to head (ef6df71).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx 42.85% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17110      +/-   ##
==========================================
- Coverage   35.73%   35.70%   -0.04%     
==========================================
  Files        6928     6955      +27     
  Lines      147811   147917     +106     
  Branches    42125    42196      +71     
==========================================
- Hits        52816    52809       -7     
- Misses      94995    95108     +113     
Flag Coverage Δ
judicial-system-web 27.89% <42.85%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
apps/judicial-system/web/messages/Core/index.ts 100.00% <ø> (ø)
...ponents/BlueBoxWithIcon/BlueBoxWithDate.strings.ts 100.00% <ø> (ø)
...nts/SendToPrisonAdmin/SendToPrisonAdmin.strings.ts 0.00% <ø> (ø)
...l-system/web/src/utils/hooks/useCaseList/index.tsx 14.77% <ø> (ø)
...src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx 58.33% <42.85%> (-1.93%) ⬇️

... and 214 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 5f9b084...ef6df71. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 3, 2024

Datadog Report

Branch report: j-s/revoke-send-to-prison-admin-modal
Commit report: 5b265f4
Test service: judicial-system-web

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

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 (1)
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (1)

364-377: Consider handling loading state in the secondary button.

While the implementation is good, consider disabling the secondary button (cancel) when the primary action is in progress to prevent potential race conditions.

 <Modal
   title={formatMessage(strings.revokeSendToPrisonAdminModalTitle)}
   text={formatMessage(strings.revokeSendToPrisonAdminModalText, {
     courtCaseNumber: workingCase.courtCaseNumber,
     defendant: defendant.name,
   })}
   onPrimaryButtonClick={handleRevokeSendToPrisonAdmin}
   primaryButtonText={formatMessage(strings.revoke)}
   isPrimaryButtonLoading={isUpdatingDefendant}
   secondaryButtonText={formatMessage(core.cancel)}
   onSecondaryButtonClick={() => setModalVisible(undefined)}
+  isSecondaryButtonDisabled={isUpdatingDefendant}
 />
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bebcf49 and 043e110.

📒 Files selected for processing (4)
  • apps/judicial-system/web/messages/Core/index.ts (1 hunks)
  • apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts (1 hunks)
  • apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (6 hunks)
  • apps/judicial-system/web/src/routes/PublicProsecutor/Indictments/SendToPrisonAdmin/SendToPrisonAdmin.strings.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/judicial-system/web/src/routes/PublicProsecutor/Indictments/SendToPrisonAdmin/SendToPrisonAdmin.strings.ts
🧰 Additional context used
📓 Path-based instructions (3)
apps/judicial-system/web/messages/Core/index.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/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (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/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.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 (2)
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (3)
Learnt from: oddsson
PR: island-is/island.is#16831
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx:204-337
Timestamp: 2024-11-19T09:28:36.448Z
Learning: Buttons in this project are considered accessible as is, and adding additional ARIA attributes like `aria-label` and `aria-disabled` is not required unless specifically needed.
Learnt from: oddsson
PR: island-is/island.is#16495
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx:102-103
Timestamp: 2024-11-12T15:15:11.835Z
Learning: In the TypeScript file `apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx`, within the `handleSetDate` function, the else block is intentionally kept to handle an unlikely scenario and should not be removed, even if it appears unnecessary due to prior validation checks.
Learnt from: oddsson
PR: island-is/island.is#16495
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx:84-105
Timestamp: 2024-11-12T15:15:11.835Z
Learning: In `apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx`, the `setAndSendDefendantToServer` function handles errors internally, so additional error handling when calling it is not necessary.
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts (1)
Learnt from: oddsson
PR: island-is/island.is#16495
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts:3-3
Timestamp: 2024-11-12T15:15:20.157Z
Learning: In `apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts`, prefer not to add explicit TypeScript type definitions for the messages object.
🔇 Additional comments (5)
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts (1)

86-101: LGTM! The new localization messages are well-structured.

The new messages follow consistent naming patterns and provide clear descriptions for translators.

apps/judicial-system/web/messages/Core/index.ts (1)

212-216: LGTM! The new core message is well-structured.

The cancel message follows consistent naming patterns and provides a clear description for translators.

apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (3)

39-40: LGTM! Clean type definition and state management.

The VisibleModal type and state management for modal visibility are well-implemented.

Also applies to: 53-54


118-119: LGTM! Proper modal cleanup.

The modal is correctly hidden after the revoke action is completed.


344-344: LGTM! Modal trigger implementation.

The button correctly triggers the modal visibility state.

Copy link
Member

@unakb unakb left a comment

Choose a reason for hiding this comment

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

Minor nitpicks

@oddsson oddsson added the automerge Merge this PR as soon as all checks pass label Dec 9, 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/judicial-system/web/src/utils/hooks/useCaseList/index.tsx (1)

Line range hint 171-171: Consider adding user feedback when access is being determined

While the check for limitedAccess === undefined prevents race conditions, users might be confused why clicking doesn't work. Consider showing a loading state or toast message.

 if (
   isTransitioningCase ||
   isSendingNotification ||
   clickedCase[0] === id ||
   limitedAccess === undefined
 ) {
+  if (limitedAccess === undefined) {
+    toast.info(formatMessage({ id: 'checking.access' }))
+  }
   return
 }
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (1)

39-40: Consider making VisibleModal type more extensible

While the current implementation works, consider using an enum or union type that's easier to extend for future modal types.

-type VisibleModal = 'REVOKE_SEND_TO_PRISON_ADMIN'
+enum VisibleModal {
+  REVOKE_SEND_TO_PRISON_ADMIN = 'REVOKE_SEND_TO_PRISON_ADMIN'
+}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d3473ca and ef6df71.

📒 Files selected for processing (2)
  • apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (7 hunks)
  • apps/judicial-system/web/src/utils/hooks/useCaseList/index.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/judicial-system/web/src/utils/hooks/useCaseList/index.tsx (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/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (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/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (3)
Learnt from: oddsson
PR: island-is/island.is#16831
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx:204-337
Timestamp: 2024-11-19T09:28:36.448Z
Learning: Buttons in this project are considered accessible as is, and adding additional ARIA attributes like `aria-label` and `aria-disabled` is not required unless specifically needed.
Learnt from: oddsson
PR: island-is/island.is#16495
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx:102-103
Timestamp: 2024-11-12T15:15:11.835Z
Learning: In the TypeScript file `apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx`, within the `handleSetDate` function, the else block is intentionally kept to handle an unlikely scenario and should not be removed, even if it appears unnecessary due to prior validation checks.
Learnt from: oddsson
PR: island-is/island.is#16495
File: apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx:84-105
Timestamp: 2024-11-12T15:15:11.835Z
Learning: In `apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx`, the `setAndSendDefendantToServer` function handles errors internally, so additional error handling when calling it is not necessary.
🔇 Additional comments (3)
apps/judicial-system/web/src/utils/hooks/useCaseList/index.tsx (1)

145-145: LGTM: Correct dependency added to useCallback

The addition of 'features' to the dependency array is necessary as it's used within the callback to determine traffic violation cases. This prevents potential stale closure issues.

apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (2)

364-377: LGTM: Modal implementation follows best practices

The modal implementation is well-structured with:

  • Proper conditional rendering
  • Internationalized text
  • Loading state handling
  • Clear action buttons

344-344: LGTM: Button implementation aligns with project standards

The button implementation correctly triggers the modal and follows the project's accessibility standards.

@kodiakhq kodiakhq bot merged commit 02d4080 into main Dec 9, 2024
34 checks passed
@kodiakhq kodiakhq bot deleted the j-s/revoke-send-to-prison-admin-modal branch December 9, 2024 21:08
thorhildurt pushed a commit that referenced this pull request Dec 11, 2024
* Add modal when revoking send to prison admin

* Update CF ids

* Fix lint
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