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): Handling of wrong appeal info #16643

Merged
merged 6 commits into from
Nov 1, 2024
Merged

fix(j-s): Handling of wrong appeal info #16643

merged 6 commits into from
Nov 1, 2024

Conversation

unakb
Copy link
Member

@unakb unakb commented Oct 30, 2024

What

  • Transform appeal info to more accurate portrayal of appeal states and dates

Why

Strange behaviour when case is reopened and closed with both having accepted the appeal

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 appeal decision logic to accurately reflect case status based on prosecutor and accused acceptance.
  • Bug Fixes
    • Improved handling of appeal states for reopened cases to ensure correct status representation.
  • Tests
    • Added a new test case for the getAppealInfo function to validate appeal state conditions.

@unakb unakb requested a review from a team as a code owner October 30, 2024 10:49
Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

Walkthrough

The pull request introduces modifications primarily to the caseList.interceptor.ts, case.transformer.ts, and case.transformer.spec.ts files. A new function, wasAcceptedInCourt, is added to evaluate appeal decisions, influencing the intercept method's logic in the interceptor. Additionally, the getAppealInfo function in case.transformer.ts is updated to refine how appeal statuses are determined. Corresponding tests are added to ensure coverage of these changes, specifically addressing scenarios where appeal data does not align.

Changes

File Change Summary
apps/judicial-system/api/src/app/modules/case-list/interceptors/caseList.interceptor.ts - Added import of CaseAppealDecision.
- Introduced wasAcceptedInCourt function to evaluate appeal decisions.
- Updated intercept method to conditionally set appealState based on appeal decision evaluations.
apps/judicial-system/api/src/app/modules/case/interceptors/case.transformer.ts - Modified getAppealInfo to incorporate checks for acceptance of appeal decisions.
- Introduced new boolean variables for refined appeal logic.
- Updated transformRequestCase to reflect changes in appeal handling.
apps/judicial-system/api/src/app/modules/case/interceptors/case.transformer.spec.ts - Added new test case for getAppealInfo to check behavior when appeal data does not match.
- Existing tests for other functions remain unchanged.

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.

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 (2)
apps/judicial-system/api/src/app/modules/case-list/interceptors/caseList.interceptor.ts (1)

26-34: Add JSDoc documentation for better maintainability

The function is well-implemented and follows good practices. Consider adding JSDoc documentation to explain the purpose and parameters.

+/**
+ * Checks if both prosecutor and accused have accepted the appeal in court
+ * @param prosecutorAppealDecision - The prosecutor's appeal decision
+ * @param accusedAppealDecision - The accused's appeal decision
+ * @returns true if both parties accepted the appeal, false otherwise
+ */
 const wasAcceptedInCourt = (
   prosecutorAppealDecision?: CaseAppealDecision,
   accusedAppealDecision?: CaseAppealDecision,
apps/judicial-system/api/src/app/modules/case/interceptors/case.transformer.spec.ts (1)

596-617: LGTM! Consider adding a clarifying comment.

The test case effectively verifies the handling of mismatched appeal data, particularly when both parties have accepted the appeal decision. This aligns well with the PR objective of fixing appeal info handling.

Consider adding a comment to clarify this edge case:

+  // When both parties have accepted the appeal decision, the case should not be
+  // marked as appealed, regardless of the appeal state, to handle edge cases
+  // where a case is reopened and subsequently closed
  it('should transform appeal state and dates if appeal data does not match up', () => {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 27cfebb and cbdf383.

📒 Files selected for processing (3)
  • apps/judicial-system/api/src/app/modules/case-list/interceptors/caseList.interceptor.ts (3 hunks)
  • apps/judicial-system/api/src/app/modules/case/interceptors/case.transformer.spec.ts (1 hunks)
  • apps/judicial-system/api/src/app/modules/case/interceptors/case.transformer.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
apps/judicial-system/api/src/app/modules/case-list/interceptors/caseList.interceptor.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/api/src/app/modules/case/interceptors/case.transformer.spec.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/api/src/app/modules/case/interceptors/case.transformer.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 (4)
apps/judicial-system/api/src/app/modules/case-list/interceptors/caseList.interceptor.ts (2)

11-14: LGTM: Clean import organization

The new import is properly organized and follows TypeScript best practices.


55-63: Document the edge case more explicitly and consider a permanent solution

The comment indicates this is a temporary fix for handling reopened cases. To ensure maintainability:

  1. Document the specific edge case and its impact more explicitly
  2. Consider implementing a more permanent solution if this is a recurring issue

Let's verify if this is a common scenario:

apps/judicial-system/api/src/app/modules/case/interceptors/case.transformer.ts (2)

64-70: LGTM! Clear and well-structured appeal acceptance checks.

The new boolean variables improve code readability and provide a clear separation of concerns for tracking appeal acceptance states.


71-71: LGTM! Improved appeal status logic.

The updated condition correctly handles cases where both parties accept in court, fixing the issue with reopened and closed cases mentioned in the PR objectives.

Copy link

codecov bot commented Oct 30, 2024

Codecov Report

Attention: Patch coverage is 55.55556% with 8 lines in your changes missing coverage. Please review.

Project coverage is 36.71%. Comparing base (b267ed0) to head (a9db009).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...les/case-list/interceptors/caseList.interceptor.ts 0.00% 8 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16643      +/-   ##
==========================================
+ Coverage   36.63%   36.71%   +0.08%     
==========================================
  Files        6873     6859      -14     
  Lines      143121   142634     -487     
  Branches    40798    40656     -142     
==========================================
- Hits        52432    52368      -64     
+ Misses      90689    90266     -423     
Flag Coverage Δ
judicial-system-api 19.57% <55.55%> (+0.05%) ⬆️
judicial-system-backend 55.28% <ø> (ø)
judicial-system-formatters 79.93% <ø> (ø)
judicial-system-web 27.58% <ø> (ø)

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

Files with missing lines Coverage Δ
.../app/modules/case/interceptors/case.transformer.ts 100.00% <100.00%> (ø)
...les/case-list/interceptors/caseList.interceptor.ts 0.00% <0.00%> (ø)

... and 41 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 b267ed0...a9db009. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 30, 2024

Datadog Report

All test runs a3d92bc 🔗

5 Total Test Services: 0 Failed, 5 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.07%), 7 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
judicial-system-api 0 0 0 59 0 5.11s 1 increased (+0.07%) Link
judicial-system-backend 0 0 0 21278 0 15m 53.04s 1 no change Link
judicial-system-formatters 0 0 0 38 0 4.77s 1 no change Link
judicial-system-web 0 0 0 338 0 55.5s 1 no change Link
judicial-system-xrd-api 0 0 0 6 0 4.67s 1 no change Link

Copy link
Member

@gudjong gudjong left a comment

Choose a reason for hiding this comment

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

LGTM - need to remember to revisit this code when cases have been corrected

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

3 participants