Skip to content

polish(payments-next): Use jest.spyOn() #19740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elizabeth-ilina wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −52
Open

polish(payments-next): Use jest.spyOn() #19740

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 71 additions & 52 deletions libs/payments/management/src/lib/churn-intervention.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@

import { ChurnInterventionService } from './churn-intervention.service';
import { ChurnInterventionManager, ChurnInterventionEntryFactory } from '@fxa/payments/cart';
import { ChurnInterventionByProductIdResultFactory } from '@fxa/shared/cms';
import {
ChurnInterventionByProductIdResultFactory,
ChurnInterventionByProductIdRawResultFactory,
ChurnInterventionByProductIdResultUtil
} from '@fxa/shared/cms';
import { StripeSubscriptionFactory, StripeResponseFactory } from '@fxa/payments/stripe';
import { ProductConfigurationManager } from '@fxa/shared/cms';
import { SubscriptionManagementService } from './subscriptionManagement.service';
import { Test } from '@nestjs/testing';
Expand Down Expand Up @@ -75,7 +80,8 @@ describe('ChurnInterventionService', () => {

describe('getChurnInterventionForCustomerId', () => {
it('returns the churn intervention entry', async () => {
(churnInterventionManager.getEntry as jest.Mock).mockResolvedValue(mockEntry);
jest.spyOn(churnInterventionManager, 'getEntry')
.mockResolvedValue(mockEntry);
const result = await churnInterventionService.getChurnInterventionForCustomerId(mockEntry.customerId, mockEntry.churnInterventionId);

expect(churnInterventionManager.getEntry).toHaveBeenCalledWith(
Expand All @@ -90,17 +96,16 @@ describe('ChurnInterventionService', () => {
const uid = 'uid_123';
const subscriptionId = 'sub_123';

const cmsResult = (entries: any[]) => ({
getTransformedChurnInterventionByProductId: () => entries,
});

afterEach(() => {
jest.resetAllMocks();
});

it('returns ineligible when no churn intervention entries are found', async () => {
(productConfigurationManager.getChurnInterventionBySubscription as jest.Mock)
.mockResolvedValue(cmsResult([]));
const rawResult = ChurnInterventionByProductIdRawResultFactory();
const util = new ChurnInterventionByProductIdResultUtil(rawResult);
jest.spyOn(productConfigurationManager, 'getChurnInterventionBySubscription')
.mockResolvedValue(util);
jest.spyOn(util, 'getTransformedChurnInterventionByProductId').mockReturnValue([]);

const result = await churnInterventionService.determineStaySubscribedEligibility(
uid,
Expand All @@ -115,13 +120,19 @@ describe('ChurnInterventionService', () => {
});

it('returns ineligible when redemption limit reached', async () => {
const entry = {
const rawResult = ChurnInterventionByProductIdRawResultFactory();
const util = new ChurnInterventionByProductIdResultUtil(rawResult);
jest.spyOn(productConfigurationManager, 'getChurnInterventionBySubscription')
.mockResolvedValue(util);

const mockCmsChurnEntry = ChurnInterventionByProductIdResultFactory({
churnInterventionId: 'churn_id',
redemptionLimit: 1
};
(productConfigurationManager.getChurnInterventionBySubscription as jest.Mock)
.mockResolvedValue(cmsResult([entry]));
(churnInterventionManager.getRedemptionCountForUid as jest.Mock)
});
jest.spyOn(util, 'getTransformedChurnInterventionByProductId')
.mockReturnValue([mockCmsChurnEntry]);

jest.spyOn(churnInterventionManager, 'getRedemptionCountForUid')
.mockResolvedValue(1);

const result = await churnInterventionService.determineStaySubscribedEligibility(
Expand All @@ -137,15 +148,14 @@ describe('ChurnInterventionService', () => {
});

it('returns ineligible when subscription is not active', async () => {
const entry = {
churnInterventionId: 'churn_id',
redemptionLimit: null
};
(productConfigurationManager.getChurnInterventionBySubscription as jest.Mock)
.mockResolvedValue(cmsResult([entry]));
(churnInterventionManager.getRedemptionCountForUid as jest.Mock)
const rawResult = ChurnInterventionByProductIdRawResultFactory();
const util = new ChurnInterventionByProductIdResultUtil(rawResult);
jest.spyOn(productConfigurationManager, 'getChurnInterventionBySubscription')
.mockResolvedValue(util);

jest.spyOn(churnInterventionManager, 'getRedemptionCountForUid')
.mockResolvedValue(0);
(subscriptionManagementService.getSubscriptionStatus as jest.Mock)
jest.spyOn(subscriptionManagementService, 'getSubscriptionStatus')
.mockResolvedValue({ active: false, cancelAtPeriodEnd: true });

const result = await churnInterventionService.determineStaySubscribedEligibility(
Expand All @@ -161,15 +171,14 @@ describe('ChurnInterventionService', () => {
});

it('returns ineligible when subscription is still active', async () => {
const entry = {
churnInterventionId: 'churn_id',
redemptionLimit: null
};
(productConfigurationManager.getChurnInterventionBySubscription as jest.Mock)
.mockResolvedValue(cmsResult([entry]));
(churnInterventionManager.getRedemptionCountForUid as jest.Mock)
const rawResult = ChurnInterventionByProductIdRawResultFactory();
const util = new ChurnInterventionByProductIdResultUtil(rawResult);
jest.spyOn(productConfigurationManager, 'getChurnInterventionBySubscription')
.mockResolvedValue(util);

jest.spyOn(churnInterventionManager, 'getRedemptionCountForUid')
.mockResolvedValue(0);
(subscriptionManagementService.getSubscriptionStatus as jest.Mock)
jest.spyOn(subscriptionManagementService, 'getSubscriptionStatus')
.mockResolvedValue({ active: true, cancelAtPeriodEnd: false });

const result = await churnInterventionService.determineStaySubscribedEligibility(
Expand All @@ -185,15 +194,18 @@ describe('ChurnInterventionService', () => {
});

it('returns eligible on success', async () => {
const entry = {
churnInterventionId: 'churn_id',
redemptionLimit: null
};
(productConfigurationManager.getChurnInterventionBySubscription as jest.Mock)
.mockResolvedValue(cmsResult([entry]));
(churnInterventionManager.getRedemptionCountForUid as jest.Mock)
const rawResult = ChurnInterventionByProductIdRawResultFactory();
const util = new ChurnInterventionByProductIdResultUtil(rawResult);
jest.spyOn(productConfigurationManager, 'getChurnInterventionBySubscription')
.mockResolvedValue(util);

const mockCmsChurnEntry = ChurnInterventionByProductIdResultFactory();
jest.spyOn(util, 'getTransformedChurnInterventionByProductId')
.mockReturnValue([mockCmsChurnEntry]);

jest.spyOn(churnInterventionManager, 'getRedemptionCountForUid')
.mockResolvedValue(0);
(subscriptionManagementService.getSubscriptionStatus as jest.Mock)
jest.spyOn(subscriptionManagementService, 'getSubscriptionStatus')
.mockResolvedValue({ active: true, cancelAtPeriodEnd: true });

const result = await churnInterventionService.determineStaySubscribedEligibility(
Expand All @@ -204,12 +216,12 @@ describe('ChurnInterventionService', () => {
expect(result).toEqual({
isEligible: true,
reason: 'eligible',
cmsChurnInterventionEntry: entry,
cmsChurnInterventionEntry: mockCmsChurnEntry,
});
});

it('returns general_error for general errors', async () => {
(productConfigurationManager.getChurnInterventionBySubscription as jest.Mock)
jest.spyOn(productConfigurationManager, 'getChurnInterventionBySubscription')
.mockRejectedValue(new Error('error'));

const result = await churnInterventionService.determineStaySubscribedEligibility(
Expand Down Expand Up @@ -240,8 +252,15 @@ describe('ChurnInterventionService', () => {
cmsChurnInterventionEntry: mockCmsChurnEntry,
});

(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
.mockResolvedValue({ id: subscriptionId, cancel_at_period_end: true });
const updatedSubscription = StripeResponseFactory(
StripeSubscriptionFactory({
id: subscriptionId,
cancel_at_period_end: true,
})
);

jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription')
.mockResolvedValue(updatedSubscription);

const prevCount = mockChurnInterventionEntry.redemptionCount || 0;

Expand All @@ -251,23 +270,23 @@ describe('ChurnInterventionService', () => {
churnInterventionId: mockChurnInterventionEntry.churnInterventionId,
redemptionCount: prevCount + 1,
});
(churnInterventionManager.updateEntry as jest.Mock)
jest.spyOn(churnInterventionManager, 'updateEntry')
.mockResolvedValue(updatedEntry);

const result = await churnInterventionService.redeemChurnCoupon(
mockChurnInterventionEntry.customerId,
subscriptionId
);

expect(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
expect(jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription'))
.toHaveBeenCalledWith({
uid: mockChurnInterventionEntry.customerId,
subscriptionId,
stripeCouponId: mockCmsChurnEntry.stripeCouponId,
setCancelAtPeriodEnd: true,
});

expect(churnInterventionManager.updateEntry as jest.Mock)
expect(jest.spyOn(churnInterventionManager, 'updateEntry'))
.toHaveBeenCalledWith(
mockChurnInterventionEntry.customerId,
mockCmsChurnEntry.churnInterventionId,
Expand All @@ -292,23 +311,23 @@ describe('ChurnInterventionService', () => {
cmsChurnInterventionEntry: mockCmsChurnEntry,
});

(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription')
.mockRejectedValue(new Error('Stripe error'));

const result = await churnInterventionService.redeemChurnCoupon(
mockChurnInterventionEntry.customerId,
subscriptionId
);

expect(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
expect(jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription'))
.toHaveBeenCalledWith({
uid: mockChurnInterventionEntry.customerId,
subscriptionId,
stripeCouponId: mockCmsChurnEntry.stripeCouponId,
setCancelAtPeriodEnd: true,
});

expect(churnInterventionManager.updateEntry as jest.Mock).not.toHaveBeenCalled();
expect(jest.spyOn(churnInterventionManager, 'updateEntry')).not.toHaveBeenCalled();
expect(result).toEqual({
redeemed: false,
reason: 'failed_to_redeem_coupon',
Expand All @@ -331,10 +350,10 @@ describe('ChurnInterventionService', () => {
subscriptionId
);

expect(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
expect(jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription'))
.not.toHaveBeenCalled();

expect(churnInterventionManager.updateEntry as jest.Mock).not.toHaveBeenCalled();
expect(jest.spyOn(churnInterventionManager, 'updateEntry')).not.toHaveBeenCalled();
expect(result).toEqual({
redeemed: false,
reason: 'discount_already_applied',
Expand All @@ -352,23 +371,23 @@ describe('ChurnInterventionService', () => {
cmsChurnInterventionEntry: mockCmsChurnEntry,
});

(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription')
.mockResolvedValue(null);

const result = await churnInterventionService.redeemChurnCoupon(
mockChurnInterventionEntry.customerId,
subscriptionId
);

expect(subscriptionManagementService.applyStripeCouponToSubscription as jest.Mock)
expect(jest.spyOn(subscriptionManagementService, 'applyStripeCouponToSubscription'))
.toHaveBeenCalledWith({
uid: mockChurnInterventionEntry.customerId,
subscriptionId,
stripeCouponId: mockCmsChurnEntry.stripeCouponId,
setCancelAtPeriodEnd: true,
});

expect(churnInterventionManager.updateEntry as jest.Mock).not.toHaveBeenCalled();
expect(jest.spyOn(churnInterventionManager, 'updateEntry')).not.toHaveBeenCalled();
expect(result).toEqual({
redeemed: false,
reason: 'stripe_subscription_update_failed',
Expand Down