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(service-portal): subpoena fixes #16261

Merged
merged 6 commits into from
Oct 4, 2024
Merged

Conversation

disaerna
Copy link
Member

@disaerna disaerna commented Oct 3, 2024

Subpoena fixes

What

  • Add more detailed audit logs
  • Fix ID for download file

Why

Specify why you need to achieve this

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

Release Notes

  • New Features

    • Introduced a new query for document confirmation actions.
    • Enhanced document retrieval with additional properties for urgent documents.
    • Added a confirmation modal for user acknowledgment on urgent documents.
  • Bug Fixes

    • Improved handling of document confirmation actions in the user interface.
  • Documentation

    • Updated GraphQL queries to include new fields and types related to document confirmations.

@disaerna disaerna requested a review from a team as a code owner October 3, 2024 14:52
Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Walkthrough

The pull request introduces a new GraphQL query method confirmActions in the DocumentResolverV2 class to handle document confirmation actions. It also adds the input type DocumentConfirmActionsInput and the output type DocumentConfirmActions. The DocumentServiceV2 class is updated to enhance document retrieval by including additional properties. The ConfirmationModal component is modified to use a new interface for props, and the DocumentLineV3 component integrates a lazy query for managing confirmation actions. Changes to GraphQL queries enhance data retrieval for document details.

Changes

File Path Change Summary
libs/api/domains/documents/src/lib/documentV2.resolver.ts Added method confirmActions with @Scopes decorator, logging audit entries. Updated query signature for documentV2ConfirmActions.
libs/api/domains/documents/src/lib/documentV2.service.ts Updated findDocumentById to include confirmation and alert actions in the returned document. Modified actionMapper to use document ID for constructing download URLs.
libs/api/domains/documents/src/lib/models/v2/confirmActions.input.ts Introduced new input type DocumentConfirmActionsInput with fields id (required string) and confirmed (optional boolean).
libs/api/domains/documents/src/lib/models/v2/confirmActions.model.ts Added new object type DocumentConfirmActions with fields id (required string) and confirmed (optional boolean).
libs/service-portal/core/src/components/ConfirmationModal/ConfirmationModal.tsx Added Props interface for ConfirmationModal component, defining required properties. Updated component to accept these props.
libs/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx Introduced useDocumentConfirmActionsLazyQuery for handling confirmation actions. Updated modal handling logic to include confirmation actions based on document urgency.
libs/service-portal/documents/src/screens/Overview/Overview.graphql Added DocumentConfirmActions query and updated existing queries (DocumentsV3, GetDocumentInboxLineV3) to include new fields for document confirmation actions and alerts.

Possibly related PRs

Suggested labels

automerge, high priority

Suggested reviewers

  • thordurhhh
  • oddsson
  • albinagu

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: 3

🧹 Outside diff range and nitpick comments (7)
libs/service-portal/documents/src/screens/Overview/Overview.graphql (2)

Line range hint 60-77: Approved: Enhanced document inbox line query with additional fields and localization support

The GetDocumentInboxLineV3 query has been successfully updated with new fields confirmation and alert, providing more detailed information about document inbox lines. The addition of the $locale parameter suggests support for localization, which is a valuable enhancement.

Consider adding documentation for the new $locale parameter to clarify its usage and supported values.


108-113: Approved: New query for document confirmation actions

The new DocumentConfirmActions query has been successfully added, aligning with the PR objectives related to subpoena fixes. The query structure is consistent with other queries in the file and follows the coding guidelines.

Consider adding a brief comment above the query to explain its specific purpose and usage context. This would enhance maintainability and clarity for other developers.

libs/service-portal/core/src/components/ConfirmationModal/ConfirmationModal.tsx (1)

Line range hint 15-23: LGTM! Consider using consistent naming for callback props.

The Props interface is well-defined and enhances the component's type safety. It includes all necessary properties with appropriate types.

For consistency, consider renaming onClose to onCloseModal to match the prop name used in the Modal component:

 interface Props {
   onSubmit: () => void
   onCancel: () => void
-  onClose: () => void
+  onCloseModal: () => void
   loading: boolean
   modalTitle: string
   modalText: string
   redirectPath: string
 }
libs/api/domains/documents/src/lib/documentV2.resolver.ts (1)

92-96: Consider renaming the method to follow existing naming convention.

