Skip to content

Commit

Permalink
feat(next): Clean up artifacts from checkout process on checkout failure
Browse files Browse the repository at this point in the history 
Because:

* As the user processes through the checkout process for a subscription, we create business objects to represent their subscription and the stakeholders. If the subscription fails, the artifacts need to be cleaned up.

This commit:

* Adds additional logic to the cart service wrapWithCartCatch method to clean up defunct artifacts.

Closes #FXA-10628
  • Loading branch information
@david1alvarez
david1alvarez committed Feb 7, 2025
1 parent b2f92cf commit 16eff52
Show file tree
Hide file tree
Showing 12 changed files with 427 additions and 19 deletions.
255 changes: 254 additions & 1 deletion libs/payments/cart/src/lib/cart.service.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ import {
StripePaymentIntentFactory,
StripeCustomerSessionFactory,
StripeApiListFactory,
StripeInvoiceFactory,
StripeDeletedInvoiceFactory,
} from '@fxa/payments/stripe';
import {
MockProfileClientConfigProvider,
Expand Down Expand Up @@ -199,6 +201,249 @@ describe('CartService', () => {
paymentMethodManager = moduleRef.get(PaymentMethodManager);
});

describe('wrapCartWithCatch', () => {
it('calls cartManager.finishErrorCart', async () => {
const mockCart = ResultCartFactory({
state: CartState.PROCESSING,
stripeSubscriptionId: null,
stripeCustomerId: null,
});
jest
.spyOn(cartManager, 'fetchCartById')
.mockRejectedValueOnce(new Error('test'))
.mockResolvedValue(mockCart);
jest.spyOn(cartManager, 'finishErrorCart').mockResolvedValue();

await expect(
cartService.finalizeProcessingCart(mockCart.id)
).rejects.toThrow(Error);

expect(cartManager.finishErrorCart).toHaveBeenCalled();
});

it('cancels a created subscription', async () => {
const mockCustomer = StripeResponseFactory(StripeCustomerFactory());
const mockSubscription = StripeResponseFactory(
StripeSubscriptionFactory({
customer: mockCustomer.id,
latest_invoice: null,
})
);
const mockCart = ResultCartFactory({
state: CartState.PROCESSING,
stripeSubscriptionId: mockSubscription.id,
stripeCustomerId: mockCustomer.id,
});

jest
.spyOn(cartManager, 'fetchCartById')
.mockRejectedValueOnce(new Error('test'))
.mockResolvedValue(mockCart);

jest.spyOn(cartManager, 'finishErrorCart').mockResolvedValue();
jest
.spyOn(subscriptionManager, 'retrieve')
.mockResolvedValue(mockSubscription);
jest
.spyOn(subscriptionManager, 'getLatestPaymentIntent')
.mockResolvedValue(undefined);
jest
.spyOn(subscriptionManager, 'cancel')
.mockResolvedValue(mockSubscription);

await expect(
cartService.finalizeProcessingCart(mockCart.id)
).rejects.toThrow(Error);

expect(subscriptionManager.cancel).toHaveBeenCalledWith(
mockSubscription.id,
{
cancellation_details: {
comment: 'Automatic Cancellation: Cart checkout failed.',
},
}
);
});

it('deletes a created draft invoice', async () => {
const mockCustomer = StripeResponseFactory(StripeCustomerFactory());
const mockInvoice = StripeResponseFactory(
StripeInvoiceFactory({ status: 'draft' })
);
const mockDeletedInvoice = StripeResponseFactory(
StripeDeletedInvoiceFactory({ id: mockInvoice.id })
);
const mockSubscription = StripeResponseFactory(
StripeSubscriptionFactory({
customer: mockCustomer.id,
latest_invoice: mockInvoice.id,
})
);
const mockCart = ResultCartFactory({
state: CartState.PROCESSING,
stripeSubscriptionId: mockSubscription.id,
stripeCustomerId: mockCustomer.id,
});

jest
.spyOn(cartManager, 'fetchCartById')
.mockRejectedValueOnce(new Error('test'))
.mockResolvedValue(mockCart);

jest.spyOn(cartManager, 'finishErrorCart').mockResolvedValue();
jest
.spyOn(subscriptionManager, 'retrieve')
.mockResolvedValue(mockSubscription);
jest.spyOn(invoiceManager, 'retrieve').mockResolvedValue(mockInvoice);
jest
.spyOn(invoiceManager, 'delete')
.mockResolvedValue(mockDeletedInvoice);
jest
.spyOn(subscriptionManager, 'getLatestPaymentIntent')
.mockResolvedValue(undefined);
jest
.spyOn(subscriptionManager, 'cancel')
.mockResolvedValue(mockSubscription);

await expect(
cartService.finalizeProcessingCart(mockCart.id)
).rejects.toThrow(Error);

expect(invoiceManager.delete).toHaveBeenCalledWith(mockInvoice.id);
});

it('voids a created finalized invoice', async () => {
const mockCustomer = StripeResponseFactory(StripeCustomerFactory());
const mockInvoice = StripeResponseFactory(
StripeInvoiceFactory({ status: 'open' })
);
const mockSubscription = StripeResponseFactory(
StripeSubscriptionFactory({
customer: mockCustomer.id,
latest_invoice: mockInvoice.id,
})
);
const mockCart = ResultCartFactory({
state: CartState.PROCESSING,
stripeSubscriptionId: mockSubscription.id,
stripeCustomerId: mockCustomer.id,
});

jest
.spyOn(cartManager, 'fetchCartById')
.mockRejectedValueOnce(new Error('test'))
.mockResolvedValue(mockCart);

jest.spyOn(cartManager, 'finishErrorCart').mockResolvedValue();
jest
.spyOn(subscriptionManager, 'retrieve')
.mockResolvedValue(mockSubscription);
jest.spyOn(invoiceManager, 'retrieve').mockResolvedValue(mockInvoice);
jest.spyOn(invoiceManager, 'void').mockResolvedValue(mockInvoice);
jest
.spyOn(subscriptionManager, 'getLatestPaymentIntent')
.mockResolvedValue(undefined);
jest
.spyOn(subscriptionManager, 'cancel')
.mockResolvedValue(mockSubscription);

await expect(
cartService.finalizeProcessingCart(mockCart.id)
).rejects.toThrow(Error);

expect(invoiceManager.void).toHaveBeenCalledWith(mockInvoice.id);
});

it('cancels a created payment intent', async () => {
const mockCustomer = StripeResponseFactory(StripeCustomerFactory());
const mockPaymentIntent = StripeResponseFactory(
StripePaymentIntentFactory({ status: 'processing' })
);
const mockSubscription = StripeResponseFactory(
StripeSubscriptionFactory({
customer: mockCustomer.id,
latest_invoice: null,
})
);
const mockCart = ResultCartFactory({
state: CartState.PROCESSING,
stripeSubscriptionId: mockSubscription.id,
stripeCustomerId: mockCustomer.id,
});

jest
.spyOn(cartManager, 'fetchCartById')
.mockRejectedValueOnce(new Error('test'))
.mockResolvedValue(mockCart);

jest.spyOn(cartManager, 'finishErrorCart').mockResolvedValue();
jest
.spyOn(subscriptionManager, 'retrieve')
.mockResolvedValue(mockSubscription);
jest
.spyOn(subscriptionManager, 'getLatestPaymentIntent')
.mockResolvedValue(mockPaymentIntent);
jest
.spyOn(paymentIntentManager, 'cancel')
.mockResolvedValue(mockPaymentIntent);
jest
.spyOn(subscriptionManager, 'cancel')
.mockResolvedValue(mockSubscription);

await expect(
cartService.finalizeProcessingCart(mockCart.id)
).rejects.toThrow(Error);

expect(paymentIntentManager.cancel).toHaveBeenCalledWith(
mockPaymentIntent.id
);
});

it('does not delete a customer with preexisting subscriptions', async () => {
const mockCustomer = StripeResponseFactory(StripeCustomerFactory());
const mockSubscription = StripeResponseFactory(
StripeSubscriptionFactory({
customer: mockCustomer.id,
latest_invoice: null,
})
);
const mockPreviousSubscription = StripeResponseFactory(
StripeSubscriptionFactory()
);
const mockCart = ResultCartFactory({
state: CartState.PROCESSING,
stripeSubscriptionId: mockSubscription.id,
stripeCustomerId: mockCustomer.id,
});

jest
.spyOn(cartManager, 'fetchCartById')
.mockRejectedValueOnce(new Error('test'))
.mockResolvedValue(mockCart);

jest.spyOn(cartManager, 'finishErrorCart').mockResolvedValue();
jest
.spyOn(subscriptionManager, 'retrieve')
.mockResolvedValue(mockSubscription);
jest
.spyOn(subscriptionManager, 'getLatestPaymentIntent')
.mockResolvedValue(undefined);
jest
.spyOn(subscriptionManager, 'cancel')
.mockResolvedValue(mockSubscription);
jest
.spyOn(subscriptionManager, 'listForCustomer')
.mockResolvedValue([mockPreviousSubscription]);
jest.spyOn(customerManager, 'delete');

await expect(
cartService.finalizeProcessingCart(mockCart.id)
).rejects.toThrow(Error);

expect(customerManager.delete).not.toHaveBeenCalledWith(mockCustomer.id);
});
});

describe('setupCart', () => {
const args = {
interval: SubplatInterval.Monthly,
Expand Down Expand Up @@ -314,7 +559,12 @@ describe('CartService', () => {
});

describe('restartCart', () => {
const mockStripeCustomerId = faker.string.uuid();
const mockAccountCustomer = ResultAccountCustomerFactory({
stripeCustomerId: mockStripeCustomerId,
});
const mockOldCart = ResultCartFactory({
uid: mockAccountCustomer.uid,
couponCode: faker.word.noun(),
});
const mockNewCart = ResultCartFactory();
Expand All @@ -333,6 +583,9 @@ describe('CartService', () => {
.spyOn(promotionCodeManager, 'assertValidPromotionCodeNameForPrice')
.mockResolvedValue(undefined);
jest.spyOn(cartManager, 'createCart').mockResolvedValue(mockNewCart);
jest
.spyOn(accountCustomerManager, 'getAccountCustomerByUid')
.mockResolvedValue(mockAccountCustomer);

const result = await cartService.restartCart(mockOldCart.id);

Expand All @@ -344,7 +597,7 @@ describe('CartService', () => {
couponCode: mockOldCart.couponCode,
taxAddress: mockOldCart.taxAddress,
currency: mockOldCart.currency,
stripeCustomerId: mockOldCart.stripeCustomerId,
stripeCustomerId: mockAccountCustomer.stripeCustomerId,
email: mockOldCart.email,
amount: mockOldCart.amount,
eligibilityStatus: mockOldCart.eligibilityStatus,
Expand Down
Loading

0 comments on commit 16eff52

Please sign in to comment.