fix(j-s): Merge Case Access #16786

gudjong · 2024-11-08T21:04:29Z

Merge Case Access

Laga aðgang verjenda að gögnum í sameinuðum málum

What

Fixes defender and spokesperson access to uploaded case files in merged cases.
Fixes access to subpoena PDF in merged cases for all full access users.
Rewrites case queries with respect to memory footprint.

Why

Verified bug.
Query optimization.

Screenshots / Gifs

Screen.Recording.2024-11-08.at.21.02.20.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
- Enhanced GraphQL query now includes detailed information about defendants in cases.
- Added new notification types for better event handling.
- Introduced access control improvements for file management and case retrieval.
Bug Fixes
- Adjusted role-based access for retrieving case file URLs.
Documentation
- Updated test cases to reflect changes in query parameters and access control logic.
Chores
- Removed unused imports and parameters across various files to streamline code.

coderabbitai · 2024-11-08T21:04:36Z

Walkthrough

The changes in this pull request primarily involve modifications to various service and filter files within the judicial system application. Key updates include the removal of unused constants, the introduction of new constants, and enhancements to query structures. Additionally, access control logic has been refined in the FileController, and new fields have been added to the GraphQL query for case information. Test files have also been adjusted to reflect these changes, particularly in how cases are filtered and retrieved, ensuring that the overall functionality remains intact while improving clarity and maintainability.

Changes

File	Change Summary
`apps/judicial-system/backend/src/app/modules/case/case.service.ts`	Removed unused constants (`eventTypes`, `dateTypes`, `stringTypes`), added `notificationTypes`, restructured Sequelize queries, simplified `where` clauses, refined `update` method for case state transitions.
`apps/judicial-system/backend/src/app/modules/case/filters/cases.filter.ts`	Updated filtering logic to use subqueries for event and date logs based on user roles.
`apps/judicial-system/backend/src/app/modules/case/filters/test/cases.filter.spec.ts`	Modified tests for user role filters to reflect subquery changes.
`apps/judicial-system/backend/src/app/modules/case/guards/mergedCaseExists.guard.ts`	Updated `canActivate` method to assign `mergedCaseParent` to request.
`apps/judicial-system/backend/src/app/modules/case/guards/test/caseExistsGuard.spec.ts`	Removed `order` import and parameter from tests.
`apps/judicial-system/backend/src/app/modules/case/guards/test/caseHasExistedGuard.spec.ts`	Removed `order` import and parameter from tests.
`apps/judicial-system/backend/src/app/modules/case/guards/test/limitedAccessCaseExistsGuard.spec.ts`	Removed `order` parameter from tests.
`apps/judicial-system/backend/src/app/modules/case/limitedAccessCase.service.ts`	Removed unused constants, updated query structures, simplified `where` clauses, refined logging in `update` method.
`apps/judicial-system/backend/src/app/modules/case/test/caseController/*.spec.ts`	Removed `order` import and parameter from multiple test files, simplifying query tests.
`apps/judicial-system/backend/src/app/modules/file/file.controller.ts`	Modified access control for `getCaseFileSignedUrl` and added `CaseReceivedGuard` to `uploadCaseFileToCourt`.
`apps/judicial-system/backend/src/app/modules/file/guards/limitedAccessViewCaseFile.guard.ts`	Enhanced access control logic to use `accessControlCase`.
`apps/judicial-system/backend/src/app/modules/file/test/fileController/getCaseFileSignedUrlRolesRules.spec.ts`	Updated tests to reflect removal of `prisonSystemStaffRule`.
`apps/judicial-system/web/src/components/FormProvider/case.graphql`	Added `defendants` field to GraphQL query with detailed attributes.
`libs/judicial-system/types/src/index.ts`	Added exports for new constants (`notificationTypes`, `eventTypes`, `dateTypes`, `stringTypes`).
`libs/judicial-system/types/src/lib/caseString.ts`	Added `stringTypes` constant.
`libs/judicial-system/types/src/lib/dateLog.ts`	Added `dateTypes` constant.
`libs/judicial-system/types/src/lib/eventLog.ts`	Added `eventTypes` constant.
`libs/judicial-system/types/src/lib/notification.ts`	Introduced new enums and constants for notifications, updated existing enum references.