To maintain consistency with other methods in the class (e.g., documentV2, documentsV2), consider renaming the method to documentV2ConfirmActions. This would align with the GraphQL query name specified in the @Query decorator.

Here's the suggested change:

@Query(() => DocumentConfirmActions, {
  nullable: true,
  name: 'documentV2ConfirmActions',
})
async documentV2ConfirmActions(
  // ... rest of the method
)
libs/api/domains/documents/src/lib/documentV2.service.ts (2)

Line range hint 67-75: LGTM! Consider using array destructuring for better readability.

The changes enhance the document retrieval process by adding new data points for confirmation modal and alert box, which aligns with the PR objectives. The code adheres to TypeScript usage and improves the overall functionality.

To further improve code readability, consider using array destructuring:

const [confirmation, alert, ...actions] = document.actions?.reduce(
  ([conf, alrt, acts], action) => {
    if (action.type === 'confirmation') return [action, alrt, acts];
    if (action.type === 'alert') return [conf, action, acts];
    return [conf, alrt, [...acts, action]];
  },
  [undefined, undefined, []]
);

This approach eliminates the need for multiple array operations and improves performance slightly.


381-381: LGTM! Consider adding error handling for missing document ID.

The change correctly addresses the PR objective of fixing the ID associated with a download file. Using the document ID instead of 'x.data' ensures that the correct identifier is used for generating the download URL, improving the accuracy of the download URL generation.

To further improve robustness, consider adding error handling for cases where the document ID might be undefined:

data: id 
  ? `${this.downloadServiceConfig.baseUrl}/download/v1/electronic-documents/${id}`
  : undefined,

This will prevent potential runtime errors if the document ID is missing for any reason.

libs/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (1)

131-133: Reconsider the use of 'no-cache' fetch policy

Setting fetchPolicy: 'no-cache' for confirmAction disables Apollo Client's caching mechanism, which may lead to unnecessary network requests and impact performance. Unless there's a specific need to bypass the cache, consider using the default fetch policy to leverage caching benefits.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7b20920 and 16188f8.

