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: Vendor categories tranlation compatibility stuff with WPML. #2364

Conversation

MdAsifHossainNadim
Copy link
Contributor

@MdAsifHossainNadim MdAsifHossainNadim commented Sep 5, 2024

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

How to test the changes in this Pull Request:

  • Steps or issue link

Changelog entry

Fix: Vendor product category translation compatibility issue with WPML.

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

  • New Features

    • Improved category retrieval process for a more efficient display of product categories.
    • Enhanced handling of categories to ensure a clean structure when no categories are found.
  • Bug Fixes

    • Removed outdated caching mechanism that could lead to inconsistencies in category data.
    • Improved handling of potential undefined indices to prevent errors in category retrieval.

Copy link
Contributor

coderabbitai bot commented Sep 5, 2024

Walkthrough

The changes involve significant modifications to the Categories class in includes/ProductCategory/Categories.php, specifically in the get_all_categories and get_categories methods. The caching mechanism in get_all_categories has been removed, leading to a direct call to get_categories(). The get_categories method now utilizes get_terms() instead of direct database queries, transforming the fetched categories into a structured format with array_map and array_column. The overall structure and logic for handling categories have been streamlined.

Changes

File Change Summary
includes/ProductCategory/Categories.php Refactored get_all_categories to remove caching and call get_categories() directly; modified get_categories to use get_terms() instead of $wpdb, restructuring the categories array.

Possibly related PRs

  • fix: dokan js translation loading #2377: The changes in the includes/ProductCategory/Categories.php file regarding the category retrieval methods may relate to the overall structure and handling of data, which is also a focus in the includes/Assets.php modifications for localization and script dependencies in PR fix: dokan js translation loading #2377. Both PRs involve significant changes to how data is managed and retrieved within the application.

Suggested labels

QA approved, :+1: Dev Review Done, Upcoming Release, Dependency With Pro

Suggested reviewers

  • shohag121

Poem

In the garden where the code does play,
A rabbit hops with joy today.
No more SQL, just terms so neat,
A simpler path, oh what a treat!
With every hop, the changes sing,
A happy dance for coding spring! 🐰✨


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

Outside diff range, codebase verification and nitpick comments (1)
includes/ProductCategory/Categories.php (1)

Line range hint 32-32: Correct typographical errors in documentation comments.

The annotation @sience should be corrected to @since to adhere to standard documentation practices.

Apply this diff to correct the typographical errors:

- * @sience 3.6.2
+ * @since 3.6.2

Also applies to: 187-187

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 616b620 and 6424dfd.

Files selected for processing (1)
  • includes/ProductCategory/Categories.php (1 hunks)
Additional comments not posted (1)
includes/ProductCategory/Categories.php (1)

137-158: Refactor of get_categories method enhances maintainability and security.

The switch from direct SQL queries to using get_terms is a significant improvement. This change not only simplifies the code but also leverages WordPress's built-in functionality, which is more secure and compatible with plugins like WPML. The use of array_map and array_column for data transformation and indexing is well implemented, enhancing the readability and efficiency of the code.

Copy link
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: 3

🧹 Outside diff range and nitpick comments (2)
includes/ProductCategory/Categories.php (2)

129-133: Consider Using Pagination for Large Category Sets

Fetching all categories at once may lead to performance issues on sites with a vast number of categories.

Consider implementing pagination or lazy loading to improve performance:

$product_categories = get_terms(
    [
        'taxonomy'   => 'product_cat',
        'hide_empty' => false,
+       'number'     => 100,
+       'offset'     => 0,
    ]
);

You may need to loop through pages of categories if there are more than the specified limit.


23-23: Maintain Consistency with Coding Standards

Ensure that all methods and properties have proper documentation blocks, and that annotations like @since are correctly spelled.

For example, correct the typo in the docblock:

- * @sience 3.6.4
+ * @since 3.6.4
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6424dfd and 6f26d45.

📒 Files selected for processing (1)
  • includes/ProductCategory/Categories.php (2 hunks)
🔇 Additional comments (1)
includes/ProductCategory/Categories.php (1)

129-133: ⚠️ Potential issue

Verify Language Compatibility with WPML When Fetching Terms

Using get_terms() without specifying language parameters may not retrieve categories in the correct language when WPML is active. Ensure that the categories fetched are appropriately filtered based on the current language.

Run the following script to verify that get_terms() respects the current language settings:

If necessary, modify the arguments passed to get_terms() to include language considerations, possibly using WPML's language filters.

// set category data to cache
Cache::set_transient( $transient_key, $this->categories, '', MONTH_IN_SECONDS );
}
$this->get_categories();
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Potential Performance Impact Due to Removal of Caching

By removing the transient caching mechanism in the get_all_categories() method, the categories will be fetched from the database on every call. This could lead to increased database load and slower performance, especially on sites with a large number of categories or high traffic.

[performance]

Consider reintroducing caching to improve performance. You might implement caching with a unique key that respects the current language, ensuring compatibility with WPML.

Comment on lines 136 to 145
// Transform the categories
$transformed_categories = array_map(
function ( $category ) {
return (object) [
'term_id' => $category->term_id,
'name' => $category->name,
'parent_id' => $category->parent,
];
},
$product_categories
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Simplify Data Transformation by Avoiding Unnecessary Object Casting and JSON Encoding

The current transformation process casts categories to objects and then decodes them back to arrays using JSON encoding. This is inefficient and can be simplified.

Refactor the code to work directly with arrays:

// Transform the categories
$transformed_categories = array_map(
    function ( $category ) {
-       return (object) [
+       return [
            'term_id'   => $category->term_id,
            'name'      => $category->name,
            'parent_id' => $category->parent,
        ];
    },
    $product_categories
);

// Index the array by term_id.
$categories = array_column( $transformed_categories, null, 'term_id' );

- // Convert category data to array
- $this->categories = json_decode( wp_json_encode( $categories ), true );
- unset( $categories );
+ $this->categories = $categories;

This eliminates unnecessary conversions and improves code readability and performance.

Committable suggestion was skipped due to low confidence.

Comment on lines 148 to 149
// Index the array by term_id.
$categories = array_column( $transformed_categories, null, 'term_id' );
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Ensure Proper Handling of Empty Categories

If $categories is empty after processing, the method should return early to prevent errors in subsequent operations.

Add a condition to handle empty category data:

+ if ( empty( $categories ) ) {
+     $this->categories = [];
+     return;
+ }

This ensures that the class property $this->categories is always set, and avoids potential undefined index errors later in the code.

Committable suggestion was skipped due to low confidence.

Copy link
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6f26d45 and 70ff089.

📒 Files selected for processing (1)
  • includes/ProductCategory/Categories.php (3 hunks)

includes/ProductCategory/Categories.php Show resolved Hide resolved
@MdAsifHossainNadim MdAsifHossainNadim added Needs: Dev Review It requires a developer review and approval Needs: Testing This requires further testing labels Oct 24, 2024
@mrabbani mrabbani added 👍 Dev Review Done and removed Needs: Dev Review It requires a developer review and approval labels Nov 1, 2024
@shashwatahalder01 shashwatahalder01 added QA In Progress QA approved This PR is approved by the QA team and removed Needs: Testing This requires further testing QA In Progress labels Nov 8, 2024
@shohag121 shohag121 merged commit 5923a4a into develop Nov 8, 2024
2 checks passed
@mrabbani mrabbani deleted the fix/refactor-vendor-product-category-translation-compatible-with-wpml branch January 27, 2025 07:59
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.

4 participants