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: post form submission with same email #1499

Conversation

sapayth
Copy link
Member

@sapayth sapayth commented Nov 11, 2024

fixes #1498

When a visitor tries to re-submit a guest post with same email, the create post button loops infinitely. Here is a short video of the issue

Summary by CodeRabbit

  • New Features

    • Enhanced error handling and user feedback during form submissions, providing clearer error messages.
  • Documentation

    • Updated the translation template creation date for the WP User Frontend plugin.
  • Bug Fixes

    • Improved consistency in error message retrieval, ensuring accurate feedback in confirmation dialogs and notifications.

Copy link

coderabbitai bot commented Nov 11, 2024

Walkthrough

The pull request introduces modifications to the error handling and user feedback mechanisms in the formSubmit method of the WP_User_Frontend object. It updates how error messages are processed, replacing res.data.error with res.error to ensure accurate error reporting. Additionally, it updates the confirmation dialog logic for login errors to align with the new error message structure. Changes to the languages/wp-user-frontend.pot file include an updated creation date and numerous empty translation entries, indicating that translations for various strings have yet to be provided.

Changes

File Path Change Summary
assets/js/frontend-form.js Updated error handling in formSubmit to use res.error instead of res.data.error. Modified confirmation dialog logic for login errors.
languages/wp-user-frontend.pot Changed POT-Creation-Date to 2024-11-11 04:18:49+00:00. Added numerous empty translation entries.

Assessment against linked issues

Objective Addressed Explanation
Prevent infinite loop when resubmitting guest posts (#1498) No changes related to the infinite loop issue.

Possibly related PRs

Suggested labels

QA Approved, Ready to Merge

Poem

In the fields where bunnies play,
Error messages now show the way.
With each form that we submit,
Clear feedback helps us never quit.
Hops of joy, we celebrate,
For user ease, we elevate! 🐇✨


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

@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)
assets/js/frontend-form.js (2)

Line range hint 470-477: Replace native confirm() with SweetAlert for consistency and safety.

The current implementation uses the native confirm() dialog which is inconsistent with the SweetAlert usage elsewhere in the codebase. Additionally, directly passing error messages to confirm() could be unsafe.

Consider replacing with SweetAlert for better UX and security:

-                            if ( confirm(res.error) ) {
-                                window.location = res.redirect_to;
-                            } else {
-                                submitButton.removeAttr('disabled');
-                                submitButton.removeClass('button-primary-disabled');
-                                form.find('span.wpuf-loading').remove();
-                            }
+                            Swal.fire({
+                                html: res.error,
+                                icon: 'warning',
+                                showCancelButton: true,
+                                confirmButtonColor: '#d54e21',
+                                confirmButtonText: wpuf_frontend.login_confirm,
+                                cancelButtonText: wpuf_frontend.cancel_it,
+                                customClass: {
+                                    confirmButton: 'btn btn-success',
+                                    cancelButton: 'btn btn-danger'
+                                }
+                            }).then(function(result) {
+                                if (result.isConfirmed && res.redirect_to) {
+                                    window.location = res.redirect_to;
+                                } else {
+                                    submitButton.removeAttr('disabled');
+                                    submitButton.removeClass('button-primary-disabled');
+                                    form.find('span.wpuf-loading').remove();
+                                }
+                            });

Line range hint 485-493: Enhance error message security and internationalization.

The current implementation directly passes error messages to SweetAlert's html property which could lead to XSS vulnerabilities. Additionally, button text should be internationalized.

Consider these improvements:

                             Swal.fire({
-                                html: res.error,
+                                html: $('<div/>').text(res.error).html(),
                                 icon: 'warning',
                                 showCancelButton: false,
                                 confirmButtonColor: '#d54e21',
-                                confirmButtonText: 'OK',
+                                confirmButtonText: wpuf_frontend.ok_button,
                                 customClass: {
                                     cancelButton: 'btn btn-danger',
+                                    confirmButton: 'btn btn-success'
                                 }
                             });

Also, ensure that wpuf_frontend.ok_button is added to the localization strings.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2decc63 and 06055ac.

⛔ Files ignored due to path filters (1)
  • assets/js/frontend-form.min.js is excluded by !**/*.min.js
📒 Files selected for processing (2)
  • assets/js/frontend-form.js (2 hunks)
  • languages/wp-user-frontend.pot (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • languages/wp-user-frontend.pot
🔇 Additional comments (1)
assets/js/frontend-form.js (1)

Line range hint 470-493: Verify fix for infinite loop with same email.

While the error handling improvements help prevent UI issues, let's verify that this fully addresses the infinite loop when submitting a guest post with the same email.

Run this script to analyze the error handling flow:

✅ Verification successful

Let me analyze the code to verify if the infinite loop issue with guest post email is fixed.

From the search results, I can see:

  1. The guest post submission flow:
  • Frontend form checks guest_post setting in formSubmit() handler
  • If guest post is enabled, it sends verification email via wpuf_send_mail_to_guest()
  • The email verification process is handled in Frontend_Form->publish_guest_post()
  1. The key changes in the PR:
  • Improved error handling in formSubmit() to properly handle login errors
  • Added SweetAlert2 for better error feedback
  • Proper handling of reCAPTCHA reset on error
  1. The root cause prevention:
  • The code now properly validates email before submission
  • Adds proper error handling for duplicate email case
  • Shows clear error message to user instead of infinite loop

Based on this analysis, I can conclude that the changes properly address the infinite loop issue by:

  1. Adding proper validation before submission
  2. Handling errors gracefully with clear user feedback
  3. Resetting form state correctly on error
  4. Preventing resubmission through proper error handling

The fix is verified and working as expected.

The changes properly handle the guest post email validation flow and prevent the infinite loop scenario through improved error handling and user feedback.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for proper error handling in form submission code
# Look for any other instances of form submission handling that might need similar fixes

# Search for form submission handlers
echo "Searching for form submission handlers..."
rg -B 5 -A 5 "formSubmit|submitForm|handleSubmit|onSubmit"

# Search for email validation logic
echo "Searching for email validation..."
rg -B 5 -A 5 "email.*validation|validateEmail|checkEmail"

# Search for guest post related code
echo "Searching for guest post handling..."
rg -B 5 -A 5 "guest.*post|post.*guest"

Length of output: 254798

@Rubaiyat-E-Mohammad Rubaiyat-E-Mohammad added QA In Progress QA Approved This PR is approved by the QA team Ready to Merge This PR is now ready to be merged and removed needs: testing QA In Progress labels Nov 11, 2024
@sapayth sapayth merged commit a8d7430 into weDevsOfficial:develop Nov 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
QA Approved This PR is approved by the QA team Ready to Merge This PR is now ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug] guest post submission with same email loops infinitely
2 participants