From c5852db6ed0a9c679398fd8be0407ebec1d14c23 Mon Sep 17 00:00:00 2001 From: Addison Beck Date: Wed, 13 Jul 2022 10:04:58 -0400 Subject: [PATCH] [feat] Allow CS to perform bulk actions on Stripe subscriptions from the Admin portal (#2116) * [feat] Allow CS to perform bulk actions on Stripe subscriptions from the Admin portal * [fix] An unrelated lint error --- src/Admin/Controllers/ToolsController.cs | 128 ++++++++- src/Admin/Models/StripeSubscriptionsModel.cs | 42 +++ src/Admin/Views/Shared/_Layout.cshtml | 3 + .../Views/Tools/StripeSubscriptions.cshtml | 265 ++++++++++++++++++ .../Stripe/StripeSubscriptionListOptions.cs | 41 +++ src/Core/Services/IStripeAdapter.cs | 8 +- .../Services/Implementations/StripeAdapter.cs | 29 +- 7 files changed, 510 insertions(+), 6 deletions(-) create mode 100644 src/Admin/Models/StripeSubscriptionsModel.cs create mode 100644 src/Admin/Views/Tools/StripeSubscriptions.cshtml create mode 100644 src/Core/Models/Stripe/StripeSubscriptionListOptions.cs diff --git a/src/Admin/Controllers/ToolsController.cs b/src/Admin/Controllers/ToolsController.cs index 11871c3ce7..0f3023cee5 100644 --- a/src/Admin/Controllers/ToolsController.cs +++ b/src/Admin/Controllers/ToolsController.cs @@ -1,6 +1,8 @@ -using System.Text.Json; +using System.Text; +using System.Text.Json; using Bit.Admin.Models; using Bit.Core.Entities; +using Bit.Core.Models.BitStripe; using Bit.Core.Repositories; using Bit.Core.Services; using Bit.Core.Settings; @@ -23,6 +25,7 @@ namespace Bit.Admin.Controllers private readonly IOrganizationUserRepository _organizationUserRepository; private readonly IPaymentService _paymentService; private readonly ITaxRateRepository _taxRateRepository; + private readonly IStripeAdapter _stripeAdapter; public ToolsController( GlobalSettings globalSettings, @@ -33,7 +36,8 @@ namespace Bit.Admin.Controllers IInstallationRepository installationRepository, IOrganizationUserRepository organizationUserRepository, ITaxRateRepository taxRateRepository, - IPaymentService paymentService) + IPaymentService paymentService, + IStripeAdapter stripeAdapter) { _globalSettings = globalSettings; _organizationRepository = organizationRepository; @@ -44,6 +48,7 @@ namespace Bit.Admin.Controllers _organizationUserRepository = organizationUserRepository; _taxRateRepository = taxRateRepository; _paymentService = paymentService; + _stripeAdapter = stripeAdapter; } public IActionResult ChargeBraintree() @@ -429,5 +434,124 @@ namespace Bit.Admin.Controllers return RedirectToAction("TaxRate"); } + + public async Task StripeSubscriptions(StripeSubscriptionListOptions options) + { + options = options ?? new StripeSubscriptionListOptions(); + options.Limit = 10; + options.Expand = new List() { "data.customer", "data.latest_invoice" }; + options.SelectAll = false; + + var subscriptions = await _stripeAdapter.SubscriptionListAsync(options); + + options.StartingAfter = subscriptions.LastOrDefault()?.Id; + options.EndingBefore = await StripeSubscriptionsGetHasPreviousPage(subscriptions, options) ? + subscriptions.FirstOrDefault()?.Id : + null; + + var model = new StripeSubscriptionsModel() + { + Items = subscriptions.Select(s => new StripeSubscriptionRowModel(s)).ToList(), + Prices = (await _stripeAdapter.PriceListAsync(new Stripe.PriceListOptions() { Limit = 100 })).Data, + Filter = options + }; + return View(model); + } + + [HttpPost] + public async Task StripeSubscriptions([FromForm] StripeSubscriptionsModel model) + { + if (!ModelState.IsValid) + { + model.Prices = (await _stripeAdapter.PriceListAsync(new Stripe.PriceListOptions() { Limit = 100 })).Data; + return View(model); + } + + if (model.Action == StripeSubscriptionsAction.Export || model.Action == StripeSubscriptionsAction.BulkCancel) + { + var subscriptions = model.Filter.SelectAll ? + await _stripeAdapter.SubscriptionListAsync(model.Filter) : + model.Items.Where(x => x.Selected).Select(x => x.Subscription); + + if (model.Action == StripeSubscriptionsAction.Export) + { + return StripeSubscriptionsExport(subscriptions); + } + + if (model.Action == StripeSubscriptionsAction.BulkCancel) + { + await StripeSubscriptionsCancel(subscriptions); + } + } + else + { + if (model.Action == StripeSubscriptionsAction.PreviousPage) + { + model.Filter.StartingAfter = null; + } + if (model.Action == StripeSubscriptionsAction.NextPage) + { + model.Filter.EndingBefore = null; + } + } + + + return RedirectToAction("StripeSubscriptions", model.Filter); + } + + // This requires a redundant API call to Stripe because of the way they handle pagination. + // The StartingBefore value has to be infered from the list we get, and isn't supplied by Stripe. + private async Task StripeSubscriptionsGetHasPreviousPage(List subscriptions, StripeSubscriptionListOptions options) + { + var hasPreviousPage = false; + if (subscriptions.FirstOrDefault()?.Id != null) + { + var previousPageSearchOptions = new StripeSubscriptionListOptions() + { + EndingBefore = subscriptions.FirstOrDefault().Id, + Limit = 1, + Status = options.Status, + CurrentPeriodEndDate = options.CurrentPeriodEndDate, + CurrentPeriodEndRange = options.CurrentPeriodEndRange, + Price = options.Price + }; + hasPreviousPage = (await _stripeAdapter.SubscriptionListAsync(previousPageSearchOptions)).Count > 0; + } + return hasPreviousPage; + } + + private async Task StripeSubscriptionsCancel(IEnumerable subscriptions) + { + foreach (var s in subscriptions) + { + await _stripeAdapter.SubscriptionCancelAsync(s.Id); + if (s.LatestInvoice?.Status == "open") + { + await _stripeAdapter.InvoiceVoidInvoiceAsync(s.LatestInvoiceId); + } + } + } + + private FileResult StripeSubscriptionsExport(IEnumerable subscriptions) + { + var fieldsToExport = subscriptions.Select(s => new + { + StripeId = s.Id, + CustomerEmail = s.Customer?.Email, + SubscriptionStatus = s.Status, + InvoiceDueDate = s.CurrentPeriodEnd, + SubscriptionProducts = s.Items?.Data.Select(p => p.Plan.Id) + }); + + var options = new JsonSerializerOptions + { + PropertyNamingPolicy = JsonNamingPolicy.CamelCase, + WriteIndented = true + }; + + var result = System.Text.Json.JsonSerializer.Serialize(fieldsToExport, options); + var bytes = Encoding.UTF8.GetBytes(result); + return File(bytes, "application/json", "StripeSubscriptionsSearch.json"); + } } } diff --git a/src/Admin/Models/StripeSubscriptionsModel.cs b/src/Admin/Models/StripeSubscriptionsModel.cs new file mode 100644 index 0000000000..2596db9abd --- /dev/null +++ b/src/Admin/Models/StripeSubscriptionsModel.cs @@ -0,0 +1,42 @@ +using System.ComponentModel.DataAnnotations; +using Bit.Core.Models.BitStripe; + +namespace Bit.Admin.Models +{ + public class StripeSubscriptionRowModel + { + public Stripe.Subscription Subscription { get; set; } + public bool Selected { get; set; } + + public StripeSubscriptionRowModel() { } + public StripeSubscriptionRowModel(Stripe.Subscription subscription) + { + Subscription = subscription; + } + } + + public enum StripeSubscriptionsAction + { + Search, + PreviousPage, + NextPage, + Export, + BulkCancel + } + + public class StripeSubscriptionsModel : IValidatableObject + { + public List Items { get; set; } + public StripeSubscriptionsAction Action { get; set; } = StripeSubscriptionsAction.Search; + public string Message { get; set; } + public List Prices { get; set; } + public StripeSubscriptionListOptions Filter { get; set; } = new StripeSubscriptionListOptions(); + public IEnumerable Validate(ValidationContext validationContext) + { + if (Action == StripeSubscriptionsAction.BulkCancel && Filter.Status != "unpaid") + { + yield return new ValidationResult("Bulk cancel is currently only supported for unpaid subscriptions"); + } + } + } +} diff --git a/src/Admin/Views/Shared/_Layout.cshtml b/src/Admin/Views/Shared/_Layout.cshtml index 9165424dca..3954091335 100644 --- a/src/Admin/Views/Shared/_Layout.cshtml +++ b/src/Admin/Views/Shared/_Layout.cshtml @@ -66,6 +66,9 @@ Manage Tax Rates + + Manage Stripe Subscriptions +
  • diff --git a/src/Admin/Views/Tools/StripeSubscriptions.cshtml b/src/Admin/Views/Tools/StripeSubscriptions.cshtml new file mode 100644 index 0000000000..3f66e08019 --- /dev/null +++ b/src/Admin/Views/Tools/StripeSubscriptions.cshtml @@ -0,0 +1,265 @@ +@model StripeSubscriptionsModel +@{ + ViewData["Title"] = "Stripe Subscriptions"; +} + +@section Scripts { + +} + +

    Manage Stripe Subscriptions

    +@if (!string.IsNullOrWhiteSpace(Model.Message)) +{ +
    +} +
    +
    +
    +
    + + +
    +
    + +
    +
    +
    + + Before + + After +
    +
    + @{ + var date = @Model.Filter.CurrentPeriodEndDate.HasValue ? @Model.Filter.CurrentPeriodEndDate.Value.ToString("yyyy-MM-dd") : string.Empty; + + } +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    +
    + +
    +
    + All @Model.Items.Count subscriptions on this page are selected.
    + + ✔ All subscriptions for this search are selected.
    + +
    +
    +
    + + + + + + + + + + + + + @if(!Model.Items.Any()) + { + + + + } + else + { + @for(var i = 0; i < Model.Items.Count; i++) + { + + + + + + + + + } + } + +
    +
    + +
    +     		IdCustomer EmailStatusProductCurrent Period End
    No results to list.
    + + + + + + + + @for(var j = 0; j < Model.Items[i].Subscription.Items.Data.Count; j++) + { + + } +
    + +
    +     		+ @Model.Items[i].Subscription.Id + + @Model.Items[i].Subscription.Customer?.Email + + @Model.Items[i].Subscription.Status + + @string.Join(",", Model.Items[i].Subscription.Items.Data.Select(product => product.Plan.Id).ToArray()) + + @Model.Items[i].Subscription.CurrentPeriodEnd.ToShortDateString() +
    +
    + +
    diff --git a/src/Core/Models/Stripe/StripeSubscriptionListOptions.cs b/src/Core/Models/Stripe/StripeSubscriptionListOptions.cs new file mode 100644 index 0000000000..99d1f02c76 --- /dev/null +++ b/src/Core/Models/Stripe/StripeSubscriptionListOptions.cs @@ -0,0 +1,41 @@ +namespace Bit.Core.Models.BitStripe +{ + // Stripe's SubscriptionListOptions model has a complex input for date filters. + // It expects a dictionary, and has lots of validation rules around what can have a value and what can't. + // To simplify this a bit we are extending Stripe's model and using our own date inputs, and building the dictionary they expect JiT. + // ___ + // Our model also facilitates selecting all elements in a list, which is unsupported by Stripe's model. + public class StripeSubscriptionListOptions : Stripe.SubscriptionListOptions + { + public DateTime? CurrentPeriodEndDate { get; set; } + public string CurrentPeriodEndRange { get; set; } = "lt"; + public bool SelectAll { get; set; } + public new Stripe.DateRangeOptions CurrentPeriodEnd + { + get + { + return CurrentPeriodEndDate.HasValue ? + new Stripe.DateRangeOptions() + { + LessThan = CurrentPeriodEndRange == "lt" ? CurrentPeriodEndDate : null, + GreaterThan = CurrentPeriodEndRange == "gt" ? CurrentPeriodEndDate : null + } : + null; + } + } + + public Stripe.SubscriptionListOptions ToStripeApiOptions() + { + var stripeApiOptions = (Stripe.SubscriptionListOptions)this; + if (CurrentPeriodEndDate.HasValue) + { + stripeApiOptions.CurrentPeriodEnd = new Stripe.DateRangeOptions() + { + LessThan = CurrentPeriodEndRange == "lt" ? CurrentPeriodEndDate : null, + GreaterThan = CurrentPeriodEndRange == "gt" ? CurrentPeriodEndDate : null + }; + } + return stripeApiOptions; + } + } +} diff --git a/src/Core/Services/IStripeAdapter.cs b/src/Core/Services/IStripeAdapter.cs index 82915a207c..48a589fed6 100644 --- a/src/Core/Services/IStripeAdapter.cs +++ b/src/Core/Services/IStripeAdapter.cs @@ -1,4 +1,6 @@ -namespace Bit.Core.Services +using Bit.Core.Models.BitStripe; + +namespace Bit.Core.Services { public interface IStripeAdapter { @@ -8,8 +10,9 @@ Task CustomerDeleteAsync(string id); Task SubscriptionCreateAsync(Stripe.SubscriptionCreateOptions subscriptionCreateOptions); Task SubscriptionGetAsync(string id, Stripe.SubscriptionGetOptions options = null); + Task> SubscriptionListAsync(StripeSubscriptionListOptions subscriptionSearchOptions); Task SubscriptionUpdateAsync(string id, Stripe.SubscriptionUpdateOptions options = null); - Task SubscriptionCancelAsync(string Id, Stripe.SubscriptionCancelOptions options); + Task SubscriptionCancelAsync(string Id, Stripe.SubscriptionCancelOptions options = null); Task InvoiceUpcomingAsync(Stripe.UpcomingInvoiceOptions options); Task InvoiceGetAsync(string id, Stripe.InvoiceGetOptions options); Task> InvoiceListAsync(Stripe.InvoiceListOptions options); @@ -31,5 +34,6 @@ Task CardDeleteAsync(string customerId, string cardId, Stripe.CardDeleteOptions options = null); Task BankAccountCreateAsync(string customerId, Stripe.BankAccountCreateOptions options = null); Task BankAccountDeleteAsync(string customerId, string bankAccount, Stripe.BankAccountDeleteOptions options = null); + Task> PriceListAsync(Stripe.PriceListOptions options = null); } } diff --git a/src/Core/Services/Implementations/StripeAdapter.cs b/src/Core/Services/Implementations/StripeAdapter.cs index 019ba99c82..cd7719fcce 100644 --- a/src/Core/Services/Implementations/StripeAdapter.cs +++ b/src/Core/Services/Implementations/StripeAdapter.cs @@ -1,4 +1,6 @@ -namespace Bit.Core.Services +using Bit.Core.Models.BitStripe; + +namespace Bit.Core.Services { public class StripeAdapter : IStripeAdapter { @@ -12,6 +14,7 @@ private readonly Stripe.RefundService _refundService; private readonly Stripe.CardService _cardService; private readonly Stripe.BankAccountService _bankAccountService; + private readonly Stripe.PriceService _priceService; public StripeAdapter() { @@ -25,6 +28,7 @@ _refundService = new Stripe.RefundService(); _cardService = new Stripe.CardService(); _bankAccountService = new Stripe.BankAccountService(); + _priceService = new Stripe.PriceService(); } public Task CustomerCreateAsync(Stripe.CustomerCreateOptions options) @@ -63,7 +67,7 @@ return _subscriptionService.UpdateAsync(id, options); } - public Task SubscriptionCancelAsync(string Id, Stripe.SubscriptionCancelOptions options) + public Task SubscriptionCancelAsync(string Id, Stripe.SubscriptionCancelOptions options = null) { return _subscriptionService.CancelAsync(Id, options); } @@ -173,5 +177,26 @@ { return _bankAccountService.DeleteAsync(customerId, bankAccount, options); } + + public async Task> SubscriptionListAsync(StripeSubscriptionListOptions options) + { + if (!options.SelectAll) + { + return (await _subscriptionService.ListAsync(options.ToStripeApiOptions())).Data; + } + + options.Limit = 100; + var items = new List(); + await foreach (var i in _subscriptionService.ListAutoPagingAsync(options.ToStripeApiOptions())) + { + items.Add(i); + } + return items; + } + + public async Task> PriceListAsync(Stripe.PriceListOptions options = null) + { + return await _priceService.ListAsync(options); + } } }