Suggested labels

automerge, high priority

Suggested reviewers

unakb

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

🧹 Outside diff range and nitpick comments (21)

libs/judicial-system/types/src/lib/caseString.ts (1)
6-6: Consider adding explicit type annotation for better type safety.

While the current implementation works, adding an explicit type annotation would improve type safety and documentation.
-export const stringTypes = Object.values(StringType)
+export const stringTypes: StringType[] = Object.values(StringType)
Also consider adding a JSDoc comment to document the purpose of this constant:
+/** Array of all available string types for case filtering */
 export const stringTypes: StringType[] = Object.values(StringType)
apps/judicial-system/backend/src/app/modules/case/guards/mergedCaseExists.guard.ts (1)
40-42: Consider adding type declarations for request extensions.

To improve type safety and maintainability, consider declaring custom types for the request object extensions.
interface MergedCaseRequest extends Request {
  mergedCaseParent?: Case;
  case?: Case;
  params: {
    caseId: string;
    mergedCaseId?: string;
  };
}
apps/judicial-system/backend/src/app/modules/file/guards/limitedAccessViewCaseFile.guard.ts (1)
Line range hint 1-56: Consider adding logging for access denied cases.

For security auditing purposes, it would be valuable to log when access is denied, including the user role and case identifier (but no PII).
    if (
      canLimitedAccessUserViewCaseFile(
        user,
        accessControlCase.type,
        accessControlCase.state,
        caseFile.category,
        accessControlCase.defendants,
        accessControlCase.civilClaimants,
      )
    ) {
      return true
    }

+   logger.warn('Access denied to case file', {
+     userRole: user.role,
+     caseId: theCase.id,
+     isMergedCase: !!request.mergedCaseParent
+   });
    throw new ForbiddenException(`Forbidden for ${user.role}`)
apps/judicial-system/backend/src/app/modules/case/guards/test/caseHasExistedGuard.spec.ts (1)

Line range hint 1-108: Well-structured test suite with comprehensive coverage.

The test suite effectively covers:

Success case with proper query parameters

Error handling for non-existent cases

Validation of missing case IDs

The structure follows Jest best practices and maintains good separation of concerns.

Consider adding test cases for:

Cases with isArchived: true

Edge cases around merged cases, given this PR's focus on merged case access
libs/judicial-system/types/src/index.ts (1)
24-26: Consider grouping related type exports together.

While the exports are valid, consider organizing related type exports together for better maintainability. The event, date, and string type exports could be grouped with their corresponding type definitions.
- export { EventType, eventTypes } from './lib/eventLog'
- export { DateType, dateTypes } from './lib/dateLog'
- export { StringType, stringTypes } from './lib/caseString'
+ // Case-related types and constants
+ export { 
+   EventType, 
+   eventTypes,
+   DateType, 
+   dateTypes,
+   StringType, 
+   stringTypes 
+ } from './lib/case-types'
apps/judicial-system/backend/src/app/modules/case/guards/test/limitedAccessCaseExistsGuard.spec.ts (1)

14-14: LGTM: Query optimization through centralized attributes and includes.

The import of attributes and include from limitedAccessCase.service aligns well with the PR's objective of optimizing case queries. This centralization helps maintain consistency in query parameters across the codebase.

This approach of centralizing query parameters is particularly beneficial for:

Maintaining consistent memory usage across queries

Reducing duplication of query specifications

Making query parameter updates more maintainable

libs/judicial-system/types/src/lib/notification.ts (1)

64-64: LGTM! Efficient notification type aggregation.

The constant provides a centralized way to access all notification types and supports effective tree-shaking.

Consider adding a type guard or validation function if this constant is used for runtime type checking of notification values.
apps/judicial-system/web/src/components/FormProvider/limitedAccessCase.graphql (1)
211-211: Consider adding field documentation.

