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 functionality to enable revoking appeal #17301

Merged
merged 9 commits into from
Jan 2, 2025

Conversation

oddsson
Copy link
Member

@oddsson oddsson commented Dec 19, 2024

Add functionality to enable revoking appeal

Asana

What

This PR implements functionality that enables staff at the public prosecutors office to revoke appeals by a defendant. In doing this, we discovered a bug in production that is fixed in this PR. The bug is that users can mark cases as appealed when the case has been sent to FMST and that should not be possible (the users should have to revoke the case from FMST first and then mark it as appealed).

This PR also tidies up a bit of animation code in the BlueBoxWithDate component. Mainly, we are renaming variables for clarity and making the animations a bit more smooth.

Why

This feature is needed so that the staff at the PP office can do their jobs properly.

Screenshots / Gifs

Screen.Recording.2024-12-20.at.10.41.00.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 a new message for revoking an appeal with the text "Afturkalla áfrýjun".
    • Added functionality to manage the visibility of date pickers based on appeal status.
    • Implemented a new handler for revoking the appeal date.
  • Bug Fixes

    • Updated rendering logic for buttons related to appeal actions.
  • Refactor

    • Improved animation control flow and renamed animation variants for clarity.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

This pull request introduces a new feature for revoking appeals in the Judicial System web application. A new message key revokeAppeal has been added to the internationalization strings, and the BlueBoxWithDate component has been updated to include a handler for revoking an appeal. The changes modify the component's rendering logic to conditionally display a revoke appeal button based on the defendant's verdict appeal date, and add a method to clear the appeal date when requested.

Changes

File Change Summary
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts Added new internationalization message revokeAppeal with ID and default message in Icelandic
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx - Added handleRevokeAppeal method to clear appeal date
- Introduced shouldHideDatePickers state variable
- Updated rendering logic for date pickers and buttons
- Renamed animation variants

Sequence Diagram

sequenceDiagram
    participant User
    participant Component
    participant Server
    
    User->>Component: Click "Revoke Appeal" button
    Component->>Server: Send request to clear appeal date
    Server-->>Component: Confirm date cleared
    Component->>Component: Update UI to remove appeal date
Loading

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

codecov bot commented Dec 19, 2024

Codecov Report

Attention: Patch coverage is 78.57143% with 3 lines in your changes missing coverage. Please review.

Project coverage is 35.68%. Comparing base (029015c) to head (0c9706e).
Report is 1 commits behind head on main.

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

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17301   +/-   ##
=======================================
  Coverage   35.68%   35.68%           
=======================================
  Files        6931     6931           
  Lines      148786   148794    +8     
  Branches    42510    42515    +5     
=======================================
+ Hits        53092    53097    +5     
- Misses      95694    95697    +3     
Flag Coverage Δ
judicial-system-web 27.74% <78.57%> (+0.01%) ⬆️

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

Files with missing lines Coverage Δ
...ponents/BlueBoxWithIcon/BlueBoxWithDate.strings.ts 100.00% <ø> (ø)
...src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx 58.69% <78.57%> (+0.36%) ⬆️

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 029015c...0c9706e. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 19, 2024

Datadog Report

Branch report: j-s/revoke-appeal
Commit report: 66a8901
Test service: judicial-system-web

✅ 0 Failed, 344 Passed, 0 Skipped, 55.12s Total Time
➡️ Test Sessions change in coverage: 1 no change

@oddsson oddsson changed the title J s/revoke appeal feat(j-s): Add functionality to enable revoking appeal Dec 20, 2024
@oddsson oddsson marked this pull request as ready for review December 20, 2024 10:42
@oddsson oddsson requested a review from a team as a code owner December 20, 2024 10:42
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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 27a704f and 2559059.

📒 Files selected for processing (2)
  • apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts (1 hunks)
  • apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (7 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
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."
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 (2)
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.
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx (3)
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.
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.
🔇 Additional comments (3)
apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.strings.ts (1)

102-106: LGTM! The new message key follows the established pattern.

The revokeAppeal message key is well-structured with a clear namespace, appropriate default message in Icelandic, and a descriptive explanation of its usage.

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

64-69: LGTM! Clear and efficient visibility control logic.

The shouldHideDatePickers variable effectively combines multiple conditions into a single, readable boolean expression, making the component's logic easier to follow.


219-241: LGTM! Animation variants are now more descriptive and consistent.

The renamed variants (verdictViewDateVariants and appealDateVariants) provide better clarity about their purpose, and the transition properties are well-defined for smooth animations.

Copy link
Member

@thorhildurt thorhildurt left a comment

Choose a reason for hiding this comment

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

Looks good! Tested and works well 🍰

Just one question about the components location in our project: Is there a reason why BlueBoxWithDate (apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx) is not co-located with the Overview component (apps/judicial-system/web/src/routes/PublicProsecutor/Indictments/Overview/Overview.tsx)? Asking because it seems to be specific to the public prosecutor component context 👀

@oddsson
Copy link
Member Author

oddsson commented Jan 2, 2025

Looks good! Tested and works well 🍰

Just one question about the components location in our project: Is there a reason why BlueBoxWithDate (apps/judicial-system/web/src/components/BlueBoxWithIcon/BlueBoxWithDate.tsx) is not co-located with the Overview component (apps/judicial-system/web/src/routes/PublicProsecutor/Indictments/Overview/Overview.tsx)? Asking because it seems to be specific to the public prosecutor component context 👀

You're right, this component is specific to the overview component. There is no specific reason for this component being where it is other than most components live in the components folder.

@oddsson oddsson added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Jan 2, 2025
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.

2 participants