Add Commission tests

[shashwatahalder01]

All Submissions:

• My code follow the WordPress' coding standards
• My code satisfies feature requirements
• My code is tested
• My code passes the PHPCS tests
• My code has proper inline documentation
• I've included related pull request(s) (optional)
• I've included developer documentation (optional)
• I've added proper labels to this pull request

Changes proposed in this Pull Request:

Related Pull Request(s)

• Full PR Link

Closes

• Closes #

How to test the changes in this Pull Request:

• Steps or issue link

Changelog entry

Title

Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

• Code is not following code style guidelines
• Bad naming: make sure you would understand your code if you read it a few months from now.
• KISS: Keep it simple, Sweetie (not stupid!).
• DRY: Don't Repeat Yourself.
• Code that is not readable: too many nested 'if's are a bad sign.
• Performance issues
• Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
• Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

• Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
• Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
• Readable — Will your future self be able to understand this change months down the road?
• Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced commission management for admins and vendors, including viewing earnings and related orders.
  • Improved withdrawal request filtering capabilities.
  • New product search functionality for admins.
  • Expanded catalog settings control for admin and vendor roles.

• Bug Fixes

  • Refined visibility checks in vendor support ticket handling.

• Documentation

  • Updated payload structures to support multi-vendor capabilities.

These updates significantly enhance user experience by providing more control and visibility over commissions, product management, and vendor interactions.

[coderabbitai]

Walkthrough

This pull request introduces significant updates across multiple files, particularly enhancing the feature set in feature-map.yml related to commission management for different user roles. New methods and selectors have been added to the CommissionPage, ProductsPage, and ApiUtils classes to facilitate improved vendor and product management functionalities. Additionally, modifications to the BasePage class enhance type safety and method flexibility. Test files have been updated to include new test cases for the added functionalities, ensuring comprehensive coverage of the new features.

Changes

File Path	Change Summary
tests/pw/feature-map/feature-map.yml	Added multiple new features in the "Commission", "Withdraw", "Reverse Withdrawal", and "Catalog Mode" sections for admin and vendor roles.
tests/pw/pages/basePage.ts	Updated multipleElementVisible for type safety and added parameters to clickAndWaitForLoadState for enhanced control over load state behavior.
tests/pw/pages/commissionPage.ts	Added new methods for viewing commissions and earnings for vendors, including navigation and visibility checks for various elements related to orders.
tests/pw/pages/productsPage.ts	Introduced adminSearchProduct method for product searching in the admin interface; updated vendorAddNewProductRenderProperly for visibility checks.
tests/pw/pages/selectors.ts	Enhanced organization and added new selectors for commission-related elements and improved structure for product-related selectors.
tests/pw/pages/storeSupportsPage.ts	Modified visibility checks and input handling in vendor support ticket methods for improved accuracy.
tests/pw/tests/e2e/commission.spec.ts	Updated test file to include new test cases for vendor commission views and modified setup for vendor context.
tests/pw/utils/apiUtils.ts	Added methods for creating multivendor orders and enhanced line item handling for complex order scenarios.
tests/pw/utils/payloads.ts	Introduced VENDOR2_ID and createMultiVendorOrder method, improving support for multi-vendor capabilities.

Possibly related PRs

• Add Pro module tests(wholesale, vendorstaff) (test automation) #2379: Modifications to feature-map.yml adding features related to commission management.
• Add Setup tests (test automation) #2380: Updates to feature-map.yml enhancing vendor capabilities.
• Add product addon tests(automation suite) #2381: Introduces tests for product addons related to commission management.
• Add product form tests #2383: Adds tests for product forms connected to commission management updates.
• Add product categories & tags tests  #2384: Enhances testing framework for product categories relevant to vendor capabilities.
• Add: add product form tests (gallery, description) #2385: Introduces tests for product forms, targeting gallery and description functionalities.
• Add: product form tests (other options, catalog) #2391: Adds tests for product options and catalog functionalities related to vendor capabilities.
• Add: add product tests (product addon, rma) #2396: Introduces tests for product addons and RMA, closely related to commission management.
• Auction tests #2452: Enhances vendor capabilities in auction management, aligning with commission management.
• Enhancement: product commission bulk edit #2464: Enhances bulk editing of product commissions, directly related to commission management.

Suggested labels

QA approved

Poem

🐰 In the meadow where features bloom,
New commissions bring joy, dispelling gloom.
Vendors and admins, with power in hand,
Manage their orders, just as they planned.
With tests all around, the code's a delight,
Hop, skip, and jump into the bright night! 🌟

---

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 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: 4

🧹 Outside diff range and nitpick comments (9)

tests/pw/pages/productsPage.ts (1)

20-26: Consider enhancing error handling and type safety.

The method implementation is clean but could benefit from some improvements:

1. Add explicit return type for type safety
2. Add error handling for cases where product is not found
3. Consider adding timeout configuration for network requests

-    async adminSearchProduct(productName: string) {
+    async adminSearchProduct(productName: string): Promise<void> {
         await this.gotoUntilNetworkidle(data.subUrls.backend.wc.products);
         await this.clearAndType(selector.admin.products.search.searchInput, productName);
         await this.clickAndWaitForLoadState(selector.admin.products.search.searchButton, 'networkidle');
-        await this.toBeVisible(selector.admin.products.productRow(productName));
+        try {
+            await this.toBeVisible(selector.admin.products.productRow(productName), { timeout: 5000 });
+        } catch (error) {
+            throw new Error(`Product "${productName}" not found in admin search results`);
+        }
     }

tests/pw/pages/commissionPage.ts (3)

253-254: Correct the comment to accurately describe the function.

The comment on line 253 should be updated to reflect that the function vendorViewEarningOnOrderDetails is for viewing earnings on order details, not the order list.

---

280-280: Avoid direct DOM manipulation to control visibility in tests.

Directly removing attributes to force element visibility (line 280) can lead to brittle tests. Instead, consider using more reliable methods such as waiting for the element to become visible, or adjusting the application's state to ensure the element is interactable without manipulating the DOM.

---

222-242: Consolidate similar methods to reduce code duplication.

The methods vendorViewEarningOnProductList, vendorViewEarningOnAddProductDetails, and vendorViewEarningOnEditProductDetails have similar patterns of navigating to a page and verifying the visibility of earning elements. Refactoring these methods to extract common code can reduce duplication and improve readability.

tests/pw/utils/apiUtils.ts (3)

2056-2060: Enhance type safety by specifying precise parameter types.

The createMultivendorOrder method uses any types for orderPayload and lineItemPayload. Defining specific interfaces or type aliases for these parameters will improve type safety and code maintainability.

---

Line range hint 2084-2109: Add validation to prevent potential NaN errors in loops.

In the createLineItemsEnhanced method, the calculation of length on line 2099 can result in NaN if item.products is not a valid number string. This would cause the for-loop to fail. Add validation to ensure item.products can be converted to a number and handle cases where it cannot.

---

2070-2070: Address the TODO comment regarding method replacement.

The TODO comment on line 2070 indicates that createLineItems should be replaced with createLineItemsEnhanced and tests updated accordingly. Completing this task will help keep the codebase updated and reduce technical debt.

tests/pw/utils/payloads.ts (1)

403-403: Remove or clarify commented-out code.

The line // post_author: '', is commented out. If it's not needed, consider removing it. If it's intended for future use, add a comment explaining its purpose to improve code clarity.

tests/pw/pages/basePage.ts (1)

1429-1437: LGTM: Improved type safety and selector handling

The changes enhance the method by:

• Using TypeScript interface for better type safety
• Adding recursive handling for nested selectors
• Properly handling function type selectors

Remove unnecessary continue statement

The continue statement on line 1434 is redundant as it's the last statement in the if block.

 } else if (typeof selectors[selector] === 'function') {
-    continue;
 } else {

🧰 Tools

🪛 Biome (1.9.4)

[error] 1434-1435: Unnecessary continue statement

Unsafe fix: Delete the unnecessary continue statement

(lint/correctness/noUnnecessaryContinue)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b44d4b3 and d694935.

📒 Files selected for processing (9)

• tests/pw/feature-map/feature-map.yml (1 hunks)
• tests/pw/pages/basePage.ts (3 hunks)
• tests/pw/pages/commissionPage.ts (2 hunks)
• tests/pw/pages/productsPage.ts (2 hunks)
• tests/pw/pages/selectors.ts (6 hunks)
• tests/pw/pages/storeSupportsPage.ts (1 hunks)
• tests/pw/tests/e2e/commission.spec.ts (4 hunks)
• tests/pw/utils/apiUtils.ts (3 hunks)
• tests/pw/utils/payloads.ts (3 hunks)

🧰 Additional context used

🪛 Biome (1.9.4)

tests/pw/pages/basePage.ts

[error] 1434-1435: Unnecessary continue statement

Unsafe fix: Delete the unnecessary continue statement

(lint/correctness/noUnnecessaryContinue)

🔇 Additional comments (15)

tests/pw/pages/productsPage.ts (1)

313-313: LGTM!

The addition of the earning element visibility check is appropriate and consistent with the surrounding code.

tests/pw/pages/storeSupportsPage.ts (1)

230-230: Verify completeness of visibility checks after method change.

Changing from multipleElementVisible to toBeVisible for closeTicketText (line 230) may reduce the number of elements being checked. Ensure that all necessary elements are still being verified for visibility when a ticket is closed.

tests/pw/pages/basePage.ts (2)

9-9: LGTM: Import statement is correctly added

The import for helpers is necessary for using the isPlainObject utility in the multipleElementVisible method.

---

214-215: LGTM: Enhanced method flexibility

The method signature changes improve flexibility by:

• Adding state parameter with 'domcontentloaded' default
• Adding optional timeout configuration

tests/pw/feature-map/feature-map.yml (1)

351-359: LGTM: Well-structured commission visibility features

The new features provide comprehensive commission visibility capabilities:

• Admin features for viewing commission data in various contexts
• Vendor features for viewing earning information across different pages
• All features are properly categorized and marked as [lite]

tests/pw/pages/selectors.ts (10)

2981-2982: LGTM: Added commission column selector for orders table

The selector for the commission column in orders table is correctly defined.

---

2985-2987: LGTM: Added first row order commission selector

The selectors for accessing the first row and its commission value are properly defined.

---

2991-2997: LGTM: Added commission meta box table column selectors

The table column selectors for the commission meta box are well structured with clear naming.

---

3002-3014: LGTM: Added sub orders meta box selectors

The selectors for sub orders meta box and its table columns are properly organized.

---

3016-3030: LGTM: Added related orders meta box selectors

The selectors for related orders meta box and its table columns are well defined.

---

3053-3058: LGTM: Added commission column and row selectors for products

The selectors for accessing commission data in the products table are properly implemented.

---

3877-3878: LGTM: Added first row product commission selector

The selectors for accessing the first row product and its commission value are correctly defined.

---

3917-3917: LGTM: Added vendor earning selector

The selector for vendor earning span is properly defined.

---

4304-4305: LGTM: Added first row order earning selector

The selectors for accessing the first row order and its earning value are well structured.

---

4339-4342: LGTM: Added order details earning selectors

The selectors for order details earning information are properly organized.