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): Allow public prosecutor user to open case files #15852

Merged
merged 11 commits into from
Sep 6, 2024

Conversation

unakb
Copy link
Member

@unakb unakb commented Sep 2, 2024

Ríksak - skrifstofustarfsmenn geta ekki opnað nein skjöl á yfirliti máls.

What

Allow public prosecutor staff to open case files

Why

Because they should be allowed to view the case files

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 role-based access control by adding the publicProsecutorStaffRule, allowing public prosecutor staff to access case management functionalities.
    • Updated access permissions in the ViewCaseFileGuard to permit public prosecutors to view completed cases.
  • Bug Fixes

    • Improved test coverage for role permissions related to accessing case files and generating signed URLs, ensuring correct validation of the new role.
  • Tests

    • Expanded test cases for the CaseController and FileController to include checks for the new publicProsecutorStaffRule.

@unakb unakb requested a review from a team as a code owner September 2, 2024 14:56
Copy link
Contributor

coderabbitai bot commented Sep 2, 2024

Walkthrough

The changes involve the addition of the publicProsecutorStaffRule role to various controllers and tests within the judicial system application. This new role enhances role-based access control by allowing public prosecutor staff to access specific functionalities across multiple components, including case management and file handling. Additionally, corresponding test cases have been updated to ensure the new role is properly validated within the permission checks.

Changes

Files Change Summary
apps/judicial-system/backend/src/app/modules/case/case.controller.ts Added publicProsecutorStaffRule to @RolesRules decorator in CaseController.
apps/judicial-system/backend/src/app/modules/case/test/caseController/getCaseFilesRecordPdfRolesRules.spec.ts Updated test to include publicProsecutorStaffRule in the rules array, increasing expected length from 5 to 6.
apps/judicial-system/backend/src/app/modules/case/test/caseController/getIndictmentPdfRolesRules.spec.ts Added publicProsecutorStaffRule to the test for indictment PDF permissions, increasing expected length from 5 to 6.
apps/judicial-system/backend/src/app/modules/file/file.controller.ts Added publicProsecutorStaffRule to @RolesRules decorator in FileController.
apps/judicial-system/backend/src/app/modules/file/guards/test/viewCaseFileGuard.spec.ts Enhanced tests for View Case File Guard to include publicProsecutorRoles, validating access control.
apps/judicial-system/backend/src/app/modules/file/guards/viewCaseFile.guard.ts Introduced a check for isPublicProsecutorUser in canActivate method to permit access to completed cases.
apps/judicial-system/backend/src/app/modules/file/test/fileController/getCaseFileSignedUrlRolesRules.spec.ts Updated test to include publicProsecutorStaffRule, increasing expected length of rules array from 9 to 10.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 2, 2024

Datadog Report

Branch report: j-s/rsak-user-file-access
Commit report: 064e3d7
Test service: judicial-system-backend

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

Copy link

codecov bot commented Sep 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.95%. Comparing base (6bfcab3) to head (1c919ea).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15852      +/-   ##
==========================================
+ Coverage   36.85%   36.95%   +0.09%     
==========================================
  Files        6684     6680       -4     
  Lines      136781   136383     -398     
  Branches    38885    38716     -169     
==========================================
- Hits        50415    50403      -12     
+ Misses      86366    85980     -386     
Flag Coverage Δ
judicial-system-backend 56.11% <100.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...em/backend/src/app/modules/case/case.controller.ts 84.36% <ø> (ø)
...em/backend/src/app/modules/file/file.controller.ts 100.00% <ø> (ø)
.../src/app/modules/file/guards/viewCaseFile.guard.ts 90.62% <100.00%> (+0.62%) ⬆️

... and 25 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 2c15109...1c919ea. Read the comment docs.

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.

This looks good, but consider adding access to other generated files for indictments.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f7dc690 and aa584fd.

Files selected for processing (7)
  • apps/judicial-system/backend/src/app/modules/case/case.controller.ts (2 hunks)
  • apps/judicial-system/backend/src/app/modules/case/test/caseController/getCaseFilesRecordPdfRolesRules.spec.ts (2 hunks)
  • apps/judicial-system/backend/src/app/modules/case/test/caseController/getIndictmentPdfRolesRules.spec.ts (2 hunks)
  • apps/judicial-system/backend/src/app/modules/file/file.controller.ts (2 hunks)
  • apps/judicial-system/backend/src/app/modules/file/guards/test/viewCaseFileGuard.spec.ts (2 hunks)
  • apps/judicial-system/backend/src/app/modules/file/guards/viewCaseFile.guard.ts (2 hunks)
  • apps/judicial-system/backend/src/app/modules/file/test/fileController/getCaseFileSignedUrlRolesRules.spec.ts (2 hunks)