📒 Files selected for processing (7)
  • libs/api/domains/documents/src/lib/documentV2.resolver.ts (2 hunks)
  • libs/api/domains/documents/src/lib/documentV2.service.ts (2 hunks)
  • libs/api/domains/documents/src/lib/models/v2/confirmActions.input.ts (1 hunks)
  • libs/api/domains/documents/src/lib/models/v2/confirmActions.model.ts (1 hunks)
  • libs/service-portal/core/src/components/ConfirmationModal/ConfirmationModal.tsx (1 hunks)
  • libs/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (4 hunks)
  • libs/service-portal/documents/src/screens/Overview/Overview.graphql (1 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
libs/api/domains/documents/src/lib/documentV2.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/documents/src/lib/documentV2.service.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/documents/src/lib/models/v2/confirmActions.input.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/documents/src/lib/models/v2/confirmActions.model.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/service-portal/core/src/components/ConfirmationModal/ConfirmationModal.tsx (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/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (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/service-portal/documents/src/screens/Overview/Overview.graphql (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."
🔇 Additional comments (17)
libs/api/domains/documents/src/lib/models/v2/confirmActions.model.ts (5)

1-2: LGTM: Imports are appropriate and specific.

The imports from '@nestjs/graphql' and 'class-validator' are correctly used for defining the GraphQL object type and adding validation. This adheres to good practices by importing only what's necessary.


4-5: LGTM: Class definition is well-structured.

The DocumentConfirmActions class is properly defined as a GraphQL object type using the @ObjectType decorator. The naming convention follows PascalCase, which is standard for TypeScript classes.


6-8: LGTM: The 'id' field is well-defined and validated.

The id field is correctly exposed in the GraphQL schema using @Field(), validated as a string with @IsString(), and marked as readonly and non-nullable. This ensures type safety and prevents unintended modifications.


10-11: LGTM: The 'confirmed' field is properly defined as an optional boolean.

The confirmed field is correctly exposed in the GraphQL schema as a nullable Boolean. It's marked as readonly and optional, which aligns with good practices for immutable, optional properties.


1-12: Adherence to coding guidelines for libs/**/* confirmed.

This model adheres to the coding guidelines for the libs/**/* pattern:

  1. It's a reusable component that can be used across different NextJS apps.
  2. TypeScript is effectively used for defining props and exporting types.
  3. The simple nature of this model supports effective tree-shaking and bundling practices.
libs/api/domains/documents/src/lib/models/v2/confirmActions.input.ts (5)

1-2: Imports and file structure look good.

The imports are concise and appropriate for the functionality implemented in the file. The file structure follows TypeScript best practices.


4-5: Class definition and decorator usage are correct.

The class name DocumentConfirmActionsInput is descriptive and follows PascalCase convention. The @InputType decorator is correctly used with the class name as an argument, adhering to TypeScript best practices for GraphQL input types.


6-8: The id field is well-implemented.

The id field is correctly defined as a required string with appropriate decorators. The use of @Field() for GraphQL and @IsString() for validation is correct. The readonly modifier ensures immutability, which is a good practice for input types.


10-11: The confirmed field is correctly implemented.

The confirmed field is properly defined as an optional boolean. The @Field() decorator is correctly used with an explicit type and nullable option. The optional modifier ? aligns with the nullable nature of the field, and the readonly modifier ensures immutability.


1-12: Code adheres to libs/**/* coding guidelines.

This implementation follows the coding guidelines for the libs directory:

  1. The DocumentConfirmActionsInput class is reusable across different NextJS apps.
  2. TypeScript is effectively used for defining props and exporting types.
  3. The code structure supports effective tree-shaking and bundling practices.
libs/service-portal/documents/src/screens/Overview/Overview.graphql (1)

Line range hint 22-58: Approved: Enhanced document query with additional fields

The DocumentsV3 query has been successfully updated with new fields isUrgent and confirmation. These additions provide more detailed information about documents, aligning with the PR objectives. The changes are consistent with the existing structure and maintain reusability across different NextJS apps.

libs/service-portal/core/src/components/ConfirmationModal/ConfirmationModal.tsx (2)

Line range hint 25-33: LGTM! Component signature is well-defined.

The updated component signature correctly uses the Props interface and React.PropsWithChildren. This enhances type safety and allows for potential future expansion of the component to include child elements.


Line range hint 35-92: LGTM! Consider adding an aria-label to the modal for improved accessibility.

The component implementation is clean, well-structured, and follows React best practices. It makes good use of the project's UI components and localization hooks.

To improve accessibility, consider adding an aria-label to the Modal component:

 <Modal id="confirmation-modal-errand" onCloseModal={onClose}
+       aria-label={formatMessage(m.confirmationModalAriaLabel)}>

Don't forget to add the corresponding message to your localization file.

Let's verify if the aria-label property is supported by the Modal component:

libs/api/domains/documents/src/lib/documentV2.resolver.ts (3)

33-34: LGTM: New imports are consistent with existing code.

The new imports for DocumentConfirmActionsInput and DocumentConfirmActions are correctly added and follow the existing import style in the file.


92-108: LGTM: New confirmActions method is well-implemented.

The new method is properly scoped, uses correct decorators, and implements audit logging as per the PR objectives. Good job on maintaining consistency with other methods in the class.


Line range hint 1-108: Confirm adherence to coding guidelines for libs/**/* pattern.

The code in this file adheres to the specified guidelines:

  1. Reusability: The DocumentResolverV2 class can be reused across different NextJS apps that require document-related functionality.
  2. TypeScript usage: The code effectively uses TypeScript for defining types, interfaces, and method signatures.
  3. Tree-shaking and bundling: The use of named exports allows for effective tree-shaking in the bundling process.
libs/api/domains/documents/src/lib/documentV2.service.ts (1)

Line range hint 93-94: LGTM! Consistent with earlier changes.

The addition of 'confirmation' and 'alert' properties to the returned object is consistent with the earlier modifications in the method. This improves the document structure by including confirmation and alert data, which aligns with the PR objectives of enhancing audit logs.

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.93%. Comparing base (fa89e26) to head (030a1ad).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16261   +/-   ##
=======================================
  Coverage   36.92%   36.93%           
=======================================
  Files        6781     6781           
  Lines      140030   139997   -33     
  Branches    39815    39802   -13     
=======================================
- Hits        51705    51701    -4     
+ Misses      88325    88296   -29     
Flag Coverage Δ
api 3.37% <ø> (ø)

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

see 5 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 babf669...030a1ad. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 3, 2024

Datadog Report

All test runs d335bf3 🔗

3 Total Test Services: 0 Failed, 2 Passed
➡️ Test Sessions change in coverage: 25 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.66s 1 no change Link
service-portal-core 0 0 0 5 0 1.8s N/A Link
service-portal-health 0 0 0 0 0 506.63ms 1 no change Link

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 (3)
libs/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (3)

135-136: Create a task for query refactoring

The TODO comment correctly identifies the need to refactor queries and move them to a shared file. This aligns with our coding guidelines for reusability across different NextJS apps.

Consider creating a specific task or issue to track this refactoring work, ensuring it doesn't get overlooked in future development cycles.


378-388: LGTM with minor suggestion: Modal action handlers

The changes to the ConfirmationModal handlers (onSubmit, onCancel, and onClose) correctly implement the confirmation action calling, which aligns with the PR objective of subpoena-related fixes. Each handler appropriately calls confirmActionCaller with the correct boolean value.

Consider refactoring to reduce the duplication of setModalVisible(false) in onSubmit and onCancel. You could extract this into a separate function that also calls confirmActionCaller, like this:

const handleModalAction = (confirmed: boolean | null) => {
  setModalVisible(false);
  confirmActionCaller(confirmed);
};

// Then in the handlers:
onSubmit={() => {
  handleModalAction(true);
  getDocument();
}}
onCancel={() => handleModalAction(false)}
onClose={() => handleModalAction(null)}

This refactoring would make the code more DRY and easier to maintain.


Line range hint 1-402: Overall assessment: Well-implemented changes with minor improvements needed

The changes in this file effectively implement the PR objectives of adding more detailed audit logs and fixing subpoena-related issues. The new functionality for handling confirmation actions and urgent documents is well-implemented and improves the user experience.

The code adheres to TypeScript usage for defining props and exporting types, which is in line with our coding guidelines. There are no apparent issues with tree-shaking or bundling practices.

To fully align with our coding guidelines for reusability across different NextJS apps, please prioritize the TODO task of moving queries to a shared file. This will enhance the modularity and reusability of the component.

Overall, great job on implementing these important features while maintaining code quality!

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 16188f8 and ae69022.

📒 Files selected for processing (2)
  • libs/api/domains/documents/src/lib/documentV2.resolver.ts (2 hunks)
  • libs/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
libs/api/domains/documents/src/lib/documentV2.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/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (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."
🔇 Additional comments (5)
libs/api/domains/documents/src/lib/documentV2.resolver.ts (2)

33-34: LGTM: New imports are correctly added.

The new imports for DocumentConfirmActionsInput and DocumentConfirmActions are appropriately added and follow TypeScript conventions. These imports are related to the newly added confirmActions method.


Line range hint 1-110: LGTM: Code complies with coding guidelines for libs/**/* files.

The code in this file adheres to the specified coding guidelines:

  1. It contributes to the reusability of components across different NextJS apps by implementing a GraphQL resolver.
  2. It uses TypeScript for defining props and exporting types, as seen in the method signatures and import statements.
  3. There are no apparent issues with tree-shaking or bundling practices.

The implementation follows good practices for a resolver in a TypeScript environment.

libs/service-portal/documents/src/components/DocumentLine/DocumentLineV3.tsx (3)

131-133: LGTM: Addition of confirmation action query

The addition of useDocumentConfirmActionsLazyQuery with a no-cache fetch policy aligns well with the PR objective of enhancing audit logs. This ensures that fresh data is always fetched for confirmation actions, which is crucial for maintaining accurate audit trails.


Line range hint 188-224: LGTM: Enhanced document metadata handling

The changes to getDocumentMetadata function effectively implement the handling of confirmation actions for urgent documents. This improvement aligns well with the PR objective of implementing subpoena-related fixes. The logic for setting modal data based on the confirmation action is sound and enhances the user experience.


251-255: LGTM: Addition of confirmActionCaller function

The new confirmActionCaller function provides a centralized way to handle confirmation actions, which is excellent for maintainability and supports the PR objective of adding more detailed audit logs. This implementation ensures consistent handling of confirmation actions across different scenarios.

@disaerna disaerna added the automerge Merge this PR as soon as all checks pass label Oct 3, 2024
Copy link
Member

@thorkellmani thorkellmani left a comment

Choose a reason for hiding this comment

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

LGTM

Could the resolver name be documentActionAudit.resolver.tsor something tho?

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