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(j-s): Fix persistent error message #16228

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Conversation

oddsson
Copy link
Member

@oddsson oddsson commented Oct 1, 2024

Fix persistent error message

Asana

What

When inputting national id you have the option to select "person does not have an Icelandic national id". If you'd leave the national id without entering anything, an error appears saying that the input cannot be empty. If you'd then check the "person does not have an Icelandic national id" select box the error would not go away. This PR fixes that.

Why

This is not the expected behaveour.

Screenshots / Gifs

###Before

Screen.Recording.2024-10-01.at.22.06.44.mov

After

Screen.Recording.2024-10-01.at.22.05.54.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

  • Bug Fixes

    • Improved state management for the National ID input component by ensuring it updates correctly based on changes to both the input value and date of birth.
  • Documentation

    • Enhanced clarity of comments within the component to better describe its purpose and functionality.

@oddsson oddsson requested a review from a team as a code owner October 1, 2024 22:07
Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

Walkthrough

The InputNationalId component has been updated to include isDateOfBirth as an additional dependency in the useEffect hook. This modification allows the component to react appropriately to changes in both the value and isDateOfBirth props, enhancing its state management. The input validation logic on blur remains unchanged, ensuring consistent functionality while improving the component's responsiveness to prop updates.

Changes

File Path Change Summary
apps/judicial-system/web/src/components/Inputs/InputNationalId.tsx Added isDateOfBirth to the useEffect dependency array to improve state updates based on prop changes. Comments updated for clarity.

Possibly related PRs

Suggested labels

automerge


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

🧹 Outside diff range and nitpick comments (2)
apps/judicial-system/web/src/components/Inputs/InputNationalId.tsx (2)

80-80: Approved: Good improvement to useEffect dependencies

The addition of isDateOfBirth to the useEffect dependency array is a positive change. It ensures that the component properly resets its state when either the value or isDateOfBirth props change, which aligns with the PR objective of fixing persistent error messages.

For improved clarity, consider adding a comment explaining why both value and isDateOfBirth are necessary in the dependency array. This will help future maintainers understand the rationale behind this change. For example:

useEffect(() => {
  setErrorMessage(undefined)
  setInputValue(value ?? '')
  // Reset state when either the value or the input type (SSN/DOB) changes
}, [value, isDateOfBirth])

Line range hint 1-118: Overall feedback: Well-structured and aligned with objectives

The InputNationalId component is well-implemented, adhering to React and TypeScript best practices. It effectively handles both SSN and date of birth formats, uses proper input masking, and includes error handling and validation. The recent change to the useEffect hook improves the component's responsiveness to prop changes, which aligns well with the PR objective of fixing persistent error messages.

Consider extracting the validation logic into a separate custom hook for improved modularity and testability. This could look like:

const useNationalIdValidation = (value: string, isDateOfBirth: boolean, required: boolean) => {
  const [errorMessage, setErrorMessage] = useState<string>()

  const validateInput = useCallback((inputValue: string) => {
    const inputValidator = validate([
      [
        inputValue,
        isDateOfBirth ? ['date-of-birth'] : ['empty', 'national-id'],
      ],
    ])

    if (!required) {
      setErrorMessage(undefined)
      return true
    } else if (inputValidator.isValid) {
      setErrorMessage(undefined)
      return true
    } else {
      setErrorMessage(inputValidator.errorMessage)
      return false
    }
  }, [isDateOfBirth, required])

  return { errorMessage, validateInput }
}

This would simplify the main component and make the validation logic easier to test and maintain.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 148403d and 1e49ff4.

📒 Files selected for processing (1)
  • apps/judicial-system/web/src/components/Inputs/InputNationalId.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/judicial-system/web/src/components/Inputs/InputNationalId.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."

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 1, 2024

Datadog Report

Branch report: j-s/reset-error-message
Commit report: 8571452
Test service: judicial-system-web

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

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

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.75%. Comparing base (7b20920) to head (a65365f).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16228      +/-   ##
==========================================
- Coverage   36.92%   36.75%   -0.18%     
==========================================
  Files        6781     6785       +4     
  Lines      140014   139778     -236     
  Branches    39811    39747      -64     
==========================================
- Hits        51703    51371     -332     
- Misses      88311    88407      +96     
Flag Coverage Δ
judicial-system-web 28.11% <ø> (ø)

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

Files with missing lines Coverage Δ
...stem/web/src/components/Inputs/InputNationalId.tsx 3.22% <ø> (ø)

... and 67 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 7b20920...a65365f. Read the comment docs.

@kodiakhq kodiakhq bot merged commit cc25f4e into main Oct 3, 2024
30 checks passed
@kodiakhq kodiakhq bot deleted the j-s/reset-error-message branch October 3, 2024 14:55
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