-
-
Notifications
You must be signed in to change notification settings - Fork 820
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19386 from totten/master-track-token
(dev/mail#81) Flexmailer - Track click-throughs for URLs with tokens
- Loading branch information
Showing
6 changed files
with
233 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
ext/flexmailer/tests/phpunit/Civi/FlexMailer/ClickTrackerTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| <?php | ||
| namespace Civi\FlexMailer; | ||
|
|
||
| use Civi\Test\HeadlessInterface; | ||
| use Civi\Test\HookInterface; | ||
| use Civi\Test\TransactionalInterface; | ||
|
|
||
| use Civi\FlexMailer\ClickTracker\TextClickTracker; | ||
| use Civi\FlexMailer\ClickTracker\HtmlClickTracker; | ||
|
|
||
| /** | ||
| * Tests that URLs are converted to tracked ones if at all possible. | ||
| * | ||
| * @group headless | ||
| */ | ||
| class ClickTrackerTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface { | ||
|
|
||
| protected $mailing_id; | ||
|
|
||
| public function setUpHeadless() { | ||
| // Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile(). | ||
| // See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest | ||
| return \Civi\Test::headless() | ||
| ->installMe(__DIR__) | ||
| ->apply(); | ||
| } | ||
|
|
||
| public function setUp() { | ||
| // Mock the getTrackerURL call; we don't need to test creating a row in a table. | ||
| // If you want this to work without runkit, then either (a) make the dummy rows or (b) switch this to a hook/event that is runtime-configurable. | ||
| require_once 'CRM/Mailing/BAO/TrackableURL.php'; | ||
| runkit7_method_rename('\CRM_Mailing_BAO_TrackableURL', 'getBasicTrackerURL', 'orig_getBasicTrackerURL'); | ||
| runkit7_method_add('\CRM_Mailing_BAO_TrackableURL', 'getBasicTrackerURL', '$a, $b, $c', 'return \'http://example.com/extern?u=1&qid=1\';', RUNKIT7_ACC_STATIC | RUNKIT7_ACC_PRIVATE); | ||
| parent::setUp(); | ||
| } | ||
|
|
||
| public function tearDown() { | ||
| // Reset the class. | ||
| runkit7_method_remove('\CRM_Mailing_BAO_TrackableURL', 'getBasicTrackerURL'); | ||
| runkit7_method_rename('\CRM_Mailing_BAO_TrackableURL', 'orig_getBasicTrackerURL', 'getBasicTrackerURL'); | ||
| parent::tearDown(); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link without any tokens works. | ||
| */ | ||
| public function testLinkWithoutTokens() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/foo/bar?a=b&c=d#frag'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: http://example.com/extern?u=1&qid=1', $result); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link with tokens in the query works. | ||
| */ | ||
| public function testLinkWithTokensInQueryWithStaticParams() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/foo/bar?a=b&cid={contact.id}'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: http://example.com/extern?u=1&qid=1&cid={contact.id}', $result); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link with tokens in the query works. | ||
| */ | ||
| public function testLinkWithTokensInQueryWithMultipleStaticParams() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/foo/bar?cs={contact.checksum}&a=b&cid={contact.id}'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: http://example.com/extern?u=1&qid=1&cs={contact.checksum}&cid={contact.id}', $result); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link with tokens in the query works. | ||
| */ | ||
| public function testLinkWithTokensInQueryWithMultipleStaticParamsHtml() { | ||
| $filter = new HtmlClickTracker(); | ||
| $msg = '<a href="https://example.com/foo/bar?cs={contact.checksum}&a=b&cid={contact.id}">See this</a>'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('<a href="http://example.com/extern?u=1&qid=1&cs={contact.checksum}&cid={contact.id}" rel=\'nofollow\'>See this</a>', $result); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link with tokens in the query works. | ||
| */ | ||
| public function testLinkWithTokensInQueryWithoutStaticParams() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/foo/bar?cid={contact.id}'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: http://example.com/extern?u=1&qid=1&cid={contact.id}', $result); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link with tokens in the fragment works. | ||
| * | ||
| * Seems browsers maintain the fragment when they receive a redirect, so a | ||
| * token here might still work. | ||
| */ | ||
| public function testLinkWithTokensInFragment() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/foo/bar?a=b#cid={contact.id}'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: http://example.com/extern?u=1&qid=1#cid={contact.id}', $result); | ||
| } | ||
|
|
||
| /** | ||
| * Example: Test that a link with tokens in the fragment works. | ||
| * | ||
| * Seems browsers maintain the fragment when they receive a redirect, so a | ||
| * token here might still work. | ||
| */ | ||
| public function testLinkWithTokensInQueryAndFragment() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/foo/bar?a=b&cid={contact.id}#cid={contact.id}'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: http://example.com/extern?u=1&qid=1&cid={contact.id}#cid={contact.id}', $result); | ||
| } | ||
|
|
||
| /** | ||
| * We can't handle tokens in the domain so it should not be tracked. | ||
| */ | ||
| public function testLinkWithTokensInDomainFails() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://{some.domain}.com/foo/bar'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: https://{some.domain}.com/foo/bar', $result); | ||
| } | ||
|
|
||
| /** | ||
| * We can't handle tokens in the path so it should not be tracked. | ||
| */ | ||
| public function testLinkWithTokensInPathFails() { | ||
| $filter = new TextClickTracker(); | ||
| $msg = 'See this: https://example.com/{some.path}'; | ||
| $result = $filter->filterContent($msg, 1, 1); | ||
| $this->assertEquals('See this: https://example.com/{some.path}', $result); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters