Sparkpost tracking config option #5
Conversation
escopecz
force-pushed
the
tracking-config
branch
from
1e318fa to
d99efa8
Compare
There was a problem hiding this comment.
PR Overview
This PR introduces a configuration option to enable Sparkpost tracking within the Mautic Sparkpost Plugin, along with updated installation and configuration instructions in the README.
- Added a "Sparkpost tracking" section describing how to enable tracking via the configuration option in config/local.php.
- Revised the README to include detailed installation methods and configuration examples.
Reviewed Changes
| File | Description |
|---|---|
| README.md | Added installation options and documentation explaining how to enable Sparkpost tracking |
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
README.md:56
- [nitpick] Consider rephrasing the sentence for clarity. For example: 'Sparkpost tracking is disabled by default to prevent duplicate tracking of email opens and clicks (once by Sparkpost and once by Mautic), which could lead to unexpected behavior.'
The Sparkpost tracking is disabled by default as then the email open and clicks would be tracked twice. Once by Sparkpost, second time by Mautic. This can create some unexpected behavior.
| @@ -127,7 +140,7 @@ private function assertSparkpostTestRequestBody(string $body): void | |||
| Assert::assertSame('Hi! This is a test email from Mautic. Testing...testing...1...2...3!', $bodyArray['content']['text']); | |||
| } | |||
|
|
|||
| private function assertSparkpostRequestBody(string $body): void | |||
| private function assertSparkpostRequestBody(string $body, bool $expectedTrackingConfig): void | |||
There was a problem hiding this comment.
The parameter $expectedTrackingConfig is not used.
There was a problem hiding this comment.
Great catch! It turns out the assertions were muted by a code that was catching generic Exception. There were already several assertions failing but the tests were green. Fixed it.
| private TranslatorInterface&MockObject $translatorMock; | ||
| private CoreParametersHelper&MockObject $coreParametersHelper; |
There was a problem hiding this comment.
We cannot use PHP's intersection types until we bump minimum PHP version to 8.1.
It is 8.0 now.
mc-cs-plugin-sparkpost/composer.json
Line 16 in 487da41
…not catch all \Exception to avoid this.
There was a problem hiding this comment.
PR Overview
This PR introduces a configuration option to enable Sparkpost tracking in the Mautic Sparkpost Plugin, allowing users to control whether click and open events are tracked by Sparkpost in addition to Mautic. Key changes include:
- Adding a "Sparkpost tracking" section in the README with an explanation on the behavior when the option is enabled.
- Detailing configuration instructions for enabling Sparkpost tracking via the Mautic configuration file.
Reviewed Changes
| File | Description |
|---|---|
| README.md | Added installation instructions and a new section for Sparkpost tracking configuration |
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Motivation
The Sparkpost email open and click tracking was always disabled. This PR keeps it disabled but allows users to enable it via a configuration option
sparkpost_tracking_enabledTesting steps