-
Notifications
You must be signed in to change notification settings - Fork 9.8k
/
HubLifetimeManagerTestBase.cs
368 lines (294 loc) · 16.5 KB
/
HubLifetimeManagerTestBase.cs
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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Threading.Tasks.Extensions;
using Microsoft.AspNetCore.SignalR.Protocol;
using Microsoft.AspNetCore.SignalR.Tests;
using Xunit;
namespace Microsoft.AspNetCore.SignalR.Specification.Tests;
/// <summary>
/// Base test class for lifetime manager implementations. Nothing specific to scale-out for these tests.
/// </summary>
/// <typeparam name="THub">The type of the <see cref="Hub"/>.</typeparam>
public abstract class HubLifetimeManagerTestsBase<THub> where THub : Hub
{
/// <summary>
/// This API is obsolete and will be removed in a future version. Use CreateNewHubLifetimeManager in tests instead.
/// </summary>
[Obsolete("This API is obsolete and will be removed in a future version. Use CreateNewHubLifetimeManager in tests instead.")]
public HubLifetimeManager<THub> Manager { get; set; }
/// <summary>
/// Method to create an implementation of <see cref="HubLifetimeManager{THub}"/> for use in tests.
/// </summary>
/// <returns>The implementation of <see cref="HubLifetimeManager{THub}"/> to test against.</returns>
public abstract HubLifetimeManager<THub> CreateNewHubLifetimeManager();
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task SendAllAsyncWritesToAllConnectionsOutput()
{
using (var client1 = new TestClient())
using (var client2 = new TestClient())
{
var manager = CreateNewHubLifetimeManager();
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
var connection2 = HubConnectionContextUtils.Create(client2.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
await manager.OnConnectedAsync(connection2).DefaultTimeout();
await manager.SendAllAsync("Hello", new object[] { "World" }).DefaultTimeout();
var message = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.Equal("Hello", message.Target);
Assert.Single(message.Arguments);
Assert.Equal("World", (string)message.Arguments[0]);
message = Assert.IsType<InvocationMessage>(await client2.ReadAsync().DefaultTimeout());
Assert.Equal("Hello", message.Target);
Assert.Single(message.Arguments);
Assert.Equal("World", (string)message.Arguments[0]);
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task SendAllAsyncDoesNotWriteToDisconnectedConnectionsOutput()
{
using (var client1 = new TestClient())
using (var client2 = new TestClient())
{
var manager = CreateNewHubLifetimeManager();
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
var connection2 = HubConnectionContextUtils.Create(client2.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
await manager.OnConnectedAsync(connection2).DefaultTimeout();
await manager.OnDisconnectedAsync(connection2).DefaultTimeout();
await manager.SendAllAsync("Hello", new object[] { "World" }).DefaultTimeout();
var message = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.Equal("Hello", message.Target);
Assert.Single(message.Arguments);
Assert.Equal("World", (string)message.Arguments[0]);
Assert.Null(client2.TryRead());
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task SendGroupAsyncWritesToAllConnectionsInGroupOutput()
{
using (var client1 = new TestClient())
using (var client2 = new TestClient())
{
var manager = CreateNewHubLifetimeManager();
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
var connection2 = HubConnectionContextUtils.Create(client2.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
await manager.OnConnectedAsync(connection2).DefaultTimeout();
await manager.AddToGroupAsync(connection1.ConnectionId, "group").DefaultTimeout();
await manager.SendGroupAsync("group", "Hello", new object[] { "World" }).DefaultTimeout();
var message = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.Equal("Hello", message.Target);
Assert.Single(message.Arguments);
Assert.Equal("World", (string)message.Arguments[0]);
Assert.Null(client2.TryRead());
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task SendGroupExceptAsyncDoesNotWriteToExcludedConnections()
{
using (var client1 = new TestClient())
using (var client2 = new TestClient())
{
var manager = CreateNewHubLifetimeManager();
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
var connection2 = HubConnectionContextUtils.Create(client2.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
await manager.OnConnectedAsync(connection2).DefaultTimeout();
await manager.AddToGroupAsync(connection1.ConnectionId, "group1").DefaultTimeout();
await manager.AddToGroupAsync(connection2.ConnectionId, "group1").DefaultTimeout();
await manager.SendGroupExceptAsync("group1", "Hello", new object[] { "World" }, new[] { connection2.ConnectionId }).DefaultTimeout();
var message = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.Equal("Hello", message.Target);
Assert.Single(message.Arguments);
Assert.Equal("World", (string)message.Arguments[0]);
Assert.Null(client2.TryRead());
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task SendConnectionAsyncWritesToConnectionOutput()
{
using (var client = new TestClient())
{
var manager = CreateNewHubLifetimeManager();
var connection = HubConnectionContextUtils.Create(client.Connection);
await manager.OnConnectedAsync(connection).DefaultTimeout();
await manager.SendConnectionAsync(connection.ConnectionId, "Hello", new object[] { "World" }).DefaultTimeout();
var message = Assert.IsType<InvocationMessage>(await client.ReadAsync().DefaultTimeout());
Assert.Equal("Hello", message.Target);
Assert.Single(message.Arguments);
Assert.Equal("World", (string)message.Arguments[0]);
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task CanProcessClientReturnResult()
{
var manager = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
var resultTask = manager.InvokeConnectionAsync<int>(connection1.ConnectionId, "Result", new object[] { "test" }, cancellationToken: default);
var invocation = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.NotNull(invocation.InvocationId);
Assert.Equal("test", invocation.Arguments[0]);
await manager.SetConnectionResultAsync(connection1.ConnectionId, CompletionMessage.WithResult(invocation.InvocationId, 10)).DefaultTimeout();
var res = await resultTask.DefaultTimeout();
Assert.Equal(10L, res);
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task CanProcessClientReturnErrorResult()
{
var manager = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
var resultTask = manager.InvokeConnectionAsync<int>(connection1.ConnectionId, "Result", new object[] { "test" }, cancellationToken: default);
var invocation = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.NotNull(invocation.InvocationId);
Assert.Equal("test", invocation.Arguments[0]);
await manager.SetConnectionResultAsync(connection1.ConnectionId, CompletionMessage.WithError(invocation.InvocationId, "Error from client")).DefaultTimeout();
var ex = await Assert.ThrowsAsync<HubException>(() => resultTask).DefaultTimeout();
Assert.Equal("Error from client", ex.Message);
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task ExceptionWhenIncorrectClientCompletesClientResult()
{
var manager = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
using (var client2 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
var connection2 = HubConnectionContextUtils.Create(client2.Connection);
await manager.OnConnectedAsync(connection1).DefaultTimeout();
await manager.OnConnectedAsync(connection2).DefaultTimeout();
var resultTask = manager.InvokeConnectionAsync<int>(connection1.ConnectionId, "Result", new object[] { "test" }, cancellationToken: default);
var invocation = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
Assert.NotNull(invocation.InvocationId);
Assert.Equal("test", invocation.Arguments[0]);
var ex = await Assert.ThrowsAsync<InvalidOperationException>(() =>
manager.SetConnectionResultAsync(connection2.ConnectionId, CompletionMessage.WithError(invocation.InvocationId, "Error from client"))).DefaultTimeout();
Assert.Equal($"Connection ID '{connection2.ConnectionId}' is not valid for invocation ID '{invocation.InvocationId}'.", ex.Message);
// Internal state for invocation isn't affected by wrong client, check that we can still complete the invocation
await manager.SetConnectionResultAsync(connection1.ConnectionId, CompletionMessage.WithResult(invocation.InvocationId, 10)).DefaultTimeout();
var res = await resultTask.DefaultTimeout();
Assert.Equal(10L, res);
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task ConnectionIDNotPresentWhenInvokingClientResult()
{
var manager1 = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
await manager1.OnConnectedAsync(connection1).DefaultTimeout();
// No client with this ID
await Assert.ThrowsAsync<IOException>(() => manager1.InvokeConnectionAsync<int>("none", "Result", new object[] { "test" }, cancellationToken: default)).DefaultTimeout();
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task InvokesForMultipleClientsDoNotCollide()
{
var manager1 = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
using (var client2 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
var connection2 = HubConnectionContextUtils.Create(client2.Connection);
await manager1.OnConnectedAsync(connection1).DefaultTimeout();
await manager1.OnConnectedAsync(connection2).DefaultTimeout();
var invoke1 = manager1.InvokeConnectionAsync<int>(connection1.ConnectionId, "Result", new object[] { "test" }, cancellationToken: default);
var invoke2 = manager1.InvokeConnectionAsync<int>(connection2.ConnectionId, "Result", new object[] { "test" }, cancellationToken: default);
var invocation1 = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
var invocation2 = Assert.IsType<InvocationMessage>(await client2.ReadAsync().DefaultTimeout());
await manager1.SetConnectionResultAsync(connection2.ConnectionId, CompletionMessage.WithError(invocation2.InvocationId, "error"));
await Assert.ThrowsAnyAsync<Exception>(() => invoke2).DefaultTimeout();
Assert.False(invoke1.IsCompleted);
await manager1.SetConnectionResultAsync(connection1.ConnectionId, CompletionMessage.WithResult(invocation1.InvocationId, 3));
Assert.Equal(3, await invoke1.DefaultTimeout());
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task ClientDisconnectsWithoutCompletingClientResult()
{
var manager1 = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
await manager1.OnConnectedAsync(connection1).DefaultTimeout();
var invoke1 = manager1.InvokeConnectionAsync<int>(connection1.ConnectionId, "Result", new object[] { "test" }, cancellationToken: default);
connection1.Abort();
await manager1.OnDisconnectedAsync(connection1).DefaultTimeout();
var ex = await Assert.ThrowsAsync<IOException>(() => invoke1).DefaultTimeout();
Assert.Equal($"Connection '{connection1.ConnectionId}' disconnected.", ex.Message);
}
}
/// <summary>
/// Specification test for SignalR HubLifetimeManager.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous completion of the test.</returns>
[Fact]
public async Task CanCancelClientResult()
{
var manager1 = CreateNewHubLifetimeManager();
using (var client1 = new TestClient())
{
var connection1 = HubConnectionContextUtils.Create(client1.Connection);
await manager1.OnConnectedAsync(connection1).DefaultTimeout();
var cts = new CancellationTokenSource();
var invoke1 = manager1.InvokeConnectionAsync<int>(connection1.ConnectionId, "Result", new object[] { "test" }, cts.Token);
var invocation1 = Assert.IsType<InvocationMessage>(await client1.ReadAsync().DefaultTimeout());
cts.Cancel();
await Assert.ThrowsAsync<HubException>(() => invoke1).DefaultTimeout();
// Noop, just checking that it doesn't throw. This could be caused by an inflight response from a client while the server cancels the token
await manager1.SetConnectionResultAsync(connection1.ConnectionId, CompletionMessage.WithResult(invocation1.InvocationId, 1));
}
}
}