Remove dead code

[oliviertassinari]

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:

There are a number of use of extensions of the WC_Email class in the codebase: https://github.com/search?q=repo%3Agetdokan%2Fdokan%20extends%20WC_Email%20%7B&type=code. The majority of them don't override the default get_from_address() method. It seems that this logic is dead code.

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

• Refactor
  • Removed custom "from" email configuration for vendor product review emails
  • Simplified email sender settings for product review notifications

[coderabbitai]

Walkthrough

The pull request involves modifications to the VendorProductReview and ContactSeller classes in the email handling system. Specifically, the changes remove the $from_email property and its associated get_from_address() method from both classes. This eliminates the custom "from" email address configuration for product review and contact seller-related emails, potentially defaulting to a system-wide email sender configuration.

Changes

File	Change Summary
includes/Emails/VendorProductReview.php	- Removed private $from_email variable - Deleted public function get_from_address() method
includes/Emails/ContactSeller.php	- Removed private $from_email variable - Deleted public function get_from_address() method

Possibly related PRs

• fix(email-template): missing attribute #2487: The changes in the WithdrawApproved class involve the removal of the $from_email property and its associated method get_from_address, which is similar to the changes made in the VendorProductReview class regarding the removal of the same property and method.

Suggested labels

QA approved, :+1: Dev Review Done

Suggested reviewers

• shohag121

Poem

🐰 Hop, hop, email code so light,
Removing lines with gentle might
From address gone, yet spirits bright
A rabbit's code review takes flight
Simplicity wins the coding fight! 📧

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 14fd4bd and ea747ab.

📒 Files selected for processing (2)

• includes/Emails/ContactSeller.php (0 hunks)
• includes/Emails/VendorProductReview.php (0 hunks)

💤 Files with no reviewable changes (2)

• includes/Emails/VendorProductReview.php
• includes/Emails/ContactSeller.php

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[shohag121]

Hi @oliviertassinari,

Thanks for your Pull Request.

By default, emails sent from WooCommerce utilize the Reply-to: header with the default value specified in the Email sender options section of WooCommerce's email settings (get_option( 'woocommerce_email_from_address' );).

To improve email responsiveness, we've modified the get_from_address() method within the relevant email classes. This adjustment ensures that the Reply-to: header for ContactSeller and VendorProductReview emails is set to the admin's email address.

This change aims to facilitate easier communication between the admin and vendors, as it is anticipated that the admin may require a response to these types of emails.

Please don't hesitate to suggest an alternative approach to this use case.

References

• https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/includes/emails/class-wc-email.php#L483-L485
• Vendor Contact form email doesn't contain any customer email #1346

[oliviertassinari]

Ok, so it's not dead code, it's a behavior change request.

In my case, get_option( 'admin_email' ) is set to [email protected] and get_option( 'woocommerce_email_from_address' ) is set to [email protected].

We also have a custom email sender that forces [email protected] for when [email protected] leaks in the form field. We had to force this because of the line of code I proposed removing. The problem for us is that [email protected] is an email that only our team internally has access to, it's technically a Gmail address, and we have Gmail filter rules for it. For our user interaction, we are using Zendesk. We don't want those people to reply to our emails, it would break the normal flow of communications (we are trying to move away from email altogether so an AI chat can do a first filter pass, it's painful to do this with email).

[oliviertassinari]

Closing for now. Feel free to move forward the way you see fit.