mirror of
https://github.com/bitwarden/server.git
synced 2025-02-18 02:11:22 +01:00
b98b74cef6
* PM-10600: Notification push notification * PM-10600: Sending to specific client types for relay push notifications * PM-10600: Sending to specific client types for other clients * PM-10600: Send push notification on notification creation * PM-10600: Explicit group names * PM-10600: Id typos * PM-10600: Revert global push notifications * PM-10600: Added DeviceType claim * PM-10600: Sent to organization typo * PM-10600: UT coverage * PM-10600: Small refactor, UTs coverage * PM-10600: UTs coverage * PM-10600: Startup fix * PM-10600: Test fix * PM-10600: Required attribute, organization group for push notification fix * PM-10600: UT coverage * PM-10600: Fix Mobile devices not registering to organization push notifications We only register devices for organization push notifications when the organization is being created. This does not work, since we have a use case (Notification Center) of delivering notifications to all users of organization. This fixes it, by adding the organization id tag when device registers for push notifications. * PM-10600: Unit Test coverage for NotificationHubPushRegistrationService Fixed IFeatureService substitute mocking for Android tests. Added user part of organization test with organizationId tags expectation. * PM-10600: Unit Tests fix to NotificationHubPushRegistrationService after merge conflict * PM-10600: Organization push notifications not sending to mobile device from self-hosted. Self-hosted instance uses relay to register the mobile device against Bitwarden Cloud Api. Only the self-hosted server knows client's organization membership, which means it needs to pass in the organization id's information to the relay. Similarly, for Bitwarden Cloud, the organizaton id will come directly from the server. * PM-10600: Fix self-hosted organization notification not being received by mobile device. When mobile device registers on self-hosted through the relay, every single id, like user id, device id and now organization id needs to be prefixed with the installation id. This have been missing in the PushController that handles this for organization id. * PM-10600: Broken NotificationsController integration test Device type is now part of JWT access token, so the notification center results in the integration test are now scoped to client type web and all. * PM-10600: Merge conflicts fix * merge conflict fix * PM-10600: Push notification with full notification center content. Notification Center push notification now includes all the fields.
242 lines
10 KiB
C#
242 lines
10 KiB
C#
#nullable enable
|
|
using System.Text.Json;
|
|
using Bit.Core.Enums;
|
|
using Bit.Core.Models;
|
|
using Bit.Core.Models.Data;
|
|
using Bit.Core.NotificationCenter.Entities;
|
|
using Bit.Core.NotificationHub;
|
|
using Bit.Core.Repositories;
|
|
using Bit.Core.Test.NotificationCenter.AutoFixture;
|
|
using Bit.Test.Common.AutoFixture;
|
|
using Bit.Test.Common.AutoFixture.Attributes;
|
|
using NSubstitute;
|
|
using Xunit;
|
|
|
|
namespace Bit.Core.Test.NotificationHub;
|
|
|
|
[SutProviderCustomize]
|
|
public class NotificationHubPushNotificationServiceTests
|
|
{
|
|
[Theory]
|
|
[BitAutoData]
|
|
[NotificationCustomize]
|
|
public async void PushNotificationAsync_Global_NotSent(
|
|
SutProvider<NotificationHubPushNotificationService> sutProvider, Notification notification)
|
|
{
|
|
await sutProvider.Sut.PushNotificationAsync(notification);
|
|
|
|
await sutProvider.GetDependency<INotificationHubPool>()
|
|
.Received(0)
|
|
.AllClients
|
|
.Received(0)
|
|
.SendTemplateNotificationAsync(Arg.Any<IDictionary<string, string>>(), Arg.Any<string>());
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData(false)]
|
|
[BitAutoData(true)]
|
|
[NotificationCustomize(false)]
|
|
public async void PushNotificationAsync_UserIdProvidedClientTypeAll_SentToUser(
|
|
bool organizationIdNull, SutProvider<NotificationHubPushNotificationService> sutProvider,
|
|
Notification notification)
|
|
{
|
|
if (organizationIdNull)
|
|
{
|
|
notification.OrganizationId = null;
|
|
}
|
|
|
|
notification.ClientType = ClientType.All;
|
|
var expectedSyncNotification = ToSyncNotificationPushNotification(notification);
|
|
|
|
await sutProvider.Sut.PushNotificationAsync(notification);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, PushType.SyncNotification, expectedSyncNotification,
|
|
$"(template:payload_userId:{notification.UserId})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData(false, ClientType.Browser)]
|
|
[BitAutoData(false, ClientType.Desktop)]
|
|
[BitAutoData(false, ClientType.Web)]
|
|
[BitAutoData(false, ClientType.Mobile)]
|
|
[BitAutoData(true, ClientType.Browser)]
|
|
[BitAutoData(true, ClientType.Desktop)]
|
|
[BitAutoData(true, ClientType.Web)]
|
|
[BitAutoData(true, ClientType.Mobile)]
|
|
[NotificationCustomize(false)]
|
|
public async void PushNotificationAsync_UserIdProvidedClientTypeNotAll_SentToUser(bool organizationIdNull,
|
|
ClientType clientType, SutProvider<NotificationHubPushNotificationService> sutProvider,
|
|
Notification notification)
|
|
{
|
|
if (organizationIdNull)
|
|
{
|
|
notification.OrganizationId = null;
|
|
}
|
|
|
|
notification.ClientType = clientType;
|
|
var expectedSyncNotification = ToSyncNotificationPushNotification(notification);
|
|
|
|
await sutProvider.Sut.PushNotificationAsync(notification);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, PushType.SyncNotification, expectedSyncNotification,
|
|
$"(template:payload_userId:{notification.UserId} && clientType:{clientType})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData]
|
|
[NotificationCustomize(false)]
|
|
public async void PushNotificationAsync_UserIdNullOrganizationIdProvidedClientTypeAll_SentToOrganization(
|
|
SutProvider<NotificationHubPushNotificationService> sutProvider, Notification notification)
|
|
{
|
|
notification.UserId = null;
|
|
notification.ClientType = ClientType.All;
|
|
var expectedSyncNotification = ToSyncNotificationPushNotification(notification);
|
|
|
|
await sutProvider.Sut.PushNotificationAsync(notification);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, PushType.SyncNotification, expectedSyncNotification,
|
|
$"(template:payload && organizationId:{notification.OrganizationId})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData(ClientType.Browser)]
|
|
[BitAutoData(ClientType.Desktop)]
|
|
[BitAutoData(ClientType.Web)]
|
|
[BitAutoData(ClientType.Mobile)]
|
|
[NotificationCustomize(false)]
|
|
public async void PushNotificationAsync_UserIdNullOrganizationIdProvidedClientTypeNotAll_SentToOrganization(
|
|
ClientType clientType, SutProvider<NotificationHubPushNotificationService> sutProvider,
|
|
Notification notification)
|
|
{
|
|
notification.UserId = null;
|
|
notification.ClientType = clientType;
|
|
|
|
var expectedSyncNotification = ToSyncNotificationPushNotification(notification);
|
|
|
|
await sutProvider.Sut.PushNotificationAsync(notification);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, PushType.SyncNotification, expectedSyncNotification,
|
|
$"(template:payload && organizationId:{notification.OrganizationId} && clientType:{clientType})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData([null])]
|
|
[BitAutoData(ClientType.All)]
|
|
public async void SendPayloadToUserAsync_ClientTypeNullOrAll_SentToUser(ClientType? clientType,
|
|
SutProvider<NotificationHubPushNotificationService> sutProvider, Guid userId, PushType pushType, string payload,
|
|
string identifier)
|
|
{
|
|
await sutProvider.Sut.SendPayloadToUserAsync(userId.ToString(), pushType, payload, identifier, null,
|
|
clientType);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, pushType, payload,
|
|
$"(template:payload_userId:{userId} && !deviceIdentifier:{identifier})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData(ClientType.Browser)]
|
|
[BitAutoData(ClientType.Desktop)]
|
|
[BitAutoData(ClientType.Mobile)]
|
|
[BitAutoData(ClientType.Web)]
|
|
public async void SendPayloadToUserAsync_ClientTypeExplicit_SentToUserAndClientType(ClientType clientType,
|
|
SutProvider<NotificationHubPushNotificationService> sutProvider, Guid userId, PushType pushType, string payload,
|
|
string identifier)
|
|
{
|
|
await sutProvider.Sut.SendPayloadToUserAsync(userId.ToString(), pushType, payload, identifier, null,
|
|
clientType);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, pushType, payload,
|
|
$"(template:payload_userId:{userId} && !deviceIdentifier:{identifier} && clientType:{clientType})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData([null])]
|
|
[BitAutoData(ClientType.All)]
|
|
public async void SendPayloadToOrganizationAsync_ClientTypeNullOrAll_SentToOrganization(ClientType? clientType,
|
|
SutProvider<NotificationHubPushNotificationService> sutProvider, Guid organizationId, PushType pushType,
|
|
string payload, string identifier)
|
|
{
|
|
await sutProvider.Sut.SendPayloadToOrganizationAsync(organizationId.ToString(), pushType, payload, identifier,
|
|
null, clientType);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, pushType, payload,
|
|
$"(template:payload && organizationId:{organizationId} && !deviceIdentifier:{identifier})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
[Theory]
|
|
[BitAutoData(ClientType.Browser)]
|
|
[BitAutoData(ClientType.Desktop)]
|
|
[BitAutoData(ClientType.Mobile)]
|
|
[BitAutoData(ClientType.Web)]
|
|
public async void SendPayloadToOrganizationAsync_ClientTypeExplicit_SentToOrganizationAndClientType(
|
|
ClientType clientType, SutProvider<NotificationHubPushNotificationService> sutProvider, Guid organizationId,
|
|
PushType pushType, string payload, string identifier)
|
|
{
|
|
await sutProvider.Sut.SendPayloadToOrganizationAsync(organizationId.ToString(), pushType, payload, identifier,
|
|
null, clientType);
|
|
|
|
await AssertSendTemplateNotificationAsync(sutProvider, pushType, payload,
|
|
$"(template:payload && organizationId:{organizationId} && !deviceIdentifier:{identifier} && clientType:{clientType})");
|
|
await sutProvider.GetDependency<IInstallationDeviceRepository>()
|
|
.Received(0)
|
|
.UpsertAsync(Arg.Any<InstallationDeviceEntity>());
|
|
}
|
|
|
|
private static NotificationPushNotification ToSyncNotificationPushNotification(Notification notification) =>
|
|
new()
|
|
{
|
|
Id = notification.Id,
|
|
Priority = notification.Priority,
|
|
Global = notification.Global,
|
|
ClientType = notification.ClientType,
|
|
UserId = notification.UserId,
|
|
OrganizationId = notification.OrganizationId,
|
|
Title = notification.Title,
|
|
Body = notification.Body,
|
|
CreationDate = notification.CreationDate,
|
|
RevisionDate = notification.RevisionDate
|
|
};
|
|
|
|
private static async Task AssertSendTemplateNotificationAsync(
|
|
SutProvider<NotificationHubPushNotificationService> sutProvider, PushType type, object payload, string tag)
|
|
{
|
|
await sutProvider.GetDependency<INotificationHubPool>()
|
|
.Received(1)
|
|
.AllClients
|
|
.Received(1)
|
|
.SendTemplateNotificationAsync(
|
|
Arg.Is<IDictionary<string, string>>(dictionary => MatchingSendPayload(dictionary, type, payload)),
|
|
tag);
|
|
}
|
|
|
|
private static bool MatchingSendPayload(IDictionary<string, string> dictionary, PushType type, object payload)
|
|
{
|
|
return dictionary.ContainsKey("type") && dictionary["type"].Equals(((byte)type).ToString()) &&
|
|
dictionary.ContainsKey("payload") && dictionary["payload"].Equals(JsonSerializer.Serialize(payload));
|
|
}
|
|
}
|