[HOLD for payment 2024-01-17] [$500] [WAVE 5][LOW] Settings - Year change by months does not change selection

[izarutskaya]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: v1.4.12-0
Reproducible in staging?: Y
Reproducible in production?: Y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by:
Slack conversation: @

Action Performed:

1. Open the app
2. Open settings->profile->personal details->date of birth
3. Click on the year and select a year, observe that after value is changed, both background colour and green tick location are on the selected year
4. Click year again > now click the forward arrow of the month (>) until you get to January
5. Click on the year again and notice that the green checkmark is on the previously selected year and the highlight year is the new year

Expected Result:

App should change background color as well as green tick position for the selected or current calendar year

Actual Result:

App changes background color but does not change green tick position on change of year value by changing months value in calendar

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6312056_1702491118045.windows_chrome_-_year_change_by_months_issue.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0102b1c7f6c3df6359
• Upwork Job ID: 1735031332000718848
• Last Price Increase: 2023-12-13
• Automatic offers:
• mollfpr | Reviewer | 28064580
• ishpaul777 | Contributor | 28064581

[melvin-bot]

Triggered auto assignment to @Christinadobrzyn (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

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

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[melvin-bot]

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

[ishpaul777]

Proposal

Problem

Year change by months does not change selection

Root Cause

When we add a month (here) to selected date or move to previous (here) we only modify the currentDateView state and isSelected field in years state is not changed when year is also changes

Changes

we need to change selected year in years state when year is added(move to next month) or subtracted(moveToprevMonth)

    /**
     * Handles the user pressing the previous month arrow of the calendar picker.
     */
    moveToPrevMonth() {
        this.setState((prev) => {
            const prevMonth = subMonths(new Date(prev.currentDateView), 1);
            // if year is subtracted, we need to update the years list
            let newYears = prev.years;
            if (prevMonth.getFullYear() < prev.currentDateView.getFullYear()) {
                newYears = _.map(prev.years, (item) => ({
                    ...item,
                    isSelected: item.value === prevMonth.getFullYear(),
                }));
            }

            return {
                ...prev,
                currentDateView: prevMonth,
                years: newYears,
            };
        });
    }

    /**
     * Handles the user pressing the next month arrow of the calendar picker.
     */
    moveToNextMonth() {
        this.setState((prev) => {
            const nextMonth = addMonths(new Date(prev.currentDateView), 1);
            // if year is added, we need to update the years list
            let newYears = prev.years;
            if (nextMonth.getFullYear() > prev.currentDateView.getFullYear()) {
                newYears = _.map(prev.years, (item) => ({
                    ...item,
                    isSelected: item.value === nextMonth.getFullYear(),
                }));
            }

            return {
                ...prev,
                currentDateView: nextMonth,
                years: newYears,
            };
        });
    }

[ZhenjaHorbach]

Proposal

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

Settings - Year change by months does not change selection

What is the root cause of that problem?

The main problem is that the selected year changes thanks only to onYearSelected which call only when we set year

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

Instead of duplicating the logic for changing the selected year, we can simply add a listener

We can add new useEffect which will listen currentYear for YearPickerModal when our modal is not visible

App/src/components/DatePicker/CalendarPicker/YearPickerModal.js

Line 36 in 3df907c

function YearPickerModal(props) {

    useEffect(() => {
        if (!props.isVisible) {
            props.onYearChange(props.currentYear);
        }
    }, [props.currentYear, props.isVisible]);

What alternative solutions did you explore? (Optional)

As alternative we can use componentDidUpdate inside CalendarPicker

App/src/components/DatePicker/CalendarPicker/index.js

Line 46 in e81ed8f

class CalendarPicker extends React.PureComponent {

    componentDidUpdate(prevProps, prevState) {
        if (this.state.currentDateView.getFullYear() !== prevState.currentDateView.getFullYear()) {
            this.onYearSelected(this.state.currentDateView.getFullYear());
        }
    }

[Christinadobrzyn]

I can reproduce this - I think it's a low priority but I think it could be part of [ECARD] LOW: Settings - Remove unnecessary requirement for dateOfBirth when creating physical cards in Marqeta#316704

Adding it to that Wave to evaluate this change!

[ishpaul777]

@Christinadobrzyn i think we should treat this as normal priorty issue because the Calendar component is widely used in app, in bank account flow, money request and date of birth, and it looks like visual inconsistency which feels broken, user may encounter this in a normal flow of using app

[tienifr]

Proposal

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

Settings - Year change by months does not change selection

What is the root cause of that problem?

1. In CalendarPicker we store years but did not use it in CalendarPicker, we just pass it to YearPickerModal. So it can make our component re-renders unexpectedly
2. To show the selected year, we have to check isSelected here, but when year changes by months, we did not call onYearSelected so years sections is not updated

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

1. We should not store years in CalendarPicker, because we did not use it in CalendarPicker. We should calculate years in YearPickerModal. We will pass minYear, maxYear instead of years
2. When calculate years in YearPickerModal, we check isSelected=value === props.currentYear so we can make sure the currentYear will be selected

    const initialYears = useRef(_.map(
        Array.from({length: props.maxYear - props.minYear + 1}, (v, i) => i + props.minYear),
        (value) => ({
            text: value.toString(),
            value,
            keyForList: value.toString(),
        }),
    ))

    const years = useMemo(()=>{
        return _.map(
            initialYears.current,
            (year) => ({
                ...year,
                isSelected: year.value === props.currentYear,
            }),
        )
    },[props.currentYear])

Result

Screen.Recording.2023-12-14.at.11.30.35.mov

[Christinadobrzyn]

Hi @ishpaul777 it looks like this job will be treated with our normal priority.

@mollfpr feel free to evaluate the provided proposal to see if any will work. Thanks!

[flodnv]

I think it could be part of https://github.com/Expensify/Expensify/issues/316704

FWIW this is unrelated

[melvin-bot]

@mollfpr, @Christinadobrzyn Whoops! This issue is 2 days overdue. Let's get this updated quick!

[mollfpr]

I feel the proposal from @ishpaul777 is the correct way to handle this issue. It makes it easier to maintain the prev/next month's function.

🎀 👀 🎀 C+ reviewed!

[melvin-bot]

Triggered auto assignment to @danieldoglas, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[Christinadobrzyn]

still working on a review - @danieldoglas when you have a moment can you check on this decision - #33006 (comment)

[mollfpr]

@Christinadobrzyn, I think we already let @ishpaul777 work on the issue. We need to wait for the PR to be ready.

[Christinadobrzyn]

hi @mollfpr just checking on the PR review!

[mollfpr]

@Christinadobrzyn Yup, working on it!

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.23-4 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix/33006 #33355

If no regressions arise, payment will be issued on 2024-01-17. 🎊

For reference, here are some details about the assignees on this issue:

• @mollfpr requires payment automatic offer (Reviewer)
• @ishpaul777 requires payment automatic offer (Contributor)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@mollfpr] The PR that introduced the bug has been identified. Link to the PR:
• [@mollfpr] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@mollfpr] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@mollfpr] Determine if we should create a regression test for this bug.
• [@mollfpr] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@Christinadobrzyn] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[mollfpr]

