Skip to content

Commit 7621f90

Browse files
mikechu-optimizelymikechu-optimizely
authored
[FSSDK-9039] Fix e2e ODP event response (#343)
* [FSSDK-9039] Move FS_USER_ID to Constants * [FSSDK-9039] Change json serialization strategy * [FSSDK-9039] Fix tests * [FSSDK-9039] Use snake_case_strategy when serializing
1 parent 05e60bd commit 7621f90

File tree

10 files changed

+41
-44
lines changed

10 files changed

+41
-44
lines changed

‎OptimizelySDK.Tests/OdpTests/OdpEventManagerTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ public void ShouldPrepareCorrectPayloadForIdentifyUser()
515515
Assert.IsNotNull(actualEvent);
516516
Assert.AreEqual(Constants.ODP_EVENT_TYPE, actualEvent.Type);
517517
Assert.AreEqual("identified", actualEvent.Action);
518-
Assert.AreEqual(USER_ID, actualEvent.Identifiers[OdpUserKeyType.FS_USER_ID.ToString()]);
518+
Assert.AreEqual(USER_ID, actualEvent.Identifiers[Constants.FS_USER_ID]);
519519
var eventData = actualEvent.Data;
520520
Assert.AreEqual(Guid.NewGuid().ToString().Length,
521521
eventData["idempotence_id"].ToString().Length);

‎OptimizelySDK.Tests/OdpTests/OdpSegmentApiManagerTest.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022 Optimizely
2+
* Copyright 2022-2023 Optimizely
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.
@@ -158,7 +158,7 @@ public void ShouldFetchValidQualifiedSegments()
158158
var segments = manager.FetchSegments(
159159
VALID_ODP_PUBLIC_KEY,
160160
ODP_GRAPHQL_HOST,
161-
OdpUserKeyType.FS_USER_ID,
161+
Constants.FS_USER_ID,
162162
"tester-101",
163163
_segmentsToCheck);
164164

@@ -180,7 +180,7 @@ public void ShouldHandleEmptyQualifiedSegments()
180180
var segments = manager.FetchSegments(
181181
VALID_ODP_PUBLIC_KEY,
182182
ODP_GRAPHQL_HOST,
183-
OdpUserKeyType.FS_USER_ID,
183+
Constants.FS_USER_ID,
184184
"tester-101",
185185
_segmentsToCheck);
186186

@@ -204,7 +204,7 @@ public void ShouldHandleErrorWithInvalidIdentifier()
204204
var segments = manager.FetchSegments(
205205
VALID_ODP_PUBLIC_KEY,
206206
ODP_GRAPHQL_HOST,
207-
OdpUserKeyType.FS_USER_ID,
207+
Constants.FS_USER_ID,
208208
"invalid-user",
209209
_segmentsToCheck);
210210

@@ -224,7 +224,7 @@ public void ShouldHandleBadResponse()
224224
var segments = manager.FetchSegments(
225225
VALID_ODP_PUBLIC_KEY,
226226
ODP_GRAPHQL_HOST,
227-
OdpUserKeyType.FS_USER_ID,
227+
Constants.FS_USER_ID,
228228
"tester-101",
229229
_segmentsToCheck);
230230

@@ -246,7 +246,7 @@ public void ShouldHandleUnrecognizedJsonResponse()
246246
var segments = manager.FetchSegments(
247247
VALID_ODP_PUBLIC_KEY,
248248
ODP_GRAPHQL_HOST,
249-
OdpUserKeyType.FS_USER_ID,
249+
Constants.FS_USER_ID,
250250
"tester-101",
251251
_segmentsToCheck);
252252

@@ -266,7 +266,7 @@ public void ShouldHandle400HttpCode()
266266
var segments = manager.FetchSegments(
267267
VALID_ODP_PUBLIC_KEY,
268268
ODP_GRAPHQL_HOST,
269-
OdpUserKeyType.FS_USER_ID,
269+
Constants.FS_USER_ID,
270270
"tester-101",
271271
_segmentsToCheck);
272272

@@ -285,7 +285,7 @@ public void ShouldHandle500HttpCode()
285285
var segments = manager.FetchSegments(
286286
VALID_ODP_PUBLIC_KEY,
287287
ODP_GRAPHQL_HOST,
288-
OdpUserKeyType.FS_USER_ID,
288+
Constants.FS_USER_ID,
289289
"tester-101",
290290
_segmentsToCheck);
291291

‎OptimizelySDK.Tests/OdpTests/OdpSegmentManagerTest.cs‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022, 2023 Optimizely
2+
* Copyright 2022-2023 Optimizely
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.
@@ -14,14 +14,10 @@
1414
* limitations under the License.
1515
*/
1616

17-
using System;
1817
using System.Collections.Generic;
1918
using System.Linq;
20-
using System.Net;
2119
using Moq;
2220
using NUnit.Framework;
23-
using OptimizelySDK.AudienceConditions;
24-
using OptimizelySDK.ErrorHandler;
2521
using OptimizelySDK.Logger;
2622
using OptimizelySDK.Odp;
2723

@@ -64,7 +60,7 @@ public void ShouldFetchSegmentsOnCacheMiss()
6460
_mockCache.Setup(c => c.Lookup(Capture.In(keyCollector))).
6561
Returns(default(List<string>));
6662
_mockApiManager.Setup(a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
67-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>())).
63+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>())).
6864
Returns(segmentsToCheck.ToArray());
6965
var manager = new OdpSegmentManager(_mockApiManager.Object, _mockCache.Object,
7066
_mockLogger.Object);
@@ -82,7 +78,7 @@ public void ShouldFetchSegmentsOnCacheMiss()
8278
a => a.FetchSegments(
8379
API_KEY,
8480
API_HOST,
85-
OdpUserKeyType.FS_USER_ID,
81+
Constants.FS_USER_ID,
8682
FS_USER_ID,
8783
_odpConfig.SegmentsToCheck), Times.Once);
8884
_mockCache.Verify(c => c.Save(cacheKey, It.IsAny<List<string>>()), Times.Once);
@@ -95,7 +91,7 @@ public void ShouldFetchSegmentsSuccessOnCacheHit()
9591
var keyCollector = new List<string>();
9692
_mockCache.Setup(c => c.Lookup(Capture.In(keyCollector))).Returns(segmentsToCheck);
9793
_mockApiManager.Setup(a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
98-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>()));
94+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>()));
9995
var manager = new OdpSegmentManager(_mockApiManager.Object, _mockCache.Object,
10096
_mockLogger.Object);
10197
manager.UpdateSettings(_odpConfig);
@@ -110,7 +106,7 @@ public void ShouldFetchSegmentsSuccessOnCacheHit()
110106
l.Log(LogLevel.DEBUG, "ODP Cache Hit. Returning segments from Cache."), Times.Once);
111107
_mockApiManager.Verify(
112108
a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
113-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>()),
109+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>()),
114110
Times.Never);
115111
_mockCache.Verify(c => c.Save(expectedCacheKey, It.IsAny<List<string>>()), Times.Never);
116112
Assert.AreEqual(segmentsToCheck, segments);
@@ -121,7 +117,7 @@ public void ShouldHandleFetchSegmentsWithError()
121117
{
122118
// OdpSegmentApiManager.FetchSegments() return null on any error
123119
_mockApiManager.Setup(a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
124-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>())).
120+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>())).
125121
Returns(null as string[]);
126122
var manager = new OdpSegmentManager(_mockApiManager.Object, _mockCache.Object,
127123
_mockLogger.Object);
@@ -133,7 +129,7 @@ public void ShouldHandleFetchSegmentsWithError()
133129
_mockCache.Verify(c => c.Lookup(expectedCacheKey), Times.Once);
134130
_mockApiManager.Verify(
135131
a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
136-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>()),
132+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>()),
137133
Times.Once);
138134
_mockCache.Verify(c => c.Save(expectedCacheKey, It.IsAny<List<string>>()), Times.Never);
139135
Assert.IsNull(segments);
@@ -187,7 +183,7 @@ public void ShouldIgnoreCache()
187183
_mockCache.Verify(c => c.Lookup(It.IsAny<string>()), Times.Never);
188184
_mockApiManager.Verify(
189185
a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
190-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>()),
186+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>()),
191187
Times.Once);
192188
_mockCache.Verify(c => c.Save(expectedCacheKey, It.IsAny<List<string>>()), Times.Never);
193189
}
@@ -206,7 +202,7 @@ public void ShouldResetCache()
206202
_mockCache.Verify(c => c.Lookup(It.IsAny<string>()), Times.Once);
207203
_mockApiManager.Verify(
208204
a => a.FetchSegments(It.IsAny<string>(), It.IsAny<string>(),
209-
It.IsAny<OdpUserKeyType>(), It.IsAny<string>(), It.IsAny<List<string>>()),
205+
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<List<string>>()),
210206
Times.Once);
211207
_mockCache.Verify(c => c.Save(expectedCacheKey, It.IsAny<List<string>>()), Times.Once);
212208
}

