Skip to content

Commit 66400f3

Browse files
yasirfolio3yasirfolio3
authored
[FSSDK-9029]: Adds Top-level ODP Interface. (#50)
* Adding support for sendOdpEvent, SdkSettings and getVuid. * 1. Adding odp api's to user context. 2. Adding new unit tests.
1 parent e8e0b91 commit 66400f3

File tree

10 files changed

+550
-49
lines changed

10 files changed

+550
-49
lines changed

‎example/lib/main.dart‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ class _MyAppState extends State<MyApp> {
4343
var randomUserName = "${rng.nextInt(1000)}";
4444

4545
// Create user context
46-
var userContext = await flutterSDK.createUserContext(randomUserName);
46+
var userContext =
47+
await flutterSDK.createUserContext(userId: randomUserName);
4748

4849
// Set attributes
4950
response = await userContext!.setAttributes({

‎lib/optimizely_flutter_sdk.dart‎

Lines changed: 47 additions & 17 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. *
@@ -21,6 +21,8 @@ import 'package:optimizely_flutter_sdk/src/data_objects/activate_response.dart';
2121
import 'package:optimizely_flutter_sdk/src/data_objects/base_response.dart';
2222
import 'package:optimizely_flutter_sdk/src/data_objects/datafile_options.dart';
2323
import 'package:optimizely_flutter_sdk/src/data_objects/event_options.dart';
24+
import 'package:optimizely_flutter_sdk/src/data_objects/get_vuid_response.dart';
25+
import 'package:optimizely_flutter_sdk/src/data_objects/sdk_settings.dart';
2426
import 'package:optimizely_flutter_sdk/src/data_objects/get_variation_response.dart';
2527
import 'package:optimizely_flutter_sdk/src/data_objects/optimizely_config_response.dart';
2628
import 'package:optimizely_flutter_sdk/src/optimizely_client_wrapper.dart';
@@ -33,7 +35,7 @@ export 'package:optimizely_flutter_sdk/src/user_context/optimizely_forced_decisi
3335
export 'package:optimizely_flutter_sdk/src/user_context/optimizely_decision_context.dart'
3436
show OptimizelyDecisionContext;
3537
export 'package:optimizely_flutter_sdk/src/user_context/optimizely_user_context.dart'
36-
show OptimizelyUserContext, OptimizelyDecideOption;
38+
show OptimizelyUserContext, OptimizelyDecideOption, OptimizelySegmentOption;
3739
export 'package:optimizely_flutter_sdk/src/data_objects/decide_response.dart'
3840
show Decision;
3941
export 'package:optimizely_flutter_sdk/src/data_objects/track_listener_response.dart'
@@ -44,6 +46,8 @@ export 'package:optimizely_flutter_sdk/src/data_objects/logevent_listener_respon
4446
show LogEventListenerResponse;
4547
export 'package:optimizely_flutter_sdk/src/data_objects/event_options.dart'
4648
show EventOptions;
49+
export 'package:optimizely_flutter_sdk/src/data_objects/sdk_settings.dart'
50+
show SDKSettings;
4751
export 'package:optimizely_flutter_sdk/src/data_objects/datafile_options.dart'
4852
show DatafileHostOptions;
4953

@@ -59,17 +63,19 @@ class OptimizelyFlutterSdk {
5963
final int _datafilePeriodicDownloadInterval;
6064
final Map<ClientPlatform, DatafileHostOptions> _datafileHostOptions;
6165
final Set<OptimizelyDecideOption> _defaultDecideOptions;
62-
OptimizelyFlutterSdk(
63-
this._sdkKey, {
64-
EventOptions eventOptions = const EventOptions(),
65-
int datafilePeriodicDownloadInterval =
66-
10 * 60, // Default time interval in seconds
67-
Map<ClientPlatform, DatafileHostOptions> datafileHostOptions = const {},
68-
Set<OptimizelyDecideOption> defaultDecideOptions = const {},
69-
}) : _eventOptions = eventOptions,
66+
final SDKSettings _sdkSettings;
67+
OptimizelyFlutterSdk(this._sdkKey,
68+
{EventOptions eventOptions = const EventOptions(),
69+
int datafilePeriodicDownloadInterval =
70+
10 * 60, // Default time interval in seconds
71+
Map<ClientPlatform, DatafileHostOptions> datafileHostOptions = const {},
72+
Set<OptimizelyDecideOption> defaultDecideOptions = const {},
73+
SDKSettings sdkSettings = const SDKSettings()})
74+
: _eventOptions = eventOptions,
7075
_datafilePeriodicDownloadInterval = datafilePeriodicDownloadInterval,
7176
_datafileHostOptions = datafileHostOptions,
72-
_defaultDecideOptions = defaultDecideOptions;
77+
_defaultDecideOptions = defaultDecideOptions,
78+
_sdkSettings = sdkSettings;
7379

7480
/// Starts Optimizely SDK (Synchronous) with provided sdkKey.
7581
Future<BaseResponse> initializeClient() async {
@@ -78,7 +84,8 @@ class OptimizelyFlutterSdk {
7884
_eventOptions,
7985
_datafilePeriodicDownloadInterval,
8086
_datafileHostOptions,
81-
_defaultDecideOptions);
87+
_defaultDecideOptions,
88+
_sdkSettings);
8289
}
8390

8491
/// Use the activate method to start an experiment.
@@ -140,17 +147,40 @@ class OptimizelyFlutterSdk {
140147
return await OptimizelyClientWrapper.getOptimizelyConfig(_sdkKey);
141148
}
142149

150+
/// Send an event to the ODP server.
151+
///
152+
/// Takes [action] The event action name.
153+
/// Optional [type] The event type (default = "fullstack").
154+
/// Optional [identifiers] A dictionary for identifiers.
155+
/// Optional [data] A dictionary for associated data. The default event data will be added to this data before sending to the ODP server.
156+
/// Returns [BaseResponse] A object containing success result or reason of failure.
157+
Future<BaseResponse> sendOdpEvent(String action,
158+
{String? type,
159+
Map<String, String> identifiers = const {},
160+
Map<String, dynamic> data = const {}}) async {
161+
return await OptimizelyClientWrapper.sendOdpEvent(_sdkKey, action,
162+
type: type, identifiers: identifiers, data: data);
163+
}
164+
165+
/// Returns the device vuid.
166+
///
167+
/// Returns [GetVuidResponse] A object containing device vuid
168+
Future<GetVuidResponse> getVuid() async {
169+
return await OptimizelyClientWrapper.getVuid(_sdkKey);
170+
}
171+
143172
/// Creates a context of the user for which decision APIs will be called.
144173
///
145174
/// NOTE: A user context will only be created successfully when the SDK is fully configured using initializeClient.
146175
///
147-
/// Takes [userId] the [String] user ID to be used for bucketing.
176+
/// Optional [userId] the [String] user ID to be used for bucketing.
177+
/// The device vuid will be used as an userId when userId is not provided.
148178
/// Takes [attributes] An Optional [Map] of attribute names to current user attribute values.
149179
/// Returns An [OptimizelyUserContext] associated with this OptimizelyClient.
150-
Future<OptimizelyUserContext?> createUserContext(String userId,
151-
[Map<String, dynamic> attributes = const {}]) async {
152-
return await OptimizelyClientWrapper.createUserContext(
153-
_sdkKey, userId, attributes);
180+
Future<OptimizelyUserContext?> createUserContext(
181+
{String? userId, Map<String, dynamic> attributes = const {}}) async {
182+
return await OptimizelyClientWrapper.createUserContext(_sdkKey,
183+
userId: userId, attributes: attributes);
154184
}
155185

156186
/// Allows user to remove notification listener using id.

‎lib/src/data_objects/get_qualified_segments_response.dart‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/// **************************************************************************
2+
/// Copyright 2023, Optimizely, Inc. and contributors *
3+
/// *
4+
/// Licensed under the Apache License, Version 2.0 (the "License"); *
5+
/// you may not use this file except in compliance with the License. *
6+
/// You may obtain a copy of the License at *
7+
/// *
8+
/// http://www.apache.org/licenses/LICENSE-2.0 *
9+
/// *
10+
/// Unless required by applicable law or agreed to in writing, software *
11+
/// distributed under the License is distributed on an "AS IS" BASIS, *
12+
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13+
/// See the License for the specific language governing permissions and *
14+
/// limitations under the License. *
15+
///**************************************************************************/
16+
17+
import 'package:optimizely_flutter_sdk/src/data_objects/base_response.dart';
18+
import 'package:optimizely_flutter_sdk/src/utils/constants.dart';
19+
20+
class GetQualifiedSegmentsResponse extends BaseResponse {
21+
List<String> qualifiedSegments = [];
22+
23+
GetQualifiedSegmentsResponse(Map<String, dynamic> json) : super(json) {
24+
if (json[Constants.responseResult] is Map<dynamic, dynamic>) {
25+
var response = Map<String, dynamic>.from(json[Constants.responseResult]);
26+
if (response[Constants.qualifiedSegments] is List<dynamic>) {
27+
qualifiedSegments =
28+
List<String>.from(response[Constants.qualifiedSegments]);
29+
}
30+
}
31+
}
32+
}

‎lib/src/data_objects/get_vuid_response.dart‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/// **************************************************************************
2+
/// Copyright 2023, Optimizely, Inc. and contributors *
3+
/// *
4+
/// Licensed under the Apache License, Version 2.0 (the "License"); *
5+
/// you may not use this file except in compliance with the License. *
6+
/// You may obtain a copy of the License at *
7+
/// *
8+
/// http://www.apache.org/licenses/LICENSE-2.0 *
9+
/// *
10+
/// Unless required by applicable law or agreed to in writing, software *
11+
/// distributed under the License is distributed on an "AS IS" BASIS, *
12+
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13+
/// See the License for the specific language governing permissions and *
14+
/// limitations under the License. *
15+
///**************************************************************************/
16+
17+
import 'package:optimizely_flutter_sdk/src/data_objects/base_response.dart';
18+
import 'package:optimizely_flutter_sdk/src/utils/constants.dart';
19+
20+
class GetVuidResponse extends BaseResponse {
21+
String vuid = "";
22+
23+
GetVuidResponse(Map<String, dynamic> json) : super(json) {
24+
if (json[Constants.responseResult] is Map<dynamic, dynamic>) {
25+
var response = Map<String, dynamic>.from(json[Constants.responseResult]);
26+
if (response[Constants.vuid] is String) {
27+
vuid = response[Constants.vuid];
28+
}
29+
}
30+
}
31+
}

‎lib/src/data_objects/sdk_settings.dart‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/// **************************************************************************
2+
/// Copyright 2023, Optimizely, Inc. and contributors *
3+
/// *
4+
/// Licensed under the Apache License, Version 2.0 (the "License"); *
5+
/// you may not use this file except in compliance with the License. *
6+
/// You may obtain a copy of the License at *
7+
/// *
8+
/// http://www.apache.org/licenses/LICENSE-2.0 *
9+
/// *
10+
/// Unless required by applicable law or agreed to in writing, software *
11+
/// distributed under the License is distributed on an "AS IS" BASIS, *
12+
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13+
/// See the License for the specific language governing permissions and *
14+
/// limitations under the License. *
15+
///**************************************************************************/
16+
17+
class SDKSettings {
18+
// The maximum size of audience segments cache (optional. default = 100). Set to zero to disable caching.
19+
final int segmentsCacheSize;
20+
// The timeout in seconds of audience segments cache (optional. default = 600). Set to zero to disable timeout.
21+
final int segmentsCacheTimeoutInSecs;
22+
// The timeout in seconds of odp segment fetch (optional. default = 10) - OS default timeout will be used if this is set to zero.
23+
final int timeoutForSegmentFetchInSecs;
24+
// The timeout in seconds of odp event dispatch (optional. default = 10) - OS default timeout will be used if this is set to zero.
25+
final int timeoutForOdpEventInSecs;
26+
// Set this flag to true (default = false) to disable ODP features
27+
final bool disableOdp;
28+
29+
const SDKSettings({
30+
this.segmentsCacheSize = 100, // Default segmentsCacheSize
31+
this.segmentsCacheTimeoutInSecs = 600, // Default segmentsCacheTimeoutInSecs
32+
this.timeoutForSegmentFetchInSecs =
33+
10, // Default timeoutForSegmentFetchInSecs
34+
this.timeoutForOdpEventInSecs = 10, // Default timeoutForOdpEventInSecs
35+
this.disableOdp = false, // Default disableOdp
36+
});
37+
}

‎lib/src/optimizely_client_wrapper.dart‎

Lines changed: 54 additions & 9 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. *
@@ -22,6 +22,7 @@ import 'package:optimizely_flutter_sdk/src/data_objects/activate_listener_respon
2222
import 'package:optimizely_flutter_sdk/src/data_objects/activate_response.dart';
2323
import 'package:optimizely_flutter_sdk/src/data_objects/base_response.dart';
2424
import 'package:optimizely_flutter_sdk/src/data_objects/get_variation_response.dart';
25+
import 'package:optimizely_flutter_sdk/src/data_objects/get_vuid_response.dart';
2526
import 'package:optimizely_flutter_sdk/src/data_objects/optimizely_config_response.dart';
2627
import 'package:optimizely_flutter_sdk/src/utils/constants.dart';
2728
import 'package:optimizely_flutter_sdk/src/utils/utils.dart';
@@ -59,7 +60,8 @@ class OptimizelyClientWrapper {
5960
EventOptions eventOptions,
6061
int datafilePeriodicDownloadInterval,
6162
Map<ClientPlatform, DatafileHostOptions> datafileHostOptions,
62-
Set<OptimizelyDecideOption> defaultDecideOptions) async {
63+
Set<OptimizelyDecideOption> defaultDecideOptions,
64+
SDKSettings sdkSettings) async {
6365
_channel.setMethodCallHandler(methodCallHandler);
6466
final convertedOptions = Utils.convertDecideOptions(defaultDecideOptions);
6567
Map<String, dynamic> requestDict = {
@@ -72,6 +74,18 @@ class OptimizelyClientWrapper {
7274
Constants.eventMaxQueueSize: eventOptions.maxQueueSize,
7375
};
7476

77+
// Odp Request params
78+
Map<String, dynamic> optimizelySdkSettings = {
79+
Constants.segmentsCacheSize: sdkSettings.segmentsCacheSize,
80+
Constants.segmentsCacheTimeoutInSecs:
81+
sdkSettings.segmentsCacheTimeoutInSecs,
82+
Constants.timeoutForSegmentFetchInSecs:
83+
sdkSettings.timeoutForSegmentFetchInSecs,
84+
Constants.timeoutForOdpEventInSecs: sdkSettings.timeoutForOdpEventInSecs,
85+
Constants.disableOdp: sdkSettings.disableOdp,
86+
};
87+
requestDict[Constants.optimizelySdkSettings] = optimizelySdkSettings;
88+
7589
// clearing notification listeners, if they are mapped to the same sdkKey.
7690
activateCallbacksById.remove(sdkKey);
7791
decisionCallbacksById.remove(sdkKey);
@@ -164,6 +178,35 @@ class OptimizelyClientWrapper {
164178
return OptimizelyConfigResponse(result);
165179
}
166180

181+
/// Send an event to the ODP server.
182+
static Future<BaseResponse> sendOdpEvent(String sdkKey, String action,
183+
{String? type,
184+
Map<String, String> identifiers = const {},
185+
Map<String, dynamic> data = const {}}) async {
186+
Map<String, dynamic> request = {
187+
Constants.sdkKey: sdkKey,
188+
Constants.action: action,
189+
Constants.identifiers: identifiers,
190+
Constants.data: Utils.convertToTypedMap(data)
191+
};
192+
if (type != null) {
193+
request[Constants.type] = type;
194+
}
195+
196+
final result = Map<String, dynamic>.from(
197+
await _channel.invokeMethod(Constants.sendOdpEventMethod, request));
198+
return BaseResponse(result);
199+
}
200+
201+
/// Returns the device vuid (read only)
202+
static Future<GetVuidResponse> getVuid(String sdkKey) async {
203+
final result = Map<String, dynamic>.from(
204+
await _channel.invokeMethod(Constants.getVuidMethod, {
205+
Constants.sdkKey: sdkKey,
206+
}));
207+
return GetVuidResponse(result);
208+
}
209+
167210
/// Remove notification listener by notification id.
168211
static Future<BaseResponse> removeNotificationListener(
169212
String sdkKey, int id) async {
@@ -217,15 +260,17 @@ class OptimizelyClientWrapper {
217260
/// Creates a context of the user for which decision APIs will be called.
218261
///
219262
/// A user context will only be created successfully when the SDK is fully configured using initializeClient.
220-
static Future<OptimizelyUserContext?> createUserContext(
221-
String sdkKey, String userId,
222-
[Map<String, dynamic> attributes = const {}]) async {
223-
final result = Map<String, dynamic>.from(
224-
await _channel.invokeMethod(Constants.createUserContextMethod, {
263+
static Future<OptimizelyUserContext?> createUserContext(String sdkKey,
264+
{String? userId, Map<String, dynamic> attributes = const {}}) async {
265+
Map<String, dynamic> request = {
225266
Constants.sdkKey: sdkKey,
226-
Constants.userId: userId,
227267
Constants.attributes: Utils.convertToTypedMap(attributes)
228-
}));
268+
};
269+
if (userId != null) {
270+
request[Constants.userId] = userId;
271+
}
272+
final result = Map<String, dynamic>.from(await _channel.invokeMethod(
273+
Constants.createUserContextMethod, request));
229274

230275
if (result[Constants.responseSuccess] == true) {
231276
final response =

0 commit comments

Comments
 (0)