[Due for payment 2025-04-10] [$125] Flaky test SubscriptionUtils › getEarlyDiscountInfo

[mountiny]

In this run, you could see flaky unit test SubscriptionUtils › getEarlyDiscountInfo.

Flaky tests flow us down as we need to wait for them to pass.

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021905361796963763784
• Upwork Job ID: 1905361796963763784
• Last Price Increase: 2025-03-27
• Automatic offers:
• nkdengineer | Contributor | 106697516

Issue Owner

Current Issue Owner: @stephanieelliott

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~021905361796963763784

[melvin-bot]

Triggered auto assignment to @stephanieelliott (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @jayeshmangwani (External)

[melvin-bot]

Upwork job price has been updated to $125

[Shahidullah-Muffakir]

Proposal

Please re-state the problem that we are trying to solve in this issue.

The getEarlyDiscountInfo test in SubscriptionUtilsTest.ts is flaky, causing inconsistent test results.

What is the root cause of that problem?

The test is flaky because it relies on real-time calculations using new Date(). When the test runs:

1. It uses the current time as a reference point
2. Calculates trial start/end times relative to that current time
3. Expects exact values for minutes and seconds

This causes inconsistencies because:

• The test execution time varies between runs
• The time between test setup and assertion can cause slight differences

What changes do you think we should make in order to solve the problem?

1. Use Jest's timer mocking to set a fixed reference time for all tests
2. Replace relative time calculations with fixed timestamps

updated code

describe('getEarlyDiscountInfo', () => {
        afterEach(async () => {
            await Onyx.clear();
        });

        it('should return the discount info if the user is on a free trial and trial was started less than 24 hours before', async () => {
            // Use a fixed reference time
            const referenceTime = new Date('2024-01-01T12:00:00Z');
            const trialStartTime = new Date('2024-01-01T11:48:00Z'); // 12 minutes before reference time
            const trialEndTime = new Date('2024-01-11T12:00:00Z'); // 10 days after reference time

            // Mock the current time to be our reference time
            jest.useFakeTimers();
            jest.setSystemTime(referenceTime);

            await Onyx.multiSet({
                [ONYXKEYS.NVP_FIRST_DAY_FREE_TRIAL]: formatDate(trialStartTime, CONST.DATE.FNS_DATE_TIME_FORMAT_STRING),
                [ONYXKEYS.NVP_LAST_DAY_FREE_TRIAL]: formatDate(trialEndTime, CONST.DATE.FNS_DATE_TIME_FORMAT_STRING),
            });

            expect(getEarlyDiscountInfo()).toEqual({
                discountType: 50,
                days: 0,
                hours: 0,
                minutes: 12,
                seconds: 0,
            });

            // Restore the real timer
            jest.useRealTimers();
        });

        it('should return the discount info if the user is on a free trial and trial was started more than 24 hours before', async () => {
            // Use a fixed reference time
            const referenceTime = new Date('2024-01-01T12:00:00Z');
            const trialStartTime = new Date('2023-12-30T12:00:00Z'); // 2 days before reference time
            const trialEndTime = new Date('2024-01-11T12:00:00Z'); // 10 days after reference time

            // Mock the current time to be our reference time
            jest.useFakeTimers();
            jest.setSystemTime(referenceTime);

            await Onyx.multiSet({
                [ONYXKEYS.NVP_FIRST_DAY_FREE_TRIAL]: formatDate(trialStartTime, CONST.DATE.FNS_DATE_TIME_FORMAT_STRING),
                [ONYXKEYS.NVP_LAST_DAY_FREE_TRIAL]: formatDate(trialEndTime, CONST.DATE.FNS_DATE_TIME_FORMAT_STRING),
            });

            expect(getEarlyDiscountInfo()).toEqual({
                discountType: 25,
                days: 6,
                hours: 0,
                minutes: 0,
                seconds: 0,
            });

            // Restore the real timer
            jest.useRealTimers();
        });

        it('should return null if the user is not on a free trial', async () => {
            await Onyx.multiSet({
                [ONYXKEYS.NVP_FIRST_DAY_FREE_TRIAL]: null,
                [ONYXKEYS.NVP_LAST_DAY_FREE_TRIAL]: null,
            });

            expect(getEarlyDiscountInfo()).toBeNull();
        });
    });

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

NA