mirror of
https://github.com/Govor-team/Govor.git
synced 2026-11-18 05:15:06 +00:00
Harden push notification delivery
Keep encrypted message content out of push payloads and improve cross-platform notification data. Add token registration validation and per-session unregister support, batch and deduplicate sends, remove only confirmed unregistered tokens, and protect queued retries with leases. Add delivery tests and document the push API and Firebase setup.
This commit is contained in:
@@ -0,0 +1,95 @@
|
||||
using System.Collections.Concurrent;
|
||||
using System.Net;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using FirebaseAdmin;
|
||||
using FirebaseAdmin.Messaging;
|
||||
using Google.Apis.Auth.OAuth2;
|
||||
using Google.Apis.Http;
|
||||
using Govor.Application.Interfaces.PushNotifications.Models;
|
||||
using Govor.Application.PushNotifications.Providers;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
|
||||
namespace Govor.Server.Tests;
|
||||
|
||||
[TestFixture]
|
||||
public class FirebasePushProviderTests
|
||||
{
|
||||
private FirebaseApp _app = null!;
|
||||
private FirebasePushProvider _provider = null!;
|
||||
private readonly ConcurrentQueue<JsonElement> _requests = new();
|
||||
private HttpStatusCode _status;
|
||||
private string _response = "";
|
||||
|
||||
[SetUp]
|
||||
public void SetUp()
|
||||
{
|
||||
_requests.Clear();
|
||||
_status = HttpStatusCode.OK;
|
||||
_response = """{"name":"projects/test/messages/accepted"}""";
|
||||
_app = FirebaseApp.Create(new AppOptions
|
||||
{
|
||||
ProjectId = "test",
|
||||
Credential = GoogleCredential.FromAccessToken("test-access-token"),
|
||||
HttpClientFactory = new StubHttpFactory(async request =>
|
||||
{
|
||||
using var json = JsonDocument.Parse(await request.Content!.ReadAsStringAsync());
|
||||
_requests.Enqueue(json.RootElement.GetProperty("message").Clone());
|
||||
return new HttpResponseMessage(_status) { Content = new StringContent(_response, Encoding.UTF8, "application/json") };
|
||||
})
|
||||
}, Guid.NewGuid().ToString());
|
||||
_provider = new FirebasePushProvider(NullLogger<FirebasePushProvider>.Instance, FirebaseMessaging.GetMessaging(_app));
|
||||
}
|
||||
|
||||
[TearDown]
|
||||
public void TearDown() => _app.Delete();
|
||||
|
||||
[TestCase(false)]
|
||||
[TestCase(true)]
|
||||
public async Task SingleAndMulticastUseEquivalentPlatformPayloads(bool multicast)
|
||||
{
|
||||
var message = new PushMessage { Title = "Alice", Body = "New message", ChannelId = "chat_messages",
|
||||
Tag = "chat_123", Data = new() { ["messageId"] = "123" } };
|
||||
var result = multicast
|
||||
? await _provider.SendMulticastAsync(new[] { "device", "device" }, message)
|
||||
: await _provider.SendToTokenAsync("device", message);
|
||||
Assert.That(result.SuccessCount, Is.EqualTo(1));
|
||||
var sent = _requests.Single();
|
||||
Assert.That(sent.GetProperty("token").GetString(), Is.EqualTo("device"));
|
||||
Assert.That(sent.GetProperty("data").GetProperty("messageId").GetString(), Is.EqualTo("123"));
|
||||
Assert.That(sent.GetProperty("android").GetProperty("priority").GetString(), Is.EqualTo("high"));
|
||||
var android = sent.GetProperty("android").GetProperty("notification");
|
||||
Assert.That(android.GetProperty("channel_id").GetString(), Is.EqualTo("chat_messages"));
|
||||
Assert.That(android.GetProperty("tag").GetString(), Is.EqualTo("chat_123"));
|
||||
var apns = sent.GetProperty("apns");
|
||||
Assert.That(apns.GetProperty("headers").GetProperty("apns-push-type").GetString(), Is.EqualTo("alert"));
|
||||
Assert.That(apns.GetProperty("payload").GetProperty("aps").GetProperty("thread-id").GetString(), Is.EqualTo("chat_123"));
|
||||
Assert.That(sent.GetProperty("webpush").GetProperty("notification").GetProperty("tag").GetString(), Is.EqualTo("chat_123"));
|
||||
}
|
||||
|
||||
[TestCase("UNREGISTERED", HttpStatusCode.NotFound, true)]
|
||||
[TestCase("INVALID_ARGUMENT", HttpStatusCode.BadRequest, false)]
|
||||
[TestCase("SENDER_ID_MISMATCH", HttpStatusCode.Forbidden, false)]
|
||||
public async Task MulticastInvalidatesOnlyUnregisteredTokens(string code, HttpStatusCode status, bool invalid)
|
||||
{
|
||||
_status = status;
|
||||
_response = JsonSerializer.Serialize(new { error = new { code = (int)status, message = "FCM failure",
|
||||
status = status == HttpStatusCode.NotFound ? "NOT_FOUND" : status == HttpStatusCode.BadRequest ? "INVALID_ARGUMENT" : "PERMISSION_DENIED",
|
||||
details = new[] { new Dictionary<string, string> { ["@type"] = "type.googleapis.com/google.firebase.fcm.v1.FcmError", ["errorCode"] = code } } } });
|
||||
|
||||
var result = await _provider.SendMulticastAsync(new[] { "device" }, new PushMessage { Title = "test", Body = "test" });
|
||||
|
||||
Assert.That(result.FailureCount, Is.EqualTo(1));
|
||||
Assert.That(result.FailedTokens, Is.EqualTo(invalid ? new[] { "device" } : Array.Empty<string>()));
|
||||
}
|
||||
|
||||
private sealed class StubHttpFactory(Func<HttpRequestMessage, Task<HttpResponseMessage>> send) : Google.Apis.Http.HttpClientFactory
|
||||
{
|
||||
protected override HttpMessageHandler CreateHandler(CreateHttpClientArgs args) => new StubHandler(send);
|
||||
}
|
||||
|
||||
private sealed class StubHandler(Func<HttpRequestMessage, Task<HttpResponseMessage>> send) : HttpMessageHandler
|
||||
{
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) => send(request);
|
||||
}
|
||||
}
|
||||
@@ -75,7 +75,7 @@ public class NotificationTests
|
||||
Assert.That(_events.Single(e => e.Method == ChatHubConstants.MessageSent).Groups,
|
||||
Is.EqualTo(new[] { ChatHubConstants.GetSessionGroup(_aliceSession) }));
|
||||
_push.Verify(p => p.SendToUsersAsync(It.Is<IEnumerable<Guid>>(ids => ids.SequenceEqual(new[] { _db.Bob })),
|
||||
"Alice", "hello", "chat_messages", $"chat_{_db.ChatId}",
|
||||
"Alice", "New message", "chat_messages", $"chat_{_db.ChatId}",
|
||||
It.Is<Dictionary<string, string>?>(data => data != null && data["messageId"] == message.MessageId.ToString())), Times.Once);
|
||||
}
|
||||
|
||||
@@ -99,6 +99,34 @@ public class NotificationTests
|
||||
It.IsAny<Dictionary<string, string>?>()), Times.Once);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task MessageReadBeforeRetrySuppressesPush()
|
||||
{
|
||||
var saved = _db.AddMessage();
|
||||
_db.Context.MessageViews.Add(new MessageView
|
||||
{ Id = Guid.NewGuid(), MessageId = saved.Id, UserId = _db.Bob, ViewedAt = DateTime.UtcNow });
|
||||
await _db.Context.SaveChangesAsync();
|
||||
var message = Message();
|
||||
message.MessageId = saved.Id;
|
||||
|
||||
Assert.That(await _notifier.DeliverPushAsync(message), Is.True);
|
||||
_push.Verify(p => p.SendToUsersAsync(It.IsAny<IEnumerable<Guid>>(), It.IsAny<string>(), It.IsAny<string>(),
|
||||
It.IsAny<string>(), It.IsAny<string>(), It.IsAny<Dictionary<string, string>?>()), Times.Never);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task PushDoesNotExposeContentAndKeepsRoutingData()
|
||||
{
|
||||
var message = Message();
|
||||
message.EncryptedContent = "sensitive plaintext or ciphertext";
|
||||
Assert.That(await _notifier.DeliverPushAsync(message), Is.True);
|
||||
_push.Verify(p => p.SendToUsersAsync(It.IsAny<IEnumerable<Guid>>(), "Alice", "New message",
|
||||
"chat_messages", $"chat_{_db.ChatId}", It.Is<Dictionary<string, string>?>(data => data != null &&
|
||||
data["type"] == "chat_message" && data["senderId"] == _db.Alice.ToString() &&
|
||||
data["chatId"] == _db.ChatId.ToString() && data["isGroup"] == "false" &&
|
||||
data["messageId"] == message.MessageId.ToString() && !data.Values.Contains(message.EncryptedContent))), Times.Once);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task SignalRFailureStillAttemptsPushAndProviderFailureDoesNotFailSavedSend()
|
||||
{
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
using Govor.Application.Interfaces.PushNotifications.Models;
|
||||
using Govor.Application.PushNotifications;
|
||||
using Govor.Application.PushNotifications.Providers;
|
||||
using Govor.Domain.Common;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using Moq;
|
||||
using SmartRes;
|
||||
|
||||
namespace Govor.Server.Tests;
|
||||
|
||||
[TestFixture]
|
||||
public class PushDeliveryTests
|
||||
{
|
||||
private Mock<IPushTokenService> _tokens = null!;
|
||||
private Mock<IPushNotificationProvider> _provider = null!;
|
||||
private PushNotificationService _service = null!;
|
||||
private Guid _user;
|
||||
|
||||
[SetUp]
|
||||
public void SetUp()
|
||||
{
|
||||
_user = Guid.NewGuid();
|
||||
_tokens = new Mock<IPushTokenService>(MockBehavior.Strict);
|
||||
_provider = new Mock<IPushNotificationProvider>(MockBehavior.Strict);
|
||||
_service = new PushNotificationService(_provider.Object, _tokens.Object,
|
||||
NullLogger<PushNotificationService>.Instance);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task MulticastDeduplicatesAndContinuesAfterOneBatchFails()
|
||||
{
|
||||
var tokens = Enumerable.Range(0, 501).Select(i => $"token-{i}").ToList();
|
||||
_tokens.Setup(t => t.GetStringsActiveTokensAsync(_user))
|
||||
.ReturnsAsync(Result<List<string>, Error>.Success(tokens.Concat(tokens).ToList()));
|
||||
_provider.Setup(p => p.SendMulticastAsync(It.Is<IReadOnlyList<string>>(t => t.Count == 500), It.IsAny<PushMessage>()))
|
||||
.ThrowsAsync(new HttpRequestException("Provider unavailable"));
|
||||
_provider.Setup(p => p.SendMulticastAsync(It.Is<IReadOnlyList<string>>(t => t.Count == 1 && t[0] == "token-500"), It.IsAny<PushMessage>()))
|
||||
.ReturnsAsync(new SendPushResult(1, 0, []));
|
||||
|
||||
var result = await _service.SendToUserAsync(_user, "title", "body", "chat_messages");
|
||||
|
||||
Assert.That(result.IsFailure, Is.True);
|
||||
_provider.VerifyAll();
|
||||
_tokens.Verify(t => t.RemoveTokensAsync(It.IsAny<IEnumerable<string>>()), Times.Never);
|
||||
}
|
||||
|
||||
[TestCase(1, true)]
|
||||
[TestCase(2, false)]
|
||||
public async Task OnlyUnregisteredTokensAreRemovedAndTemporaryFailuresRequireRetry(int failures, bool success)
|
||||
{
|
||||
_tokens.Setup(t => t.GetStringsActiveTokensAsync(_user))
|
||||
.ReturnsAsync(Result<List<string>, Error>.Success(["good", "unregistered", "temporary"]));
|
||||
_provider.Setup(p => p.SendMulticastAsync(It.IsAny<IReadOnlyList<string>>(), It.IsAny<PushMessage>()))
|
||||
.ReturnsAsync(new SendPushResult(3 - failures, failures, ["unregistered"]));
|
||||
_tokens.Setup(t => t.RemoveTokensAsync(It.Is<IEnumerable<string>>(t => t.SequenceEqual(new[] { "unregistered" }))))
|
||||
.ReturnsAsync(Govor.Domain.Common.Result.Success());
|
||||
|
||||
var result = await _service.SendToUserAsync(_user, "title", "body", "chat_messages");
|
||||
|
||||
Assert.That(result.IsSuccess, Is.EqualTo(success));
|
||||
_tokens.VerifyAll();
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task FailedCleanupIsNotAcknowledgedForEitherSingleOrMulticastDelivery()
|
||||
{
|
||||
_tokens.Setup(t => t.GetStringsActiveTokensAsync(_user))
|
||||
.ReturnsAsync(Result<List<string>, Error>.Success(["unregistered"]));
|
||||
_tokens.Setup(t => t.GetActiveTokenBySessionAsync(_user))
|
||||
.ReturnsAsync(Result<string?, Error>.Success("unregistered"));
|
||||
_tokens.Setup(t => t.RemoveTokensAsync(It.IsAny<IEnumerable<string>>()))
|
||||
.ReturnsAsync(Govor.Domain.Common.Result.Failure(Error.ServerError("Test.Cleanup", "Unavailable")));
|
||||
_provider.Setup(p => p.SendMulticastAsync(It.IsAny<IReadOnlyList<string>>(), It.IsAny<PushMessage>()))
|
||||
.ReturnsAsync(new SendPushResult(0, 1, ["unregistered"]));
|
||||
_provider.Setup(p => p.SendToTokenAsync("unregistered", It.IsAny<PushMessage>()))
|
||||
.ReturnsAsync(new SendPushResult(0, 1, ["unregistered"]));
|
||||
|
||||
Assert.That((await _service.SendToUserAsync(_user, "title", "body", "chat_messages")).IsFailure, Is.True);
|
||||
Assert.That((await _service.SendToSessionAsync(_user, "title", "body", "chat_messages")).IsFailure, Is.True);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task IncompleteProviderResponseDoesNotLoseTheNotification()
|
||||
{
|
||||
_tokens.Setup(t => t.GetStringsActiveTokensAsync(_user))
|
||||
.ReturnsAsync(Result<List<string>, Error>.Success(["token"]));
|
||||
_provider.Setup(p => p.SendMulticastAsync(It.IsAny<IReadOnlyList<string>>(), It.IsAny<PushMessage>()))
|
||||
.ReturnsAsync(new SendPushResult(0, 0, []));
|
||||
Assert.That((await _service.SendToUserAsync(_user, "title", "body", "chat_messages")).IsFailure, Is.True);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task NoTokensIsSuccessfulWithoutContactingProvider()
|
||||
{
|
||||
_tokens.Setup(t => t.GetStringsActiveTokensAsync(_user))
|
||||
.ReturnsAsync(Result<List<string>, Error>.Success([]));
|
||||
Assert.That((await _service.SendToUserAsync(_user, "title", "body", "chat_messages")).IsSuccess, Is.True);
|
||||
_provider.VerifyNoOtherCalls();
|
||||
}
|
||||
}
|
||||
@@ -112,6 +112,56 @@ public class PushReliabilityTests
|
||||
Assert.That(forbidden.Error.Type, Is.EqualTo(ErrorType.Forbidden));
|
||||
}
|
||||
|
||||
[TestCase(true)]
|
||||
[TestCase(false)]
|
||||
public async Task ExpiredWorkerCannotDeleteOrRescheduleANewerLease(bool delivered)
|
||||
{
|
||||
var message = _db.AddMessage();
|
||||
_db.Context.ChatPushNotifications.Add(new Govor.Domain.Models.Messages.ChatPushNotification
|
||||
{ MessageId = message.Id, NextAttemptAt = _now });
|
||||
await _db.Context.SaveChangesAsync();
|
||||
var notifier = new Mock<IChatNotificationService>();
|
||||
var secondWorker = new Mock<IChatNotificationService>();
|
||||
secondWorker.Setup(n => n.DeliverPushAsync(It.IsAny<UserMessageResponse>())).ReturnsAsync(false);
|
||||
DateTime retryAt = default;
|
||||
notifier.Setup(n => n.DeliverPushAsync(It.IsAny<UserMessageResponse>())).Returns(async () =>
|
||||
{
|
||||
_now = _now.AddMinutes(3);
|
||||
using var otherContext = _db.CreateContext();
|
||||
await new ChatPushDispatcher(otherContext, secondWorker.Object, _clock.Object).DispatchAsync();
|
||||
retryAt = (await otherContext.ChatPushNotifications.AsNoTracking().SingleAsync()).NextAttemptAt;
|
||||
_now = _now.AddSeconds(1);
|
||||
return delivered;
|
||||
});
|
||||
|
||||
await new ChatPushDispatcher(_db.Context, notifier.Object, _clock.Object).DispatchAsync();
|
||||
|
||||
var pending = await _db.Context.ChatPushNotifications.AsNoTracking().SingleAsync();
|
||||
Assert.That(pending.Attempts, Is.EqualTo(2));
|
||||
Assert.That(pending.NextAttemptAt, Is.EqualTo(retryAt));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task NotificationExceptionDoesNotBlockRemainingMessagesInBatch()
|
||||
{
|
||||
foreach (var _ in Enumerable.Range(0, 2))
|
||||
{
|
||||
var message = _db.AddMessage();
|
||||
_db.Context.ChatPushNotifications.Add(new Govor.Domain.Models.Messages.ChatPushNotification
|
||||
{ MessageId = message.Id, NextAttemptAt = _now });
|
||||
}
|
||||
await _db.Context.SaveChangesAsync();
|
||||
var notifier = new Mock<IChatNotificationService>();
|
||||
notifier.SetupSequence(n => n.DeliverPushAsync(It.IsAny<UserMessageResponse>()))
|
||||
.ThrowsAsync(new HttpRequestException("offline")).ReturnsAsync(true);
|
||||
|
||||
await new ChatPushDispatcher(_db.Context, notifier.Object, _clock.Object).DispatchAsync();
|
||||
|
||||
notifier.Verify(n => n.DeliverPushAsync(It.IsAny<UserMessageResponse>()), Times.Exactly(2));
|
||||
var pending = await _db.Context.ChatPushNotifications.AsNoTracking().SingleAsync();
|
||||
Assert.That(pending.NextAttemptAt, Is.EqualTo(_now.AddSeconds(2)));
|
||||
}
|
||||
|
||||
private Guid AddSession(Guid user)
|
||||
{
|
||||
var session = new UserSession { UserId = user, ExpiresAt = _now.AddDays(1), RefreshTokenHash = Guid.NewGuid().ToString() };
|
||||
|
||||
@@ -86,6 +86,43 @@ public class ReadApiTests
|
||||
Assert.That(await count.Content.ReadAsStringAsync(), Does.Contain("\"unreadCount\":0"));
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task PushRegistrationRotationAndUnregisterAffectOnlyTheAuthenticatedSession()
|
||||
{
|
||||
var otherSession = new UserSession { UserId = _db.Bob, ExpiresAt = DateTime.UtcNow.AddDays(1), RefreshTokenHash = "other-device" };
|
||||
_db.Context.UserSessions.Add(otherSession);
|
||||
_db.Context.UserPushTokens.Add(new UserPushToken
|
||||
{ UserId = _db.Bob, UserSessionId = otherSession.Id, Token = "other-device", Platform = "android" });
|
||||
await _db.Context.SaveChangesAsync();
|
||||
Assert.That((await _client.DeleteAsync("/api/pushes/token")).StatusCode, Is.EqualTo(HttpStatusCode.Unauthorized));
|
||||
Authorize();
|
||||
foreach (var token in new[] { "original", "rotated" })
|
||||
Assert.That((await _client.PostAsJsonAsync("/api/pushes/token/register", new { token, platform = "android" })).StatusCode,
|
||||
Is.EqualTo(HttpStatusCode.NoContent));
|
||||
var registered = await _db.Context.UserPushTokens.AsNoTracking().SingleAsync(t => t.UserSessionId == _session);
|
||||
Assert.That(registered.Token, Is.EqualTo("rotated"));
|
||||
foreach (var _ in Enumerable.Range(0, 2))
|
||||
Assert.That((await _client.DeleteAsync("/api/pushes/token")).StatusCode, Is.EqualTo(HttpStatusCode.NoContent));
|
||||
Assert.That((await _db.Context.UserPushTokens.AsNoTracking().SingleAsync(t => t.UserSessionId == _session)).IsActive, Is.False);
|
||||
Assert.That((await _db.Context.UserPushTokens.AsNoTracking().SingleAsync(t => t.UserSessionId == otherSession.Id)).IsActive, Is.True);
|
||||
Assert.That((await _client.PostAsJsonAsync("/api/pushes/token/register", new { token = "rotated", platform = "android" })).StatusCode,
|
||||
Is.EqualTo(HttpStatusCode.NoContent));
|
||||
Assert.That((await _db.Context.UserPushTokens.AsNoTracking().SingleAsync(t => t.UserSessionId == _session)).IsActive, Is.True);
|
||||
}
|
||||
|
||||
[TestCase(null, "android")]
|
||||
[TestCase("", "android")]
|
||||
[TestCase(" ", "android")]
|
||||
[TestCase("token", " ")]
|
||||
[TestCase("token", null)]
|
||||
public async Task PushRegistrationRejectsMissingOrBlankFields(string? token, string? platform)
|
||||
{
|
||||
Authorize();
|
||||
Assert.That((await _client.PostAsJsonAsync("/api/pushes/token/register", new { token, platform })).StatusCode,
|
||||
Is.EqualTo(HttpStatusCode.BadRequest));
|
||||
Assert.That(await _db.Context.UserPushTokens.CountAsync(), Is.Zero);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task AnonymousAndRefreshTokenCannotUseReadApi()
|
||||
{
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user