[PM-17562] Add feature flag for event-based organization integrations (#5710)

brant-livefront · web-flow · commit ad19d3d3ade9 · 2025-04-28T08:20:47.000-04:00
* Added EventBasedOrganizationIntegrations feature flag; Added enforcement of flag at the API layer * [PM-17562] Use EventBasedOrganizationIntegrations feature flag to turn on/off event queue * Optimization that removes the need for EventRouteService (from @justindbaur)
diff --git a/src/Api/AdminConsole/Controllers/OrganizationIntegrationConfigurationController.cs b/src/Api/AdminConsole/Controllers/OrganizationIntegrationConfigurationController.cs
@@ -1,13 +1,16 @@
 ﻿using Bit.Api.AdminConsole.Models.Request.Organizations;
 using Bit.Api.AdminConsole.Models.Response.Organizations;
+using Bit.Core;
 using Bit.Core.Context;
 using Bit.Core.Exceptions;
 using Bit.Core.Repositories;
+using Bit.Core.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
 namespace Bit.Api.AdminConsole.Controllers;
 
+[RequireFeature(FeatureFlagKeys.EventBasedOrganizationIntegrations)]
 [Route("organizations/{organizationId:guid}/integrations/{integrationId:guid}/configurations")]
 [Authorize("Application")]
 public class OrganizationIntegrationConfigurationController(
diff --git a/src/Api/AdminConsole/Controllers/OrganizationIntegrationController.cs b/src/Api/AdminConsole/Controllers/OrganizationIntegrationController.cs
@@ -1,15 +1,18 @@
 ﻿using Bit.Api.AdminConsole.Models.Request.Organizations;
 using Bit.Api.AdminConsole.Models.Response.Organizations;
+using Bit.Core;
 using Bit.Core.Context;
 using Bit.Core.Exceptions;
 using Bit.Core.Repositories;
+using Bit.Core.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
 #nullable enable
 
 namespace Bit.Api.AdminConsole.Controllers;
 
+[RequireFeature(FeatureFlagKeys.EventBasedOrganizationIntegrations)]
 [Route("organizations/{organizationId:guid}/integrations")]
 [Authorize("Application")]
 public class OrganizationIntegrationController(
diff --git a/src/Api/AdminConsole/Controllers/SlackIntegrationController.cs b/src/Api/AdminConsole/Controllers/SlackIntegrationController.cs
@@ -1,17 +1,20 @@
 ﻿using System.Text.Json;
 using Bit.Api.AdminConsole.Models.Response.Organizations;
+using Bit.Core;
 using Bit.Core.AdminConsole.Entities;
 using Bit.Core.Context;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
 using Bit.Core.Models.Data.Integrations;
 using Bit.Core.Repositories;
 using Bit.Core.Services;
+using Bit.Core.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
 namespace Bit.Api.AdminConsole.Controllers;
 
+[RequireFeature(FeatureFlagKeys.EventBasedOrganizationIntegrations)]
 [Route("organizations/{organizationId:guid}/integrations/slack")]
 [Authorize("Application")]
 public class SlackIntegrationController(
diff --git a/src/Core/Constants.cs b/src/Core/Constants.cs
@@ -108,6 +108,7 @@ public static class FeatureFlagKeys
     public const string PolicyRequirements = "pm-14439-policy-requirements";
     public const string SsoExternalIdVisibility = "pm-18630-sso-external-id-visibility";
     public const string ScimInviteUserOptimization = "pm-16811-optimize-invite-user-flow-to-fail-fast";
+    public const string EventBasedOrganizationIntegrations = "event-based-organization-integrations";
 
     /* Auth Team */
     public const string PM9112DeviceApprovalPersistence = "pm-9112-device-approval-persistence";
diff --git a/src/Events/Startup.cs b/src/Events/Startup.cs
@@ -1,4 +1,5 @@
 ﻿using System.Globalization;
+using Bit.Core;
 using Bit.Core.AdminConsole.Services.Implementations;
 using Bit.Core.AdminConsole.Services.NoopImplementations;
 using Bit.Core.Context;
@@ -62,33 +63,45 @@ public void ConfigureServices(IServiceCollection services)
         {
             services.AddSingleton<IApplicationCacheService, InMemoryApplicationCacheService>();
         }
-        services.AddScoped<IEventService, EventService>();
+
         if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Events.ConnectionString))
         {
+            services.AddKeyedSingleton<IEventWriteService, AzureQueueEventWriteService>("storage");
+
             if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.ConnectionString) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.TopicName))
             {
-                services.AddSingleton<IEventWriteService, AzureServiceBusEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, AzureServiceBusEventWriteService>("broadcast");
             }
             else
             {
-                services.AddSingleton<IEventWriteService, AzureQueueEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");
             }
         }
         else
         {
+            services.AddKeyedSingleton<IEventWriteService, RepositoryEventWriteService>("storage");
+
             if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.HostName) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Username) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Password) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.ExchangeName))
             {
-                services.AddSingleton<IEventWriteService, RabbitMqEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, RabbitMqEventWriteService>("broadcast");
             }
             else
             {
-                services.AddSingleton<IEventWriteService, RepositoryEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");
             }
         }