To improve schema maintainability, consider adding GraphQL documentation for the new defendants field using a description directive:
+ """
+ Information about defendants in merged cases, including their personal details,
+ defender information, and associated subpoenas.
+ """
  defendants {
apps/judicial-system/backend/src/app/modules/case/filters/cases.filter.ts (2)

89-95: Consider monitoring query performance with the new subquery.

While the subquery implementation is secure (using enum values), it might impact performance on large datasets. Consider:

Adding an index on event_log.case_id and event_log.event_type if not already present

Monitoring query execution time in production

256-264: Optimize the arraignment date subquery.

While the implementation is secure, consider optimizing the query:

Add an index on date_log.case_id and date_log.date_type if not present

Consider batching or pagination for large result sets
apps/judicial-system/backend/src/app/modules/case/test/caseController/extend.spec.ts (1)
Line range hint 1-386: Enhance test coverage for access permissions.

While the test suite comprehensively covers the case extension functionality, considering the PR's primary objective of fixing access permissions for defenders and spokespersons in merged cases, we should add test cases that verify:

Access permissions for defenders in merged cases

Access permissions for spokespersons in merged cases

Access to subpoena PDFs for users with full access

Consider adding these test cases:
describe('access permissions in extended cases', () => {
  it('should allow defender access to merged case files', () => {
    // Test implementation
  })

  it('should allow spokesperson access to merged case files', () => {
    // Test implementation
  })

  it('should allow full access users to access subpoena PDFs', () => {
    // Test implementation
  })
})
apps/judicial-system/backend/src/app/modules/case/filters/test/cases.filter.spec.ts (1)
320-326: Consider improving SQL template literal formatting.

While the subquery logic is correct, the SQL formatting could be improved for better readability.
             id: {
               [Op.in]: Sequelize.literal(`
-            (SELECT case_id
-              FROM event_log
-              WHERE event_type = '${EventType.INDICTMENT_SENT_TO_PUBLIC_PROSECUTOR}')
+                (
+                  SELECT case_id
+                  FROM event_log
+                  WHERE event_type = '${EventType.INDICTMENT_SENT_TO_PUBLIC_PROSECUTOR}'
+                )
           `),
             },
apps/judicial-system/backend/src/app/modules/case/test/caseController/transition.spec.ts (3)
Line range hint 82-324: Consider improving test readability and error coverage.

While the test suite is comprehensive, consider these improvements:

The test descriptions in the each blocks could be more readable by using template literals instead of concatenation.

Add test cases for error scenarios, such as invalid state transitions.

Example of improved test description:
-    '$transition $oldState case transitioning to $newState case',
+    `Case transition: ${transition} (${oldState} → ${newState})`,
Line range hint 325-566: Refactor notification testing for better maintainability.

The notification testing logic is spread across multiple test blocks with some duplication. Consider:

Creating a helper function to verify notifications based on transition type and states

Using a shared constant for common notification payloads

Example helper function:
const verifyNotifications = (
  transition: CaseTransition,
  oldState: CaseState,
  newState: CaseState,
  mockMessageService: MessageService,
  theCase: Case,
  user: User,
) => {
  const expectedNotifications = getExpectedNotifications(
    transition,
    oldState,
    newState,
    theCase,
  )
  if (expectedNotifications.length > 0) {
    expect(mockMessageService.sendMessagesToQueue).toHaveBeenCalledWith(
      expectedNotifications.map(type => ({
        type,
        user,
        caseId: theCase.id,
        // ... other common properties
      }))
    )
  } else {
    expect(mockMessageService.sendMessagesToQueue).not.toHaveBeenCalled()
  }
}
Line range hint 567-709: Improve organization of appeal transition tests.

The appeal transition tests mix state transition logic with file handling. Consider:

Moving the case file setup to a separate helper function

Creating constants for common file categories and states

Example refactor:
const createAppealCaseFiles = (
  category: CaseFileCategory,
  state: CaseFileState = CaseFileState.STORED_IN_RVG,
) => ({
  id: uuid(),
  key: uuid(),
  state,
  category,
})

const setupAppealTestCase = (
  type: string,
  state: CaseState,
  appealState?: CaseAppealState,
) => ({
  id: uuid(),
  type,
  state,
  appealState,
  caseFiles: [
    createAppealCaseFiles(CaseFileCategory.PROSECUTOR_APPEAL_BRIEF),
    createAppealCaseFiles(CaseFileCategory.PROSECUTOR_APPEAL_BRIEF_CASE_FILE),
    createAppealCaseFiles(CaseFileCategory.APPEAL_RULING),
  ],
  origin: CaseOrigin.LOKE,
})
apps/judicial-system/web/src/components/FormProvider/case.graphql (1)

317-353: Consider limiting the data fetched to improve performance.

Including all fields for defendants and their subpoenas may increase payload size and impact performance. Consider selecting only the necessary fields required by the client components.
apps/judicial-system/backend/src/app/modules/case/case.service.ts (5)
2-2: Consider importing types directly from 'sequelize'

Importing Includeable and Transaction from 'sequelize/types' is not recommended. Instead, import them directly from 'sequelize' to maintain compatibility and future-proof the code.
-import { Includeable, Transaction } from 'sequelize/types'
+import { Includeable, Transaction } from 'sequelize'
291-304: Review the use of 'separate: true' in associations

Using separate: true for the civilClaimants and indictmentCounts associations will execute separate queries for each. While this can prevent large JOINs and reduce memory usage for large datasets, it may increase the number of database queries and impact performance. Consider if separate: true is necessary or if eager loading without it would suffice.

316-316: Assess performance implications of 'separate: true' and 'where' clauses

Adding where clauses and separate: true to the eventLogs, dateLogs, caseStrings, and notifications associations can lead to multiple queries being executed. This might impact performance due to increased database load. Evaluate whether these associations require separate: true, or if the filtering can be handled efficiently within the main query.

Also applies to: 324-326, 332-334, 335-341

349-364: Monitor performance of deeply nested includes with 'separate: true'

Including defendants and nested subpoenas within mergedCases using separate: true results in multiple additional queries. This depth of eager loading can negatively affect performance. Consider if all nested data is required immediately or if some associations can be loaded lazily when needed.

398-404: Evaluate necessity of including 'defendants' in case list queries

Including defendants in caseListInclude with separate: true may increase the number of queries when retrieving case lists, potentially impacting performance. Assess whether fetching defendants is essential for the case list view or if it can be deferred to improve efficiency.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5d43b90 and ffb1621.

📒 Files selected for processing (22)

apps/judicial-system/backend/src/app/modules/case/case.service.ts (6 hunks)
apps/judicial-system/backend/src/app/modules/case/filters/cases.filter.ts (5 hunks)
apps/judicial-system/backend/src/app/modules/case/filters/test/cases.filter.spec.ts (5 hunks)
apps/judicial-system/backend/src/app/modules/case/guards/mergedCaseExists.guard.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/case/guards/test/caseExistsGuard.spec.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/case/guards/test/caseHasExistedGuard.spec.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/case/guards/test/limitedAccessCaseExistsGuard.spec.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/case/limitedAccessCase.service.ts (4 hunks)
apps/judicial-system/backend/src/app/modules/case/test/caseController/create.spec.ts (2 hunks)
apps/judicial-system/backend/src/app/modules/case/test/caseController/createCourtCase.spec.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/case/test/caseController/extend.spec.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/case/test/caseController/transition.spec.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/file/file.controller.ts (0 hunks)
apps/judicial-system/backend/src/app/modules/file/guards/limitedAccessViewCaseFile.guard.ts (1 hunks)
apps/judicial-system/backend/src/app/modules/file/test/fileController/getCaseFileSignedUrlRolesRules.spec.ts (1 hunks)
apps/judicial-system/web/src/components/FormProvider/case.graphql (1 hunks)
apps/judicial-system/web/src/components/FormProvider/limitedAccessCase.graphql (1 hunks)
libs/judicial-system/types/src/index.ts (1 hunks)
libs/judicial-system/types/src/lib/caseString.ts (1 hunks)
libs/judicial-system/types/src/lib/dateLog.ts (1 hunks)
libs/judicial-system/types/src/lib/eventLog.ts (1 hunks)
libs/judicial-system/types/src/lib/notification.ts (2 hunks)

💤 Files with no reviewable changes (1)

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

✅ Files skipped from review due to trivial changes (1)

libs/judicial-system/types/src/lib/eventLog.ts

🧰 Additional context used

📓 Path-based instructions (20)

apps/judicial-system/backend/src/app/modules/case/case.service.ts (1)