Skip to content

Commit 3867550

Browse files
gtheagthea
committed
Update event listener naming
1 parent e2285c8 commit 3867550

15 files changed

Lines changed: 72 additions & 74 deletions

File tree

‎api/src/main/java/io/split/android/client/SplitClient.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import java.util.Map;
88

99
import io.split.android.client.attributes.AttributesManager;
10-
import io.split.android.client.events.SdkEventListener;
10+
import io.split.android.client.events.SplitEventListener;
1111
import io.split.android.client.events.SplitEvent;
1212
import io.split.android.client.events.SplitEventTask;
1313

@@ -214,7 +214,7 @@ public interface SplitClient extends AttributesManager {
214214
*
215215
* @param listener the event listener to register. Must not be null.
216216
*/
217-
void addEventListener(@NonNull SdkEventListener listener);
217+
void addEventListener(@NonNull SplitEventListener listener);
218218

219219
/**
220220
* Enqueue a new event to be sent to Split data collection services.

api/src/main/java/io/split/android/client/events/SdkEventListener.java renamed to api/src/main/java/io/split/android/client/events/SplitEventListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* });
3737
* }</pre>
3838
*/
39-
public abstract class SdkEventListener {
39+
public abstract class SplitEventListener {
4040

4141
/**
4242
* Called when SDK_READY event occurs, executed on a background thread.

‎api/src/main/java/io/split/android/client/events/SplitEventTask.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* </ul>
1515
* <p>
1616
* For events with metadata (like SDK_UPDATE or SDK_READY_FROM_CACHE), use
17-
* {@link SdkEventListener} instead for type-safe metadata access.
17+
* {@link SplitEventListener} instead for type-safe metadata access.
1818
* <p>
1919
* Example usage:
2020
* <pre>{@code

‎events-domain/src/main/java/io/split/android/client/events/ListenableEventsManager.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ public interface ListenableEventsManager {
88

99
void register(SplitEvent event, SplitEventTask task);
1010

11-
void registerEventListener(SdkEventListener listener);
11+
void registerEventListener(SplitEventListener listener);
1212

1313
boolean eventAlreadyTriggered(SplitEvent event);
1414
}

‎events-domain/src/main/java/io/split/android/client/events/SplitEventsManager.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ public void register(SplitEvent event, SplitEventTask task) {
113113
}
114114

115115
@Override
116-
public void registerEventListener(SdkEventListener listener) {
116+
public void registerEventListener(SplitEventListener listener) {
117117
requireNonNull(listener);
118118

119119
// Register SDK_READY handlers (bg + main)
@@ -190,15 +190,15 @@ private EventHandler<SplitEvent, EventMetadata> createMainThreadHandler(final Sp
190190
}
191191

192192
// SdkEventListener handlers for SDK_READY
193-
private EventHandler<SplitEvent, EventMetadata> createReadyBackgroundHandler(final SdkEventListener listener) {
193+
private EventHandler<SplitEvent, EventMetadata> createReadyBackgroundHandler(final SplitEventListener listener) {
194194
return (event, metadata) -> {
195195
SplitClient client = mResources.getSplitClient();
196196
SdkReadyMetadata typedMetadata = TypedTaskConverter.convertForSdkReady(metadata);
197197
executeMethod(() -> listener.onReady(client, typedMetadata));
198198
};
199199
}
200200

201-
private EventHandler<SplitEvent, EventMetadata> createReadyMainThreadHandler(final SdkEventListener listener) {
201+
private EventHandler<SplitEvent, EventMetadata> createReadyMainThreadHandler(final SplitEventListener listener) {
202202
return (event, metadata) -> {
203203
SplitClient client = mResources.getSplitClient();
204204
SdkReadyMetadata typedMetadata = TypedTaskConverter.convertForSdkReady(metadata);
@@ -207,15 +207,15 @@ private EventHandler<SplitEvent, EventMetadata> createReadyMainThreadHandler(fin
207207
}
208208

209209
// SdkEventListener handlers for SDK_UPDATE
210-
private EventHandler<SplitEvent, EventMetadata> createUpdateBackgroundHandler(final SdkEventListener listener) {
210+
private EventHandler<SplitEvent, EventMetadata> createUpdateBackgroundHandler(final SplitEventListener listener) {
211211
return (event, metadata) -> {
212212
SplitClient client = mResources.getSplitClient();
213213
SdkUpdateMetadata typedMetadata = TypedTaskConverter.convertForSdkUpdate(metadata);
214214
executeMethod(() -> listener.onUpdate(client, typedMetadata));
215215
};
216216
}
217217

218-
private EventHandler<SplitEvent, EventMetadata> createUpdateMainThreadHandler(final SdkEventListener listener) {
218+
private EventHandler<SplitEvent, EventMetadata> createUpdateMainThreadHandler(final SplitEventListener listener) {
219219
return (event, metadata) -> {
220220
SplitClient client = mResources.getSplitClient();
221221
SdkUpdateMetadata typedMetadata = TypedTaskConverter.convertForSdkUpdate(metadata);
@@ -224,15 +224,15 @@ private EventHandler<SplitEvent, EventMetadata> createUpdateMainThreadHandler(fi
224224
}
225225

226226
// SdkEventListener handlers for SDK_READY_FROM_CACHE
227-
private EventHandler<SplitEvent, EventMetadata> createReadyFromCacheBackgroundHandler(final SdkEventListener listener) {
227+
private EventHandler<SplitEvent, EventMetadata> createReadyFromCacheBackgroundHandler(final SplitEventListener listener) {
228228
return (event, metadata) -> {
229229
SplitClient client = mResources.getSplitClient();
230230
SdkReadyMetadata typedMetadata = TypedTaskConverter.convertForSdkReady(metadata);
231231
executeMethod(() -> listener.onReadyFromCache(client, typedMetadata));
232232
};
233233
}
234234

235-
private EventHandler<SplitEvent, EventMetadata> createReadyFromCacheMainThreadHandler(final SdkEventListener listener) {
235+
private EventHandler<SplitEvent, EventMetadata> createReadyFromCacheMainThreadHandler(final SplitEventListener listener) {
236236
return (event, metadata) -> {
237237
SplitClient client = mResources.getSplitClient();
238238
SdkReadyMetadata typedMetadata = TypedTaskConverter.convertForSdkReady(metadata);

‎main/src/androidTest/java/fake/SplitClientStub.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import io.split.android.client.EvaluationOptions;
1212
import io.split.android.client.SplitClient;
1313
import io.split.android.client.SplitResult;
14-
import io.split.android.client.events.SdkEventListener;
14+
import io.split.android.client.events.SplitEventListener;
1515
import io.split.android.client.events.SplitEvent;
1616
import io.split.android.client.events.SplitEventTask;
1717

@@ -122,7 +122,7 @@ public void on(SplitEvent event, SplitEventTask task) {
122122
}
123123

124124
@Override
125-
public void addEventListener(SdkEventListener listener) {
125+
public void addEventListener(SplitEventListener listener) {
126126
// Stub implementation - does nothing
127127
}
128128

‎main/src/androidTest/java/tests/integration/events/SdkEventsIntegrationTest.java‎

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77

88
import android.content.Context;
99

10-
import androidx.annotation.NonNull;
1110
import androidx.test.platform.app.InstrumentationRegistry;
1211

1312
import org.junit.After;
@@ -37,14 +36,13 @@
3736
import io.split.android.client.SplitClientConfig;
3837
import io.split.android.client.SplitFactory;
3938
import io.split.android.client.api.Key;
40-
import io.split.android.client.events.SdkEventListener;
39+
import io.split.android.client.events.SplitEventListener;
4140
import io.split.android.client.events.SdkReadyMetadata;
4241
import io.split.android.client.events.SdkUpdateMetadata;
4342
import io.split.android.client.events.SplitEvent;
4443
import io.split.android.client.events.SplitEventTask;
4544
import io.split.android.client.network.HttpMethod;
4645
import io.split.android.client.storage.db.GeneralInfoEntity;
47-
import io.split.android.client.storage.db.MyLargeSegmentEntity;
4846
import io.split.android.client.storage.db.MySegmentEntity;
4947
import io.split.android.client.storage.db.SplitEntity;
5048
import io.split.android.client.storage.db.SplitRoomDatabase;
@@ -246,7 +244,7 @@ public void sdkReadyListenerFiresWithMetadata() throws Exception {
246244
SplitClient client = factory.client(new Key("key_1"));
247245

248246
// And: a handler H is registered using addEventListener with onReady
249-
client.addEventListener(new SdkEventListener() {
247+
client.addEventListener(new SplitEventListener() {
250248
@Override
251249
public void onReady(SplitClient client, SdkReadyMetadata metadata) {
252250
onReadyCount.incrementAndGet();
@@ -297,7 +295,7 @@ public void sdkReadyListenerReplaysToLateSubscribers() throws Exception {
297295
AtomicReference<SdkReadyMetadata> receivedMetadata = new AtomicReference<>();
298296
CountDownLatch lateReadyLatch = new CountDownLatch(1);
299297

300-
fixture.client.addEventListener(new SdkEventListener() {
298+
fixture.client.addEventListener(new SplitEventListener() {
301299
@Override
302300
public void onReady(SplitClient client, SdkReadyMetadata metadata) {
303301
onReadyCount.incrementAndGet();
@@ -342,7 +340,7 @@ public void sdkReadyViewListenerFiresOnMainThread() throws Exception {
342340
SplitClient client = factory.client(new Key("key_1"));
343341

344342
// And: a handler H is registered using addEventListener with onReadyView
345-
client.addEventListener(new SdkEventListener() {
343+
client.addEventListener(new SplitEventListener() {
346344
@Override
347345
public void onReadyView(SplitClient client, SdkReadyMetadata metadata) {
348346
onReadyViewCount.incrementAndGet();
@@ -488,7 +486,7 @@ public void sdkUpdateEmittedOnlyAfterSdkReady() throws Exception {
488486
CountDownLatch updateLatch = new CountDownLatch(1);
489487

490488
// Register handlers BEFORE SDK_READY fires
491-
fixture.client.addEventListener(new SdkEventListener() {
489+
fixture.client.addEventListener(new SplitEventListener() {
492490
@Override
493491
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
494492
updateHandlerCount.incrementAndGet();
@@ -546,7 +544,7 @@ public void sdkUpdateFiresOnAnyDataChangeEventAfterSdkReady() throws Exception {
546544
AtomicReference<SdkUpdateMetadata> lastMetadata = new AtomicReference<>();
547545
CountDownLatch updateLatch = new CountDownLatch(1);
548546

549-
fixture.client.addEventListener(new SdkEventListener() {
547+
fixture.client.addEventListener(new SplitEventListener() {
550548
@Override
551549
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
552550
updateHandlerCount.incrementAndGet();
@@ -591,7 +589,7 @@ public void sdkUpdateDoesNotReplayToLateSubscribers() throws Exception {
591589
AtomicReference<CountDownLatch> secondUpdateLatchRef = new AtomicReference<>(null);
592590

593591
// And: a handler H1 is registered for sdkUpdate
594-
fixture.client.addEventListener(new SdkEventListener() {
592+
fixture.client.addEventListener(new SplitEventListener() {
595593
@Override
596594
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
597595
handler1Count.incrementAndGet();
@@ -620,7 +618,7 @@ public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
620618
CountDownLatch secondUpdateLatch = new CountDownLatch(2);
621619
secondUpdateLatchRef.set(secondUpdateLatch);
622620

623-
fixture.client.addEventListener(new SdkEventListener() {
621+
fixture.client.addEventListener(new SplitEventListener() {
624622
@Override
625623
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
626624
handler2Count.incrementAndGet();
@@ -872,7 +870,7 @@ public void handlersInvokedSequentiallyErrorsIsolated() throws Exception {
872870

873871
// Given: three handlers H1, H2 and H3 are registered for sdkUpdate in that order
874872
// And: H2 throws an exception when invoked
875-
fixture.client.addEventListener(new SdkEventListener() {
873+
fixture.client.addEventListener(new SplitEventListener() {
876874
@Override
877875
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
878876
handler1Count.incrementAndGet();
@@ -881,7 +879,7 @@ public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
881879
}
882880
});
883881

884-
fixture.client.addEventListener(new SdkEventListener() {
882+
fixture.client.addEventListener(new SplitEventListener() {
885883
@Override
886884
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
887885
handler2Count.incrementAndGet();
@@ -891,7 +889,7 @@ public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
891889
}
892890
});
893891

894-
fixture.client.addEventListener(new SdkEventListener() {
892+
fixture.client.addEventListener(new SplitEventListener() {
895893
@Override
896894
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
897895
handler3Count.incrementAndGet();
@@ -948,7 +946,7 @@ public void metadataCorrectlyPropagatedToHandlers() throws Exception {
948946
CountDownLatch updateLatch = new CountDownLatch(1);
949947

950948
// Given: a handler H is registered for sdkUpdate which inspects the received metadata
951-
fixture.client.addEventListener(new SdkEventListener() {
949+
fixture.client.addEventListener(new SplitEventListener() {
952950
@Override
953951
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
954952
updateHandlerCount.incrementAndGet();
@@ -1038,15 +1036,15 @@ public void sdkScopedEventsFanOutToMultipleClients() throws Exception {
10381036
CountDownLatch updateLatchB = new CountDownLatch(1);
10391037

10401038
// And: handlers HA and HB are registered for sdkUpdate
1041-
fixture.clientA.addEventListener(new SdkEventListener() {
1039+
fixture.clientA.addEventListener(new SplitEventListener() {
10421040
@Override
10431041
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
10441042
handlerACount.incrementAndGet();
10451043
updateLatchA.countDown();
10461044
}
10471045
});
10481046

1049-
fixture.clientB.addEventListener(new SdkEventListener() {
1047+
fixture.clientB.addEventListener(new SplitEventListener() {
10501048
@Override
10511049
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
10521050
handlerBCount.incrementAndGet();
@@ -1092,15 +1090,15 @@ public void clientScopedEventsDoNotFanOutToOtherClients() throws Exception {
10921090
CountDownLatch updateLatchB = new CountDownLatch(1);
10931091

10941092
// And: handlers HA and HB are registered for sdkUpdate
1095-
fixture.clientA.addEventListener(new SdkEventListener() {
1093+
fixture.clientA.addEventListener(new SplitEventListener() {
10961094
@Override
10971095
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
10981096
handlerACount.incrementAndGet();
10991097
updateLatchA.countDown();
11001098
}
11011099
});
11021100

1103-
fixture.clientB.addEventListener(new SdkEventListener() {
1101+
fixture.clientB.addEventListener(new SplitEventListener() {
11041102
@Override
11051103
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
11061104
handlerBCount.incrementAndGet();
@@ -1140,7 +1138,7 @@ public void sdkUpdateMetadataContainsTypeForFlagsUpdate() throws Exception {
11401138
AtomicReference<SdkUpdateMetadata> receivedMetadata = new AtomicReference<>();
11411139
CountDownLatch updateLatch = new CountDownLatch(1);
11421140

1143-
fixture.client.addEventListener(new SdkEventListener() {
1141+
fixture.client.addEventListener(new SplitEventListener() {
11441142
@Override
11451143
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
11461144
receivedMetadata.set(metadata);
@@ -1182,7 +1180,7 @@ public void sdkUpdateMetadataContainsTypeForSegmentsUpdate() throws Exception {
11821180
AtomicReference<SdkUpdateMetadata> receivedMetadata = new AtomicReference<>();
11831181
CountDownLatch updateLatch = new CountDownLatch(1);
11841182

1185-
fixture.client.addEventListener(new SdkEventListener() {
1183+
fixture.client.addEventListener(new SplitEventListener() {
11861184
@Override
11871185
public void onUpdate(SplitClient client, SdkUpdateMetadata metadata) {
11881186
receivedMetadata.set(metadata);
@@ -1285,7 +1283,7 @@ public void onPostExecution(SplitClient c) {
12851283
List<SdkUpdateMetadata> receivedMetadataList = new ArrayList<>();
12861284
CountDownLatch updateLatch = new CountDownLatch(1);
12871285

1288-
client.addEventListener(new SdkEventListener() {
1286+
client.addEventListener(new SplitEventListener() {
12891287
@Override
12901288
public void onUpdate(SplitClient c, SdkUpdateMetadata metadata) {
12911289
synchronized (receivedMetadataList) {
@@ -1470,7 +1468,7 @@ public void onPostExecution(SplitClient c) {
14701468
CountDownLatch updateLatch = new CountDownLatch(expectedEventCount * 2);
14711469

14721470
// Register new API handler (addEventListener)
1473-
client.addEventListener(new SdkEventListener() {
1471+
client.addEventListener(new SplitEventListener() {
14741472
@Override
14751473
public void onUpdate(SplitClient c, SdkUpdateMetadata metadata) {
14761474
synchronized (receivedMetadataList) {
@@ -1841,7 +1839,7 @@ private TwoClientFixture createTwoStreamingClientsAndWaitForReady(Key keyA, Key
18411839
private void registerCacheReadyHandler(SplitClient client, AtomicInteger count,
18421840
AtomicReference<SdkReadyMetadata> metadata,
18431841
CountDownLatch latch) {
1844-
client.addEventListener(new SdkEventListener() {
1842+
client.addEventListener(new SplitEventListener() {
18451843
@Override
18461844
public void onReadyFromCache(SplitClient client, SdkReadyMetadata eventMetadata) {
18471845
count.incrementAndGet();
@@ -1856,7 +1854,7 @@ public void onReadyFromCache(SplitClient client, SdkReadyMetadata eventMetadata)
18561854
*/
18571855
private void registerUpdateHandler(SplitClient client, AtomicInteger count,
18581856
AtomicReference<SdkUpdateMetadata> metadata) {
1859-
client.addEventListener(new SdkEventListener() {
1857+
client.addEventListener(new SplitEventListener() {
18601858
@Override
18611859
public void onUpdate(SplitClient client, SdkUpdateMetadata eventMetadata) {
18621860
count.incrementAndGet();
@@ -1881,10 +1879,10 @@ public void onPostExecution(SplitClient client) {
18811879
/**
18821880
* Creates a SdkEventListener that counts onReady invocations and captures metadata.
18831881
*/
1884-
private SdkEventListener createOnReadyListener(AtomicInteger count,
1885-
AtomicReference<SdkReadyMetadata> metadata,
1886-
CountDownLatch latch) {
1887-
return new SdkEventListener() {
1882+
private SplitEventListener createOnReadyListener(AtomicInteger count,
1883+
AtomicReference<SdkReadyMetadata> metadata,
1884+
CountDownLatch latch) {
1885+
return new SplitEventListener() {
18881886
@Override
18891887
public void onReady(SplitClient client, SdkReadyMetadata eventMetadata) {
18901888
if (count != null) count.incrementAndGet();
@@ -1897,10 +1895,10 @@ public void onReady(SplitClient client, SdkReadyMetadata eventMetadata) {
18971895
/**
18981896
* Creates a SdkEventListener that counts onUpdate invocations and captures metadata.
18991897
*/
1900-
private SdkEventListener createOnUpdateListener(AtomicInteger count,
1901-
AtomicReference<SdkUpdateMetadata> metadata,
1902-
CountDownLatch latch) {
1903-
return new SdkEventListener() {
1898+
private SplitEventListener createOnUpdateListener(AtomicInteger count,
1899+
AtomicReference<SdkUpdateMetadata> metadata,
1900+
CountDownLatch latch) {
1901+
return new SplitEventListener() {
19041902
@Override
19051903
public void onUpdate(SplitClient client, SdkUpdateMetadata eventMetadata) {
19061904
if (count != null) count.incrementAndGet();
@@ -1913,9 +1911,9 @@ public void onUpdate(SplitClient client, SdkUpdateMetadata eventMetadata) {
19131911
/**
19141912
* Creates a SdkEventListener with both onReady and onUpdate handlers.
19151913
*/
1916-
private SdkEventListener createDualListener(AtomicInteger readyCount, CountDownLatch readyLatch,
1917-
AtomicInteger updateCount, CountDownLatch updateLatch) {
1918-
return new SdkEventListener() {
1914+
private SplitEventListener createDualListener(AtomicInteger readyCount, CountDownLatch readyLatch,
1915+
AtomicInteger updateCount, CountDownLatch updateLatch) {
1916+
return new SplitEventListener() {
19191917
@Override
19201918
public void onReady(SplitClient client, SdkReadyMetadata metadata) {
19211919
if (readyCount != null) readyCount.incrementAndGet();

0 commit comments

Comments
 (0)