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): Add loading state to create subpoena button #16612

Merged
merged 7 commits into from
Oct 29, 2024

Conversation

oddsson
Copy link
Member

@oddsson oddsson commented Oct 29, 2024

Add loading state to create subpoena button

Asana

What

When a user clicks the "Create subpoena" button, we update the defendant and clear the court date. This could take some time and the users can click the button again while this is happening, creating a duplicate subpoena.

Why

We never want to create duplicate subpoenas

Screenshots / Gifs

Screen.Recording.2024-10-29.at.11.27.34.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 user feedback during subpoena creation with loading indicators.
    • Integrated error handling that displays notifications for failed updates.
  • Bug Fixes

    • Improved error handling for defendant and court date updates, ensuring users receive timely feedback.

@oddsson oddsson requested a review from a team as a code owner October 29, 2024 11:27
Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

Walkthrough

The changes in this pull request focus on the Subpoena component within the Subpoena.tsx file. A new state variable isCreatingSubpoena has been introduced to manage the loading state during the subpoena creation process. The handleNavigationTo function has been updated to include error handling that resets the loading state if updates fail. Additionally, the isPrimaryButtonLoading prop of the Modal component is now linked to this new state variable, enhancing user feedback during the creation process.

Changes

File Path Change Summary
apps/judicial-system/web/src/routes/Court/Indictments/Subpoena/Subpoena.tsx - Added state variable isCreatingSubpoena to manage loading state.
- Updated handleNavigationTo for error handling that resets loading state.
- Linked isPrimaryButtonLoading prop of Modal to isCreatingSubpoena state.
- Modified import statements to include toast and errors.

Possibly related PRs

Suggested labels

automerge

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.

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)
apps/judicial-system/web/src/routes/Court/Indictments/Subpoena/Subpoena.tsx (3)

Line range hint 55-82: Consider splitting handleNavigationTo into smaller functions.

The function handles multiple responsibilities: updating defendants, clearing conclusions, and updating court dates. Consider splitting it into smaller, more focused functions for better maintainability and testing.

const updateDefendants = async () => {
  const promises = workingCase.defendants?.map((defendant) =>
    updateDefendant({
      caseId: workingCase.id,
      defendantId: defendant.id,
      subpoenaType: defendant.subpoenaType,
    })
  ) ?? [];
  
  return Promise.all(promises);
};

const clearConclusion = () => {
  return isArraignmentScheduled && workingCase.indictmentDecision
    ? [{
        indictmentDecision: null,
        courtSessionType: null,
        courtDate: null,
        postponedIndefinitelyExplanation: null,
        indictmentRulingDecision: null,
        mergeCaseId: null,
        force: true,
      }]
    : undefined;
};

Also applies to: 105-107


80-82: Enhance error messages with specific failure details.

The current error messages are generic. Consider providing more specific error messages that indicate which operation failed and why.

-toast.error(formatMessage(errors.updateDefendant))
+toast.error(formatMessage(errors.updateDefendant, {
+  details: 'Failed to update defendant information. Please try again.',
+}))

-toast.error(formatMessage(errors.updateCase))
+toast.error(formatMessage(errors.updateCase, {
+  details: 'Failed to update court date. Please try again.',
+}))

Also applies to: 105-107


Line range hint 27-271: Consider extracting subpoena creation logic into a custom hook.

To improve code organization and reusability, consider extracting the subpoena creation logic into a custom hook (e.g., useSubpoenaCreation). This would:

  • Simplify the component by moving complex state management logic
  • Make the code more testable
  • Follow React's composition pattern

Example implementation:

const useSubpoenaCreation = (workingCase, onSuccess) => {
  const [isCreating, setIsCreating] = useState(false);
  
  const createSubpoena = async () => {
    setIsCreating(true);
    try {
      // Subpoena creation logic here
      onSuccess();
    } catch (error) {
      toast.error(error.message);
    } finally {
      setIsCreating(false);
    }
  };
  
  return { isCreating, createSubpoena };
};
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cc6778a and 9f48c3c.

