-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAdminAnnouncementProjectionRecoveryWorkerIntegrationTests.cs
More file actions
438 lines (361 loc) · 18.4 KB
/
Copy pathAdminAnnouncementProjectionRecoveryWorkerIntegrationTests.cs
File metadata and controls
438 lines (361 loc) · 18.4 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
using Admin.Application.ProcessManagers;
using Admin.Infrastructure.Inbox;
using Admin.PublicContracts.Queries;
using BuildingBlocks.Application.Dispatching;
using BuildingBlocks.Application.ProcessManagers;
using BuildingBlocks.Infrastructure;
using BuildingBlocks.Infrastructure.Persistence;
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using NodaTime;
using Npgsql;
using System.Net;
using System.Net.Http.Json;
using System.Text.Json;
using BuildingBlocks.Testing.Http;
using static BuildingBlocks.Testing.Http.IntegrationTestHttpHelpers;
namespace Integration.Tests.Modules.Admin.Workers;
public sealed class AdminAnnouncementProjectionRecoveryWorkerIntegrationTests
{
[Xunit.Fact]
public async Task AdminRecoveryWorkerCompletesFailedAnnouncementProjectionBeforeOutboxRetry()
{
await using var application = await PostgresBackedApiApplication.StartAsync(
configurationOverrides: CreateWorkerConfiguration(),
configureBuilder: builder =>
{
builder.Services.Replace(ServiceDescriptor.Singleton<global::Admin.Application.Consumers.IAdminAnnouncementInbox, ThrowOnceAdminAnnouncementInbox>());
});
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var session = await SignInAsync(client);
var authCookie = session.Cookie;
var cookies = session.Cookies;
var publishResponse = await SendJsonAsync(
client,
HttpMethod.Post,
"/api/v1/sample-feature/announcements",
new { title = "Recover this announcement", body = "The Admin worker should recover the failed checkpoint." },
cookies,
session.HeaderName,
session.RequestToken,
"admin-worker-recovery-1");
Xunit.Assert.Equal(HttpStatusCode.OK, publishResponse.StatusCode);
using var publishJson = await ReadJsonAsync(publishResponse);
var announcementId = publishJson.RootElement.GetProperty("announcementId").GetGuid();
using (var scope = application.App.Services.CreateScope())
{
var dispatcher = scope.ServiceProvider.GetRequiredService<IIntegrationEventOutboxDispatcher>();
var dispatched = await dispatcher.DispatchAvailableAsync(CancellationToken.None);
Xunit.Assert.Equal(0, dispatched);
}
await WaitForConditionAsync(
async () =>
{
using var scope = application.App.Services.CreateScope();
var checkpointStore = scope.ServiceProvider.GetRequiredService<IProcessManagerCheckpointStore>();
var checkpoint = await checkpointStore.LoadAsync<AdminAnnouncementProjectionProcessState>(
"admin",
AdminAnnouncementProjectionProcessManager.ProcessManagerName,
announcementId.ToString("N"),
CancellationToken.None);
return checkpoint is { LifecycleState: ProcessManagerLifecycleState.Completed } completed
&& completed.State.ProjectionStored;
},
TimeSpan.FromSeconds(3));
using (var scope = application.App.Services.CreateScope())
{
var reader = scope.ServiceProvider.GetRequiredService<IAdminAnnouncementQueryService>();
var announcement = await reader.GetAsync(announcementId, CancellationToken.None);
Xunit.Assert.NotNull(announcement);
Xunit.Assert.Equal("Recover this announcement", announcement!.Title);
}
}
[Xunit.Fact]
public async Task AdminRecoveryWorkerWaitsUntilModuleIsReEnabledBeforeRecovering()
{
await using var application = await PostgresBackedApiApplication.StartAsync(configurationOverrides: CreateWorkerConfiguration());
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var session = await SignInAsync(client);
var authCookie = session.Cookie;
var cookies = session.Cookies;
var disableResponse = await SendAsync(
client,
HttpMethod.Post,
"/api/v1/platform/modules/admin/disable",
cookies,
session.HeaderName,
session.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.OK, disableResponse.StatusCode);
var announcementId = Guid.Parse("4ec99668-c29a-42f5-90dd-5821285f4fb8");
await SeedFailedCheckpointAsync(application.App.Services, announcementId);
await Task.Delay(TimeSpan.FromMilliseconds(500));
using (var scope = application.App.Services.CreateScope())
{
var checkpointStore = scope.ServiceProvider.GetRequiredService<IProcessManagerCheckpointStore>();
var checkpoint = await checkpointStore.LoadAsync<AdminAnnouncementProjectionProcessState>(
"admin",
AdminAnnouncementProjectionProcessManager.ProcessManagerName,
announcementId.ToString("N"),
CancellationToken.None);
Xunit.Assert.NotNull(checkpoint);
Xunit.Assert.Equal(ProcessManagerLifecycleState.Failed, checkpoint!.LifecycleState);
var reader = scope.ServiceProvider.GetRequiredService<IAdminAnnouncementQueryService>();
Xunit.Assert.Null(await reader.GetAsync(announcementId, CancellationToken.None));
}
var enableResponse = await SendAsync(
client,
HttpMethod.Post,
"/api/v1/platform/modules/admin/enable",
cookies,
session.HeaderName,
session.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.OK, enableResponse.StatusCode);
await WaitForConditionAsync(
async () =>
{
using var scope = application.App.Services.CreateScope();
var checkpointStore = scope.ServiceProvider.GetRequiredService<IProcessManagerCheckpointStore>();
var checkpoint = await checkpointStore.LoadAsync<AdminAnnouncementProjectionProcessState>(
"admin",
AdminAnnouncementProjectionProcessManager.ProcessManagerName,
announcementId.ToString("N"),
CancellationToken.None);
return checkpoint is { LifecycleState: ProcessManagerLifecycleState.Completed } completed
&& completed.State.ProjectionStored;
},
TimeSpan.FromSeconds(3));
}
private static IReadOnlyDictionary<string, string?> CreateWorkerConfiguration()
{
return new Dictionary<string, string?>
{
["Modules:Admin:ProjectionRecoveryWorker:PollIntervalMilliseconds"] = "100",
["Modules:Admin:ProjectionRecoveryWorker:StaleAfterMilliseconds"] = "100",
["Modules:Admin:ProjectionRecoveryWorker:BatchSize"] = "10"
};
}
private static async Task SeedFailedCheckpointAsync(IServiceProvider services, Guid announcementId)
{
using var scope = services.CreateScope();
var checkpointStore = scope.ServiceProvider.GetRequiredService<IProcessManagerCheckpointStore>();
// Fixed sentinel in the past: the worker's StaleAfterMilliseconds guard treats anything
// older than a few milliseconds as stale, so a hard-coded past Instant is sufficient and
// keeps the test independent of wall-clock time.
var occurredAt = Instant.FromUtc(2024, 1, 1, 0, 0);
await checkpointStore.SaveAsync(
new ProcessManagerCheckpoint<AdminAnnouncementProjectionProcessState>(
"admin",
AdminAnnouncementProjectionProcessManager.ProcessManagerName,
announcementId.ToString("N"),
ProcessManagerLifecycleState.Failed,
Version: 0,
UpdatedAt: occurredAt,
State: new AdminAnnouncementProjectionProcessState(
announcementId,
"Seeded recovery candidate",
"The worker should recover this after Admin is re-enabled.",
occurredAt.ToDateTimeOffset(),
"admin",
"sample-feature",
null,
Step: "projection-failed",
ProjectionStored: false,
FailureCode: "admin.announcement_projection_failed"),
Failure: new BuildingBlocks.Application.Results.Error(
"admin.announcement_projection_failed",
"Seeded to prove worker recovery.")),
CancellationToken.None);
}
private static async Task WaitForConditionAsync(Func<Task<bool>> condition, TimeSpan timeout)
{
using var deadline = new CancellationTokenSource(timeout);
while (!deadline.Token.IsCancellationRequested)
{
if (await condition())
{
return;
}
try
{
await Task.Delay(TimeSpan.FromMilliseconds(50), deadline.Token);
}
catch (OperationCanceledException)
{
break;
}
}
Xunit.Assert.Fail($"Condition was not satisfied within {timeout}.");
}
private static JsonElement GetModule(JsonDocument document, string moduleKey)
{
return document.RootElement
.GetProperty("modules")
.EnumerateArray()
.Single(element => string.Equals(element.GetProperty("key").GetString(), moduleKey, StringComparison.Ordinal));
}
[Xunit.Fact]
public async Task AdminRecoveryWorkerLetsInFlightRecoveryDrainBeforeDisableFinalizes()
{
var coordinator = new BlockingAdminAnnouncementInboxCoordinator();
await using var application = await PostgresBackedApiApplication.StartAsync(
configurationOverrides: CreateWorkerConfiguration(),
configureBuilder: builder =>
{
builder.Services.AddSingleton(coordinator);
builder.Services.Replace(ServiceDescriptor.Singleton<global::Admin.Application.Consumers.IAdminAnnouncementInbox, BlockingAdminAnnouncementInbox>());
});
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var session = await SignInAsync(client);
var authCookie = session.Cookie;
var cookies = session.Cookies;
var announcementId = Guid.Parse("b7e2a5c1-3f84-4d19-9c72-6e8a1b3d4f5e");
await SeedFailedCheckpointAsync(application.App.Services, announcementId);
await coordinator.WaitForStoreStartedAsync().WaitAsync(TimeSpan.FromSeconds(10));
var disableTask = SendAsync(
client,
HttpMethod.Post,
"/api/v1/platform/modules/admin/disable",
cookies,
session.HeaderName,
session.RequestToken);
await WaitForConditionAsync(
async () =>
{
var modulesResponse = await SendAsync(client, HttpMethod.Get, "/api/v1/platform/modules");
if (modulesResponse.StatusCode != HttpStatusCode.OK)
{
return false;
}
using var modulesJson = await ReadJsonAsync(modulesResponse);
var admin = GetModule(modulesJson, "admin");
return string.Equals(admin.GetProperty("desiredState").GetString(), "disabled", StringComparison.Ordinal)
&& string.Equals(admin.GetProperty("runtimeState").GetString(), "disabling", StringComparison.Ordinal);
},
TimeSpan.FromSeconds(5));
Xunit.Assert.False(disableTask.IsCompleted, "Disable should wait for the in-flight recovery lease to drain.");
using (var scope = application.App.Services.CreateScope())
{
var checkpointStore = scope.ServiceProvider.GetRequiredService<IProcessManagerCheckpointStore>();
var checkpoint = await checkpointStore.LoadAsync<AdminAnnouncementProjectionProcessState>(
"admin",
AdminAnnouncementProjectionProcessManager.ProcessManagerName,
announcementId.ToString("N"),
CancellationToken.None);
Xunit.Assert.NotNull(checkpoint);
Xunit.Assert.Equal(ProcessManagerLifecycleState.Failed, checkpoint!.LifecycleState);
}
coordinator.ReleaseStore();
var disableResponse = await disableTask.WaitAsync(TimeSpan.FromSeconds(10));
Xunit.Assert.Equal(HttpStatusCode.OK, disableResponse.StatusCode);
await WaitForConditionAsync(
async () =>
{
using var scope = application.App.Services.CreateScope();
var checkpointStore = scope.ServiceProvider.GetRequiredService<IProcessManagerCheckpointStore>();
var checkpoint = await checkpointStore.LoadAsync<AdminAnnouncementProjectionProcessState>(
"admin",
AdminAnnouncementProjectionProcessManager.ProcessManagerName,
announcementId.ToString("N"),
CancellationToken.None);
return checkpoint is { LifecycleState: ProcessManagerLifecycleState.Completed } completed
&& completed.State.ProjectionStored;
},
TimeSpan.FromSeconds(5));
using (var scope = application.App.Services.CreateScope())
{
var reader = scope.ServiceProvider.GetRequiredService<IAdminAnnouncementQueryService>();
var announcement = await reader.GetAsync(announcementId, CancellationToken.None);
Xunit.Assert.NotNull(announcement);
Xunit.Assert.Equal("Seeded recovery candidate", announcement!.Title);
}
}
private sealed class BlockingAdminAnnouncementInboxCoordinator
{
private readonly TaskCompletionSource _releaseStore = new(TaskCreationOptions.RunContinuationsAsynchronously);
private readonly TaskCompletionSource _storeStarted = new(TaskCreationOptions.RunContinuationsAsynchronously);
public Task WaitForStoreStartedAsync()
{
return _storeStarted.Task;
}
public void MarkStoreStarted()
{
_storeStarted.TrySetResult();
}
public void ReleaseStore()
{
_releaseStore.TrySetResult();
}
public Task WaitForReleaseAsync(CancellationToken cancellationToken)
{
return _releaseStore.Task.WaitAsync(cancellationToken);
}
}
private sealed class BlockingAdminAnnouncementInbox : global::Admin.Application.Consumers.IAdminAnnouncementInbox
{
private readonly BlockingAdminAnnouncementInboxCoordinator _coordinator;
private readonly string _connectionString;
private int _remainingBlocks = 1;
public BlockingAdminAnnouncementInbox(IConfiguration configuration, BlockingAdminAnnouncementInboxCoordinator coordinator)
{
ArgumentNullException.ThrowIfNull(configuration);
_coordinator = coordinator ?? throw new ArgumentNullException(nameof(coordinator));
_connectionString = configuration.GetConnectionString("BaselineDatabase")
?? throw new InvalidOperationException("Admin worker recovery test requires ConnectionStrings:BaselineDatabase.");
}
public async ValueTask StoreAsync(global::Admin.Application.Consumers.AdminAnnouncementProjection announcement, CancellationToken cancellationToken)
{
if (Interlocked.Exchange(ref _remainingBlocks, 0) == 1)
{
_coordinator.MarkStoreStarted();
await _coordinator.WaitForReleaseAsync(cancellationToken);
}
await InsertAnnouncementAsync(_connectionString, announcement, cancellationToken);
}
}
private sealed class ThrowOnceAdminAnnouncementInbox : global::Admin.Application.Consumers.IAdminAnnouncementInbox
{
private readonly string _connectionString;
private int _remainingFailures = 1;
public ThrowOnceAdminAnnouncementInbox(IConfiguration configuration)
{
ArgumentNullException.ThrowIfNull(configuration);
_connectionString = configuration.GetConnectionString("BaselineDatabase")
?? throw new InvalidOperationException("Admin worker recovery test requires ConnectionStrings:BaselineDatabase.");
}
public async ValueTask StoreAsync(global::Admin.Application.Consumers.AdminAnnouncementProjection announcement, CancellationToken cancellationToken)
{
if (Interlocked.Exchange(ref _remainingFailures, 0) == 1)
{
throw new InvalidOperationException("Synthetic Admin projection failure.");
}
await InsertAnnouncementAsync(_connectionString, announcement, cancellationToken);
}
}
private static async Task InsertAnnouncementAsync(
string connectionString,
global::Admin.Application.Consumers.AdminAnnouncementProjection announcement,
CancellationToken cancellationToken)
{
const string sql = """
INSERT INTO admin.announcements (announcement_id, title, body, published_utc, published_by_actor_id, source_module_key, source_reference)
VALUES (@announcementId, @title, @body, @publishedUtc, @publishedByActorId, @sourceModuleKey, @sourceReference)
ON CONFLICT (announcement_id) DO NOTHING;
""";
await using var connection = new NpgsqlConnection(connectionString);
await connection.OpenAsync(cancellationToken);
await using var command = new NpgsqlCommand(sql, connection);
command.Parameters.AddWithValue("announcementId", announcement.AnnouncementId);
command.Parameters.AddWithValue("title", announcement.Title);
command.Parameters.AddWithValue("body", announcement.Body);
command.Parameters.AddWithValue("publishedUtc", announcement.PublishedUtc);
command.Parameters.AddWithValue("publishedByActorId", announcement.PublishedByActorId);
command.Parameters.AddWithValue("sourceModuleKey", announcement.SourceModuleKey);
command.Parameters.AddWithValue("sourceReference", (object?)announcement.SourceReference ?? DBNull.Value);
await command.ExecuteNonQueryAsync(cancellationToken);
}
}