Skip to content

Commit 69959d4

Browse files
mnoman09NomanShoaib
mnoman09
and
NomanShoaib
authored
[FSSDK-8840]: Adds native Android implementation for ODP (#57)
* Adds native Android implementation for ODP --------- Co-authored-by: NomanShoaib <m.nomanshoaib09@gmail.com>
1 parent 9471ff0 commit 69959d4

File tree

9 files changed

+267
-19
lines changed

9 files changed

+267
-19
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Refer to the [Flutter SDK's developer documentation](https://docs.developers.opt
2121

2222
See the [pubspec.yaml](https://github.com/optimizely/optimizely-flutter-sdk/blob/master/pubspec.yaml) file for Flutter version requirements.
2323

24-
On the Android platform, the SDK requires a minimum SDK version of 14 or higher and compile SDK version of 32.
24+
On the Android platform, the SDK requires a minimum SDK version of 21 or higher and compile SDK version of 32.
2525

2626
On the iOS platform, the SDK requires a minimum version of 10.0.
2727

‎android/build.gradle‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ apply plugin: 'com.android.library'
3434
ext {
3535
compile_sdk_version = 32
3636
build_tools_version = "30.0.3"
37-
min_sdk_version = 14
37+
min_sdk_version = 21
3838
target_sdk_version = 29
3939
}
4040

@@ -77,7 +77,7 @@ dependencies {
7777
implementation 'com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava'
7878
implementation group: 'org.slf4j', name: 'slf4j-android', version: '1.7.25'
7979
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10"
80-
implementation "com.optimizely.ab:android-sdk:3.13.2"
80+
implementation "com.optimizely.ab:android-sdk:4.0.0-beta2"
8181
implementation 'com.fasterxml.jackson.core:jackson-databind:2.9.8'
8282
implementation ('com.google.guava:guava:19.0') {
8383
exclude group:'com.google.guava', module:'listenablefuture'

‎android/src/main/java/com/optimizely/optimizely_flutter_sdk/OptimizelyFlutterClient.java‎

Lines changed: 151 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/****************************************************************************
2-
* Copyright 2022, Optimizely, Inc. and contributors *
2+
* Copyright 2022-2023, Optimizely, Inc. and contributors *
33
* *
44
* Licensed under the Apache License, Version 2.0 (the "License"); *
55
* you may not use this file except in compliance with the License. *
@@ -46,13 +46,19 @@
4646
import com.optimizely.ab.notification.NotificationCenter;
4747
import com.optimizely.ab.notification.TrackNotification;
4848
import com.optimizely.ab.notification.UpdateConfigNotification;
49+
import com.optimizely.ab.odp.ODPSegmentOption;
4950
import com.optimizely.ab.optimizelyconfig.OptimizelyConfig;
5051
import com.optimizely.ab.optimizelydecision.OptimizelyDecideOption;
5152
import com.optimizely.ab.optimizelydecision.OptimizelyDecision;
5253
import com.optimizely.optimizely_flutter_sdk.helper_classes.ArgumentsParser;
5354
import com.optimizely.optimizely_flutter_sdk.helper_classes.Utils;
5455

5556
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Constants.*;
57+
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Constants.RequestParameterKey.DISABLE_ODP;
58+
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Constants.RequestParameterKey.SEGMENTS_CACHE_SIZE;
59+
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Constants.RequestParameterKey.SEGMENTS_CACHE_TIMEOUT_IN_SECONDS;
60+
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Constants.RequestParameterKey.TIMEOUT_FOR_ODP_EVENT_IN_SECONDS;
61+
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Constants.RequestParameterKey.TIMEOUT_FOR_SEGMENT_FETCH_IN_SECONDS;
5662
import static com.optimizely.optimizely_flutter_sdk.helper_classes.Utils.getNotificationListenerType;
5763

5864
import java.util.Collections;
@@ -127,16 +133,48 @@ protected void initializeOptimizely(@NonNull ArgumentsParser argumentsParser, @N
127133
notificationIdsTracker.remove(sdkKey);
128134

129135
List<OptimizelyDecideOption> defaultDecideOptions = argumentsParser.getDecideOptions();
136+
137+
// SDK Settings Default Values
138+
int segmentsCacheSize = 100;
139+
int segmentsCacheTimeoutInSecs = 600;
140+
int timeoutForSegmentFetchInSecs = 10;
141+
int timeoutForOdpEventInSecs = 10;
142+
boolean disableOdp = false;
143+
Map<String, Object> sdkSettings = argumentsParser.getOptimizelySdkSettings();
144+
if (sdkSettings != null) {
145+
if (sdkSettings.containsKey(SEGMENTS_CACHE_SIZE)) {
146+
segmentsCacheSize = (Integer) sdkSettings.get(SEGMENTS_CACHE_SIZE);
147+
}
148+
if (sdkSettings.containsKey(SEGMENTS_CACHE_TIMEOUT_IN_SECONDS)) {
149+
segmentsCacheTimeoutInSecs = (Integer) sdkSettings.get(SEGMENTS_CACHE_TIMEOUT_IN_SECONDS);
150+
}
151+
if (sdkSettings.containsKey(TIMEOUT_FOR_SEGMENT_FETCH_IN_SECONDS)) {
152+
timeoutForSegmentFetchInSecs = (Integer) sdkSettings.get(TIMEOUT_FOR_SEGMENT_FETCH_IN_SECONDS);
153+
}
154+
if (sdkSettings.containsKey(TIMEOUT_FOR_ODP_EVENT_IN_SECONDS)) {
155+
timeoutForOdpEventInSecs = (Integer) sdkSettings.get(TIMEOUT_FOR_ODP_EVENT_IN_SECONDS);
156+
}
157+
if (sdkSettings.containsKey(DISABLE_ODP)) {
158+
disableOdp = (boolean) sdkSettings.get(DISABLE_ODP);
159+
}
160+
}
130161
// Creating new instance
131-
OptimizelyManager optimizelyManager = OptimizelyManager.builder()
162+
OptimizelyManager.Builder optimizelyManagerBuilder = OptimizelyManager.builder()
132163
.withEventProcessor(batchProcessor)
133164
.withEventHandler(eventHandler)
134165
.withNotificationCenter(notificationCenter)
135166
.withDatafileDownloadInterval(datafilePeriodicDownloadInterval, TimeUnit.SECONDS)
136167
.withErrorHandler(new RaiseExceptionErrorHandler())
137168
.withDefaultDecideOptions(defaultDecideOptions)
138-
.withSDKKey(sdkKey)
139-
.build(context);
169+
.withODPSegmentCacheSize(segmentsCacheSize)
170+
.withODPSegmentCacheTimeout(segmentsCacheTimeoutInSecs, TimeUnit.SECONDS)
171+
.withTimeoutForODPSegmentFetch(timeoutForSegmentFetchInSecs)
172+
.withTimeoutForODPEventDispatch(timeoutForOdpEventInSecs)
173+
.withSDKKey(sdkKey);
174+
if (disableOdp) {
175+
optimizelyManagerBuilder.withODPDisabled();
176+
}
177+
OptimizelyManager optimizelyManager = optimizelyManagerBuilder.build(context);
140178

141179
optimizelyManager.initialize(context, null, (OptimizelyClient client) -> {
142180
if (client.isValid()) {
@@ -158,14 +196,14 @@ protected void createUserContext(ArgumentsParser argumentsParser, @NonNull Resul
158196

159197
String userId = argumentsParser.getUserId();
160198
Map<String, Object> attributes = argumentsParser.getAttributes();
161-
if (userId == null) {
162-
result.success(createResponse(ErrorMessage.INVALID_PARAMS));
163-
return;
164-
}
165199
try {
166200
String userContextId = Utils.getRandomUUID();
167-
168-
OptimizelyUserContext optlyUserContext = optimizelyClient.createUserContext(userId, attributes);
201+
OptimizelyUserContext optlyUserContext;
202+
if (userId != null) {
203+
optlyUserContext = optimizelyClient.createUserContext(userId, attributes);
204+
} else {
205+
optlyUserContext = optimizelyClient.createUserContext(attributes);
206+
}
169207
if (optlyUserContext != null) {
170208
if (userContextsTracker.containsKey(sdkKey)) {
171209
userContextsTracker.get(sdkKey).put(userContextId, optlyUserContext);
@@ -390,6 +428,109 @@ protected void removeAllForcedDecisions(ArgumentsParser argumentsParser, @NonNul
390428
result.success(createResponse());
391429
}
392430

431+
/// Returns an array of segments that the user is qualified for.
432+
protected void getQualifiedSegments(ArgumentsParser argumentsParser, @NonNull Result result) {
433+
String sdkKey = argumentsParser.getSdkKey();
434+
OptimizelyUserContext userContext = getUserContext(argumentsParser);
435+
if (!isUserContextValid(sdkKey, userContext, result)) {
436+
return;
437+
}
438+
List<String> qualifiedSegments = userContext.getQualifiedSegments();
439+
if (qualifiedSegments != null) {
440+
result.success(createResponse(Collections.singletonMap(RequestParameterKey.QUALIFIED_SEGMENTS, qualifiedSegments)));
441+
} else {
442+
result.success(createResponse(ErrorMessage.QUALIFIED_SEGMENTS_NOT_FOUND));
443+
}
444+
}
445+
446+
/// Sets qualified segments for the user context.
447+
protected void setQualifiedSegments(ArgumentsParser argumentsParser, @NonNull Result result) {
448+
String sdkKey = argumentsParser.getSdkKey();
449+
OptimizelyUserContext userContext = getUserContext(argumentsParser);
450+
if (!isUserContextValid(sdkKey, userContext, result)) {
451+
return;
452+
}
453+
List<String> qualifiedSegments = argumentsParser.getQualifiedSegments();
454+
if (qualifiedSegments == null) {
455+
result.success(createResponse(ErrorMessage.INVALID_PARAMS));
456+
return;
457+
}
458+
userContext.setQualifiedSegments(qualifiedSegments);
459+
result.success(createResponse());
460+
}
461+
462+
/// Returns the device vuid.
463+
protected void getVuid(ArgumentsParser argumentsParser, @NonNull Result result) {
464+
String sdkKey = argumentsParser.getSdkKey();
465+
OptimizelyClient optimizelyClient = getOptimizelyClient(sdkKey);
466+
if (!isOptimizelyClientValid(sdkKey, optimizelyClient, result)) {
467+
return;
468+
}
469+
result.success(createResponse(true, Collections.singletonMap(RequestParameterKey.VUID, optimizelyClient.getVuid()), ""));
470+
}
471+
472+
/// Checks if the user is qualified for the given segment.
473+
protected void isQualifiedFor(ArgumentsParser argumentsParser, @NonNull Result result) {
474+
String sdkKey = argumentsParser.getSdkKey();
475+
OptimizelyUserContext userContext = getUserContext(argumentsParser);
476+
if (!isUserContextValid(sdkKey, userContext, result)) {
477+
return;
478+
}
479+
String segment = argumentsParser.getSegment();
480+
if (segment == null) {
481+
result.success(createResponse(ErrorMessage.INVALID_PARAMS));
482+
return;
483+
}
484+
485+
result.success(createResponse(userContext.isQualifiedFor(segment)));
486+
}
487+
488+
/// Send an event to the ODP server.
489+
protected void sendODPEvent(ArgumentsParser argumentsParser, @NonNull Result result) {
490+
String sdkKey = argumentsParser.getSdkKey();
491+
OptimizelyClient optimizelyClient = getOptimizelyClient(sdkKey);
492+
if (!isOptimizelyClientValid(sdkKey, optimizelyClient, result)) {
493+
return;
494+
}
495+
String action = argumentsParser.getAction();
496+
if (action == null || action.isEmpty()) {
497+
result.success(createResponse(ErrorMessage.INVALID_PARAMS));
498+
return;
499+
}
500+
501+
String type = argumentsParser.getType();
502+
Map<String, String> identifiers = argumentsParser.getIdentifiers();
503+
if (identifiers == null) {
504+
identifiers = new HashMap<>();
505+
}
506+
Map<String, Object> data = argumentsParser.getData();
507+
if (data == null) {
508+
data = new HashMap<>();
509+
}
510+
511+
optimizelyClient.sendODPEvent(type, action, identifiers, data);
512+
result.success(createResponse());
513+
}
514+
515+
/// Fetch all qualified segments for the user context.
516+
protected void fetchQualifiedSegments(ArgumentsParser argumentsParser, @NonNull Result result) {
517+
String sdkKey = argumentsParser.getSdkKey();
518+
OptimizelyUserContext userContext = getUserContext(argumentsParser);
519+
if (!isUserContextValid(sdkKey, userContext, result)) {
520+
return;
521+
}
522+
List<ODPSegmentOption> segmentOptions = argumentsParser.getSegmentOptions();
523+
524+
try {
525+
userContext.fetchQualifiedSegments((fetchQualifiedResult) -> {
526+
result.success(createResponse(fetchQualifiedResult));
527+
},segmentOptions);
528+
529+
} catch (Exception ex) {
530+
result.success(createResponse(ex.getMessage()));
531+
}
532+
}
533+
393534
protected void close(ArgumentsParser argumentsParser, @NonNull Result result) {
394535
String sdkKey = argumentsParser.getSdkKey();
395536
OptimizelyClient optimizelyClient = getOptimizelyClient(sdkKey);

‎android/src/main/java/com/optimizely/optimizely_flutter_sdk/OptimizelyFlutterSdkPlugin.java‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/****************************************************************************
2-
* Copyright 2022, Optimizely, Inc. and contributors *
2+
* Copyright 2022-2023, Optimizely, Inc. and contributors *
33
* *
44
* Licensed under the Apache License, Version 2.0 (the "License"); *
55
* you may not use this file except in compliance with the License. *
@@ -119,6 +119,30 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
119119
removeAllForcedDecisions(argumentsParser, result);
120120
break;
121121
}
122+
case APIs.GET_QUALIFIED_SEGMENTS: {
123+
getQualifiedSegments(argumentsParser, result);
124+
break;
125+
}
126+
case APIs.SET_QUALIFIED_SEGMENTS: {
127+
setQualifiedSegments(argumentsParser, result);
128+
break;
129+
}
130+
case APIs.GET_VUID: {
131+
getVuid(argumentsParser, result);
132+
break;
133+
}
134+
case APIs.IS_QUALIFIED_FOR: {
135+
isQualifiedFor(argumentsParser, result);
136+
break;
137+
}
138+
case APIs.SEND_ODP_EVENT: {
139+
sendODPEvent(argumentsParser, result);
140+
break;
141+
}
142+
case APIs.FETCH_QUALIFIED_SEGMENTS: {
143+
fetchQualifiedSegments(argumentsParser, result);
144+
break;
145+
}
122146
case APIs.CLOSE: {
123147
close(argumentsParser, result);
124148
break;

‎android/src/main/java/com/optimizely/optimizely_flutter_sdk/helper_classes/ArgumentsParser.java‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/****************************************************************************
2-
* Copyright 2022, Optimizely, Inc. and contributors *
2+
* Copyright 2022-2023, Optimizely, Inc. and contributors *
33
* *
44
* Licensed under the Apache License, Version 2.0 (the "License"); *
55
* you may not use this file except in compliance with the License. *
@@ -15,6 +15,7 @@
1515
***************************************************************************/
1616
package com.optimizely.optimizely_flutter_sdk.helper_classes;
1717

18+
import com.optimizely.ab.odp.ODPSegmentOption;
1819
import com.optimizely.ab.optimizelydecision.OptimizelyDecideOption;
1920

2021
import java.util.List;
@@ -110,4 +111,36 @@ public String getDatafileHostPrefix() {
110111
public String getExperimentKey() {
111112
return (String) arguments.get(Constants.RequestParameterKey.EXPERIMENT_KEY);
112113
}
114+
115+
public List<String> getQualifiedSegments() {
116+
return (List<String>) arguments.get(Constants.RequestParameterKey.QUALIFIED_SEGMENTS);
117+
}
118+
119+
public String getSegment() {
120+
return (String) arguments.get(Constants.RequestParameterKey.SEGMENT);
121+
}
122+
123+
public String getAction() {
124+
return (String) arguments.get(Constants.RequestParameterKey.ACTION);
125+
}
126+
127+
public String getType() {
128+
return (String) arguments.get(Constants.RequestParameterKey.ODP_EVENT_TYPE);
129+
}
130+
131+
public Map<String, String> getIdentifiers() {
132+
return (Map<String, String>) arguments.get(Constants.RequestParameterKey.IDENTIFIERS);
133+
}
134+
135+
public Map<String, Object> getData() {
136+
return (Map<String, Object>) arguments.get(Constants.RequestParameterKey.DATA);
137+
}
138+
139+
public List<ODPSegmentOption> getSegmentOptions() {
140+
return Utils.getSegmentOptions((List<String>) arguments.get(Constants.RequestParameterKey.OPTIMIZELY_SEGMENT_OPTION));
141+
}
142+
143+
public Map<String, Object> getOptimizelySdkSettings() {
144+
return (Map<String, Object>) arguments.get(Constants.RequestParameterKey.OPTIMIZELY_SDK_SETTINGS);
145+
}
113146
}

‎android/src/main/java/com/optimizely/optimizely_flutter_sdk/helper_classes/Constants.java‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/****************************************************************************
2-
* Copyright 2022, Optimizely, Inc. and contributors *
2+
* Copyright 2022-2023, Optimizely, Inc. and contributors *
33
* *
44
* Licensed under the Apache License, Version 2.0 (the "License"); *
55
* you may not use this file except in compliance with the License. *
@@ -38,6 +38,14 @@ public static class APIs {
3838
public static final String REMOVE_NOTIFICATION_LISTENER = "removeNotificationListener";
3939
public static final String CLEAR_ALL_NOTIFICATION_LISTENERS = "clearAllNotificationListeners";
4040
public static final String CLEAR_NOTIFICATION_LISTENERS = "clearNotificationListeners";
41+
42+
// ODP APIs constants
43+
public static final String SEND_ODP_EVENT = "sendOdpEvent";
44+
public static final String GET_VUID = "getVuid";
45+
public static final String GET_QUALIFIED_SEGMENTS = "getQualifiedSegments";
46+
public static final String SET_QUALIFIED_SEGMENTS = "setQualifiedSegments";
47+
public static final String IS_QUALIFIED_FOR = "isQualifiedFor";
48+
public static final String FETCH_QUALIFIED_SEGMENTS = "fetchQualifiedSegments";
4149
}
4250

4351
public static class NotificationType {
@@ -71,6 +79,21 @@ public static class RequestParameterKey {
7179
public static final String VARIATION_KEY = "variationKey";
7280
public static final String DATAFILE_HOST_PREFIX = "datafileHostPrefix";
7381
public static final String DATAFILE_HOST_SUFFIX = "datafileHostSuffix";
82+
83+
public static final String VUID = "vuid";
84+
public static final String QUALIFIED_SEGMENTS = "qualifiedSegments";
85+
public static final String SEGMENT = "segment";
86+
public static final String ACTION = "action";
87+
public static final String IDENTIFIERS = "identifiers";
88+
public static final String DATA = "data";
89+
public static final String ODP_EVENT_TYPE = "type";
90+
public static final String OPTIMIZELY_SEGMENT_OPTION = "optimizelySegmentOption";
91+
public static final String OPTIMIZELY_SDK_SETTINGS = "optimizelySdkSettings";
92+
public static final String SEGMENTS_CACHE_SIZE = "segmentsCacheSize";
93+
public static final String SEGMENTS_CACHE_TIMEOUT_IN_SECONDS = "segmentsCacheTimeoutInSecs";
94+
public static final String TIMEOUT_FOR_SEGMENT_FETCH_IN_SECONDS = "timeoutForSegmentFetchInSecs";
95+
public static final String TIMEOUT_FOR_ODP_EVENT_IN_SECONDS = "timeoutForOdpEventInSecs";
96+
public static final String DISABLE_ODP = "disableOdp";
7497
}
7598

7699
public static class ErrorMessage {
@@ -80,6 +103,7 @@ public static class ErrorMessage {
80103
public static final String OPTIMIZELY_CLIENT_NOT_FOUND = "Optimizely client not found.";
81104
public static final String USER_CONTEXT_NOT_FOUND = "User context not found.";
82105
public static final String USER_CONTEXT_NOT_CREATED = "User context not created.";
106+
public static final String QUALIFIED_SEGMENTS_NOT_FOUND = "Qualified Segments not found.";
83107
}
84108

85109
public static class DecisionListenerKeys {
@@ -124,4 +148,9 @@ public static class DecideOption {
124148
public static final String INCLUDE_REASONS = "includeReasons";
125149
public static final String EXCLUDE_VARIABLES = "excludeVariables";
126150
}
151+
152+
public static class SegmentOption {
153+
public static final String IGNORE_CACHE = "ignoreCache";
154+
public static final String RESET_CACHE = "resetCache";
155+
}
127156
}

0 commit comments

Comments
 (0)