📒 Files selected for processing (1)
  • apps/judicial-system/web/src/routes/Court/Indictments/Subpoena/Subpoena.tsx (7 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/judicial-system/web/src/routes/Court/Indictments/Subpoena/Subpoena.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 (2)
apps/judicial-system/web/src/routes/Court/Indictments/Subpoena/Subpoena.tsx (2)

5-5: LGTM: Import changes follow best practices.

The addition of toast notifications and centralized error messages follows good practices for consistent error handling.

Also applies to: 8-8


267-267: LGTM: Modal loading state prevents duplicate submissions.

The addition of isPrimaryButtonLoading effectively prevents users from creating duplicate subpoenas by disabling the button during submission.

Copy link

codecov bot commented Oct 29, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 36.78%. Comparing base (e50ded3) to head (1ed8597).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...src/routes/Court/Indictments/Subpoena/Subpoena.tsx 0.00% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16612   +/-   ##
=======================================
  Coverage   36.78%   36.78%           
=======================================
  Files        6855     6855           
  Lines      142311   142315    +4     
  Branches    40584    40584           
=======================================
+ Hits        52348    52350    +2     
- Misses      89963    89965    +2     
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
api 3.37% <ø> (ø)
application-api-files 56.78% <ø> (ø)
application-core 71.17% <ø> (ø)
application-system-api 41.32% <ø> (ø)
application-template-api-modules 27.78% <ø> (ø)
application-templates-accident-notification 29.24% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.30% <ø> (ø)
application-templates-driving-license 18.40% <ø> (ø)
application-templates-estate 12.25% <ø> (ø)
application-templates-example-payment 25.20% <ø> (ø)
application-templates-financial-aid 15.50% <ø> (ø)
application-templates-general-petition 23.42% <ø> (ø)
application-templates-inheritance-report 6.51% <ø> (ø)
application-templates-marriage-conditions 15.18% <ø> (ø)
application-templates-mortgage-certificate 43.55% <ø> (ø)
application-templates-parental-leave 29.94% <ø> (ø)
application-types 6.62% <ø> (ø)
application-ui-components 1.27% <ø> (ø)
application-ui-shell 21.22% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
judicial-system-web 27.72% <0.00%> (-0.01%) ⬇️
web 1.79% <ø> (ø)

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

Files with missing lines Coverage Δ
...src/routes/Court/Indictments/Subpoena/Subpoena.tsx 0.00% <0.00%> (ø)

... and 2 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 2c50ca6...1ed8597. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 29, 2024

Datadog Report

All test runs 537fedf 🔗

22 Total Test Services: 0 Failed, 21 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.01%), 92 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-web 0 0 0 2 0 7.99s 1 no change Link
api 0 0 0 4 0 2.3s 1 no change Link
application-api-files 0 0 0 12 0 5.4s 1 no change Link
application-core 0 0 0 92 0 14.4s 1 no change Link
application-system-api 0 0 0 120 2 3m 8.63s 1 no change Link
application-template-api-modules 0 0 0 123 0 2m 2.23s 1 no change Link
application-templates-accident-notification 0 0 0 148 0 15.16s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 11.91s 1 no change Link
application-templates-driving-license 0 0 0 13 0 13.28s 1 no change Link
application-templates-example-payment 0 0 0 2 0 10.56s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • judicial-system-web - jest 32.01% (-0.01%) - Details

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.

Some changes suggested.

@oddsson oddsson requested a review from gudjong October 29, 2024 13:55
@oddsson oddsson added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Oct 29, 2024
@oddsson oddsson removed the request for review from gudjong October 29, 2024 14:12
@oddsson oddsson added the high priority VIP-Kodiak PR label Oct 29, 2024
@kodiakhq kodiakhq bot merged commit 701c1e8 into main Oct 29, 2024
88 checks passed
@kodiakhq kodiakhq bot deleted the j-s/prevent-double-subpoena branch October 29, 2024 15:03
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 high priority VIP-Kodiak PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants