fix(compat): prevent missing donation data with Restrict Content Pro

[ravinderk]

Issue Overview

If you activate restrict content pro then you will see information missing on donation listing page in admin.

Related

• https://secure.helpscout.net/conversation/543868415/15603?folderId=672197
• https://secure.helpscout.net/conversation/546042810/15768/

Tasks

• Implement solution
  • Renaming the meta type payment to donation
  • Renaming the table {*}_give_paymentmeta to {*}_give_donationmeta
  • Renaming the table and payment_id -> donation_id column
  • Rename $wpdb property paymentmeta -> donationmeta
  • Add DB upgrade
  • Add backward compatibility
• Tests
  • Check DB upgrade
  • Test with multiple addon
• Add blog post
• Add issue for document update

[ravinderk]

@DevinWalker

Cause of issue:

I found the conflict between RCP and Give. We have same $wpdb->paymentmeta table name param, so restrict content pro overwriting over table name or vice versa 😞
For ref:
https://github.com/WordPress/WordPress/blob/master/wp-includes/meta.php#L931
https://github.com/restrictcontentpro/restrict-content-pro/blob/master/restrict-content-pro.php#L371

[samsmith89]

Having this issue currently with a customer. Was this fixed and reopened, or still waiting?
https://secure.helpscout.net/conversation/543868415/15603?folderId=1823994

[kevinwhoffman]

@ravinderk Please complete the following tasks but do not move forward with implementation until we discuss with @DevinWalker.

• Post a possible solution in this issue, including whether a database upgrade routine would be necessary.
• Update the task list based on your proposed solution.
• Update the story point estimate based on your proposed solution.
• Notify @DevinWalker and @kevinwhoffman to discuss next steps.

[ravinderk]

@kevinwhoffman I already explained the problem here: #2710 (comment)

paymentdata is not a general table name prefix that was logic behind keeping. But conflict with Restrict content pro prove that In future, we will have the possibility to conflict with a plugin which can process payment own there own.

Thanks to Restrict content pro team which took the first step to resolve conflict (release/3.0): https://github.com/restrictcontentpro/restrict-content-pro/issues/1656

To resolve this problem we can take following steps:

• Rename meta type payment --> donation : https://github.com/WordImpress/Give/blob/36231565464706a8ebc00156ed1ab705c04b97fb/includes/class-give-db-payment-meta.php#L41
• Rename table {*}_give_paymentmeta --> {*}_give_donationmeta: https://github.com/WordImpress/Give/blob/36231565464706a8ebc00156ed1ab705c04b97fb/includes/class-give-db-payment-meta.php#L53
• Add upgrade routine to rename table and payment_id --> donation_id column
• Test addon compatibility
• Add post on developer blog

@DevinWalker @kevinwhoffman Let me know what do you think.

[kevinwhoffman]

@ravinderk Thanks for the breakdown. RCP seems to have merged a fix on their end, but it is not slated for release until RCP 3.0, which does not look like it has a known release.

We should still adress it from our end, but this does not look like a minor fix, so I'd like to hear from @mathetos how many users this is affecting. Then we can discuss timeline.

[mathetos]

@kevinwhoffman Only two customers reporting as far as I've seen so far. But the urgency is related to the fact that Give 2.0+ is completely unusable for any user that is also running RCP. Additionally, I can imagine this problem would happen with other plugins that call paymentmeta using wpdb as well.

[Benunc]

This issue also breaks functionality with Zapier and Give, and I have a user reporting that, and I replicated the problem on my test (live) install.

Findings

WHen RCP and Give are active on the same site, in addition to the above reference (donor missing) issue, Zapier is unable to connect to the api URL at all.

Additionally, the API returns incomplete and incorrect information:

Before activating RCP:

---

---

After Activating RCP:

---

---

So, in addition to removing all relevant data from the API, it also incorrectly attributes the donations to the POST "Thought 53" which isn't a form at all.

[ravinderk]

@WordImpress/support I think this issue fixed with latest https://github.com/restrictcontentpro/restrict-content-pro/releases/tag/2.9.12

I tested it. Can you confirm?

[samsmith89]

I will check on this today.

[mathetos]

@ravinderk Two things:

1. It looks like that PR on RCP was merged into version 3.0, but that's not their current release.
2. Even if they fix it on their end, I believe we need a way to avoid this happening with other plugins as well. Is there any prefixing or namespacing we can do to avoid this problem in the future?

[ravinderk]

@mathetos yes, I will be fixing in release assign to this issue.

[mehul0810]

@ravinderk I can see an issue on 2.2 Give core branch even after running DB upgrade.

[ravinderk]

@mehul0810 Close this issue because it fixed.