🎯 fix: Translation cache not flashing after updating plugin language directory files

[devAsadNur]

All Submissions:

• My code follows 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: https://github.com/getdokan/dokan-pro/issues/2505

How to test the changes in this Pull Request:

• Please follow the steps from: https://github.com/getdokan/dokan-pro/issues/2505

Changelog entry

fix: Translation cache not flashing after updating plugin language directory files

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

Summary by CodeRabbit

• New Features

  • Enhanced localization support by improving the management of language files specific to the plugin.
  • Improved caching mechanism for language data retrieval.

• Bug Fixes

  • Reduced potential cache collisions related to language file data through a more unique transient key construction.

[coderabbitai]

Walkthrough

The recent changes enhance the dokan_get_jed_locale_data function in the includes/functions.php file by introducing a new variable for the plugin's language directory. This improvement refines the transient key construction, which is crucial for accurate localization data retrieval. These modifications aim to reduce cache collisions, thereby enhancing the handling of localized strings, particularly for shipping-related features in the vendor dashboard.

Changes

Files	Change Summary
includes/functions.php	Modified dokan_get_jed_locale_data to include a new variable for the plugin language directory and refined transient key construction for better caching of localization data.

Assessment against linked issues

Objective	Addressed	Explanation
Some shipping-related strings do not translate properly (#2505)	✅

🐰 In the realm of code where changes take flight,
A function got smarter, making translations just right.
With new paths for language, it’s clear as can be,
Shipping strings flourish, as happy as me!
So hop on, dear coder, embrace this delight,
For now our translations will shine ever bright! ✨

---

Tip

Early access features: enabled

We are currently testing the following features in early access:

• Anthropic Claude for code reviews: The new model is designed to enhance code understanding and generation capabilities. We're excited to hear your feedback as we evaluate its performance.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are currently opted into early access features by default.

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 817f833 and 789d0b1.

Files selected for processing (1)

• includes/functions.php (1 hunks)

Additional comments not posted (1)

includes/functions.php (1)

2953-2954: LGTM! But verify the function usage in the codebase.

The introduction of $plugin_language_dir and its inclusion in the $transient_key is a logical enhancement to improve cache handling for translations. The changes are approved.

However, ensure that all usages of dokan_get_jed_locale_data in the codebase are compatible with these changes.

Verification successful

---

Function Usage Verified: No Issues Found

The function dokan_get_jed_locale_data is used in includes/Assets.php, and the usage is compatible with the recent changes. The transient key logic is correctly applied. No further action is needed.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `dokan_get_jed_locale_data` to ensure compatibility with changes.

# Test: Search for the function usage. Expect: No issues with the new implementation.
rg --type php -A 5 $'dokan_get_jed_locale_data'

Length of output: 1098

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 789d0b1 and a104d51.

Files selected for processing (1)

• includes/functions.php (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• includes/functions.php

[mrabbani]

This is addressed in #2377