Skip to content

Commit 2d8b71a

Browse files
mikechu-optimizelymsohailhussainmnoman09NomanShoaib
authored
feat: Integrated ODPManager with UserContext and Optimizely client (#323)
* Include ODP Manager instantiation in Optimizely.cs Includes lint/format updates...Sorry PR-Reviewer :-/ * Add FetchQualifiedSegments to Optimizely.cs * Add FetchQualifiedSegments to UserContext * Add IdentifyUser, fetch segments callback, & docs * WIP existing test fixes * Fix legacy test (mock) constructors * Add SendOdpEvent to Optimizely * WIP Init OdpManager * WIP Add OptimizelySdkSettings & fix some legacy tests * WIP fixes * Remove early UpdateOdpSettings * Add internal accessor for ProjectConfig Segments Sorry for the linter formatting updates * Linter fixes * Preprocessing conditional compilation directives * Add Segments array to ProjectConfig * Lint corrections * More linter fixes hopefully ;-) * WIP PR review changes * Lint fix * Lint fix * Add async FetchQualifiedSegments * WIP parse TypedAudience to ODP Segments * WIP parsing Segments * More ODP test datafile more scenarios * Revert IMultipleConditions concept * Correct Segments from datafile * Lint fix * Add segment unit tests * WIP satisfying legacy tests * Remove Ignore from legacy tests * Finalize SetupOdp; add Dispose to OptimizelyUserContext * Add missing preprocessing conditions * Fix linting * PR code review updates * Lint fixes * feat: Fix NotificationCenter Issue for ODPManager (#324) * PR changes * More PR changes * proposed changes * Understanding & additional updates * WIP Refactors & test fixes * WIP correcting tests... * Refactors * WIP OdpEventManagerTest resolutions * Remove NotificationCenter from NotificationCenterRegistry on Dispose * Fix Disposed = true location * Modify NCR Dispose * Mods to NCR and NC disposal * Mods to NCR and NC disposal * Fix OdpEventManager & tests * Remove double lock in NotificationCenterRegistry * Fix final test corrections * Pass logger into NotificationCenterRegistry * Last PR change request * Remove TODO comments Co-authored-by: msohailhussain <sohail.mirza@SMirza-MBP.local> * Lint fixes + Copyright year updates * Lint fix PollingProjectConfigManager * Trying to fix TestPollingConfigManagerBlocksWhenProjectConfigIsNotProvided * Another attempt to figure out TestPollingConfigManagerBlocksWhenProjectConfigIsNotProvided * Update OptimizelySDK/Config/PollingProjectConfigManager.cs Co-authored-by: Muhammad Noman <Muhammadnoman@folio3.com> * Update OptimizelySDK/Config/HttpProjectConfigManager.cs Co-authored-by: Muhammad Noman <Muhammadnoman@folio3.com> * Update OptimizelySDK/Config/FallbackProjectConfigManager.cs Co-authored-by: Muhammad Noman <Muhammadnoman@folio3.com> * Update OptimizelySDK/Config/FallbackProjectConfigManager.cs Co-authored-by: Muhammad Noman <Muhammadnoman@folio3.com> * Implement a NoOpOdpManager * Remove configurable batch size for OdpEventManager * Fix lint (Mike not happy) * OMG Linter needs config * Split condition for UpdateSettings & NotificationCenterRegistry add * Remove optional chaining * PR review changes * Fix InternalsVisibleTo & use internal for testing * PR change requests * Add unit test for defaults from OdpManager & below * Remove NoOpOdpManager & default OdpManager instantiation * Lint fixes * Allow signed + assigned friend assemblies * Use pubkey of OptimizelySDK.Tests * Testing InternalsVisibleTo in csproj * More testing signed assems * WIP fix InternalsVisibleTo with Release build * Require providing SDK key in HttpProjectConfigManager constructor * Fix: Some suggested changes related to ODP (#325) * Some suggested changes to fix null pointer exception * - Removed batchsize support from ODP event manager - Made some general fixes * Flush previous event * reverting this change Co-authored-by: mnoman09 <m.nomanshoaib09@gmail.com> * Merge fixes + lint * Lint fixes * Build fix and lint * PR change requests * Lint fix * Fix: ODP Event manager not consistent in triggering events. (#326) * Refactored OdpEventManager flushEvent function. * To wait for events using flushInterval when eventBatch is not empty. * Or wait indefinitely if no event is in batch until any event arrive. * Avoid calling flush on shutdown if no events are present * Avoid calling unnecessary flushQueue if _currentBatch.Count is zero. * Fixed the test as when there are no remaining items in queue then odpEventManager should not flush. * Removing mutex lock from notification registry instead using concurrentDictionary * Revert "Removing mutex lock from notification registry instead using concurrentDictionary" This reverts commit 64cdf80. * Added Thread.sleep which somehow enabling thread to shutdown gracefully. --------- Co-authored-by: mnoman09 <m.nomanshoaib09@gmail.com> --------- Co-authored-by: msohailhussain <sohail.mirza@SMirza-MBP.local> Co-authored-by: Muhammad Noman <Muhammadnoman@folio3.com> Co-authored-by: mnoman09 <m.nomanshoaib09@gmail.com>
1 parent bdaef7f commit 2d8b71a

38 files changed

+6991
-2797
lines changed

‎OptimizelySDK.NetStandard20/OptimizelySDK.NetStandard20.csproj‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,84 @@
1010
<Compile Include="..\OptimizelySDK\IOptimizely.cs">
1111
<Link>IOptimizely.cs</Link>
1212
</Compile>
13+
<Compile Include="..\OptimizelySDK\Notifications\NotificationCenterRegistry.cs">
14+
<Link>Notifications\NotificationCenterRegistry.cs</Link>
15+
</Compile>
16+
<Compile Include="..\OptimizelySDK\Odp\Constants.cs">
17+
<Link>Odp\Constants.cs</Link>
18+
</Compile>
19+
<Compile Include="..\OptimizelySDK\Odp\Entity\Audience.cs">
20+
<Link>Odp\Entity\Audience.cs</Link>
21+
</Compile>
22+
<Compile Include="..\OptimizelySDK\Odp\Entity\Customer.cs">
23+
<Link>Odp\Entity\Customer.cs</Link>
24+
</Compile>
25+
<Compile Include="..\OptimizelySDK\Odp\Entity\Data.cs">
26+
<Link>Odp\Entity\Data.cs</Link>
27+
</Compile>
28+
<Compile Include="..\OptimizelySDK\Odp\Entity\Edge.cs">
29+
<Link>Odp\Entity\Edge.cs</Link>
30+
</Compile>
31+
<Compile Include="..\OptimizelySDK\Odp\Entity\Error.cs">
32+
<Link>Odp\Entity\Error.cs</Link>
33+
</Compile>
34+
<Compile Include="..\OptimizelySDK\Odp\Entity\Extension.cs">
35+
<Link>Odp\Entity\Extension.cs</Link>
36+
</Compile>
37+
<Compile Include="..\OptimizelySDK\Odp\Entity\Location.cs">
38+
<Link>Odp\Entity\Location.cs</Link>
39+
</Compile>
40+
<Compile Include="..\OptimizelySDK\Odp\Entity\Node.cs">
41+
<Link>Odp\Entity\Node.cs</Link>
42+
</Compile>
43+
<Compile Include="..\OptimizelySDK\Odp\Entity\OdpEvent.cs">
44+
<Link>Odp\Entity\OdpEvent.cs</Link>
45+
</Compile>
46+
<Compile Include="..\OptimizelySDK\Odp\Entity\Response.cs">
47+
<Link>Odp\Entity\Response.cs</Link>
48+
</Compile>
49+
<Compile Include="..\OptimizelySDK\Odp\Enums.cs">
50+
<Link>Odp\Enums.cs</Link>
51+
</Compile>
52+
<Compile Include="..\OptimizelySDK\Odp\ICache.cs">
53+
<Link>Odp\ICache.cs</Link>
54+
</Compile>
55+
<Compile Include="..\OptimizelySDK\Odp\IOdpEventApiManager.cs">
56+
<Link>Odp\IOdpEventApiManager.cs</Link>
57+
</Compile>
58+
<Compile Include="..\OptimizelySDK\Odp\IOdpEventManager.cs">
59+
<Link>Odp\IOdpEventManager.cs</Link>
60+
</Compile>
61+
<Compile Include="..\OptimizelySDK\Odp\IOdpManager.cs">
62+
<Link>Odp\IOdpManager.cs</Link>
63+
</Compile>
64+
<Compile Include="..\OptimizelySDK\Odp\IOdpSegmentApiManager.cs">
65+
<Link>Odp\IOdpSegmentApiManager.cs</Link>
66+
</Compile>
67+
<Compile Include="..\OptimizelySDK\Odp\IOdpSegmentManager.cs">
68+
<Link>Odp\IOdpSegmentManager.cs</Link>
69+
</Compile>
70+
<Compile Include="..\OptimizelySDK\Odp\LruCache.cs">
71+
<Link>Odp\LruCache.cs</Link>
72+
</Compile>
73+
<Compile Include="..\OptimizelySDK\Odp\OdpConfig.cs">
74+
<Link>Odp\OdpConfig.cs</Link>
75+
</Compile>
76+
<Compile Include="..\OptimizelySDK\Odp\OdpEventApiManager.cs">
77+
<Link>Odp\OdpEventApiManager.cs</Link>
78+
</Compile>
79+
<Compile Include="..\OptimizelySDK\Odp\OdpEventManager.cs">
80+
<Link>Odp\OdpEventManager.cs</Link>
81+
</Compile>
82+
<Compile Include="..\OptimizelySDK\Odp\OdpManager.cs">
83+
<Link>Odp\OdpManager.cs</Link>
84+
</Compile>
85+
<Compile Include="..\OptimizelySDK\Odp\OdpSegmentApiManager.cs">
86+
<Link>Odp\OdpSegmentApiManager.cs</Link>
87+
</Compile>
88+
<Compile Include="..\OptimizelySDK\Odp\OdpSegmentManager.cs">
89+
<Link>Odp\OdpSegmentManager.cs</Link>
90+
</Compile>
1391
<Compile Include="..\OptimizelySDK\Optimizely.cs">
1492
<Link>Optimizely.cs</Link>
1593
</Compile>
@@ -223,6 +301,9 @@
223301
<Compile Include="..\OptimizelySDK\Utils\AttributeMatchTypes.cs">
224302
<Link>Utils\AttributeMatchTypes.cs</Link>
225303
</Compile>
304+
<Compile Include="..\OptimizelySDK\Utils\CollectionExtensions.cs">
305+
<Link>Utils\CollectionExtensions.cs</Link>
306+
</Compile>
226307
<Compile Include="..\OptimizelySDK\Utils\ConditionParser.cs">
227308
<Link>Utils\ConditionParser.cs</Link>
228309
</Compile>

‎OptimizelySDK.Tests/AudienceConditionsTests/SegmentsTests.cs‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
/*
2+
* Copyright 2022-2023 Optimizely
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+
* https://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+
using Moq;
18+
using NUnit.Framework;
19+
using OptimizelySDK.AudienceConditions;
20+
using OptimizelySDK.Entity;
21+
using OptimizelySDK.Logger;
22+
using System.Collections.Generic;
23+
using System.Linq;
24+
25+
namespace OptimizelySDK.Tests.AudienceConditionsTests
26+
{
27+
[TestFixture]
28+
public class SegmentsTests
29+
{
30+
private BaseCondition _firstThirdPartyOdpQualifiedMatchCondition;
31+
private BaseCondition _secondThirdPartyOdpQualifiedMatchCondition;
32+
private ICondition _customExactMatchCondition;
33+
private Mock<ILogger> _mockLogger;
34+
35+
private const string FIRST_CONDITION_VALUE = "first_condition_value";
36+
private const string SECOND_CONDITION_VALUE = "second_condition_value";
37+
38+
[TestFixtureSetUp]
39+
public void Setup()
40+
{
41+
_firstThirdPartyOdpQualifiedMatchCondition = new BaseCondition
42+
{
43+
Value = FIRST_CONDITION_VALUE,
44+
Type = "third_party_dimension",
45+
Name = "odp.audiences",
46+
Match = "qualified",
47+
};
48+
49+
_secondThirdPartyOdpQualifiedMatchCondition = new BaseCondition
50+
{
51+
Value = SECOND_CONDITION_VALUE,
52+
Type = "third_party_dimension",
53+
Name = "odp.audiences",
54+
Match = "qualified",
55+
};
56+
57+
_customExactMatchCondition = new BaseCondition()
58+
{
59+
Value = "test_custom_value",
60+
Type = "custom_attribute",
61+
Name = "test_custom_name",
62+
Match = "exact",
63+
};
64+
65+
_mockLogger = new Mock<ILogger>();
66+
_mockLogger.Setup(l => l.Log(It.IsAny<LogLevel>(), It.IsAny<string>()));
67+
}
68+
69+
[Test]
70+
public void ShouldGetSegmentsFromDatafileTypedAudiences()
71+
{
72+
var expectedSegments = new SortedSet<string>
73+
{
74+
"ats_bug_bash_segment_gender",
75+
"ats_bug_bash_segment_has_purchased",
76+
"has_email_opted_out",
77+
"ats_bug_bash_segment_dob",
78+
};
79+
var optimizelyClient = new Optimizely(TestData.OdpSegmentsDatafile,
80+
new ValidEventDispatcher(), _mockLogger.Object);
81+
82+
var allSegments = optimizelyClient.ProjectConfigManager.GetConfig().Segments;
83+
84+
var orderedDistinctSegments = new SortedSet<string>(allSegments);
85+
// check for no duplicates
86+
Assert.AreEqual(allSegments.Length, orderedDistinctSegments.Count);
87+
Assert.AreEqual(expectedSegments, orderedDistinctSegments);
88+
}
89+
90+
[Test]
91+
public void ShouldFindOdpSegmentFromAndCondition()
92+
{
93+
var conditions = new AndCondition
94+
{
95+
Conditions = new[]
96+
{
97+
_firstThirdPartyOdpQualifiedMatchCondition, _customExactMatchCondition,
98+
},
99+
};
100+
101+
var allSegments = Audience.GetSegments(conditions);
102+
103+
Assert.AreEqual(_firstThirdPartyOdpQualifiedMatchCondition.Value.ToString(),
104+
allSegments.FirstOrDefault());
105+
}
106+
107+
[Test]
108+
public void ShouldFindOdpSegmentFromOrCondition()
109+
{
110+
var conditions = new OrCondition
111+
{
112+
Conditions = new[]
113+
{
114+
_customExactMatchCondition, _firstThirdPartyOdpQualifiedMatchCondition,
115+
},
116+
};
117+
118+
var allSegments = Audience.GetSegments(conditions);
119+
120+
Assert.AreEqual(_firstThirdPartyOdpQualifiedMatchCondition.Value.ToString(),
121+
allSegments.FirstOrDefault());
122+
}
123+
124+
[Test]
125+
public void ShouldNotFindOdpSegmentsFromConditions()
126+
{
127+
var conditions = new AndCondition
128+
{
129+
Conditions = new[]
130+
{
131+
_customExactMatchCondition, _customExactMatchCondition, _customExactMatchCondition,
132+
},
133+
};
134+
135+
var allSegments = Audience.GetSegments(conditions);
136+
137+
Assert.IsEmpty(allSegments);
138+
}
139+
140+
[Test]
141+
public void ShouldFindAndDedupeNestedOdpSegments()
142+
{
143+
var qualifiedAndExact = new AndCondition
144+
{
145+
Conditions = new ICondition[]
146+
{
147+
_firstThirdPartyOdpQualifiedMatchCondition, _customExactMatchCondition,
148+
},
149+
};
150+
var twoQualified = new AndCondition
151+
{
152+
Conditions = new ICondition[]
153+
{
154+
_secondThirdPartyOdpQualifiedMatchCondition, _firstThirdPartyOdpQualifiedMatchCondition,
155+
},
156+
};
157+
var orConditions = new OrCondition
158+
{
159+
Conditions = new ICondition[]
160+
{
161+
qualifiedAndExact, twoQualified,
162+
},
163+
};
164+
var notCondition = new NotCondition
165+
{
166+
Condition = orConditions,
167+
};
168+
169+
var allSegments = Audience.GetSegments(notCondition).ToList();
170+
171+
Assert.AreEqual(2, allSegments.Count);
172+
Assert.Contains(FIRST_CONDITION_VALUE, allSegments);
173+
Assert.Contains(SECOND_CONDITION_VALUE, allSegments);
174+
}
175+
}
176+
}

0 commit comments

Comments
 (0)