+        services.AddScoped<IEventWriteService>(sp =>
+        {
+            var featureService = sp.GetRequiredService<IFeatureService>();
+            var key = featureService.IsEnabled(FeatureFlagKeys.EventBasedOrganizationIntegrations)
+                ? "broadcast" : "storage";
+            return sp.GetRequiredKeyedService<IEventWriteService>(key);
+        });
+        services.AddScoped<IEventService, EventService>();
 
         services.AddOptionality();
 
diff --git a/src/SharedWeb/Utilities/ServiceCollectionExtensions.cs b/src/SharedWeb/Utilities/ServiceCollectionExtensions.cs
@@ -4,6 +4,7 @@
 using System.Security.Cryptography.X509Certificates;
 using AspNetCoreRateLimit;
 using Azure.Storage.Queues;
+using Bit.Core;
 using Bit.Core.AdminConsole.Models.Business.Tokenables;
 using Bit.Core.AdminConsole.OrganizationFeatures.Policies;
 using Bit.Core.AdminConsole.Services;
@@ -332,34 +333,46 @@ public static void AddDefaultServices(this IServiceCollection services, GlobalSe
 
         if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Events.ConnectionString))
         {
+            services.AddKeyedSingleton<IEventWriteService, AzureQueueEventWriteService>("storage");
+
             if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.ConnectionString) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.TopicName))
             {
-                services.AddSingleton<IEventWriteService, AzureServiceBusEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, AzureServiceBusEventWriteService>("broadcast");
             }
             else
             {
-                services.AddSingleton<IEventWriteService, AzureQueueEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");
             }
         }
         else if (globalSettings.SelfHosted)
         {
+            services.AddKeyedSingleton<IEventWriteService, RepositoryEventWriteService>("storage");
+
             if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.HostName) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Username) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Password) &&
                 CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.ExchangeName))
             {
-                services.AddSingleton<IEventWriteService, RabbitMqEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, RabbitMqEventWriteService>("broadcast");
             }
             else
             {
-                services.AddSingleton<IEventWriteService, RepositoryEventWriteService>();
+                services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");
             }
         }
         else
         {
-            services.AddSingleton<IEventWriteService, NoopEventWriteService>();
+            services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("storage");
+            services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");
         }
+        services.AddScoped<IEventWriteService>(sp =>
+        {
+            var featureService = sp.GetRequiredService<IFeatureService>();
+            var key = featureService.IsEnabled(FeatureFlagKeys.EventBasedOrganizationIntegrations)
+                ? "broadcast" : "storage";
+            return sp.GetRequiredKeyedService<IEventWriteService>(key);
+        });
 
         if (CoreHelpers.SettingHasValue(globalSettings.Attachment.ConnectionString))
         {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System.Globalization;`
	`2`	`+using Bit.Core;`
`2`	`3`	`using Bit.Core.AdminConsole.Services.Implementations;`
`3`	`4`	`using Bit.Core.AdminConsole.Services.NoopImplementations;`
`4`	`5`	`using Bit.Core.Context;`
`@@ -62,33 +63,45 @@ public void ConfigureServices(IServiceCollection services)`
`62`	`63`	`{`
`63`	`64`	`services.AddSingleton<IApplicationCacheService, InMemoryApplicationCacheService>();`
`64`	`65`	`}`
`65`		`- services.AddScoped<IEventService, EventService>();`
	`66`	`+`
`66`	`67`	`if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Events.ConnectionString))`
`67`	`68`	`{`
	`69`	`+ services.AddKeyedSingleton<IEventWriteService, AzureQueueEventWriteService>("storage");`
	`70`	`+`
`68`	`71`	`if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.ConnectionString) &&`
`69`	`72`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.TopicName))`
`70`	`73`	`{`
`71`		`- services.AddSingleton<IEventWriteService, AzureServiceBusEventWriteService>();`
	`74`	`+ services.AddKeyedSingleton<IEventWriteService, AzureServiceBusEventWriteService>("broadcast");`
`72`	`75`	`}`
`73`	`76`	`else`
`74`	`77`	`{`
`75`		`- services.AddSingleton<IEventWriteService, AzureQueueEventWriteService>();`
	`78`	`+ services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");`
`76`	`79`	`}`
`77`	`80`	`}`
`78`	`81`	`else`
`79`	`82`	`{`
	`83`	`+ services.AddKeyedSingleton<IEventWriteService, RepositoryEventWriteService>("storage");`
	`84`	`+`
`80`	`85`	`if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.HostName) &&`
`81`	`86`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Username) &&`
`82`	`87`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Password) &&`
`83`	`88`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.ExchangeName))`
`84`	`89`	`{`
`85`		`- services.AddSingleton<IEventWriteService, RabbitMqEventWriteService>();`
	`90`	`+ services.AddKeyedSingleton<IEventWriteService, RabbitMqEventWriteService>("broadcast");`
`86`	`91`	`}`
`87`	`92`	`else`
`88`	`93`	`{`
`89`		`- services.AddSingleton<IEventWriteService, RepositoryEventWriteService>();`
	`94`	`+ services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");`
`90`	`95`	`}`
`91`	`96`	`}`
	`97`	`+ services.AddScoped<IEventWriteService>(sp =>`
	`98`	`+ {`
	`99`	`+ var featureService = sp.GetRequiredService<IFeatureService>();`
	`100`	`+ var key = featureService.IsEnabled(FeatureFlagKeys.EventBasedOrganizationIntegrations)`
	`101`	`+ ? "broadcast" : "storage";`
	`102`	`+ return sp.GetRequiredKeyedService<IEventWriteService>(key);`
	`103`	`+ });`
	`104`	`+ services.AddScoped<IEventService, EventService>();`
`92`	`105`
`93`	`106`	`services.AddOptionality();`
`94`	`107`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using System.Security.Cryptography.X509Certificates;`
`5`	`5`	`using AspNetCoreRateLimit;`
`6`	`6`	`using Azure.Storage.Queues;`
	`7`	`+using Bit.Core;`
`7`	`8`	`using Bit.Core.AdminConsole.Models.Business.Tokenables;`
`8`	`9`	`using Bit.Core.AdminConsole.OrganizationFeatures.Policies;`
`9`	`10`	`using Bit.Core.AdminConsole.Services;`
`@@ -332,34 +333,46 @@ public static void AddDefaultServices(this IServiceCollection services, GlobalSe`
`332`	`333`
`333`	`334`	`if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Events.ConnectionString))`
`334`	`335`	`{`
	`336`	`+ services.AddKeyedSingleton<IEventWriteService, AzureQueueEventWriteService>("storage");`
	`337`	`+`
`335`	`338`	`if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.ConnectionString) &&`
`336`	`339`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.AzureServiceBus.TopicName))`
`337`	`340`	`{`
`338`		`- services.AddSingleton<IEventWriteService, AzureServiceBusEventWriteService>();`
	`341`	`+ services.AddKeyedSingleton<IEventWriteService, AzureServiceBusEventWriteService>("broadcast");`
`339`	`342`	`}`
`340`	`343`	`else`
`341`	`344`	`{`
`342`		`- services.AddSingleton<IEventWriteService, AzureQueueEventWriteService>();`
	`345`	`+ services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");`
`343`	`346`	`}`
`344`	`347`	`}`
`345`	`348`	`else if (globalSettings.SelfHosted)`
`346`	`349`	`{`
	`350`	`+ services.AddKeyedSingleton<IEventWriteService, RepositoryEventWriteService>("storage");`
	`351`	`+`
`347`	`352`	`if (CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.HostName) &&`
`348`	`353`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Username) &&`
`349`	`354`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.Password) &&`
`350`	`355`	`CoreHelpers.SettingHasValue(globalSettings.EventLogging.RabbitMq.ExchangeName))`
`351`	`356`	`{`
`352`		`- services.AddSingleton<IEventWriteService, RabbitMqEventWriteService>();`
	`357`	`+ services.AddKeyedSingleton<IEventWriteService, RabbitMqEventWriteService>("broadcast");`
`353`	`358`	`}`
`354`	`359`	`else`
`355`	`360`	`{`
`356`		`- services.AddSingleton<IEventWriteService, RepositoryEventWriteService>();`
	`361`	`+ services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");`
`357`	`362`	`}`
`358`	`363`	`}`
`359`	`364`	`else`
`360`	`365`	`{`
`361`		`- services.AddSingleton<IEventWriteService, NoopEventWriteService>();`
	`366`	`+ services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("storage");`
	`367`	`+ services.AddKeyedSingleton<IEventWriteService, NoopEventWriteService>("broadcast");`
`362`	`368`	`}`
	`369`	`+ services.AddScoped<IEventWriteService>(sp =>`
	`370`	`+ {`
	`371`	`+ var featureService = sp.GetRequiredService<IFeatureService>();`
	`372`	`+ var key = featureService.IsEnabled(FeatureFlagKeys.EventBasedOrganizationIntegrations)`
	`373`	`+ ? "broadcast" : "storage";`
	`374`	`+ return sp.GetRequiredKeyedService<IEventWriteService>(key);`
	`375`	`+ });`
`363`	`376`
`364`	`377`	`if (CoreHelpers.SettingHasValue(globalSettings.Attachment.ConnectionString))`
`365`	`378`	`{`