Fix turnstile does not properly reset on AJAX error

[Crabcyborg]

Fixes https://secure.helpscout.net/conversation/2854926075/223538

Pre-release
formidable-6.18.1b.zip

[coderabbitai]

Walkthrough

The pull request introduces functionality to reset Turnstile captcha fields when form submission errors occur. The code checks if a global turnstile object exists and, if so, iterates through all elements with the cf-turnstile class to reset each corresponding Turnstile captcha using its data-rid attribute. No changes were made to exported or public entity declarations.

Changes

File	Change Summary
js/formidable.js	Added conditional logic to detect the global turnstile object and reset all Turnstile captcha fields (using their data-rid attributes) on form submission errors.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant F as Form Handler
    participant T as Global Turnstile
    participant C as Captcha Element

    U->>F: Submit form
    F->>F: Validate form
    alt Validation errors occur
        F->>T: Check if turnstile exists
        alt Turnstile exists
            loop For each .cf-turnstile element
                F->>C: Reset captcha using data-rid
            end
        else
            F->>F: Skip captcha reset
        end
    end

Loading

Possibly related PRs

• Only add Cloudflare Turnstile captcha for visible elements #1955: Modifies the rendering of Turnstile captchas based on element visibility; relates at a code level by handling Turnstile captcha functionality within the same file.

---

📜 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 78acf26 and c7663ab.

📒 Files selected for processing (1)

• js/formidable.js (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Cypress
• GitHub Check: Cypress

🔇 Additional comments (4)

js/formidable.js (4)

966-970: LGTM! The turnstile reset implementation looks good.

The code properly handles resetting turnstile captcha fields when form submission errors occur. It follows the same pattern as the existing grecaptcha and hcaptcha reset logic, and uses modern JavaScript features effectively.

---

2014-2016: LGTM! The turnstile initialization function is well-implemented.

The frmTurnstile() function properly reuses the shared frmCaptcha() function for initialization, following the same pattern as frmRecaptcha(). This ensures consistent behavior across different captcha types.

---

2045-2053: LGTM! The captcha selection logic is well-structured.

The getSelectedCaptcha() function properly handles selection between different captcha types (reCAPTCHA, Turnstile, and hCaptcha) with clear and concise logic.

---

966-970:

Details

❓ Verification inconclusive

Verify turnstile script loading and element setup.

Please ensure:

1. The turnstile script is properly loaded before this code runs.
2. All turnstile elements have the .cf-turnstile class and data-rid attribute.

Run the following script to check the turnstile setup:

---

🏁 Script executed:

#!/bin/bash
# Description: Check turnstile script loading and element setup.

# Check if turnstile script is included
rg -A 5 'turnstile.*\.js'

# Check turnstile element setup
ast-grep --pattern 'div[class="cf-turnstile"]'

Length of output: 509

---

Verify Turnstile Script & Markup Consistency

• The turnstile script is loaded from classes/models/fields/FrmFieldCaptcha.php as expected.
• Note that while the script confirms the inclusion of the Cloudflare Turnstile JS, the search for a <div> with the cf-turnstile class did not return results. This may indicate that turnstile elements are created using a different tag or rendered dynamically.
• Please double-check that your form templates (or dynamic rendering logic) produce elements with the exact .cf-turnstile class and a valid data-rid attribute so that the reset functionality in js/formidable.js works as intended.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• 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. (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.