Skip to content

Fix pro issue 1961#2003

Merged
Crabcyborg merged 2 commits into
masterfrom
pro_issue_1961
Oct 15, 2024
Merged

Fix pro issue 1961#2003
Crabcyborg merged 2 commits into
masterfrom
pro_issue_1961

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg commented Sep 20, 2024

Fixes https://github.com/Strategy11/formidable-pro/issues/5304

This includes a previous update #1961

Related comment #1961 (comment)

But fixes a bug I was seeing where invisible captchas would fail validation before the validation would happen before the invisible captchas has executed.

I also cleaned up the validateRecaptcha function a little. I didn't change any logic. I just have it return early when there are no captchas, and updated the code to use const more.

I tried testing this with v2 checkbox, invisible, and v3.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 20, 2024

Walkthrough

The changes in this pull request focus on enhancing the validation process for forms utilizing reCAPTCHA within the frmFrontFormJS function. A new conditional check determines whether to validate the reCAPTCHA based on its visibility, with validation executed only for visible reCAPTCHA elements. The validateRecaptcha function has been refactored for improved control flow, ensuring that invisible reCAPTCHA does not interfere with validation. Additionally, the submitFormManual function has been updated to incorporate this new validation logic.

Changes

Files Change Summary
js/formidable.js Enhanced frmFrontFormJS function with checks for invisible reCAPTCHA, refactored validateRecaptcha logic, and updated error handling in submitFormManual. Functions hasInvisibleRecaptcha and executeInvisibleRecaptcha added.

Possibly related PRs

Suggested reviewers

  • truongwp

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.

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
Copy Markdown
Contributor

@AbdiTolesa AbdiTolesa left a comment

Choose a reason for hiding this comment

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

This looks good to me, I found no issues with it.

@Crabcyborg
Copy link
Copy Markdown
Contributor Author

Thanks @AbdiTolesa!

🚀

@Crabcyborg Crabcyborg merged commit d2cba79 into master Oct 15, 2024
@Crabcyborg Crabcyborg deleted the pro_issue_1961 branch October 15, 2024 17:44
Copy link
Copy Markdown
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: 2

🧹 Outside diff range and nitpick comments (1)
js/formidable.js (1)

1632-1634: Remove unused classList parameter from submitFormNow call

The classList parameter is passed to frmFrontForm.submitFormNow, but it is not used in the function definition. Removing this parameter can prevent confusion and keep the code clean.

Apply this diff to remove the unused parameter:

-				frmFrontForm.submitFormNow( object, classList );
+				frmFrontForm.submitFormNow( object );
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 30ae2ca and 512b5b9.

📒 Files selected for processing (1)
  • js/formidable.js (3 hunks)
🧰 Additional context used
🔇 Additional comments (1)
js/formidable.js (1)

207-211: Appropriately skip validation for invisible reCAPTCHA

The modification ensures that validateRecaptcha is not called when an invisible reCAPTCHA is present. This aligns with the intended behavior, allowing invisible captchas to process after validation and preventing premature validation failures.

Comment thread js/formidable.js
Comment on lines +1622 to +1626
errors = frmFrontForm.validateFormSubmit( object );
if ( Object.keys( errors ).length !== 0 ) {
return;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Provide user feedback when validation fails

If frmFrontForm.validateFormSubmit( object ) returns errors, the function exits without informing the user. To enhance user experience, consider displaying validation errors so users understand why the submission did not proceed.

Would you like assistance in implementing user feedback for validation errors?

Comment thread js/formidable.js
Comment on lines +628 to +651
let response;

const $recaptcha = jQuery( form ).find( '.frm-g-recaptcha' );
if ( ! $recaptcha.length ) {
return errors;
}

if ( response.length === 0 ) {
fieldContainer = $recaptcha.closest( '.frm_form_field' );
fieldID = fieldContainer.attr( 'id' ).replace( 'frm_field_', '' ).replace( '_container', '' );
errors[ fieldID ] = '';
const recaptchaID = $recaptcha.data( 'rid' );

try {
response = grecaptcha.getResponse( recaptchaID );
} catch ( e ) {
if ( jQuery( form ).find( 'input[name="recaptcha_checked"]' ).length ) {
return errors;
}
response = '';
}

if ( response.length === 0 ) {
const fieldContainer = $recaptcha.closest( '.frm_form_field' );
const fieldID = fieldContainer.attr( 'id' ).replace( 'frm_field_', '' ).replace( '_container', '' );
errors[ fieldID ] = '';
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve error handling when retrieving reCAPTCHA response

While the try-catch block around grecaptcha.getResponse handles exceptions, consider checking if grecaptcha is defined before attempting to call getResponse. This can prevent unnecessary exceptions and improve the robustness of the code.

Apply this diff to check if grecaptcha is defined:

 try {
+    if ( typeof grecaptcha !== 'undefined' ) {
         response = grecaptcha.getResponse( recaptchaID );
+    } else {
+        response = '';
+    }
 } catch ( e ) {
     if ( jQuery( form ).find( 'input[name="recaptcha_checked"]' ).length ) {
         return errors;
     }
     response = '';
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
let response;
const $recaptcha = jQuery( form ).find( '.frm-g-recaptcha' );
if ( ! $recaptcha.length ) {
return errors;
}
if ( response.length === 0 ) {
fieldContainer = $recaptcha.closest( '.frm_form_field' );
fieldID = fieldContainer.attr( 'id' ).replace( 'frm_field_', '' ).replace( '_container', '' );
errors[ fieldID ] = '';
const recaptchaID = $recaptcha.data( 'rid' );
try {
response = grecaptcha.getResponse( recaptchaID );
} catch ( e ) {
if ( jQuery( form ).find( 'input[name="recaptcha_checked"]' ).length ) {
return errors;
}
response = '';
}
if ( response.length === 0 ) {
const fieldContainer = $recaptcha.closest( '.frm_form_field' );
const fieldID = fieldContainer.attr( 'id' ).replace( 'frm_field_', '' ).replace( '_container', '' );
errors[ fieldID ] = '';
}
let response;
const $recaptcha = jQuery( form ).find( '.frm-g-recaptcha' );
if ( ! $recaptcha.length ) {
return errors;
}
const recaptchaID = $recaptcha.data( 'rid' );
try {
if ( typeof grecaptcha !== 'undefined' ) {
response = grecaptcha.getResponse( recaptchaID );
} else {
response = '';
}
} catch ( e ) {
if ( jQuery( form ).find( 'input[name="recaptcha_checked"]' ).length ) {
return errors;
}
response = '';
}
if ( response.length === 0 ) {
const fieldContainer = $recaptcha.closest( '.frm_form_field' );
const fieldID = fieldContainer.attr( 'id' ).replace( 'frm_field_', '' ).replace( '_container', '' );
errors[ fieldID ] = '';
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants