Feat/paypal library upgrade #1578

arifulhoque7 · 2025-05-29T06:27:03Z

Description :

Fix redirected too many time issues in browser
-Settings updated for paypal (user experience update)

Summary by CodeRabbit

Chores
- Updated code quality configuration to include files in all "lib" directories for scanning.
New Features
- Multi-select fields for taxonomy exclusion now dynamically populate options and update reactively.
- Form builder default categories initialize on page load and on post type changes, improving taxonomy field handling.
- Added warning notice for users with plain permalink settings to prevent REST API issues.
- Subscription management improved with dynamic REST API URL usage for better compatibility.
- Admin subscription scripts now access REST API URL dynamically.
Bug Fixes
- Fixed JavaScript syntax error in subscription script.
- Corrected SQL query preparation in subscription-related classes.
UI Improvements
- Added yellow/amber color utility classes for admin styling.
- Subscription dashboard UI enhanced with expandable remaining posts list and clearer subscription details.
- "Upgrade to Pro" button styling improved for consistent interactive states.
Documentation
- Updated screenshots and feature highlights in README files to reflect new and revised features.

coderabbitai · 2025-05-29T06:27:09Z

Walkthrough

The exclusion of the */lib/* directory from PHP CodeSniffer scans in the phpcs.xml.dist configuration file has been commented out. As a result, files within any lib directory are now included in code quality checks.

Changes

Files	Change Summary
phpcs.xml.dist	Commented out the exclusion of `/lib/` from CodeSniffer scan scope.
admin/form-builder/assets/js/components/field-multiselect/index.js, assets/js/wpuf-form-builder-components.js	Added computed property `dynamic_options` to dynamically generate taxonomy options; added watcher to re-bind Selectize on changes; modified `bind_selectize` to destroy existing Selectize instance before reinitializing.
admin/form-builder/assets/js/components/field-multiselect/template.php, assets/js-templates/form-components.php	Changed multiselect `<option>` iteration source from static `option_field.options` to dynamic `dynamic_options`.
admin/form-builder/assets/js/form-builder.js, assets/js/wpuf-form-builder.js	Refactored `populate_default_categories` to initialize on page load and change events; generalized taxonomy field handling and Selectize initialization.
assets/css/admin/form-builder.css	Removed `.wpuf-my-4` margin class; added new yellow/amber color utility classes for borders, backgrounds, hover, and focus states.
assets/js/components/FormsList.vue	Added reactive constants for permalink type and settings URL; updated REST API URL construction; added warning UI for plain permalinks.
assets/js/components/subscriptions/SectionInputField.vue	Updated "Upgrade to Pro" button styles; replaced static numeric input attributes with dynamic bindings from field properties.
assets/js/components/subscriptions/SubscriptionBox.vue	Updated REST API URL construction for fetching subscribers to use dynamic base URL.
assets/js/stores/subscription.js	Updated all REST API endpoint URLs to use dynamic REST API root URL from localized data, replacing hardcoded paths.
assets/js/subscriptions-old.js	Fixed syntax error by adding missing comma after function declaration in subscription object.
includes/Admin/Admin_Subscription.php	Added localized REST API URL to admin scripts; removed `'number_of_global_styles'` subscription field from settings.
includes/Admin/Menu.php	Added permalink info (`is_plain_permalink` and `permalink_settings_url`) to localized script data for forms list page.
includes/Admin/Subscription.php	Updated `subs_redirect_pram` method signature and logic to accept 2 params; fixed SQL prepare calls; improved nonce validation; refined conditional logic and output formatting.
includes/Ajax/Admin_Form_Builder_Ajax.php	Enhanced `get_post_taxonomies` to preserve and reflect existing default taxonomy selections with dynamic multiple-select elements.
includes/Frontend/Payment.php	Removed hidden divs with subscription pack info from payment form output.
includes/User_Subscription.php	Added strict types declaration; refined expiration and recurring subscription logic; improved error formatting and condition checks.
languages/wp-user-frontend.pot	Updated POT file metadata and source reference line numbers without changing translation strings.
readme.md	Updated screenshots section with revised and reordered feature highlights, adding new features and consolidating entries.
readme.txt	Updated screenshots section to align with readme.md changes, streamlining and rephrasing feature list.
templates/dashboard/subscription.php	Added functions to modularize subscription data retrieval and display; improved UI for remaining posts with toggle; unified recurring subscription display and cancellation handling.

Possibly related PRs

fix: custom taxonomies are not selectable in post form #1577: Introduces dynamic taxonomy options and Selectize re-binding in the field-multiselect Vue component, closely related to this PR's enhancements in the same component.
fix: subscription feature remaining bugs #1560: Modularizes subscription data display and adds UI improvements in the subscription dashboard template, directly related to this PR's dashboard subscription template changes.
fix: payment gateway expire field data #1567: Refines subscription expiration logic and handling of special expiration values in includes/User_Subscription.php, closely connected to this PR's subscription class updates.

Suggested labels

QA Approved, needs: developer feedback

Suggested reviewers

sapayth

Poem

🐇 Hopping through the code with flair,
Now lib is scanned with care!
Dynamic options bloom and grow,
Selectize refreshed to show.
Yellow hues and toggles bright,
Subscriptions shine in dashboard light.
CodeRabbit cheers, the changes flow! ✨🐰

✨ 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

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

coderabbitai

Actionable comments posted: 2

🔭 Outside diff range comments (2)

includes/Admin/Subscription.php (2)
62-72: 🛠️ Refactor suggestion

⚠️ Potential issue

Good SQL fix with unused variable.

The SQL query fix correctly separates prepare() from get_row(). However, the $sql variable defined on line 62 is never used and should be removed.

Remove the unused variable:
-$sql = $wpdb->prepare(
-    'SELECT transaction_id FROM ' . $wpdb->prefix . 'wpuf_transaction
-    WHERE user_id = %d AND pack_id = %d LIMIT 1', $user_id, $pack_id
-);
 $result = $wpdb->get_row(
     $wpdb->prepare(
         'SELECT transaction_id FROM ' . $wpdb->prefix . 'wpuf_transaction
     WHERE user_id = %d AND pack_id = %d LIMIT 1', $user_id, $pack_id
     )
 );
759-772: 🛠️ Refactor suggestion

⚠️ Potential issue

Consistent SQL fix needed.

Good fix for the nested prepare issue, but like the previous SQL fix, the unused $sql variable should be removed.

Apply the same cleanup:
-$sql = $wpdb->prepare(
-    "SELECT p.ID, p.post_status
-    FROM $wpdb->posts p, $wpdb->postmeta m
-    WHERE p.ID = m.post_id AND p.post_status <> 'publish' AND m.meta_key = '_wpuf_order_id' AND m.meta_value = %s", $order_id
-);
-
 return $wpdb->get_row(
     $wpdb->prepare(
         "SELECT p.ID, p.post_status
     FROM $wpdb->posts p, $wpdb->postmeta m
     WHERE p.ID = m.post_id AND p.post_status <> 'publish' AND m.meta_key = '_wpuf_order_id' AND m.meta_value = %s", $order_id
     )
 );

🧹 Nitpick comments (7)

admin/form-builder/assets/js/components/field-multiselect/index.js (2)
27-61: Excellent dynamic options implementation with room for modernization.

The new dynamic_options computed property effectively generates taxonomy-specific options. However, the code can be modernized for better safety and readability.

Apply these improvements for modern JavaScript best practices:
        // Dynamic options for taxonomy fields
        dynamic_options: function () {
            // Check if this is a Selection Terms field for a taxonomy
-            if (this.option_field.name === 'exclude' && 
-                this.editing_form_field && 
-                this.editing_form_field.input_type === 'taxonomy' &&
-                this.editing_form_field.name) {
+            if (this.option_field.name === 'exclude' && 
+                this.editing_form_field?.input_type === 'taxonomy' &&
+                this.editing_form_field?.name) {
                
                var taxonomy_name = this.editing_form_field.name;
                
                // Look for terms in the wp_post_types data
-                if (wpuf_form_builder && wpuf_form_builder.wp_post_types) {
+                if (wpuf_form_builder?.wp_post_types) {
                    for (var post_type in wpuf_form_builder.wp_post_types) {
                        var taxonomies = wpuf_form_builder.wp_post_types[post_type];
                        
-                        if (taxonomies && taxonomies.hasOwnProperty(taxonomy_name)) {
+                        if (taxonomies && Object.hasOwn(taxonomies, taxonomy_name)) {
                            var tax_field = taxonomies[taxonomy_name];
                            
-                            if (tax_field && tax_field.terms && tax_field.terms.length > 0) {
+                            if (tax_field?.terms?.length > 0) {
                                var options = {};
                                tax_field.terms.forEach(function(term) {
-                                    if (term && term.term_id && term.name) {
+                                    if (term?.term_id && term?.name) {
                                        options[term.term_id] = term.name;
                                    }
                                });
                                return options;
                            }
                        }
                    }
                }
            }
            
            // Return original options if not a taxonomy field or no dynamic options found
            return this.option_field.options || {};
        }
🧰 Tools

🪛 Biome (1.9.4)

[error] 38-38: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

[error] 42-42: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

[error] 42-42: Do not access Object.prototype method 'hasOwnProperty' from target object.

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

(lint/suspicious/noPrototypeBuiltins)

[error] 45-45: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

[error] 48-48: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

81-89: Excellent selectize management with minor improvement opportunity.

The logic to destroy existing selectize instances prevents memory leaks and duplicate bindings. The implementation can be slightly modernized.

Apply this minor improvement using optional chaining:
            // Destroy existing selectize if it exists
            var $select = $(this.$el).find('.term-list-selector');
-            if ($select[0] && $select[0].selectize) {
+            if ($select[0]?.selectize) {
                $select[0].selectize.destroy();
            }
🧰 Tools

🪛 Biome (1.9.4)

[error] 83-83: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)
assets/js/wpuf-form-builder-components.js (1)
446-480: Approve the dynamic options implementation with minor suggestions.

The implementation correctly handles dynamic population of taxonomy terms. However, consider these improvements:

Use optional chaining as suggested by static analysis to make the code more concise and safer

Use Object.hasOwn() instead of hasOwnProperty for better security

Apply this diff to improve the code:
-            if (this.option_field.name === 'exclude' && 
-                this.editing_form_field && 
-                this.editing_form_field.input_type === 'taxonomy' &&
-                this.editing_form_field.name) {
+            if (this.option_field.name === 'exclude' && 
+                this.editing_form_field?.input_type === 'taxonomy' &&
+                this.editing_form_field?.name) {
                
                var taxonomy_name = this.editing_form_field.name;
                
                // Look for terms in the wp_post_types data
-                if (wpuf_form_builder && wpuf_form_builder.wp_post_types) {
+                if (wpuf_form_builder?.wp_post_types) {
                    for (var post_type in wpuf_form_builder.wp_post_types) {
                        var taxonomies = wpuf_form_builder.wp_post_types[post_type];
                        
-                        if (taxonomies && taxonomies.hasOwnProperty(taxonomy_name)) {
+                        if (taxonomies && Object.hasOwn(taxonomies, taxonomy_name)) {
                            var tax_field = taxonomies[taxonomy_name];
                            
-                            if (tax_field && tax_field.terms && tax_field.terms.length > 0) {
+                            if (tax_field?.terms?.length > 0) {
                                var options = {};
                                tax_field.terms.forEach(function(term) {
-                                    if (term && term.term_id && term.name) {
+                                    if (term?.term_id && term?.name) {
                                        options[term.term_id] = term.name;
                                    }
                                });
🧰 Tools

🪛 Biome (1.9.4)

[error] 457-457: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

[error] 461-461: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

[error] 461-461: Do not access Object.prototype method 'hasOwnProperty' from target object.

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

(lint/suspicious/noPrototypeBuiltins)

[error] 464-464: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

[error] 467-467: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)
templates/dashboard/subscription.php (2)
14-70: Well-structured subscription data retrieval with proper security measures.

The function correctly uses $wpdb->prepare() for SQL queries, preventing SQL injection. The queries are well-formatted and the return structure is clear. However, consider adding type declarations for better code documentation.

Consider adding return type declaration for PHP 7+:
-    function wpuf_dashboard_get_subscription_data( $user_sub ) {
+    function wpuf_dashboard_get_subscription_data( array $user_sub ) : array {
241-258: Consider extracting inline JavaScript to improve maintainability.

While the show more/less functionality works correctly, inline JavaScript can be harder to maintain and test. Consider moving this to an external JavaScript file or at least wrapping it in a more structured approach.

Consider creating a reusable JavaScript component:
// In an external JS file
wpuf.subscriptionToggle = {
    init: function(toggleId, hiddenClass) {
        var btn = document.getElementById(toggleId);
        if (!btn) return;
        
        var hidden = document.querySelectorAll('.' + hiddenClass);
        var expanded = false;
        
        btn.addEventListener('click', function() {
            expanded = !expanded;
            hidden.forEach(function(el) {
                el.style.display = expanded ? 'block' : 'none';
            });
            btn.textContent = expanded ? btn.dataset.showLess : btn.dataset.showMore;
        });
        
        // Initially hide elements
        hidden.forEach(function(el) { el.style.display = 'none'; });
    }
};
Then in the template:
<button type="button" id="wpuf-remaining-posts-toggle" class="btn btn-link" 
        style="padding:0;" 
        data-show-more="<?php echo esc_attr__( 'Show More', 'wp-user-frontend' ); ?>"
        data-show-less="<?php echo esc_attr__( 'Show Less', 'wp-user-frontend' ); ?>">
    <?php esc_html_e( 'Show More', 'wp-user-frontend' ); ?>
</button>
<script>
wpuf.subscriptionToggle.init('wpuf-remaining-posts-toggle', 'wpuf-remaining-post-hidden');
</script>
admin/form-builder/assets/js/form-builder.js (1)
1128-1174: Excellent refactoring with one minor issue.

The refactoring significantly improves the robustness of the taxonomy field handling:

✅ Guard clause prevents unnecessary AJAX calls

✅ More reliable DOM manipulation

✅ Better error handling

✅ Proper selectize initialization

However, the isInitialLoad parameter is never used within the function. Consider either utilizing it for different behavior between initial load and updates, or removing it if not needed.

If the isInitialLoad parameter is truly not needed, consider simplifying:
-function populate_default_categories(obj, isInitialLoad) {
+function populate_default_categories(obj) {
And update the calling code accordingly:
-populate_default_categories($postTypeSelect[0], true);
+populate_default_categories($postTypeSelect[0]);
-populate_default_categories(this, false);
+populate_default_categories(this);
includes/Admin/Subscription.php (1)
401-403: Remove or document commented code.

The commented validation check should either be removed if no longer needed, or include a comment explaining why it's disabled.

Either remove the commented code or add explanation:
-//        if ( ! isset( $post_data['billing_amount'] ) ) {
-//            return;
-//        }
+// TODO: Billing amount validation removed as it's now optional - see issue #XXX

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5ac7551 and f9e8a23.

⛔ Files ignored due to path filters (4)

assets/js/forms-list.min.js is excluded by !**/*.min.js
assets/js/forms-list.min.js.map is excluded by !**/*.map, !**/*.min.js.map
assets/js/subscriptions.min.js is excluded by !**/*.min.js
assets/js/subscriptions.min.js.map is excluded by !**/*.map, !**/*.min.js.map

📒 Files selected for processing (23)

admin/form-builder/assets/js/components/field-multiselect/index.js (1 hunks)
admin/form-builder/assets/js/components/field-multiselect/template.php (1 hunks)
admin/form-builder/assets/js/form-builder.js (1 hunks)
assets/css/admin/form-builder.css (4 hunks)
assets/js-templates/form-components.php (1 hunks)
assets/js/components/FormsList.vue (3 hunks)
assets/js/components/subscriptions/SectionInputField.vue (3 hunks)
assets/js/components/subscriptions/SubscriptionBox.vue (1 hunks)
assets/js/stores/subscription.js (5 hunks)
assets/js/subscriptions-old.js (1 hunks)
assets/js/wpuf-form-builder-components.js (1 hunks)
assets/js/wpuf-form-builder.js (1 hunks)
class/subscription.php (9 hunks)
includes/Admin/Admin_Subscription.php (1 hunks)
includes/Admin/Menu.php (1 hunks)
includes/Admin/Subscription.php (10 hunks)
includes/Ajax/Admin_Form_Builder_Ajax.php (2 hunks)
includes/Frontend/Payment.php (0 hunks)
includes/User_Subscription.php (6 hunks)
languages/wp-user-frontend.pot (12 hunks)
readme.md (1 hunks)
readme.txt (1 hunks)
templates/dashboard/subscription.php (2 hunks)

💤 Files with no reviewable changes (1)

includes/Frontend/Payment.php

✅ Files skipped from review due to trivial changes (3)

readme.md
languages/wp-user-frontend.pot
readme.txt

🧰 Additional context used

🧬 Code Graph Analysis (1)

includes/Admin/Subscription.php (4)

class/subscription.php (1)

subs_redirect_pram (134-169)

includes/User_Subscription.php (1)

current_pack (53-73)

wpuf-functions.php (2)

wpuf_is_checkbox_or_toggle_on (5457-5459)

wpuf_get_user (3361-3367)

includes/WPUF_User.php (1)

post_locked (52-54)

🪛 Biome (1.9.4)

admin/form-builder/assets/js/components/field-multiselect/index.js

[error] 38-38: Change to an optional chain.

Unsafe fix: Change to an optional chain.