‎OptimizelySDK/Odp/Constants.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,5 +111,10 @@ public static class Constants
111111
/// Default number of seconds to cache
112112
/// </summary>
113113
public const int DEFAULT_CACHE_SECONDS = 600;
114+
115+
/// <summary>
116+
/// Type of ODP key used for fetching segments & sending events
117+
/// </summary>
118+
public const string FS_USER_ID = "fs_user_id";
114119
}
115120
}

‎OptimizelySDK/Odp/Enums.cs‎

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022 Optimizely
2+
* Copyright 2022-2023 Optimizely
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.
@@ -16,17 +16,6 @@
1616

1717
namespace OptimizelySDK.Odp
1818
{
19-
/// <summary>
20-
/// Type of ODP key used for fetching segments & sending events
21-
/// </summary>
22-
public enum OdpUserKeyType
23-
{
24-
// ReSharper disable InconsistentNaming
25-
// ODP expects these names in UPPERCASE; .ToString() used
26-
VUID = 0, // kept for SDK consistency and awareness
27-
FS_USER_ID = 1,
28-
}
29-
3019
/// <summary>
3120
/// Options used during segment cache handling
3221
/// </summary>

‎OptimizelySDK/Odp/IOdpSegmentApiManager.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ public interface IOdpSegmentApiManager
2525
/// </summary>
2626
/// <param name="apiKey">ODP public key</param>
2727
/// <param name="apiHost">Fully-qualified URL of ODP</param>
28-
/// <param name="userKey">'vuid' or 'fs_user_id key'</param>
28+
/// <param name="userKey">Server-side should be 'fs_user_id key'</param>
2929
/// <param name="userValue">Associated value to query for the user key</param>
3030
/// <param name="segmentsToCheck">Audience segments to check for experiment inclusion</param>
3131
/// <returns>Array of audience segments</returns>
3232
string[] FetchSegments(string apiKey,
3333
string apiHost,
34-
OdpUserKeyType userKey,
34+
string userKey,
3535
string userValue,
3636
List<string> segmentsToCheck
3737
);

‎OptimizelySDK/Odp/OdpEventApiManager.cs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022 Optimizely
2+
* Copyright 2022-2023 Optimizely
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.
@@ -20,6 +20,7 @@
2020
using System.Text;
2121
using System.Threading.Tasks;
2222
using Newtonsoft.Json;
23+
using Newtonsoft.Json.Serialization;
2324
using OptimizelySDK.ErrorHandler;
2425
using OptimizelySDK.Logger;
2526
using OptimizelySDK.Odp.Entity;
@@ -89,7 +90,13 @@ public bool SendEvents(string apiKey, string apiHost, List<OdpEvent> events)
8990
}
9091

