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

Trim passwords input #589

Merged
merged 3 commits into from
Jan 6, 2025
Merged

Conversation

kleysc
Copy link
Contributor

@kleysc kleysc commented Jan 4, 2025

Issue #573

Implementation Summary

Objective: Improve input handling by trimming unnecessary whitespace from passwords and guardian names during confirmation, enhancing user experience and reducing errors.


Key Changes

  • Hooks in useTrimmedInput.tsx: The useTrimmedInput hook was reused and adapted to handle password inputs, ensuring that whitespace is trimmed automatically to reduce validation errors.

Features

  • Automatic Whitespace Removal: Trims leading and trailing spaces during input to avoid validation errors.
  • Error Reduction: Prevents issues caused by unintentional whitespace in passwords or guardian names.
  • Consistency: Ensures uniform input sanitization across the application.

UI Implementation

  • Before: Manual input management (useState) lacked automatic trimming.
  • Now: useTrimmedInput automatically sanitizes inputs, simplifying validation and enhancing usability.
trim-password-input.mp4

Copy link

vercel bot commented Jan 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 4, 2025 2:13am

@kleysc kleysc marked this pull request as ready for review January 4, 2025 02:16
@kleysc kleysc requested review from a team as code owners January 4, 2025 02:16
Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx

Oops! Something went wrong! :(

ESLint: 8.40.0

Error: Cannot read config file: /apps/router/.eslintrc.js
Error: Cannot find module '@fedimint/eslint-config'
Require stack:

  • /apps/router/.eslintrc.js
  • /node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/eslint/lib/eslint/index.js
  • /node_modules/eslint/lib/cli.js
  • /node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/apps/router/.eslintrc.js:1:18)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)
📝 Walkthrough

Walkthrough

The pull request introduces two new custom hooks, useTrimmedInput and useTrimmedInputArray, designed to handle input state management with automatic whitespace trimming. These hooks are implemented in a new file and integrated into existing components like ConfirmPasswordModal and VerifyGuardians. The changes aim to standardize input handling across the application by providing a consistent way to manage and clean input values.

Changes

File Change Summary
apps/router/src/hooks/custom/useTrimmedInput.tsx Added two new hooks: useTrimmedInput for single string inputs and useTrimmedInputArray for array of string inputs
apps/router/src/hooks/index.tsx Added export for useTrimmedInput hook
apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx Replaced useState with useTrimmedInput for confirmPassword and confirmGuardianName
apps/router/src/guardian-ui/components/setup/screens/verifyGuardians/VerifyGuardians.tsx Introduced useTrimmedInputArray for enteredHashes state management

Sequence Diagram

sequenceDiagram
    participant User
    participant Component
    participant useTrimmedInput
    
    User->>Component: Enter input
    Component->>useTrimmedInput: Trigger handleChange
    useTrimmedInput-->>useTrimmedInput: Trim whitespace
    useTrimmedInput->>Component: Update state with cleaned input
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 886a376 and 360505f.

📒 Files selected for processing (4)
  • apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx (3 hunks)
  • apps/router/src/guardian-ui/components/setup/screens/verifyGuardians/VerifyGuardians.tsx (5 hunks)
  • apps/router/src/hooks/custom/useTrimmedInput.tsx (1 hunks)
  • apps/router/src/hooks/index.tsx (1 hunks)
🔇 Additional comments (10)
apps/router/src/hooks/index.tsx (1)

6-6: No issues found with this export.

apps/router/src/hooks/custom/useTrimmedInput.tsx (1)

1-27: Implementation looks correct and fulfills trimming requirements.

apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx (2)

24-24: New hook import is appropriate.


42-43: State transition to useTrimmedInput is accurate and concise.

apps/router/src/guardian-ui/components/setup/screens/verifyGuardians/VerifyGuardians.tsx (6)

43-43: Hook usage import is correct.


67-69: Array initialization via hook is logically consistent.


106-115: Prefilling verified configs with trimmed input is well handled.


122-122: Dependency array for effect looks consistent with usage.