Additional context used
Path-based instructions (7)
apps/judicial-system/backend/src/app/modules/case/test/caseController/getIndictmentPdfRolesRules.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/backend/src/app/modules/case/test/caseController/getCaseFilesRecordPdfRolesRules.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/backend/src/app/modules/file/test/fileController/getCaseFileSignedUrlRolesRules.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/backend/src/app/modules/file/guards/viewCaseFile.guard.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/backend/src/app/modules/file/file.controller.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/backend/src/app/modules/file/guards/test/viewCaseFileGuard.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/backend/src/app/modules/case/case.controller.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."
Biome
apps/judicial-system/backend/src/app/modules/file/guards/test/viewCaseFileGuard.spec.ts

[error] 218-231: Disallow duplicate setup and teardown hooks.

Disallow beforeEach duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)


[error] 245-258: Disallow duplicate setup and teardown hooks.

Disallow beforeEach duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)

Additional comments not posted (12)
apps/judicial-system/backend/src/app/modules/case/test/caseController/getIndictmentPdfRolesRules.spec.ts (2)

7-7: LGTM!

The code changes are approved.


23-23: LGTM!

The code changes are approved.

Also applies to: 26-26

apps/judicial-system/backend/src/app/modules/case/test/caseController/getCaseFilesRecordPdfRolesRules.spec.ts (2)

7-7: LGTM!

The addition of the publicProsecutorStaffRule to the imported rules is consistent with the PR objective of allowing public prosecutor staff to access case files.


23-23: LGTM!

The updated test case correctly validates the presence of the publicProsecutorStaffRule in the rules array for the getCaseFilesRecordPdf method of the CaseController.

Also applies to: 26-26

apps/judicial-system/backend/src/app/modules/file/test/fileController/getCaseFileSignedUrlRolesRules.spec.ts (2)

11-11: LGTM!

The code changes are approved.


27-30: LGTM!

The code changes are approved.

apps/judicial-system/backend/src/app/modules/file/guards/viewCaseFile.guard.ts (2)

17-17: LGTM!

The code changes are approved.


48-50: LGTM!

The code changes are approved. The new condition correctly allows public prosecutor users to access completed cases, which aligns with the PR objective.

apps/judicial-system/backend/src/app/modules/file/file.controller.ts (2)

40-40: LGTM!

The code change is approved.


137-137: LGTM!

The code change is approved for the following reasons:

  • It aligns with the PR objective of allowing public prosecutor staff to access case files.
  • The change is made in the appropriate method responsible for retrieving the signed URL of a case file.
  • The method has the necessary guards to ensure proper access control based on user roles.
apps/judicial-system/backend/src/app/modules/case/case.controller.ts (2)

551-551: Approved. The code change resolves the access control issue.

The addition of publicProsecutorStaffRule to the @RolesRules decorator allows public prosecutor staff to access the getCaseFilesRecordPdf endpoint, which is consistent with the requirement mentioned in the existing comment thread.


707-707: Approved. The code change enhances access control.

The addition of publicProsecutorStaffRule to the @RolesRules decorator allows public prosecutor staff to access the getIndictmentPdf endpoint, which is consistent with the objective of enabling public prosecutor staff to access case files.

@gudjong gudjong added the automerge Merge this PR as soon as all checks pass label Sep 6, 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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aa584fd and 1c919ea.

Files selected for processing (1)
  • apps/judicial-system/backend/src/app/modules/case/case.controller.ts (2 hunks)
Files skipped from review due to trivial changes (1)
  • apps/judicial-system/backend/src/app/modules/case/case.controller.ts

@kodiakhq kodiakhq bot merged commit 535fd14 into main Sep 6, 2024
34 checks passed
@kodiakhq kodiakhq bot deleted the j-s/rsak-user-file-access branch September 6, 2024 12:34
jonnigs pushed a commit that referenced this pull request Sep 12, 2024
* chore(j-s): Allow public prosecutor user to open case files

* Update getByIdRolesRules.spec.ts

* Update getCaseFileSignedUrlRolesRules.spec.ts

* fix(j-s): Only show public prosecutor cases in a complete state

* Update getCaseFileSignedUrlRolesRules.spec.ts

* fix(j-s):tests

* fix(j-s): Add public prosecutor staff rule for indictment pdf

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
@coderabbitai coderabbitai bot mentioned this pull request Oct 1, 2024
6 tasks
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