9192
var endpoint = $"{apiHost}{Constants.ODP_EVENTS_API_ENDPOINT_PATH}";
92-
var data = JsonConvert.SerializeObject(events);
93+
var data = JsonConvert.SerializeObject(events, settings: new JsonSerializerSettings
94+
{
95+
ContractResolver = new DefaultContractResolver
96+
{
97+
NamingStrategy = new SnakeCaseNamingStrategy(),
98+
},
99+
});
93100
var shouldRetry = false;
94101

95102
HttpResponseMessage response = default;

‎OptimizelySDK/Odp/OdpEventManager.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ public void IdentifyUser(string userId)
352352
{
353353
var identifiers = new Dictionary<string, string>
354354
{
355-
{ OdpUserKeyType.FS_USER_ID.ToString(), userId },
355+
{ Constants.FS_USER_ID, userId },
356356
};
357357

358358
var odpEvent = new OdpEvent(Constants.ODP_EVENT_TYPE, "identified", identifiers);

‎OptimizelySDK/Odp/OdpSegmentApiManager.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022 Optimizely
2+
* Copyright 2022-2023 Optimizely
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.
@@ -74,11 +74,11 @@ public OdpSegmentApiManager(ILogger logger = null, IErrorHandler errorHandler =
7474
/// </summary>
7575
/// <param name="apiKey">ODP public key</param>
7676
/// <param name="apiHost">Host of ODP endpoint</param>
77-
/// <param name="userKey">Either `vuid` or `fs_user_id key`</param>
77+
/// <param name="userKey">`fs_user_id key` for server-side SDKs</param>
7878
/// <param name="userValue">Associated value to query for the user key</param>
7979
/// <param name="segmentsToCheck">Audience segments to check for experiment inclusion</param>
8080
/// <returns>Array of audience segments</returns>
81-
public string[] FetchSegments(string apiKey, string apiHost, OdpUserKeyType userKey,
81+
public string[] FetchSegments(string apiKey, string apiHost, string userKey,
8282
string userValue, List<string> segmentsToCheck
8383
)
8484
{

‎OptimizelySDK/Odp/OdpSegmentManager.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public List<string> FetchQualifiedSegments(string fsUserId,
9999
options = options ?? new List<OdpSegmentOption>();
100100

101101
List<string> qualifiedSegments;
102-
var cacheKey = GetCacheKey(OdpUserKeyType.FS_USER_ID.ToString().ToLower(), fsUserId);
102+
var cacheKey = GetCacheKey(Constants.FS_USER_ID, fsUserId);
103103

104104
if (options.Contains(OdpSegmentOption.RESET_CACHE))
105105
{
@@ -121,7 +121,7 @@ public List<string> FetchQualifiedSegments(string fsUserId,
121121
qualifiedSegments = _apiManager.FetchSegments(
122122
_odpConfig.ApiKey,
123123
_odpConfig.ApiHost,
124-
OdpUserKeyType.FS_USER_ID,
124+
Constants.FS_USER_ID,
125125
fsUserId,
126126
_odpConfig.SegmentsToCheck)?.
127127
ToList();

0 commit comments

Comments
 (0)