[@mollfpr] The PR that introduced the bug has been identified. Link to the PR:

#21792

[@mollfpr] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:

https://github.com/Expensify/App/pull/21792/files#r1457723732

[@mollfpr] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:

The regression step should be enough.

[@mollfpr] Determine if we should create a regression test for this bug.
[@mollfpr] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.

1. Sign in to the App
2. Navigate to settings -> profile -> DOB
3. Click the forward arrow of the month (>) until you get to January. Note that the year has changed. Now open the year picker and verify the changed year is highlighted
4. Click the backward arrow of the month (<) until you get to December; note the year has changed. Now open the year picker and verify the changed year is highlighted

---

@Christinadobrzyn Could you give the payment summary for the manual request in NewDot? Thank you!

[danieldoglas]

Just awaiting payment, not overdue. cc @Christinadobrzyn

[Christinadobrzyn]

Sorry for the delay here

Regression test here- https://github.com/Expensify/Expensify/issues/363007

Payouts due:

Issue Reporter: NA
Contributor: $500 @ishpaul777 (Paid in Upwork)
Contributor+: $500 @mollfpr - you get paid in NewDot or Upwork?

Eligible for 50% #urgency bonus? NA

Upwork job is here. The upwork job is now closed so let me know if you need payment through Upwork and I'll create a new job

[mollfpr]

Thanks @Christinadobrzyn I'll request the payment in NewDot.

[JmillsExpensify]

$500 approved for @mollfpr based on summary above.

[Christinadobrzyn]

awesome! I think we're good to close this. Thanks all!