Replace StreamBatcher with StreamEventAggregator instead in the StreamSocketSession
#57
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-core-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.android.core.api.processing | ||
|
|
||
| import io.getstream.android.core.annotations.StreamInternalApi | ||
|
|
||
| /** | ||
| * A collection of events grouped by their type, produced by [StreamEventAggregator] during a | ||
| * traffic spike. | ||
| * | ||
| * When the aggregator detects high event throughput, it collects events within a time window and | ||
| * delivers them as a single [StreamAggregatedEvent] instead of dispatching each individually. This | ||
| * allows product SDKs to apply one state update and one UI recomposition per window instead of one | ||
| * per event. | ||
| * | ||
| * During normal (low) traffic, events flow through individually — this class is only used during | ||
| * spikes. | ||
| * | ||
| * ### Usage | ||
| * | ||
| * ```kotlin | ||
| * when (event) { | ||
| * is StreamAggregatedEvent<*> -> { | ||
| * event.events.forEach { (type, eventsOfType) -> | ||
| * when (type) { | ||
| * "channel.updated" -> applyLatest(eventsOfType) | ||
| * "message.new" -> processAll(eventsOfType) | ||
| * } | ||
| * } | ||
| * } | ||
| * else -> handleSingleEvent(event) | ||
| * } | ||
| * ``` | ||
| * | ||
| * @param T The type of the individual events. | ||
| * @property events Events grouped by type string. Each list preserves arrival order. | ||
| */ | ||
| @StreamInternalApi | ||
| public class StreamAggregatedEvent<T>(events: Map<String, List<T>>) { | ||
| public val events: Map<String, List<T>> = events.mapValues { (_, v) -> v.toList() } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we can aggregate into a map at the
corelevel since SDKs might rely on the order of events. For example, we might receive "reaction X added" -> "reaction X removed" and if we process them in the opposite order we end up in the wrong state. This can happen even if we useLinkedHashMap, for example if we receive this sequenceInsertion order would put the "reaction removed" key before "reaction added", but for Y "added" should be processed before "removed"
I think we can aggregate into a simple List, and then clients can implement some kind of transaction operation where they apply all updates sequentially but in one state update, so they still emit only once.