Tidy the public API before 1.0 - #52
Open
loevgaard wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## fix/29-cookie-domain #52 +/- ##
=======================================================
Coverage ? 82.29%
Complexity ? 165
=======================================================
Files ? 34
Lines ? 531
Branches ? 0
=======================================================
Hits ? 437
Misses ? 94
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
loevgaard
force-pushed
the
fix/29-cookie-domain
branch
from
September 7, 2026 12:03
3f605cd to
d692d8b
Compare
loevgaard
force-pushed
the
fix/27-public-api
branch
from
September 7, 2026 12:03
a8f579f to
0ee3ad6
Compare
loevgaard
force-pushed
the
fix/29-cookie-domain
branch
from
September 7, 2026 12:18
d692d8b to
17decfb
Compare
loevgaard
force-pushed
the
fix/27-public-api
branch
from
September 7, 2026 12:18
0ee3ad6 to
5a924d7
Compare
loevgaard
force-pushed
the
fix/29-cookie-domain
branch
from
September 7, 2026 12:47
17decfb to
8132598
Compare
loevgaard
force-pushed
the
fix/27-public-api
branch
from
September 7, 2026 12:47
5a924d7 to
960efdb
Compare
loevgaard
force-pushed
the
fix/29-cookie-domain
branch
from
September 7, 2026 12:51
8132598 to
1b315b0
Compare
loevgaard
force-pushed
the
fix/27-public-api
branch
from
September 7, 2026 12:51
960efdb to
293f806
Compare
The Roave BC check will lock this surface in, so decide on the parts that were public but unused. Keep the event context and document it as the way to pass data to your own listeners, adding a getContext() accessor; keep CommandInterface and document routing by interface; make the event properties readonly; and drop the two container parameters no service reads. Fixes #27
loevgaard
force-pushed
the
fix/29-cookie-domain
branch
from
September 7, 2026 12:57
1b315b0 to
2844117
Compare
loevgaard
force-pushed
the
fix/27-public-api
branch
from
September 7, 2026 12:57
293f806 to
ab2f04b
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #27
Problem
The Roave BC check will lock the public surface in at 1.0, and a few things were public but unused, undocumented, or both.
Change
Kept and documented
ConversionsApiEventRaised::$contextis the way to hand your own listeners data that must never reach Meta, such as the order the event was raised for. It now says so in the docblock and inREADME.md, and it gained thegetContext(string $key, mixed $default = null)accessor it was missing next tohasContext().CommandInterfaceis genuinely useful for routing every command the bundle dispatches as a group. The docblock now shows the routing snippet, and the README mentions it.Tightened
ConversionsApiEventRaised::$eventand::$contextarereadonly. TheEventobject stays mutable, which is what enrichment listeners need, but the properties can no longer be swapped.Removed
setono_meta_conversions_api.client_side.enabledand.server_side.enabledcontainer parameters. No service read them once the subscribers became conditional, and whether a side is on is already visible from whether its services exist.Tests
A test for
getContext()including the default, and the extension test drops its assertions on the two removed parameters.