Add DedupeRule, DedupeRuleGroup and DedupeException API4 entity

[monishdeb]

Overview

Add DedupeRule, DedupeRuleGroup and DedupeException APIv4 entity

Comments

ping @colemanw @eileenmcnaughton @seamuslee001

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[monishdeb]

@eileenmcnaughton I have prepared the patch as per the suggestion in https://lab.civicrm.org/dev/core/-/issues/2486#note_56902 but only for DedupeRule entity. So as per the plan:

1. I have declared a separate DedupeRule entity in CRM/Core/DAO/AllCoreTables.data.php along with Rule entity. I haven't renamed the existing one otherwise it will fail for api3 Rule entity.

2. Added Duperule DAO/BAO

3. Updated old DAO/BAO Rule class which extends DupeRule DAO/BAO respectively.

4. Added DedupeRule API4 entity.

I am not sure if we need need to entirely discard the Rule entity declaration from xml and api3, in other words:

1. Do we need to move xml/schema/Rule.xml to xml/schema/DupeRule.xml
2. Move api/v3/Rule.php to api/v3/DedupeRule.php
3. Make necessary changes in CRM/api3 unit tests

[colemanw]

It would be nice to get rid of CRM_Dedupe_DAO_Rule here.
Isn't this file autogenerated? I think that means it would disappear anyway the next time CodeGen is run.

What about adding this to fix APIv3:

diff --git a/api/v3/utils.php b/api/v3/utils.php
index d96aae6785..5abea6650c 100644
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -309,6 +309,11 @@ function _civicrm_api3_get_DAO($name) {
     $name = 'Contact';
   }
 
+  // Entity was renamed for APIv4
+  if ($name === 'Rule') {
+    return 'CRM_Dedupe_DAO_DedupeRule';
+  }
+
   // hack to deal with incorrectly named BAO/DAO - see CRM-10859
 
   // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingEventQueue

[monishdeb]

Hmm right, yeah thats another place in api3 to indicate the mapping between the old and new entity name. Updated the PR. Thanks for the patch.

[eileenmcnaughton]

@colemanw keeping the old dao for a bit reduces the chance we break things as last dao renaming we had a few issues

[colemanw]

Looks like the APIv4 ConformanceTest isn't going to be happy unless we also add the RuleGroup api.
That one could be renamed DedupeRuleGroup to match this one :)

[monishdeb]

Jenkins test this please

[seamuslee001]

Jenkins test this please

[monishdeb]

Hmm , as per test build log something wrong with the xml

[[Restore "/home/jenkins/bknix-dfl/build/core-20466-33hpo/web" DB (test) from file (/home/jenkins/bknix-dfl/build/.civibuild/snapshot/core-20466-33hpo/civi.sql.gz)]]
Check test results and set exit code
Fatal: Found <error> in XML
Build step 'Execute shell' marked build as failure

Not sure about the error, but maybe due to renaming the schema xml lead to this error somehow.

[seamuslee001]

PHP Fatal error:  Class 'CRM_Core_DedupeRuleGroup' not found in /home/jenkins/bknix-dfl/build/core-20466-33hpo/web/sites/all/modules/civicrm/CRM/Dedupe/DAO/RuleGroup.php on line 12

(in the full console log)

[colemanw]

Hooray! Fantastic work Monish!