fix: auto-clear captcha input on wrong entry

[SanjayUG]

Pull Request description

fix: auto-clear captcha input on wrong entry

Automatically clears the captcha text input field when the user enters an incorrect value, improving UX by eliminating manual clearing.

Which issue this PR aims to resolve or fix?

Solve #187

How to test these changes

• Enter an incorrect captcha value
• Verify that the captcha text input field is automatically cleared

Pull Request checklists

This PR is a:

• bug-fix
• new feature
• maintenance

About this PR:

• it includes tests.
• the tests are executed on CI.
• the tests generate log file(s) (path).
• pre-commit hooks were executed locally.
• this PR requires a project documentation update.

Author's checklist:

• I have reviewed the changes and it contains no misspelling.
• The code is well commented, especially in the parts that contain more
  complexity.
• New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved.

Summary by CodeRabbit

• Bug Fixes
  • Corrected the captcha error message for clearer, more accurate feedback.
  • Enhanced captcha input handling so that the field now resets appropriately after a failed attempt, improving user experience.

[coderabbitai]

Walkthrough

The changes update the captcha_control function in src/common/captcha_.py. The text input now includes a key="captcha_input", which enhances session state management. The error message for incorrect captcha input has been corrected, and upon failure, the approach now clears the captcha input field (by setting it to an empty string) instead of deleting the "controllo" session state key. No public entity declarations were altered.

Changes

File	Changes Made
src/common/captcha_.py	Updated the captcha_control function to include key="captcha_input" in the text input, corrected the typo in the error message ("Captch is wrong" → "Captcha is wrong"), and modified the failure logic to clear the captcha input field instead of deleting the "controllo" session state entry.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as captcha_control
    participant S as Session State
    U->>C: Enter captcha value
    C->>S: Capture input with key "captcha_input"
    alt Captcha Valid
        C-->>U: Proceed with verification
    else Captcha Invalid
        C->>S: Set "captcha_input" to ""
        C-->>U: Display error "🚨 Captcha is wrong"
    end

Loading

Poem

I'm a joyful bunny on a coding spree,
Hoping my tweaks set the errors free.
With a key in place and messages clear,
The captcha dance brings a cheer.
Code hops lightly, error woes out of sight! 🐰✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 2d8323c and dc652bb.

📒 Files selected for processing (1)

• src/common/captcha_.py (2 hunks)

🔇 Additional comments (3)

src/common/captcha_.py (3)

237-237: Well-structured use of session state key for input field tracking.

Adding a named key to the text input widget is a good practice in Streamlit as it allows direct access to this specific widget's value in the session state. This is essential for the implementation of auto-clearing functionality.

---

249-249: Fixed typo in error message.

Correcting "Captch" to "Captcha" in the error message improves the user experience by presenting a properly spelled notification.

---

251-251: Successfully implemented auto-clearing of captcha input.

This change directly addresses the PR objective by automatically clearing the captcha input field when an incorrect value is entered. The implementation uses Streamlit's session state management correctly and provides a better user experience by eliminating the need for manual field clearing.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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.

[jcharkow]

Closing as this addresses the same issue as #189