Tidy AbstractEvent internal properties #666
Merged
Conversation
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
snowplow-tracker/src/androidTest/java/com/snowplowanalytics/snowplow/event/AbstractEventTest.kt
Outdated
Show resolved
Hide resolved
| entities?.let { customContexts.addAll(entities) } | ||
| /** Replace the context entities attached to the event with a new list of entities. */ | ||
| fun entities(entities: List<SelfDescribingJson>): AbstractEvent { | ||
| this.entities = entities.toMutableList() |
There was a problem hiding this comment.
I am a bit of a coward and have a bad feeling about this 😅 On one hand, this looks like a builder function which usually replace the values, but going from a behaviour that is non-destructive (appending) to a destructive one (replacing) is a nasty breaking change. Nobody will notice this in the migration guide and it may lead to some very hard to find bugs with missing data.
I think I would prefer if we kept the Android behaviour and updated on iOS to append instead of replace. Other changes in this PR look good, I'd keep those. What do you think?
There was a problem hiding this comment.
That's fair! I do think the API makes more sense as full replacement. But being cautious is good.
snowplow-tracker/src/main/java/com/snowplowanalytics/snowplow/event/AbstractEvent.kt
Outdated
Show resolved
Hide resolved
mscwilson
changed the title
Merged
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.
Breaking changes in the base
AbstractEventclass, to standardise the API with the iOS tracker.