-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathFlagsmithTest.cs
More file actions
843 lines (764 loc) · 35.2 KB
/
FlagsmithTest.cs
File metadata and controls
843 lines (764 loc) · 35.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using FlagsmithEngine.Environment.Models;
using Moq;
using Newtonsoft.Json.Linq;
using OfflineHandler;
using Xunit;
namespace Flagsmith.FlagsmithClientTest
{
public class FlagsmithTest
{
[Fact]
public void TestFlagsmithStartsPollingManagerOnInitIfEnabled()
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
_ = new FlagsmithClient(config);
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
}
[Fact]
public async void TestUpdateEnvironmentSetsEnvironment()
{
// Given
var responses = new Dictionary<string, HttpResponseMessage>
{
{ "/api/v1/environment-document/", new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
}
},
{ "/api/v1/flags/", new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponse)
}
}
};
var mockHttpClient = HttpMocker.MockHttpResponse(responses);
// When
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
var flagsmithClientTest = new FlagsmithClient(config);
// Then
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
await flagsmithClientTest.GetEnvironmentFlags();
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/flags/", Times.Never);
}
[Fact]
public async Task TestGetEnvironmentFlagsCallsApiWhenNoLocalEnvironment()
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponse)
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = (await flagsmithClientTest.GetEnvironmentFlags()).AllFlags();
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/flags/", Times.Once);
Assert.True(flags[0].Enabled);
Assert.Equal("some-value", flags[0].Value);
Assert.Equal("some_feature", flags[0].GetFeatureName());
}
[Fact]
public async Task TestGetEnvironmentFlagsUsesLocalEnvironmentWhenAvailable()
{
// Given
var responses = new Dictionary<string, HttpResponseMessage>
{
{ "/api/v1/environment-document/", new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
}
},
{ "/api/v1/flags/", new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponse)
}
}
};
var mockHttpClient = HttpMocker.MockHttpResponse(responses);
// When
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
var flagsmithClientTest = new FlagsmithClient(config);
// Then
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
var flags = (await flagsmithClientTest.GetEnvironmentFlags()).AllFlags();
var fs = Fixtures.Environment.FeatureStates[0];
Assert.Equal(fs.Enabled, flags[0].Enabled);
Assert.Equal(fs.Value, flags[0].Value);
Assert.Equal(fs.Feature.Name, flags[0].GetFeatureName());
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
}
[Fact]
public async Task TestThatCacheDictionaryDoesNotThrowUnderLoad()
{
const int numberOfThreads = 500;
ThreadPool.SetMinThreads(numberOfThreads, numberOfThreads);
var mockHttpClient = HttpMocker.MockHttpResponse(HttpStatusCode.OK, Fixtures.ApiIdentityResponse, false);
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
CacheConfig = new CacheConfig(true)
};
var flagsmithClientTest = new FlagsmithClient(config);
var token = new CancellationToken();
await Parallel.ForEachAsync(Enumerable.Range(1, numberOfThreads), token, async (item, _) =>
{
(await flagsmithClientTest.GetIdentityFlags(item.ToString())).AllFlags();
});
}
[Theory]
[InlineData("identifier", "{\"identifier\":\"identifier\",\"traits\":[],\"transient\":false}")]
[InlineData("identifier&h=g", "{\"identifier\":\"identifier&h=g\",\"traits\":[],\"transient\":false}")]
public async Task TestGetIdentityFlagsCallsPostApiWhenNoLocalEnvironmentNoTraits(string identifier, string expectedJson)
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiIdentityResponse)
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = (await flagsmithClientTest.GetIdentityFlags(identifier)).AllFlags();
Assert.True(flags[0].Enabled);
Assert.Equal("some-value", flags[0].Value);
Assert.Equal("some_feature", flags[0].GetFeatureName());
mockHttpClient.VerifyHttpRequest(HttpMethod.Post, "/api/v1/identities/", Times.Once, expectedJson);
}
[Fact]
public async Task TestGetIdentityFlagsCallsPostApiWhenNoLocalEnvironmentWithTraits()
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiIdentityResponse)
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
var traits = new List<ITrait> { new Trait("foo", "bar") };
var flags = (await flagsmithClientTest.GetIdentityFlags("identifier", traits)).AllFlags();
Assert.True(flags[0].Enabled);
Assert.Equal("some-value", flags[0].Value);
Assert.Equal("some_feature", flags[0].GetFeatureName());
mockHttpClient.VerifyHttpRequest(HttpMethod.Post, "/api/v1/identities/", Times.Once);
}
[Fact]
public async Task TestGetIdentityFlagsUsesLocalEnvironmentWhenAvailable()
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
var flagsmithClientTest = new FlagsmithClient(config);
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
_ = await flagsmithClientTest.GetIdentityFlags("identifier", new List<ITrait>() { new Trait("foo", "bar") });
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
}
[Fact]
public async Task TestGetIdentityFlagsUsesLocalIdentityOverridesWhenAvailable()
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
});
var traits = new List<ITrait> { new Trait("foo", "bar") };
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
var flagsmithClientTest = new FlagsmithClient(config);
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/environment-document/", Times.Once);
var flags = await flagsmithClientTest.GetIdentityFlags("overridden-id", traits);
var flag = await flags.GetFlag("some_feature");
Assert.False(flag.Enabled);
Assert.Equal("some-overridden-value", flag.Value);
}
[Fact]
public async Task TestRequestConnectionErrorRaisesFlagsmithApiError()
{
var mockHttpClient = HttpMocker.MockHttpThrowConnectionError();
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
await Assert.ThrowsAsync<FlagsmithAPIError>(async () => await flagsmithClientTest.GetEnvironmentFlags());
}
[Fact]
public async Task TestNon200ResponseRaisesFlagsmithApiError()
{
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.Forbidden,
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
await Assert.ThrowsAsync<FlagsmithAPIError>(async () => await flagsmithClientTest.GetEnvironmentFlags());
}
[Fact]
public async Task TestDefaultFlagIsUsedWhenNoEnvironmentFlagsReturned()
{
var defaultFlag = new Flag(null, true, "some-default-value");
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent("[]")
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
DefaultFlagHandler = _ => defaultFlag
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = await flagsmithClientTest.GetEnvironmentFlags();
var flag = await flags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.Equal("some-default-value", flag.Value);
}
[Fact]
public async Task TestDefaultFlagIsNotUsedWhenEnvironmentFlagsReturned()
{
var defaultFlag = new Flag(null, true, "some-default-value");
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponse)
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
DefaultFlagHandler = _ => defaultFlag
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = await flagsmithClientTest.GetEnvironmentFlags();
var flag = await flags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.NotEqual("some-default-value", flag.Value);
}
[Fact]
public async Task TestDefaultFlagIsUsedWhenNoIdentityFlagsReturned()
{
var defaultFlag = new Flag(null, true, "some-default-value");
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent("{}")
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
DefaultFlagHandler = _ => defaultFlag
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = await flagsmithClientTest.GetIdentityFlags("identifier");
var flag = await flags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.Equal("some-default-value", flag.Value);
}
[Fact]
public async Task TestDefaultFlagIsNotUsedWhenIdentityFlagsReturned()
{
var defaultFlag = new Flag(null, true, "some-default-value");
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiIdentityResponse)
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
DefaultFlagHandler = _ => defaultFlag
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = await flagsmithClientTest.GetIdentityFlags("identifier");
var flag = await flags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.NotEqual("some-default-value", flag.Value);
}
[Fact]
public async Task TestDefaultFlagsAreUsedIfApiErrorAndDefaultFlagHandlerGiven()
{
var defaultFlag = new Flag(null, true, "some-default-value");
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.Forbidden,
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
DefaultFlagHandler = _ => defaultFlag
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = await flagsmithClientTest.GetEnvironmentFlags();
var flag = await flags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.Equal("some-default-value", flag.Value);
}
[Fact]
public async Task TestGetIdentityFlagsSendsTraits()
{
string identifier = "identifier";
var traits = new List<ITrait>() { new Trait("foo", "bar"), new Trait("ifoo", 1) };
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClient = new FlagsmithClient(config);
await flagsmithClient.GetIdentityFlags(identifier, traits);
mockHttpClient.VerifyHttpRequest(HttpMethod.Post, "/api/v1/identities/", Times.Once);
// TODO: verify the body is correct - I've verified manually but can't verify programmatically
}
[Fact]
public void TestGetIdentitySegmentsNoTraits()
{
// Given
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
var flagsmithClient = new FlagsmithClient(config);
// When
var segments = flagsmithClient.GetIdentitySegments("identifier");
// Then
Assert.Empty(segments);
}
[Fact]
public void TestGetIdentitySegmentsWithValidTrait()
{
// Given
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true
};
var flagsmithClient = new FlagsmithClient(config);
var identifier = "identifier";
var traits = new List<ITrait>() { new Trait(traitKey: "foo", traitValue: "bar") };
// When
var segments = flagsmithClient.GetIdentitySegments(identifier, traits);
// Then
Assert.Single(segments);
Assert.Equal("Test segment", segments[0].Name);
}
[Fact]
public void TestFlagsmithClientWithCacheInitialization()
{
// Given
var responses = new Dictionary<string, HttpResponseMessage>
{
{ "/api/v1/environment-document/", new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.JsonObject.ToString())
}
},
{ "/api/v1/flags/", new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponse)
}
}
};
var mockHttpClient = HttpMocker.MockHttpResponse(responses);
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableLocalEvaluation = true,
CacheConfig = new CacheConfig(true)
};
var flagsmithClient = new FlagsmithClient(config);
// When
var flags = flagsmithClient.GetEnvironmentFlags().Result;
// Then
Assert.NotNull(flags);
}
[Fact]
public async Task TestOfflineMode_IntegrationTest()
{
// Given
JObject
.Parse(File.ReadAllText("../../../data/offline-environment.json"))
.ToObject<EnvironmentModel>();
const string expectedPath = "../../../data/offline-environment.json";
var localFileHandler = new LocalFileHandler(expectedPath);
// When
var config = new FlagsmithConfiguration
{
OfflineMode = true,
OfflineHandler = localFileHandler
};
var flagsmithClient = new FlagsmithClient(config);
// Then
// we can request the flags from the client successfully
var environmentFlags = await flagsmithClient.GetEnvironmentFlags();
var flag = await environmentFlags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.Equal("offline-value", flag.Value);
var identityFlags = await flagsmithClient.GetIdentityFlags("identity");
flag = await identityFlags.GetFlag("some_feature");
Assert.True(flag.Enabled);
Assert.Equal("offline-value", flag.Value);
}
[Fact]
public async Task TestFlagsmithUsesOfflineHandlerIfSetAndNoAPIResponse()
{
// Given
var environment = JObject
.Parse(await File.ReadAllTextAsync("../../../data/offline-environment.json"))
.ToObject<EnvironmentModel>();
const string apiUrl = "http://some.flagsmith.com/api/v1/";
var mockOfflineHandler = new Mock<BaseOfflineHandler>();
var mockFlagsmithClient = new Mock<IFlagsmithClient>();
mockOfflineHandler.Setup(h => h.GetEnvironment()).Returns(environment);
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.InternalServerError
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = "some-key",
HttpClient = mockHttpClient.Object,
ApiUri = new Uri(apiUrl),
OfflineHandler = mockOfflineHandler.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
// When
mockFlagsmithClient.Setup(f => f.GetEnvironmentFlags()).ReturnsAsync(await flagsmithClientTest.GetEnvironmentFlags());
mockFlagsmithClient.Setup(f => f.GetIdentityFlags("identity")).ReturnsAsync(await flagsmithClientTest.GetIdentityFlags("identity"));
// Then
mockOfflineHandler.Verify(h => h.GetEnvironment(), Times.AtMost(2));
mockFlagsmithClient.Verify(h => h.GetEnvironmentFlags(), Times.AtMostOnce());
mockFlagsmithClient.Verify(h => h.GetIdentityFlags("identity"), Times.AtMostOnce());
var environmentFlags = await flagsmithClientTest.GetEnvironmentFlags();
var identityFlags = await flagsmithClientTest.GetIdentityFlags("identity");
Assert.True(await environmentFlags.IsFeatureEnabled("some_feature"));
Assert.Equal("offline-value", await environmentFlags.GetFeatureValue("some_feature"));
Assert.True(await identityFlags.IsFeatureEnabled("some_feature"));
Assert.Equal("offline-value", await identityFlags.GetFeatureValue("some_feature"));
}
[Fact]
public async Task TestFlagsmithUsesTheAPIResponseEvenIfTheOfflineHandlerIsSet()
{
// Given
var environment = JObject
.Parse(File.ReadAllText("../../../data/offline-environment.json"))
.ToObject<EnvironmentModel>();
var mockOfflineHandler = new Mock<BaseOfflineHandler>();
mockOfflineHandler.Setup(h => h.GetEnvironment()).Returns(environment);
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponse),
});
// When
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
OfflineHandler = mockOfflineHandler.Object
};
var flagsmithClientTest = new FlagsmithClient(config);
// Then
var environmentFlags = await flagsmithClientTest.GetEnvironmentFlags();
mockHttpClient.VerifyHttpRequest(HttpMethod.Get, "/api/v1/flags/", Times.Once);
Assert.True(await environmentFlags.IsFeatureEnabled("some_feature"));
Assert.NotEqual("offline-value", await environmentFlags.GetFeatureValue("some_feature"));
Assert.Equal("some-value", await environmentFlags.GetFeatureValue("some_feature"));
}
[Fact]
public void TestCannotUseOfflineModeWithoutOfflineHandler()
{
// When
void CreateFlagsmith()
{
var config = new FlagsmithConfiguration { OfflineMode = true, OfflineHandler = null };
_ = new FlagsmithClient(config);
}
// Then
var exception = Assert.Throws<Exception>(CreateFlagsmith);
Assert.Equal("ValueError: offlineHandler must be provided to use offline mode.", exception.Message);
}
[Fact]
public void TestCannotUseBothDefaultHandlerAndOfflineHandler()
{
// Given
var defaultFlag = new Flag(null, true, "some-default-value");
var expectedPath = "../../../data/offline-environment.json";
var localFileHandler = new LocalFileHandler(expectedPath);
// When
void CreateFlagsmith()
{
var config = new FlagsmithConfiguration { OfflineHandler = localFileHandler, DefaultFlagHandler = _ => defaultFlag };
_ = new FlagsmithClient(config);
}
// Then
var exception = Assert.Throws<Exception>(CreateFlagsmith);
Assert.Equal("ValueError: Cannot use both defaultFlagHandler and offlineHandler.", exception.Message);
}
[Fact]
public void TestCannotCreateFlagsmithClientInRemoteEvaluationWithoutAPIKey()
{
// When
void CreateFlagsmith() => _ = new FlagsmithClient(new FlagsmithConfiguration());
// Then
var exception = Assert.Throws<Exception>(CreateFlagsmith);
Assert.Equal("ValueError: environmentKey is required", exception.Message);
}
[Fact]
public void TestCannotCreateFlagsmithClientInLocalEvaluationWithoutServerAPIKey()
{
// When
Action createFlagsmith = () => new FlagsmithClient(
new FlagsmithConfiguration
{
EnvironmentKey = "foobar",
EnableLocalEvaluation = true
}
);
// Then
var exception = Assert.Throws<Exception>(() => createFlagsmith());
Assert.Equal
(
"ValueError: In order to use local evaluation, please generate a server key in the environment settings page.",
exception.Message
);
}
[Fact(Skip = "flaky test, needs investigation")]
/// <summary>
/// Test that analytics data is consistent with concurrent calls to get flags.
/// A huge number of threads are spawned to ensure that the issues related with
/// concurrency are systematically reproduced even in machines with good resources.
/// Tested with a MacBook Pro M2 with 16GB of RAM and a Core i7 PC with 48 GB of RAM.
/// The increment on execution time in the CI runners is not significant.
/// </summary>
public async Task TestAnalyticsDataConsistencyWithConcurrentCallsToGetFlags()
{
// Given
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiFlagResponseWithTenFlags)
});
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object,
EnableAnalytics = true
};
var flagsmithClientTest = new FlagsmithClient(config);
var flags = await flagsmithClientTest.GetEnvironmentFlags();
var featuresDictionary = new Dictionary<string, int>();
const int numberOfFeatures = 10;
const int numberOfThreads = 1000;
const int callsPerThread = 1000;
ThreadPool.SetMinThreads(numberOfThreads, numberOfThreads);
for (int i = 1; i <= numberOfFeatures; i++)
{
featuresDictionary.TryAdd($"Feature_{i}", 0);
}
// When
var tasks = new Task[numberOfThreads];
// Create numberOfThreads threads.
for (var i = 0; i < numberOfThreads; i++)
{
string[] features = new string[callsPerThread];
// Prepare an array of feature names of length callsPerThread.
for (var j = 0; j < callsPerThread; j++)
{
// The feature names are randomly selected from the featuresDictionary and added to the
// list of features, which represents the features that have been evaluated.
string featureName = $"Feature_{new Random().Next(1, featuresDictionary.Count + 1)}";
features[j] = featureName;
// The relevant key in the featuresDictionary is incremented to simulate an evaluation
// to track for that feature.
featuresDictionary[featureName]++;
}
// Each thread will call IsFeatureEnabled for callsPerThread times.
tasks[i] = Task.Run(async () =>
{
foreach (var feature in features)
{
await flags.IsFeatureEnabled(feature);
}
});
}
await Task.WhenAll(tasks);
// Then
var analyticsData = flagsmithClientTest.aggregatedAnalytics;
int totalCallsMade = 0;
foreach (var feature in featuresDictionary)
{
totalCallsMade += analyticsData[feature.Key];
Assert.Equal(feature.Value, analyticsData[feature.Key]);
}
Assert.Equal(numberOfThreads * callsPerThread, totalCallsMade);
}
[Fact]
public async Task TestGetIdentityFlagsTransientIdentityCallsExpected()
{
// Given
string identifier = "transient_identity";
var traits = new List<ITrait> { new Trait("some_trait", "some_value") };
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiTransientIdentityResponse)
});
// When
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClient = new FlagsmithClient(config);
var identityFlags = await flagsmithClient.GetIdentityFlags(identifier, traits, true);
// Then
mockHttpClient.VerifyHttpRequest(HttpMethod.Post, "/api/v1/identities/", Times.Once, "{\"identifier\":\"transient_identity\",\"traits\":[{\"trait_key\":\"some_trait\",\"trait_value\":\"some_value\",\"transient\":false}],\"transient\":true}");
Assert.True(await identityFlags.IsFeatureEnabled("some_feature"));
Assert.Equal("some-identity-trait-value", await identityFlags.GetFeatureValue("some_feature"));
}
[Fact]
public async Task TestGetIdentityFlagsTransientTraitKeysCallsExpected()
{
// Given
string identifier = "test_identity_with_transient_traits";
var traits = new List<ITrait> { new Trait("transient_trait", "transient_trait_value", true) };
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiIdentityWithTransientTraitsResponse)
});
// When
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClient = new FlagsmithClient(config);
var identityFlags = await flagsmithClient.GetIdentityFlags(identifier, traits);
// Then
mockHttpClient.VerifyHttpRequest(HttpMethod.Post, "/api/v1/identities/", Times.Once, "{\"identifier\":\"test_identity_with_transient_traits\",\"traits\":[{\"trait_key\":\"transient_trait\",\"trait_value\":\"transient_trait_value\",\"transient\":true}],\"transient\":false}");
Assert.True(await identityFlags.IsFeatureEnabled("some_feature"));
Assert.Equal("some-transient-trait-value", await identityFlags.GetFeatureValue("some_feature"));
}
[Fact]
public async Task TestGetIdentityFlagsTransientIdentityWithoutTraitCallsExpected()
{
// Given
string identifier = "transient_identity";
var mockHttpClient = HttpMocker.MockHttpResponse(new HttpResponseMessage
{
StatusCode = HttpStatusCode.OK,
Content = new StringContent(Fixtures.ApiTransientIdentityResponse)
});
// When
var config = new FlagsmithConfiguration
{
EnvironmentKey = Fixtures.ApiKey,
HttpClient = mockHttpClient.Object
};
var flagsmithClient = new FlagsmithClient(config);
var identityFlags = await flagsmithClient.GetIdentityFlags(identifier, null, true);
// Then
mockHttpClient.VerifyHttpRequest(HttpMethod.Post, "/api/v1/identities/", Times.Once, "{\"identifier\":\"transient_identity\",\"traits\":[],\"transient\":true}");
Assert.True(await identityFlags.IsFeatureEnabled("some_feature"));
Assert.Equal("some-identity-trait-value", await identityFlags.GetFeatureValue("some_feature"));
}
[Fact]
public void TestRequestTimeoutInterpretsSecondsCorrectly()
{
var config = new FlagsmithConfiguration
{
RequestTimeout = 100
};
Assert.Equal(100, config.RequestTimeout);
}
[Fact]
public void TestRequestTimeoutHasReasonableDefault()
{
Assert.True(new FlagsmithConfiguration().RequestTimeout > 1);
}
}
}