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

feat(native-app): log confirm actions of subpoena to backend #16862

Merged
merged 5 commits into from
Nov 15, 2024

Conversation

thoreyjona
Copy link
Contributor

@thoreyjona thoreyjona commented Nov 14, 2024

What

Logging when users either confirm or not confirm supoena in the app. Currently the backend does not support categories, i.e. service portal vs app so me and Dísa from Hugsmiðjan decided that I would add _app as a suffix to the id of the document so that can be used to differentiate at first.

Why

To be able to track what happens in the frontend like is done in the service portal.

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

    • Introduced a new GraphQL query for logging document confirmation actions.
    • Enhanced the Document Detail Screen with a lazy query for improved user interaction, allowing users to confirm actions seamlessly.
  • Bug Fixes

    • Maintained existing functionalities and error handling while integrating new features.

@thoreyjona thoreyjona requested a review from a team as a code owner November 14, 2024 11:33
Copy link
Contributor

coderabbitai bot commented Nov 14, 2024

Walkthrough

This pull request introduces a new GraphQL query named DocumentConfirmActions, which accepts an input of type DocumentConfirmActionsInput!. It is designed to log confirmation actions related to document handling within the DocumentDetailScreen component. The implementation includes a new lazy query and modifies existing functions to integrate the logging functionality while maintaining the original structure and behavior of the application.

Changes

File Path Change Summary
apps/native/app/src/graphql/queries/inbox.graphql Added a new query DocumentConfirmActions($input: DocumentConfirmActionsInput!).
apps/native/app/src/screens/document-detail/document-detail.tsx Introduced useDocumentConfirmActionsLazyQuery, added confirmAction function, and modified showConfirmationAlert. Updated state management and control flow to incorporate the new lazy query.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • eirikurn

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

codecov bot commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.44%. Comparing base (e1dd2d5) to head (2f5b1b5).
Report is 20 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16862   +/-   ##
=======================================
  Coverage   36.44%   36.44%           
=======================================
  Files        6852     6852           
  Lines      143559   143579   +20     
  Branches    40972    40980    +8     
=======================================
+ Hits        52326    52334    +8     
- Misses      91233    91245   +12     
Flag Coverage Δ
judicial-system-backend 55.13% <ø> (-0.05%) ⬇️

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

see 16 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 e1dd2d5...2f5b1b5. Read the comment docs.

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 (2)
apps/native/app/src/graphql/queries/inbox.graphql (1)

51-57: Add documentation for the new query and its input type.

The query structure looks good, but please add documentation comments to describe:

  • The purpose of the query
  • The structure of DocumentConfirmActionsInput
  • The meaning of the returned fields

Consider adding documentation like this:

"""
Logs confirmation actions for documents with platform differentiation.
"""
query DocumentConfirmActions($input: DocumentConfirmActionsInput!) {
  documentV2ConfirmActions(input: $input) {
    id        # Document identifier
    confirmed # Confirmation status
  }
}
apps/native/app/src/screens/document-detail/document-detail.tsx (1)

257-260: Consider a more robust platform identification strategy

The current approach of appending '_app' to the document ID is a temporary solution. Consider proposing a more maintainable approach by:

  1. Adding a platform field to the DocumentConfirmActionsInput type in the GraphQL schema
  2. Using an enum to represent different platforms (APP, SERVICE_PORTAL, etc.)

This would provide better type safety and eliminate the need for string manipulation.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 17266fc and 07a824b.

📒 Files selected for processing (2)
  • apps/native/app/src/graphql/queries/inbox.graphql (1 hunks)
  • apps/native/app/src/screens/document-detail/document-detail.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/native/app/src/graphql/queries/inbox.graphql (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/native/app/src/screens/document-detail/document-detail.tsx (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 (1)
apps/native/app/src/screens/document-detail/document-detail.tsx (1)

30-30: LGTM: Import follows GraphQL query hook conventions

The import is correctly placed and follows the established naming pattern for GraphQL query hooks.

@datadog-island-is
Copy link

datadog-island-is bot commented Nov 14, 2024

Datadog Report

All test runs 8b550ac 🔗

2 Total Test Services: 0 Failed, 2 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.04%), 1 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
judicial-system-backend 0 0 0 21209 0 22m 25.05s 1 no change Link
judicial-system-xrd-api 0 0 0 6 0 5.55s 1 decreased (-0.04%) Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • judicial-system-xrd-api - jest 75.07% (-0.04%) - Details

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

🧹 Outside diff range and nitpick comments (1)
apps/native/app/src/screens/document-detail/document-detail.tsx (1)

252-261: Add TypeScript type annotations for better type safety

The implementation aligns with the PR objectives, but could benefit from explicit type annotations.

-  const confirmAction = async (confirmed: boolean) => {
+  const confirmAction = async (confirmed: boolean): Promise<void> => {
     // Adding a suffix '_app' to the id since the backend is currently not distinguishing between the app and the web
     await logConfirmedAction({
       variables: { input: { id: `${docId}_app`, confirmed: confirmed } },
     })
   }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 07a824b and 2f5b1b5.

📒 Files selected for processing (1)
  • apps/native/app/src/screens/document-detail/document-detail.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/native/app/src/screens/document-detail/document-detail.tsx (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."

Copy link
Contributor

@snaerseljan snaerseljan left a comment

Choose a reason for hiding this comment

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

Good job

@thoreyjona thoreyjona added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Nov 15, 2024
@kodiakhq kodiakhq bot merged commit a6fa992 into main Nov 15, 2024
23 checks passed
@kodiakhq kodiakhq bot deleted the feat/add-logging-app-subpoena branch November 15, 2024 09:40
jonnigs pushed a commit that referenced this pull request Nov 26, 2024
* feat: log confirm actions of subpoena to backend

* fix: better comment

* fix: confirm action can not be null

* feat: make sure to await actions

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
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.

2 participants