(dev/core#4109) Fix tokens like {contact.email_primary.email}

[eileenmcnaughton]

Overview

Fix advertised tokens tokens for contact-related tokens (such as {contact.email_primary.email}).

See: https://lab.civicrm.org/dev/core/-/issues/4109

Before

The preferred advertised token style stopped working in the fight to get all the weird tested options to work - and because unit tests were not added for the new preferred style ..... so {contact.email} worked but not {contact.email_primary.email}

After

Preferred style works again & has a test

Technical Details

Comments

@MegaphoneJon

[civibot]

No issue was found matching the number given in the pull request title. Please check the issue number.

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

OK - I think this is the test that I was fixing when the advertised tokens broke... but now I have the test cover to not regress....

CRM_Core_BAO_MessageTemplateTest::testContactTokens
Failed asserting that two arrays are equal.
--- Expected
+++ Actual
@@ @@
'{contact.im_primary.provider_id:label}' => 'IM Provider'
'{contact.im_primary.name}' => 'IM Screen Name'
'{contact.address_primary.country_id.region_id:name}' => 'World Region'

• '{contact.website_first.url}' => 'Website'
  '{contact.custom_9}' => 'Contact reference field :: Cu... Group'
  '{contact.custom_7}' => 'Country :: Custom Group'
  '{contact.custom_8}' => 'Country-multi :: Custom Group'
  @@ @@
  '{contact.checksum}' => 'Checksum'
  '{contact.id}' => 'Contact ID'
  '{important_stuff.favourite_emoticon}' => 'Best coolest emoticon'

• '{contact.url}' => 'Website'
  )

/home/jenkins/bknix-dfl/build/build-x/web/sites/all/modules/civicrm/tests/phpunit/CRM/Core/BAO/MessageTemplateTest.php:437
/home/jenkins/bknix-dfl/build/build-x/web/sites/all/modules/civicrm/tests/phpunit/CiviTest/CiviUnitTestCase.php:235
/home/jenkins/bknix-dfl/extern/phpunit8/phpunit8.phar:1721

[eileenmcnaughton]

OK this wasn't fixed by the last website fix ...

Civi\Token\TokenProcessorTest::testRenderDoubleUrl
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'<a href="https://example.com">blah'
+'<a href="https://">blah'

[totten]

To r-run this, I took the problematic example from dev/core#4109 and tossed it into an adhoc call to CRM_Core_TokenSmarty::render(). I initially had some trouble with it (so I wound up inspecting more examples to see if I was crazy -- e.g. https://gist.github.com/totten/6b0700bbd82c7408aca0a5ba9e848568), but the problem was just caching. When you switch back/forth between the original code and the updated code, you need to cv flush.

Beyond that, tests are passing, and the new test looks good+relevant. Merging.