Document deduplication, what is sent, consent and worker mode

[loevgaard]

Fixes #31

Stacked on #54.

The earlier PRs in this series already added the pipeline table, the enrichment example, the logging channel, the async routing rationale and the test event code lifecycle. This one closes the remaining gaps from the issue.

Deduplication between the browser and the server

With both sides on, the same event is sent twice on purpose. Nothing said so, or explained why that is fine: Event::$eventId is generated in the constructor and used as eventID in the fbq() call and event_id in the api payload, so Meta collapses the pair. Also spells out the one case where it breaks, namely assigning ids yourself and not using the same one on both sides.

What is sent to Meta

A table of the four fields the bundle fills in by itself, plus the two things worth checking in the application:

• framework.trusted_proxies has to be configured, or getClientIp() returns the load balancer's address and every visitor looks identical.
• event_source_url is the full url including the query string, with a one-line listener for stripping it.

Also states that personal data is hashed before it leaves the server and is not written to the transport.

Consent

What actually happens while consent is not granted: events are still built and enriched, but no tags are rendered, no command is dispatched, and neither cookie is written, each logged at debug level. And that everything counts as granted when the consent bundle is absent or the option is off.

Long running runtimes

Requirements now state that FrankenPHP worker mode, RoadRunner and Swoole are supported, since the cached contexts are reset between requests.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.49%. Comparing base (0c26905) to head (e045401).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master      #55   +/-   ##
=========================================
  Coverage     90.49%   90.49%           
  Complexity      148      148           
=========================================
  Files            31       31           
  Lines           484      484           
=========================================
  Hits            438      438           
  Misses           46       46           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.