chore: move Installation and Push to platform's domain folders (#5085)

* chore: set up a `CODEOWNERS` space for platform

* chore: move sql objects for `Installation` to platform's domain

* chore: move `Installation` and `PushRelay` code to platform's domain

src/Admin/Controllers/ToolsController.cs

@@ -9,6 +9,7 @@ using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.Entities;
 using Bit.Core.Models.BitStripe;
 using Bit.Core.OrganizationFeatures.OrganizationLicenses.Interfaces;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Settings;

src/Api/Platform/Installations/Controllers/InstallationsController.cs

@@ -1,12 +1,10 @@
-using Bit.Api.Models.Request;
-using Bit.Api.Models.Response;
-using Bit.Core.Exceptions;
-using Bit.Core.Repositories;
+using Bit.Core.Exceptions;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
-namespace Bit.Api.Controllers;
+namespace Bit.Api.Platform.Installations;
 
 [Route("installations")]
 [SelfHosted(NotSelfHostedOnly = true)]

src/Api/Platform/Installations/Models/InstallationRequestModel.cs

@@ -1,8 +1,8 @@
 using System.ComponentModel.DataAnnotations;
-using Bit.Core.Entities;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Utilities;
 
-namespace Bit.Api.Models.Request;
+namespace Bit.Api.Platform.Installations;
 
 public class InstallationRequestModel
 {

src/Api/Platform/Installations/Models/InstallationResponseModel.cs

@@ -1,7 +1,7 @@
-using Bit.Core.Entities;
-using Bit.Core.Models.Api;
+using Bit.Core.Models.Api;
+using Bit.Core.Platform.Installations;
 
-namespace Bit.Api.Models.Response;
+namespace Bit.Api.Platform.Installations;
 
 public class InstallationResponseModel : ResponseModel
 {

src/Api/Platform/Push/Controllers/PushController.cs

@@ -1,14 +1,18 @@
 using Bit.Core.Context;
 using Bit.Core.Exceptions;
 using Bit.Core.Models.Api;
-using Bit.Core.Services;
+using Bit.Core.Platform.Push;
 using Bit.Core.Settings;
 using Bit.Core.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
-namespace Bit.Api.Controllers;
+namespace Bit.Api.Platform.Push;
 
+/// <summary>
+/// Routes for push relay: functionality that facilitates communication
+/// between self hosted organizations and Bitwarden cloud.
+/// </summary>
 [Route("push")]
 [Authorize("Push")]
 [SelfHosted(NotSelfHostedOnly = true)]

src/Billing/Services/Implementations/PaymentSucceededHandler.cs

@@ -2,6 +2,7 @@
 using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.Billing.Enums;
 using Bit.Core.Context;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Tools.Enums;

src/Billing/Services/Implementations/SubscriptionUpdatedHandler.cs

@@ -1,5 +1,6 @@
 using Bit.Billing.Constants;
 using Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Interfaces;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Utilities;

src/Core/AdminConsole/OrganizationAuth/UpdateOrganizationAuthRequestCommand.cs

@@ -7,6 +7,7 @@ using Bit.Core.Auth.Models.Api.Request.AuthRequest;
 using Bit.Core.Auth.Models.Data;
 using Bit.Core.Auth.Services;
 using Bit.Core.Enums;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Settings;

src/Core/AdminConsole/OrganizationFeatures/OrganizationUsers/DeleteManagedOrganizationUserAccountCommand.cs

@@ -4,6 +4,7 @@ using Bit.Core.Context;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Tools.Enums;

src/Core/AdminConsole/OrganizationFeatures/OrganizationUsers/RemoveOrganizationUserCommand.cs

@@ -3,6 +3,7 @@ using Bit.Core.Context;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 

src/Core/AdminConsole/OrganizationFeatures/Organizations/CloudOrganizationSignUpCommand.cs

@@ -11,6 +11,7 @@ using Bit.Core.Exceptions;
 using Bit.Core.Models.Business;
 using Bit.Core.Models.Data;
 using Bit.Core.Models.StaticStore;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Tools.Enums;

src/Core/AdminConsole/Services/Implementations/OrganizationService.cs

@@ -27,6 +27,7 @@ using Bit.Core.Models.Data;
 using Bit.Core.Models.Data.Organizations.OrganizationUsers;
 using Bit.Core.Models.Mail;
 using Bit.Core.OrganizationFeatures.OrganizationSubscriptions.Interface;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Settings;
 using Bit.Core.Tokens;

src/Core/Auth/Services/Implementations/AuthRequestService.cs

@@ -7,6 +7,7 @@ using Bit.Core.Context;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Settings;

src/Core/Auth/UserFeatures/TdeOffboardingPassword/TdeOffboardingPasswordCommand.cs

@@ -3,6 +3,7 @@ using Bit.Core.Auth.UserFeatures.TdeOffboardingPassword.Interfaces;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Microsoft.AspNetCore.Identity;

src/Core/KeyManagement/Commands/RegenerateUserAsymmetricKeysCommand.cs

@@ -8,7 +8,7 @@ using Bit.Core.Exceptions;
 using Bit.Core.KeyManagement.Commands.Interfaces;
 using Bit.Core.KeyManagement.Models.Data;
 using Bit.Core.KeyManagement.Repositories;
-using Bit.Core.Services;
+using Bit.Core.Platform.Push;
 using Microsoft.Extensions.Logging;
 
 namespace Bit.Core.KeyManagement.Commands;

src/Core/KeyManagement/UserKey/Implementations/RotateUserKeyCommand.cs

@@ -1,6 +1,7 @@
 using Bit.Core.Auth.Repositories;
 using Bit.Core.Entities;
 using Bit.Core.KeyManagement.Models.Data;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Tools.Repositories;

src/Core/NotificationHub/NotificationHubPushNotificationService.cs

@@ -6,8 +6,8 @@ using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Models;
 using Bit.Core.Models.Data;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
-using Bit.Core.Services;
 using Bit.Core.Tools.Entities;
 using Bit.Core.Vault.Entities;
 using Microsoft.AspNetCore.Http;

src/Core/NotificationHub/NotificationHubPushRegistrationService.cs

@@ -1,7 +1,7 @@
 using Bit.Core.Enums;
 using Bit.Core.Models.Data;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
-using Bit.Core.Services;
 using Bit.Core.Settings;
 using Microsoft.Azure.NotificationHubs;
 using Microsoft.Extensions.Logging;

src/Core/OrganizationFeatures/OrganizationLicenses/Cloud/CloudGetOrganizationLicenseQuery.cs

@@ -4,7 +4,7 @@ using Bit.Core.Enums;
 using Bit.Core.Exceptions;
 using Bit.Core.Models.Business;
 using Bit.Core.OrganizationFeatures.OrganizationLicenses.Interfaces;
-using Bit.Core.Repositories;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Services;
 
 namespace Bit.Core.OrganizationFeatures.OrganizationLicenses;

src/Core/Platform/Installations/Entities/Installation.cs

@@ -1,10 +1,15 @@
 using System.ComponentModel.DataAnnotations;
+using Bit.Core.Entities;
 using Bit.Core.Utilities;
 
 #nullable enable
 
-namespace Bit.Core.Entities;
+namespace Bit.Core.Platform.Installations;
 
+/// <summary>
+/// The base entity for the SQL table `dbo.Installation`. Used to store
+/// information pertinent to self hosted Bitwarden installations.
+/// </summary>
 public class Installation : ITableObject<Guid>
 {
     public Guid Id { get; set; }

src/Core/Platform/Installations/Repositories/IInstallationRepository.cs

@@ -0,0 +1,19 @@
+using Bit.Core.Repositories;
+
+#nullable enable
+
+namespace Bit.Core.Platform.Installations;
+
+/// <summary>
+/// The CRUD repository interface for communicating with `dbo.Installation`,
+/// which is used to store information pertinent to self-hosted
+/// installations.
+/// </summary>
+/// <remarks>
+/// This interface is implemented by `InstallationRepository` in the Dapper
+/// and Entity Framework projects.
+/// </remarks>
+/// <seealso cref="T:Bit.Infrastructure.Dapper.Platform.Installations.Repositories.InstallationRepository"/>
+public interface IInstallationRepository : IRepository<Installation, Guid>
+{
+}

src/Core/Platform/Push/Services/AzureQueuePushNotificationService.cs

@@ -11,7 +11,7 @@ using Bit.Core.Utilities;
 using Bit.Core.Vault.Entities;
 using Microsoft.AspNetCore.Http;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push.Internal;
 
 public class AzureQueuePushNotificationService : IPushNotificationService
 {

src/Core/Platform/Push/Services/IPushNotificationService.cs

@@ -4,7 +4,7 @@ using Bit.Core.Enums;
 using Bit.Core.Tools.Entities;
 using Bit.Core.Vault.Entities;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push;
 
 public interface IPushNotificationService
 {

src/Core/Platform/Push/Services/IPushRegistrationService.cs

@@ -1,6 +1,6 @@
 using Bit.Core.Enums;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push;
 
 public interface IPushRegistrationService
 {

src/Core/Platform/Push/Services/MultiServicePushNotificationService.cs

@@ -7,7 +7,7 @@ using Bit.Core.Vault.Entities;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push.Internal;
 
 public class MultiServicePushNotificationService : IPushNotificationService
 {

src/Core/Platform/Push/Services/NoopPushNotificationService.cs

@@ -4,7 +4,7 @@ using Bit.Core.Enums;
 using Bit.Core.Tools.Entities;
 using Bit.Core.Vault.Entities;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push.Internal;
 
 public class NoopPushNotificationService : IPushNotificationService
 {

src/Core/Platform/Push/Services/NoopPushRegistrationService.cs

@@ -1,6 +1,6 @@
 using Bit.Core.Enums;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push.Internal;
 
 public class NoopPushRegistrationService : IPushRegistrationService
 {

src/Core/Platform/Push/Services/NotificationsApiPushNotificationService.cs

@@ -3,13 +3,15 @@ using Bit.Core.Auth.Entities;
 using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Models;
+using Bit.Core.Services;
 using Bit.Core.Settings;
 using Bit.Core.Tools.Entities;
 using Bit.Core.Vault.Entities;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Logging;
 
-namespace Bit.Core.Services;
+// This service is not in the `Internal` namespace because it has direct external references.
+namespace Bit.Core.Platform.Push;
 
 public class NotificationsApiPushNotificationService : BaseIdentityClientService, IPushNotificationService
 {

src/Core/Platform/Push/Services/RelayPushNotificationService.cs

@@ -6,13 +6,14 @@ using Bit.Core.IdentityServer;
 using Bit.Core.Models;
 using Bit.Core.Models.Api;
 using Bit.Core.Repositories;
+using Bit.Core.Services;
 using Bit.Core.Settings;
 using Bit.Core.Tools.Entities;
 using Bit.Core.Vault.Entities;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Logging;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push.Internal;
 
 public class RelayPushNotificationService : BaseIdentityClientService, IPushNotificationService
 {

src/Core/Platform/Push/Services/RelayPushRegistrationService.cs

@@ -1,10 +1,11 @@
 using Bit.Core.Enums;
 using Bit.Core.IdentityServer;
 using Bit.Core.Models.Api;
+using Bit.Core.Services;
 using Bit.Core.Settings;
 using Microsoft.Extensions.Logging;
 
-namespace Bit.Core.Services;
+namespace Bit.Core.Platform.Push.Internal;
 
 public class RelayPushRegistrationService : BaseIdentityClientService, IPushRegistrationService
 {

src/Core/Repositories/IInstallationRepository.cs

@@ -1,9 +0,0 @@
-using Bit.Core.Entities;
-
-#nullable enable
-
-namespace Bit.Core.Repositories;
-
-public interface IInstallationRepository : IRepository<Installation, Guid>
-{
-}

src/Core/Services/Implementations/DeviceService.cs

@@ -2,6 +2,7 @@
 using Bit.Core.Auth.Utilities;
 using Bit.Core.Entities;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 
 namespace Bit.Core.Services;

src/Core/Services/Implementations/UserService.cs

@@ -18,6 +18,7 @@ using Bit.Core.Exceptions;
 using Bit.Core.Models.Business;
 using Bit.Core.Models.Data.Organizations.OrganizationUsers;
 using Bit.Core.OrganizationFeatures.OrganizationUsers.Interfaces;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Settings;
 using Bit.Core.Tokens;

src/Core/Tools/Services/Implementations/SendService.cs

@@ -6,6 +6,7 @@ using Bit.Core.AdminConsole.Services;
 using Bit.Core.Context;
 using Bit.Core.Entities;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Settings;

src/Core/Vault/Services/Implementations/CipherService.cs

@@ -5,6 +5,7 @@ using Bit.Core.Context;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
+using Bit.Core.Platform.Push;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 using Bit.Core.Settings;

src/Identity/IdentityServer/ClientStore.cs

@@ -5,6 +5,7 @@ using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Identity;
 using Bit.Core.IdentityServer;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Repositories;
 using Bit.Core.SecretsManager.Models.Data;
 using Bit.Core.SecretsManager.Repositories;

src/Infrastructure.Dapper/DapperServiceCollectionExtensions.cs

@@ -3,6 +3,7 @@ using Bit.Core.Auth.Repositories;
 using Bit.Core.Billing.Repositories;
 using Bit.Core.KeyManagement.Repositories;
 using Bit.Core.NotificationCenter.Repositories;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Repositories;
 using Bit.Core.SecretsManager.Repositories;
 using Bit.Core.Tools.Repositories;
@@ -12,6 +13,7 @@ using Bit.Infrastructure.Dapper.Auth.Repositories;
 using Bit.Infrastructure.Dapper.Billing.Repositories;
 using Bit.Infrastructure.Dapper.KeyManagement.Repositories;
 using Bit.Infrastructure.Dapper.NotificationCenter.Repositories;
+using Bit.Infrastructure.Dapper.Platform;
 using Bit.Infrastructure.Dapper.Repositories;
 using Bit.Infrastructure.Dapper.SecretsManager.Repositories;
 using Bit.Infrastructure.Dapper.Tools.Repositories;

src/Infrastructure.Dapper/Platform/Installations/Repositories/InstallationRepository.cs

@@ -1,11 +1,19 @@
-using Bit.Core.Entities;
-using Bit.Core.Repositories;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Settings;
+using Bit.Infrastructure.Dapper.Repositories;
 
 #nullable enable
 
-namespace Bit.Infrastructure.Dapper.Repositories;
+namespace Bit.Infrastructure.Dapper.Platform;
 
+/// <summary>
+/// The CRUD repository for communicating with `dbo.Installation`.
+/// </summary>
+/// <remarks>
+/// If referencing: you probably want the interface `IInstallationRepository`
+/// instead of directly calling this class.
+/// </remarks>
+/// <seealso cref="IInstallationRepository"/>
 public class InstallationRepository : Repository<Installation, Guid>, IInstallationRepository
 {
     public InstallationRepository(GlobalSettings globalSettings)

src/Infrastructure.EntityFramework/Billing/Models/OrganizationInstallation.cs

@@ -1,6 +1,6 @@
 using AutoMapper;
 using Bit.Infrastructure.EntityFramework.AdminConsole.Models;
-using Bit.Infrastructure.EntityFramework.Models;
+using Bit.Infrastructure.EntityFramework.Platform;
 
 namespace Bit.Infrastructure.EntityFramework.Billing.Models;
 

src/Infrastructure.EntityFramework/EntityFrameworkServiceCollectionExtensions.cs

@@ -4,6 +4,7 @@ using Bit.Core.Billing.Repositories;
 using Bit.Core.Enums;
 using Bit.Core.KeyManagement.Repositories;
 using Bit.Core.NotificationCenter.Repositories;
+using Bit.Core.Platform.Installations;
 using Bit.Core.Repositories;
 using Bit.Core.SecretsManager.Repositories;
 using Bit.Core.Tools.Repositories;
@@ -13,6 +14,7 @@ using Bit.Infrastructure.EntityFramework.Auth.Repositories;
 using Bit.Infrastructure.EntityFramework.Billing.Repositories;
 using Bit.Infrastructure.EntityFramework.KeyManagement.Repositories;
 using Bit.Infrastructure.EntityFramework.NotificationCenter.Repositories;
+using Bit.Infrastructure.EntityFramework.Platform;
 using Bit.Infrastructure.EntityFramework.Repositories;
 using Bit.Infrastructure.EntityFramework.SecretsManager.Repositories;
 using Bit.Infrastructure.EntityFramework.Tools.Repositories;

src/Infrastructure.EntityFramework/Platform/Installations/Models/Installation.cs

@@ -1,8 +1,9 @@
 using AutoMapper;
+using C = Bit.Core.Platform.Installations;
 
-namespace Bit.Infrastructure.EntityFramework.Models;
+namespace Bit.Infrastructure.EntityFramework.Platform;
 
-public class Installation : Core.Entities.Installation
+public class Installation : C.Installation
 {
     // Shadow property - to be introduced by https://bitwarden.atlassian.net/browse/PM-11129
     // This isn't a value or entity used by self hosted servers, but it's
@@ -14,10 +15,10 @@ public class InstallationMapperProfile : Profile
 {
     public InstallationMapperProfile()
     {
-        CreateMap<Core.Entities.Installation, Installation>()
+        CreateMap<C.Installation, Installation>()
             // Shadow property - to be introduced by https://bitwarden.atlassian.net/browse/PM-11129
             .ForMember(i => i.LastActivityDate, opt => opt.Ignore())
             .ReverseMap();
-        CreateMap<Core.Entities.Installation, Installation>().ReverseMap();
+        CreateMap<C.Installation, Installation>().ReverseMap();
     }
 }

src/Infrastructure.EntityFramework/Platform/Installations/Repositories/InstallationRepository.cs

@@ -0,0 +1,16 @@
+using AutoMapper;
+using Bit.Infrastructure.EntityFramework.Repositories;
+using Microsoft.Extensions.DependencyInjection;
+using C = Bit.Core.Platform.Installations;
+using Ef = Bit.Infrastructure.EntityFramework.Platform;
+
+#nullable enable
+
+namespace Bit.Infrastructure.EntityFramework.Platform;
+
+public class InstallationRepository : Repository<C.Installation, Ef.Installation, Guid>, C.IInstallationRepository
+{
+    public InstallationRepository(IServiceScopeFactory serviceScopeFactory, IMapper mapper)
+        : base(serviceScopeFactory, mapper, (DatabaseContext context) => context.Installations)
+    { }
+}

src/Infrastructure.EntityFramework/Repositories/DatabaseContext.cs

@@ -6,6 +6,7 @@ using Bit.Infrastructure.EntityFramework.Billing.Models;
 using Bit.Infrastructure.EntityFramework.Converters;
 using Bit.Infrastructure.EntityFramework.Models;
 using Bit.Infrastructure.EntityFramework.NotificationCenter.Models;
+using Bit.Infrastructure.EntityFramework.Platform;
 using Bit.Infrastructure.EntityFramework.SecretsManager.Models;
 using Bit.Infrastructure.EntityFramework.Tools.Models;
 using Bit.Infrastructure.EntityFramework.Vault.Models;

src/Infrastructure.EntityFramework/Repositories/InstallationRepository.cs

@@ -1,15 +0,0 @@
-using AutoMapper;
-using Bit.Core.Repositories;
-using Bit.Infrastructure.EntityFramework.Models;
-using Microsoft.Extensions.DependencyInjection;
-
-#nullable enable
-
-namespace Bit.Infrastructure.EntityFramework.Repositories;
-
-public class InstallationRepository : Repository<Core.Entities.Installation, Installation, Guid>, IInstallationRepository
-{
-    public InstallationRepository(IServiceScopeFactory serviceScopeFactory, IMapper mapper)
-        : base(serviceScopeFactory, mapper, (DatabaseContext context) => context.Installations)
-    { }
-}

src/SharedWeb/Utilities/ServiceCollectionExtensions.cs

@@ -30,6 +30,8 @@ using Bit.Core.KeyManagement;
 using Bit.Core.NotificationCenter;
 using Bit.Core.NotificationHub;
 using Bit.Core.OrganizationFeatures;
+using Bit.Core.Platform.Push;
+using Bit.Core.Platform.Push.Internal;
 using Bit.Core.Repositories;
 using Bit.Core.Resources;
 using Bit.Core.SecretsManager.Repositories;