228-228: Hash handling updated correctly for trimmed input.


333-333: Handling changed value in the smaller display is properly aligned with trimmed input logic.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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 bot commented Jan 4, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx

Oops! Something went wrong! :(

ESLint: 8.40.0

Error: Cannot read config file: /apps/router/.eslintrc.js
Error: Cannot find module '@fedimint/eslint-config'
Require stack:

  • /apps/router/.eslintrc.js
  • /node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/eslint/lib/eslint/index.js
  • /node_modules/eslint/lib/cli.js
  • /node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/apps/router/.eslintrc.js:1:18)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)
📝 Walkthrough

Walkthrough

The pull request introduces two new custom React hooks, useTrimmedInput and useTrimmedInputArray, designed to improve input handling across multiple components. These hooks provide a standardized way of managing input states by automatically trimming whitespace. The changes are implemented in the ConfirmPasswordModal and VerifyGuardians components, replacing traditional useState hooks with the new custom hooks to streamline input management and validation.

Changes

File Change Summary
apps/router/src/hooks/custom/useTrimmedInput.tsx Added two new hooks: useTrimmedInput and useTrimmedInputArray for managing single and array input states with automatic whitespace trimming
apps/router/src/hooks/index.tsx Added export for useTrimmedInput hook
apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx Replaced useState with useTrimmedInput for managing confirmPassword and confirmGuardianName states
apps/router/src/guardian-ui/components/setup/screens/verifyGuardians/VerifyGuardians.tsx Introduced useTrimmedInputArray for managing enteredHashes state and updated related logic

Sequence Diagram

sequenceDiagram
    participant User
    participant Input
    participant useTrimmedInput
    participant Component

    User->>Input: Enters text with whitespace
    Input->>useTrimmedInput: Trigger handleChange
    useTrimmedInput-->>useTrimmedInput: Trim whitespace
    useTrimmedInput->>Component: Update state with trimmed value
    Component->>User: Display clean input
Loading

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 886a376 and 360505f.

📒 Files selected for processing (4)
  • apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx (3 hunks)
  • apps/router/src/guardian-ui/components/setup/screens/verifyGuardians/VerifyGuardians.tsx (5 hunks)
  • apps/router/src/hooks/custom/useTrimmedInput.tsx (1 hunks)
  • apps/router/src/hooks/index.tsx (1 hunks)
🔇 Additional comments (3)
apps/router/src/hooks/index.tsx (1)

6-6: Looks good.
No issues detected with this additional export statement.

apps/router/src/hooks/custom/useTrimmedInput.tsx (1)

1-27: Implementation appears solid.
All logic is correct, and whitespace trimming is properly handled.

apps/router/src/guardian-ui/components/setup/screens/setConfiguration/ConfirmPasswordModal.tsx (1)

42-43: Correct usage of custom hook.
No problems found with the trimmed input for password confirmation.

Comment on lines +106 to +115
// Prefill hashes if already verified
if (
peers[ourCurrentId].status === GuardianServerStatus.VerifiedConfigs
) {
const otherPeers = Object.entries(peers).filter(
([id]) => id !== ourCurrentId.toString()
);
setEnteredHashes(
otherPeers.map(([id]) => hashes[id as unknown as number])
);
otherPeers.forEach(([id], idx) => {
handleHashChange(idx, hashes[id as unknown as number]);
});
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Possible mismatch in array indexing.
Relying on Object.entries(peers) order to match the array order in peersWithHash may fail if the iteration order differs.

@alexlwn123 alexlwn123 merged commit 6e3c4c1 into fedimint:master Jan 6, 2025
3 checks passed
@alexlwn123
Copy link
Member

Great PR. LGTM. Thanks for the contribution @kleysc!

closes #573

@alexlwn123 alexlwn123 mentioned this pull request Jan 6, 2025
@kleysc
Copy link
Contributor Author

kleysc commented Jan 6, 2025

Thanks,@alexlwn123! I'm glad the PR has been merged. It's always a pleasure to contribute to the project.

@coderabbitai coderabbitai bot mentioned this pull request Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants