[PM-31040] Replace ISetupIntentCache with customer-based approach (#6954)

* docs(billing): add design document for replacing SetupIntent cache

* docs(billing): add implementation plan for replacing SetupIntent cache

* feat(db): add gateway lookup stored procedures for Organization, Provider, and User

* feat(db): add gateway lookup indexes to Organization, Provider, and User table definitions

* chore(db): add SQL Server migration for gateway lookup indexes and stored procedures

* feat(repos): add gateway lookup methods to IOrganizationRepository and Dapper implementation

* feat(repos): add gateway lookup methods to IProviderRepository and Dapper implementation

* feat(repos): add gateway lookup methods to IUserRepository and Dapper implementation

* feat(repos): add EF OrganizationRepository gateway lookup methods and index configuration

* feat(repos): add EF ProviderRepository gateway lookup methods and index configuration

* feat(repos): add EF UserRepository gateway lookup methods and index configuration

* chore(db): add EF migrations for gateway lookup indexes

* refactor(billing): update SetupIntentSucceededHandler to use repository instead of cache

* refactor(billing): simplify StripeEventService by expanding customer on SetupIntent

* refactor(billing): query Stripe for SetupIntents by customer ID in GetPaymentMethodQuery

* refactor(billing): query Stripe for SetupIntents by customer ID in HasPaymentMethodQuery

* refactor(billing): update OrganizationBillingService to set customer on SetupIntent

* refactor(billing): update ProviderBillingService to set customer on SetupIntent and query by customer

* refactor(billing): update UpdatePaymentMethodCommand to set customer on SetupIntent

* refactor(billing): remove bank account support from CreatePremiumCloudHostedSubscriptionCommand

* refactor(billing): remove OrganizationBillingService.UpdatePaymentMethod dead code

* refactor(billing): remove ProviderBillingService.UpdatePaymentMethod

* refactor(billing): remove PremiumUserBillingService.UpdatePaymentMethod and UserService.ReplacePaymentMethodAsync

* refactor(billing): remove SubscriberService.UpdatePaymentSource and related dead code

* refactor(billing): update SubscriberService.GetPaymentSourceAsync to query Stripe by customer ID

Add Task 15a to plan - this was a missed requirement for updating
GetPaymentSourceAsync which still used the cache.

* refactor(billing): complete removal of PremiumUserBillingService.Finalize and UserService.SignUpPremiumAsync

* refactor(billing): remove ISetupIntentCache and SetupIntentDistributedCache

* chore: remove temporary planning documents

* chore: run dotnet format

* fix(billing): add MaxLength(50) to Provider gateway ID properties

* chore(db): add EF migrations for Provider gateway column lengths

* chore: run dotnet format

* chore: rename SQL migration for chronological order

Author: amorask-bitwarden

bitwarden_license/src/Commercial.Core/Billing/Providers/Services/ProviderBillingService.cs

@@ -9,19 +9,16 @@
 using Bit.Core.AdminConsole.Enums.Provider;
 using Bit.Core.AdminConsole.Repositories;
 using Bit.Core.Billing;
-using Bit.Core.Billing.Caches;
 using Bit.Core.Billing.Constants;
 using Bit.Core.Billing.Enums;
 using Bit.Core.Billing.Extensions;
-using Bit.Core.Billing.Models;
 using Bit.Core.Billing.Payment.Models;
 using Bit.Core.Billing.Pricing;
 using Bit.Core.Billing.Providers.Entities;
 using Bit.Core.Billing.Providers.Models;
 using Bit.Core.Billing.Providers.Repositories;
 using Bit.Core.Billing.Providers.Services;
 using Bit.Core.Billing.Services;
-using Bit.Core.Billing.Tax.Models;
 using Bit.Core.Enums;
 using Bit.Core.Exceptions;
 using Bit.Core.Repositories;
@@ -51,7 +48,6 @@ public class ProviderBillingService(
     IProviderOrganizationRepository providerOrganizationRepository,
     IProviderPlanRepository providerPlanRepository,
     IProviderUserRepository providerUserRepository,
-    ISetupIntentCache setupIntentCache,
     IStripeAdapter stripeAdapter,
     ISubscriberService subscriberService)
     : IProviderBillingService
@@ -518,6 +514,7 @@ public async Task<Customer> SetupCustomer(
         }
 
         var braintreeCustomerId = "";
+        var setupIntentId = "";
 
         // ReSharper disable once SwitchStatementMissingSomeEnumCasesNoDefault
         switch (paymentMethod.Type)
@@ -539,7 +536,7 @@ public async Task<Customer> SetupCustomer(
                         throw new BillingException();
                     }
 
-                    await setupIntentCache.Set(provider.Id, setupIntent.Id);
+                    setupIntentId = setupIntent.Id;
                     break;
                 }
             case TokenizablePaymentMethodType.Card:
@@ -558,7 +555,15 @@ public async Task<Customer> SetupCustomer(
 
         try
         {
-            return await stripeAdapter.CreateCustomerAsync(options);
+            var customer = await stripeAdapter.CreateCustomerAsync(options);
+
+            if (!string.IsNullOrEmpty(setupIntentId))
+            {
+                await stripeAdapter.UpdateSetupIntentAsync(setupIntentId,
+                    new SetupIntentUpdateOptions { Customer = customer.Id });
+            }
+
+            return customer;
         }
         catch (StripeException stripeException) when (stripeException.StripeError?.Code == ErrorCodes.TaxIdInvalid)
         {
@@ -577,12 +582,10 @@ async Task Revert()
             // ReSharper disable once SwitchStatementMissingSomeEnumCasesNoDefault
             switch (paymentMethod.Type)
             {
-                case TokenizablePaymentMethodType.BankAccount:
+                case TokenizablePaymentMethodType.BankAccount when !string.IsNullOrEmpty(setupIntentId):
                     {
-                        var setupIntentId = await setupIntentCache.GetSetupIntentIdForSubscriber(provider.Id);
                         await stripeAdapter.CancelSetupIntentAsync(setupIntentId,
                             new SetupIntentCancelOptions { CancellationReason = "abandoned" });
-                        await setupIntentCache.RemoveSetupIntentForSubscriber(provider.Id);
                         break;
                     }
                 case TokenizablePaymentMethodType.PayPal when !string.IsNullOrEmpty(braintreeCustomerId):
@@ -635,17 +638,18 @@ public async Task<Subscription> SetupSubscription(
             });
         }
 
-        var setupIntentId = await setupIntentCache.GetSetupIntentIdForSubscriber(provider.Id);
+        var setupIntents = await stripeAdapter.ListSetupIntentsAsync(new SetupIntentListOptions
+        {
+            Customer = customer.Id,
+            Expand = ["data.payment_method"]
+        });
 
-        var setupIntent = !string.IsNullOrEmpty(setupIntentId)
-            ? await stripeAdapter.GetSetupIntentAsync(setupIntentId,
-                new SetupIntentGetOptions { Expand = ["payment_method"] })
-            : null;
+        var hasUnverifiedBankAccount = setupIntents?.Any(si => si.IsUnverifiedBankAccount()) ?? false;
 
         var usePaymentMethod =
             !string.IsNullOrEmpty(customer.InvoiceSettings?.DefaultPaymentMethodId) ||
             customer.Metadata?.ContainsKey(BraintreeCustomerIdKey) == true ||
-            setupIntent?.IsUnverifiedBankAccount() == true;
+            hasUnverifiedBankAccount;
 
         int? trialPeriodDays = provider.Type switch
         {
@@ -699,19 +703,6 @@ public async Task<Subscription> SetupSubscription(
         }
     }
 
-    public async Task UpdatePaymentMethod(
-        Provider provider,
-        TokenizedPaymentSource tokenizedPaymentSource,
-        TaxInformation taxInformation)
-    {
-        await Task.WhenAll(
-            subscriberService.UpdatePaymentSource(provider, tokenizedPaymentSource),
-            subscriberService.UpdateTaxInformation(provider, taxInformation));
-
-        await stripeAdapter.UpdateSubscriptionAsync(provider.GatewaySubscriptionId,
-            new SubscriptionUpdateOptions { CollectionMethod = CollectionMethod.ChargeAutomatically });
-    }
-
     public async Task UpdateSeatMinimums(UpdateProviderSeatMinimumsCommand command)
     {
         var (provider, updatedPlanConfigurations) = command;

bitwarden_license/test/Commercial.Core.Test/Billing/Providers/Services/ProviderBillingServiceTests.cs

@@ -6,7 +6,6 @@
 using Bit.Core.AdminConsole.Enums.Provider;
 using Bit.Core.AdminConsole.Models.Data.Provider;
 using Bit.Core.AdminConsole.Repositories;
-using Bit.Core.Billing.Caches;
 using Bit.Core.Billing.Constants;
 using Bit.Core.Billing.Enums;
 using Bit.Core.Billing.Payment.Models;
@@ -934,17 +933,11 @@ public async Task SetupCustomer_WithBankAccount_Error_Reverts(
                 o.TaxIdData.FirstOrDefault().Value == billingAddress.TaxId.Value))
             .Throws<StripeException>();
 
-        sutProvider.GetDependency<ISetupIntentCache>().GetSetupIntentIdForSubscriber(provider.Id).Returns("setup_intent_id");
-
         await Assert.ThrowsAsync<StripeException>(() =>
             sutProvider.Sut.SetupCustomer(provider, tokenizedPaymentMethod, billingAddress));
 
-        await sutProvider.GetDependency<ISetupIntentCache>().Received(1).Set(provider.Id, "setup_intent_id");
-
         await stripeAdapter.Received(1).CancelSetupIntentAsync("setup_intent_id", Arg.Is<SetupIntentCancelOptions>(options =>
             options.CancellationReason == "abandoned"));
-
-        await sutProvider.GetDependency<ISetupIntentCache>().Received(1).RemoveSetupIntentForSubscriber(provider.Id);
     }
 
     [Theory, BitAutoData]
@@ -1031,7 +1024,8 @@ public async Task SetupCustomer_WithBankAccount_Success(
 
         Assert.Equivalent(expected, actual);
 
-        await sutProvider.GetDependency<ISetupIntentCache>().Received(1).Set(provider.Id, "setup_intent_id");
+        await stripeAdapter.Received(1).UpdateSetupIntentAsync("setup_intent_id",
+            Arg.Is<SetupIntentUpdateOptions>(options => options.Customer == expected.Id));
     }
 
     [Theory, BitAutoData]
@@ -1532,15 +1526,12 @@ public async Task SetupSubscription_ChargeAutomatically_HasBankAccount_Succeeds(
 
         var expected = new Subscription { Id = "subscription_id", Status = StripeConstants.SubscriptionStatus.Active };
 
-
-        const string setupIntentId = "seti_123";
-
-        sutProvider.GetDependency<ISetupIntentCache>().GetSetupIntentIdForSubscriber(provider.Id).Returns(setupIntentId);
-
-        sutProvider.GetDependency<IStripeAdapter>().GetSetupIntentAsync(setupIntentId, Arg.Is<SetupIntentGetOptions>(options =>
-            options.Expand.Contains("payment_method"))).Returns(new SetupIntent
+        sutProvider.GetDependency<IStripeAdapter>().ListSetupIntentsAsync(Arg.Is<SetupIntentListOptions>(options =>
+            options.Customer == customer.Id &&
+            options.Expand.Contains("data.payment_method"))).Returns([
+            new SetupIntent
             {
-                Id = setupIntentId,
+                Id = "seti_123",
                 Status = "requires_action",
                 NextAction = new SetupIntentNextAction
                 {
@@ -1550,7 +1541,8 @@ public async Task SetupSubscription_ChargeAutomatically_HasBankAccount_Succeeds(
                 {
                     UsBankAccount = new PaymentMethodUsBankAccount()
                 }
-            });
+            }
+        ]);
 
         sutProvider.GetDependency<IStripeAdapter>().CreateSubscriptionAsync(Arg.Is<SubscriptionCreateOptions>(
             sub =>

src/Billing/Services/Implementations/SetupIntentSucceededHandler.cs

@@ -1,7 +1,6 @@
 using Bit.Core.AdminConsole.Entities;
 using Bit.Core.AdminConsole.Entities.Provider;
 using Bit.Core.AdminConsole.Repositories;
-using Bit.Core.Billing.Caches;
 using Bit.Core.Billing.Services;
 using Bit.Core.Repositories;
 using OneOf;
@@ -11,10 +10,10 @@
 namespace Bit.Billing.Services.Implementations;
 
 public class SetupIntentSucceededHandler(
+    ILogger<SetupIntentSucceededHandler> logger,
     IOrganizationRepository organizationRepository,
     IProviderRepository providerRepository,
     IPushNotificationAdapter pushNotificationAdapter,
-    ISetupIntentCache setupIntentCache,
     IStripeAdapter stripeAdapter,
     IStripeEventService stripeEventService) : ISetupIntentSucceededHandler
 {
@@ -27,23 +26,29 @@ public async Task HandleAsync(Event parsedEvent)
 
         if (setupIntent is not
             {
+                CustomerId: not null,
                 PaymentMethod.UsBankAccount: not null
             })
         {
+            logger.LogWarning("SetupIntent {SetupIntentId} has no customer ID or is not a US bank account", setupIntent.Id);
             return;
         }
 
-        var subscriberId = await setupIntentCache.GetSubscriberIdForSetupIntent(setupIntent.Id);
-        if (subscriberId == null)
+        var organization = await organizationRepository.GetByGatewayCustomerIdAsync(setupIntent.CustomerId);
+        if (organization != null)
         {
+            await SetPaymentMethodAsync(organization, setupIntent.PaymentMethod);
             return;
         }
 
-        var organization = await organizationRepository.GetByIdAsync(subscriberId.Value);
-        var provider = await providerRepository.GetByIdAsync(subscriberId.Value);
+        var provider = await providerRepository.GetByGatewayCustomerIdAsync(setupIntent.CustomerId);
+        if (provider != null)
+        {
+            await SetPaymentMethodAsync(provider, setupIntent.PaymentMethod);
+            return;
+        }
 
-        OneOf<Organization, Provider> entity = organization != null ? organization : provider!;
-        await SetPaymentMethodAsync(entity, setupIntent.PaymentMethod);
+        logger.LogError("No organization or provider found for customer {CustomerId}", setupIntent.CustomerId);
     }
 
     private async Task SetPaymentMethodAsync(

src/Billing/Services/Implementations/StripeEventService.cs

@@ -1,18 +1,11 @@
 using Bit.Billing.Constants;
-using Bit.Core.AdminConsole.Repositories;
-using Bit.Core.Billing.Caches;
-using Bit.Core.Repositories;
 using Bit.Core.Settings;
 using Stripe;
 
 namespace Bit.Billing.Services.Implementations;
 
 public class StripeEventService(
     GlobalSettings globalSettings,
-    ILogger<StripeEventService> logger,
-    IOrganizationRepository organizationRepository,
-    IProviderRepository providerRepository,
-    ISetupIntentCache setupIntentCache,
     IStripeFacade stripeFacade)
     : IStripeEventService
 {
@@ -117,7 +110,7 @@ HandledStripeWebhook.PaymentSucceeded or HandledStripeWebhook.PaymentFailed
                 (await GetCustomer(stripeEvent, true)).Metadata,
 
             HandledStripeWebhook.SetupIntentSucceeded =>
-                await GetCustomerMetadataFromSetupIntentSucceededEvent(stripeEvent),
+                (await GetSetupIntent(stripeEvent, true, customerExpansion)).Customer?.Metadata,
 
             _ => null
         };
@@ -144,43 +137,6 @@ await GetCustomerMetadataFromSetupIntentSucceededEvent(stripeEvent),
 
             return customer?.Metadata;
         }
-
-        async Task<Dictionary<string, string>?> GetCustomerMetadataFromSetupIntentSucceededEvent(Event localStripeEvent)
-        {
-            var setupIntent = await GetSetupIntent(localStripeEvent);
-
-            logger.LogInformation("Extracted Setup Intent ({SetupIntentId}) from Stripe 'setup_intent.succeeded' event", setupIntent.Id);
-
-            var subscriberId = await setupIntentCache.GetSubscriberIdForSetupIntent(setupIntent.Id);
-
-            logger.LogInformation("Retrieved subscriber ID ({SubscriberId}) from cache for Setup Intent ({SetupIntentId})", subscriberId, setupIntent.Id);
-
-            if (subscriberId == null)
-            {
-                logger.LogError("Cached subscriber ID for Setup Intent ({SetupIntentId}) is null", setupIntent.Id);
-                return null;
-            }
-
-            var organization = await organizationRepository.GetByIdAsync(subscriberId.Value);
-            logger.LogInformation("Retrieved organization ({OrganizationId}) via subscriber ID for Setup Intent ({SetupIntentId})", organization?.Id, setupIntent.Id);
-            if (organization is { GatewayCustomerId: not null })
-            {
-                var organizationCustomer = await stripeFacade.GetCustomer(organization.GatewayCustomerId);
-                logger.LogInformation("Retrieved customer ({CustomerId}) via organization ID for Setup Intent ({SetupIntentId})", organization.Id, setupIntent.Id);
-                return organizationCustomer.Metadata;
-            }
-
-            var provider = await providerRepository.GetByIdAsync(subscriberId.Value);
-            logger.LogInformation("Retrieved provider ({ProviderId}) via subscriber ID for Setup Intent ({SetupIntentId})", provider?.Id, setupIntent.Id);
-            if (provider is not { GatewayCustomerId: not null })
-            {
-                return null;
-            }
-
-            var providerCustomer = await stripeFacade.GetCustomer(provider.GatewayCustomerId);
-            logger.LogInformation("Retrieved customer ({CustomerId}) via provider ID for Setup Intent ({SetupIntentId})", provider.Id, setupIntent.Id);
-            return providerCustomer.Metadata;
-        }
     }
 
     private static T Extract<T>(Event stripeEvent)

src/Core/AdminConsole/Entities/Provider/Provider.cs

@@ -1,4 +1,5 @@
-using System.Net;
+using System.ComponentModel.DataAnnotations;
+using System.Net;
 using Bit.Core.AdminConsole.Enums.Provider;
 using Bit.Core.Entities;
 using Bit.Core.Enums;
@@ -33,7 +34,9 @@ public class Provider : ITableObject<Guid>, ISubscriber
     public DateTime CreationDate { get; internal set; } = DateTime.UtcNow;
     public DateTime RevisionDate { get; internal set; } = DateTime.UtcNow;
     public GatewayType? Gateway { get; set; }
+    [MaxLength(50)]
     public string? GatewayCustomerId { get; set; }
+    [MaxLength(50)]
     public string? GatewaySubscriptionId { get; set; }
     public string? DiscountId { get; set; }
 

src/Core/AdminConsole/Repositories/IOrganizationRepository.cs

@@ -9,6 +9,8 @@ namespace Bit.Core.Repositories;
 
 public interface IOrganizationRepository : IRepository<Organization, Guid>
 {
+    Task<Organization?> GetByGatewayCustomerIdAsync(string gatewayCustomerId);
+    Task<Organization?> GetByGatewaySubscriptionIdAsync(string gatewaySubscriptionId);
     Task<Organization?> GetByIdentifierAsync(string identifier);
     Task<ICollection<Organization>> GetManyByEnabledAsync();
     Task<ICollection<Organization>> GetManyByUserIdAsync(Guid userId);

src/Core/AdminConsole/Repositories/IProviderRepository.cs

@@ -8,6 +8,8 @@ namespace Bit.Core.AdminConsole.Repositories;
 
 public interface IProviderRepository : IRepository<Provider, Guid>
 {
+    Task<Provider?> GetByGatewayCustomerIdAsync(string gatewayCustomerId);
+    Task<Provider?> GetByGatewaySubscriptionIdAsync(string gatewaySubscriptionId);
     Task<Provider?> GetByOrganizationIdAsync(Guid organizationId);
     Task<ICollection<Provider>> SearchAsync(string name, string userEmail, int skip, int take);
     Task<ICollection<ProviderAbility>> GetManyAbilitiesAsync();