feat(service-portal): detailed audit logs for law and order #16321

disaerna · 2024-10-08T14:33:54Z

Service Portal - Law and order - audit logs

What

Add more detailed audit logs for law and order

Why

👮🏼

Screenshots / Gifs

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 auditing and logging capabilities for court case and subpoena retrieval, as well as defense choice posting.
Bug Fixes
- Improved error handling and logging for service call failures, providing clearer context for debugging.

coderabbitai · 2024-10-08T14:34:00Z

Walkthrough

The pull request modifies the LawAndOrderResolver class in the law-and-order.resolver.ts file by integrating an AuditService and a logger into its constructor. It updates the method signatures of getCourtCaseDetail, getSubpoena, and postDefenseChoice to be asynchronous, allowing them to return promises. Each method now incorporates auditing functionality and enhanced error handling, logging specific failure messages when service calls fail. These changes aim to improve the resolver's auditing, logging, and error traceability capabilities.

Changes

File Path	Change Summary
libs/api/domains/law-and-order/src/lib/law-and-order.resolver.ts	- Added `AuditService` and logger to the constructor. - Updated method signatures for `getCourtCaseDetail`, `getSubpoena`, and `postDefenseChoice` to `async`. - Integrated auditing functionality and error logging in the mentioned methods.

Possibly related PRs

fix(service-portal): subpoena fixes #16261: This PR enhances auditing capabilities related to subpoenas, which aligns with the main PR's focus on integrating auditing functionality in the LawAndOrderResolver class.
feat(service-portal): default defender and has chosen fields for subpoena #16306: This PR introduces new fields related to subpoena choices, which may interact with the methods in the LawAndOrderResolver that handle subpoenas, particularly the getSubpoena method.
fix(service-portal): remove asFrame check from document line #16315: Although primarily focused on document handling, this PR's changes to the DocumentLineV3 component may relate to the overall functionality of the service portal, which includes the LawAndOrderResolver methods that deal with legal documents.

Suggested reviewers

thorkellmani

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.

coderabbitai

Actionable comments posted: 4

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bc3f47a and ed594d3.

📒 Files selected for processing (1)

libs/api/domains/law-and-order/src/lib/law-and-order.resolver.ts (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

libs/api/domains/law-and-order/src/lib/law-and-order.resolver.ts (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

Reusability of components and hooks across different NextJS apps.

TypeScript usage for defining props and exporting types.

Effective tree-shaking and bundling practices."

libs/api/domains/law-and-order/src/lib/law-and-order.resolver.ts

datadog-island-is · 2024-10-08T14:59:25Z

Datadog Report

Branch report: service-portal/audit-logs-law-and-order
Commit report: cc594e5
Test service: api

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

codecov · 2024-10-08T14:59:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.88%. Comparing base (5ce0312) to head (2abb624).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #16321      +/-   ##
==========================================
+ Coverage   36.75%   36.88%   +0.13%     
==========================================
  Files        6808     6801       -7     
  Lines      140991   140464     -527     
  Branches    40156    39908     -248     
==========================================
- Hits        51817    51810       -7     
+ Misses      89174    88654     -520

Flag	Coverage Δ
api	`3.37% <ø> (ø)`

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

see 223 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 5ce0312...2abb624. Read the comment docs.

thorkellmani

Good suggestion by coderabbit

feat: detailed audit logs for law and order

ed594d3

disaerna added the automerge Merge this PR as soon as all checks pass label Oct 8, 2024

disaerna requested a review from a team as a code owner October 8, 2024 14:33

coderabbitai bot requested changes Oct 8, 2024

View reviewed changes

thorkellmani approved these changes Oct 8, 2024

View reviewed changes

disaerna added 2 commits October 15, 2024 10:01

Merge branch 'main' into service-portal/audit-logs-law-and-order

9a738b8

fix: updates after PR review

37094a7

coderabbitai bot approved these changes Oct 15, 2024

View reviewed changes

Merge branch 'main' into service-portal/audit-logs-law-and-order

2abb624

kodiakhq bot merged commit 2a7cb5b into main Oct 15, 2024
30 checks passed

kodiakhq bot deleted the service-portal/audit-logs-law-and-order branch October 15, 2024 11:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(service-portal): detailed audit logs for law and order #16321

feat(service-portal): detailed audit logs for law and order #16321

disaerna commented Oct 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 8, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

datadog-island-is bot commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 8, 2024 •

edited

Loading

thorkellmani left a comment •

edited

Loading

feat(service-portal): detailed audit logs for law and order #16321

feat(service-portal): detailed audit logs for law and order #16321

Conversation

disaerna commented Oct 8, 2024 • edited by coderabbitai bot Loading

Service Portal - Law and order - audit logs

What

Why

Screenshots / Gifs

Checklist:

Summary by CodeRabbit

coderabbitai bot commented Oct 8, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

datadog-island-is bot commented Oct 8, 2024 • edited Loading

Datadog Report

codecov bot commented Oct 8, 2024 • edited Loading

Codecov Report

thorkellmani left a comment • edited Loading

Choose a reason for hiding this comment

disaerna commented Oct 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 8, 2024 •

edited

Loading

datadog-island-is bot commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 8, 2024 •

edited

Loading

thorkellmani left a comment •

edited

Loading