Use push to page for report settings #16910

Gonals · 2023-04-04T14:37:25Z

Details

Here we are refactoring the report settings page to use "push to page". So instead of entering the room name directly on the report settings page, there is a menu item for the report name. When you click it you are navigated to a separate page for entering the room name. When you save it you are navigated back. I implemented the same thing for the room notification preference selection, using the same pattern as on the LanguagePage. Push to page is our preferred pattern for inputs now.

I used functional components for the new pages, but left existing pages as class components since they should be refactored separately. The ReportSettings page is mostly unchanged, but it moved, so it will be easier to look at the diff between the new file path and the file on main.

Fixed Issues

$ #16768

Tests

Rename a room

Create a workspace if needed
Create a workspace room if needed
Open a Room chat
Click on the Header
Go to Settings
Click on the room name
Clear the room name
Click save
Verify that you see an error on the room name input saying "Please enter a room name"
Enter a new room name with a capital letter
Verify that you see an error on the room name input saying "Room names can only include lowercase letters, numbers and hyphens"
Enter a valid new room name
Click save
Confirm the name has been changed and you are navigated back to the previous page

Update room notification preference

Create a workspace if needed
Create a workspace room if needed
Open a Room chat
Click on the Header
Go to Settings
Click on the notification preference
Select a different notification preference
Confirm that you are navigated back to the previous page and the notification preference has been updated

Verify that no errors appear in the JS console

Offline tests

Rename a room offline

Create a workspace if needed
Create a workspace room if needed
Go offline
Open a Room chat
Click on the Header
Go to Settings
Click on the room name
Enter a valid new room name
Click save
Confirm the name has been changed and you are navigated back to the previous page, and the room name is grayed out
Go back online
Verify that the room name is no longer grayed out

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

I only tested on Web since the changes are platform independent.

Web

Rename a room

room-rename.mov

Update room notification preference

room-notif-pref.mov

Rename a room offline

offline-room-rename.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-04-04T14:38:02Z

@rushatgabhane @neil-marcellini One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Gonals · 2023-04-04T14:40:36Z

Removing C+, as it is a very simple fix

neil-marcellini

It looks like the recommendation in the Slack conversation was to convert this to Push to page. I think we should do that.

neil-marcellini

Hmm I'm changing my mind. I think since we already "pushed" to the settings page, if we make the "Save" button navigate back then it's effectively using push to page. It would be odd to have each settings field on its own page. For example with https://staging.new.expensify.com/settings/profile/display-name the first and last name can be updated on the same page. What do you think @shawnborton?

The changes work well for updating the room name, but let's make it navigate back when you hit the "Save" button so that it works for the notification preference.

Screen.Recording.2023-04-04.at.8.48.20.AM.mov

shawnborton · 2023-04-04T16:16:23Z

I think we decided that we want both the room name and the notification frequency to be push-to-page inputs. When you tap on room name, you get pushed to a new page where you are auto-focused. Saving this new page then returns back to the overview page.

Cc @JmillsExpensify @trjExpensify

Gonals · 2023-04-05T14:13:42Z

Gotcha! Refactoring this, then! WIP for now

neil-marcellini · 2023-04-05T15:24:21Z

Ok sounds good. It might be cool to have an illustration, animation, or branding on the "pushed" pages because they feel really empty to me.

neil-marcellini · 2023-05-16T22:54:25Z

I thought maybe the problem was the keyboard not opening. I tried forwarding a ref to the RoomNameInput and focusing it onEntryTransitionEnd, but I couldn't get the ref to work, it was always null.

Here's the changes I tried on the RoomNamePage if you want to play around with it. Anyways, I want to make sure I understand the problem before I dig deeper.

Forward ref focus attempt

import React, {useCallback, useRef} from 'react';
import {withOnyx} from 'react-native-onyx';
import PropTypes from 'prop-types';
import {View} from 'react-native';
import CONST from '../../../CONST';
import ScreenWrapper from '../../../components/ScreenWrapper';
import HeaderWithCloseButton from '../../../components/HeaderWithCloseButton';
import withLocalize, {withLocalizePropTypes} from '../../../components/withLocalize';
import Form from '../../../components/Form';
import ONYXKEYS from '../../../ONYXKEYS';
import styles from '../../../styles/styles';
import Navigation from '../../../libs/Navigation/Navigation';
import compose from '../../../libs/compose';
import * as ErrorUtils from '../../../libs/ErrorUtils';
import * as ValidationUtils from '../../../libs/ValidationUtils';
import withReportOrNotFound from '../../home/report/withReportOrNotFound';
import reportPropTypes from '../../reportPropTypes';
import ROUTES from '../../../ROUTES';
import * as Report from '../../../libs/actions/Report';
import RoomNameInput from '../../../components/RoomNameInput';

const propTypes = {
    ...withLocalizePropTypes,

    /** The room report for which the name is being edited */
    report: reportPropTypes.isRequired,

    /** All reports shared with the user */
    reports: PropTypes.objectOf(reportPropTypes),
};
const defaultProps = {
    reports: {},
};

const RoomNamePage = (props) => {
    const report = props.report;
    const reports = props.reports;
    const translate = props.translate;
    const nameInputRef = useRef(null);

    const validate = useCallback((values) => {
        console.log('debug validate nameInputRef =', nameInputRef);
        const errors = {};

        // We should skip validation hence we return an empty errors and we skip Form submission on the onSubmit method
        if (values.roomName === report.reportName) {
            return errors;
        }

        if (!values.roomName || values.roomName === CONST.POLICY.ROOM_PREFIX) {
            // We error if the user doesn't enter a room name or left blank
            ErrorUtils.addErrorMessage(errors, 'roomName', translate('newRoomPage.pleaseEnterRoomName'));
        } else if (!ValidationUtils.isValidRoomName(values.roomName)) {
            // We error if the room name has invalid characters
            ErrorUtils.addErrorMessage(errors, 'roomName', translate('newRoomPage.roomNameInvalidError'));
        } else if (ValidationUtils.isReservedRoomName(values.roomName)) {
            // Certain names are reserved for default rooms and should not be used for policy rooms.
            ErrorUtils.addErrorMessage(errors, 'roomName', translate('newRoomPage.roomNameReservedError', {reservedName: values.roomName}));
        } else if (ValidationUtils.isExistingRoomName(values.roomName, reports, report.policyID)) {
            // The room name can't be set to one that already exists on the policy
            ErrorUtils.addErrorMessage(errors, 'roomName', translate('newRoomPage.roomAlreadyExistsError'));
        }

        return errors;
    }, [report, reports, translate]);

    return (
        <ScreenWrapper
            includeSafeAreaPaddingBottom={false}
            onEntryTransitionEnd={() => {
                console.log('debug nameInputRef =', nameInputRef);
                if (!nameInputRef.current) {
                    return;
                }
                nameInputRef.current.focus();
            }}
        >
            <HeaderWithCloseButton
                title={translate('newRoomPage.roomName')}
                shouldShowBackButton
                onBackButtonPress={() => Navigation.drawerGoBack(ROUTES.getReportSettingsRoute(report.reportID))}
                onCloseButtonPress={() => Navigation.dismissModal(true)}
            />
            <Form
                style={[styles.flexGrow1, styles.ph5]}
                formID={ONYXKEYS.FORMS.ROOM_NAME_FORM}
                onSubmit={values => Report.updatePolicyRoomNameAndNavigate(report, values.roomName)}
                validate={validate}
                submitButtonText={translate('common.save')}
                enabledWhenOffline
            >
                <View style={styles.mb4}>
                    <RoomNameInput
                        inputID="roomName"
                        defaultValue={report.reportName}
                        ref={nameInputRef}
                    />
                </View>
            </Form>
        </ScreenWrapper>
    );
};

RoomNamePage.propTypes = propTypes;
RoomNamePage.defaultProps = defaultProps;
RoomNamePage.displayName = 'RoomNamePage';

export default compose(
    withLocalize,
    withReportOrNotFound,
    withOnyx({
        reports: {
            key: ONYXKEYS.COLLECTION.REPORT,
        },
    }),
)(RoomNamePage);

aimane-chnaif · 2023-05-17T15:23:00Z

@neil-marcellini it's easily reproducible. Please check #admins room settings

aimane-chnaif

We can fix android focus issue as a follow-up.

Please fix lint.

src/pages/settings/Report/ReportSettingsPage.js

neil-marcellini · 2023-05-17T19:12:44Z

@neil-marcellini it's easily reproducible. Please check #admins room settings

Ah yes, thanks for explaining!

aimane-chnaif · 2023-05-17T20:11:09Z

BUG: infinite loop when press back button after visiting room name page directly from address bar

bug3.mov

aimane-chnaif · 2023-05-17T22:48:14Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

mountiny

@neil-marcellini Great job on this one, there is one conflict though, can you please resolve it?

mountiny

Thanks @Gonals for staring, @aimane-chnaif for review and testing and @neil-marcellini getting it to the finish line.

OSBotify · 2023-05-18T00:00:12Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-05-18T07:38:27Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.16-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-05-22T23:39:54Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-05-23T00:15:49Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-05-23T19:53:43Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-05-23T21:52:27Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Gonals added 2 commits April 4, 2023 16:14

Navigate back after changing the name

467e981

remove unneded import

f9a98c7

Gonals self-assigned this Apr 4, 2023

Gonals requested a review from a team as a code owner April 4, 2023 14:37

melvin-bot bot requested review from neil-marcellini and rushatgabhane and removed request for a team April 4, 2023 14:38

Gonals removed the request for review from rushatgabhane April 4, 2023 14:40

neil-marcellini previously requested changes Apr 4, 2023

View reviewed changes

neil-marcellini reviewed Apr 4, 2023

View reviewed changes

Gonals added 11 commits April 5, 2023 14:09

Merge branch 'main' into alberto-naviOut

5e35c84

remove navigation back

09a03b5

create new RoomNamePage component

2cb9424

actually add the page

fd706e6

actually add them

e5b37e7

remove unneeded imports

512e839

cleanup component

642b698

more cleanup

05ca854

add route

faac28e

get right props

891b87f

add validation

6ec699c

Gonals changed the title ~~Navigate back after renaming Chat Room~~ [WIP] Navigate back after renaming Chat Room Apr 5, 2023

Gonals added 3 commits April 10, 2023 15:29

changing branch

a7f795d

Merge branch 'main' into alberto-naviOut

72b095e

Add prefix handling

362a51c

aimane-chnaif suggested changes May 17, 2023

View reviewed changes

neil-marcellini added 2 commits May 17, 2023 12:28

Clean up spacing and wrappers per feedback

bc6fe65

Pretty pretty

f4a4e62

neil-marcellini requested review from aimane-chnaif and removed request for parasharrajat May 17, 2023 19:32

Use sentence case

f54cf5f

Prevent navigate back loop after direct url access

b1e63d6

aimane-chnaif previously approved these changes May 17, 2023

View reviewed changes

mountiny reviewed May 17, 2023

View reviewed changes

Merge branch 'main' into alberto-naviOut

73fd848

neil-marcellini dismissed aimane-chnaif’s stale review via 73fd848 May 17, 2023 23:40

neil-marcellini requested a review from mountiny May 17, 2023 23:41

mountiny approved these changes May 17, 2023

View reviewed changes

mountiny merged commit 2005880 into main May 17, 2023

mountiny deleted the alberto-naviOut branch May 17, 2023 23:51

amyevans mentioned this pull request May 18, 2023

Add ability for admins to restrict who can post within rooms #19094

Merged

57 tasks

OSBotify mentioned this pull request May 18, 2023

Deploy Checklist: New Expensify 2023-05-18 #19175

Closed

39 tasks

melvin-bot bot mentioned this pull request May 22, 2023

[HOLD for payment 2023-05-29] Renaming chat room does not close RHP #16768

Closed

6 tasks

abdulrahuman5196 mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-06-21] [$1000] Web - Room - Visibility subtitle is wrong for public room #20127

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use push to page for report settings #16910

Use push to page for report settings #16910

Gonals commented Apr 4, 2023 •

edited by neil-marcellini

Loading

MelvinBot commented Apr 4, 2023

Gonals commented Apr 4, 2023

neil-marcellini left a comment

neil-marcellini left a comment •

edited

Loading

shawnborton commented Apr 4, 2023

Gonals commented Apr 5, 2023

neil-marcellini commented Apr 5, 2023

neil-marcellini commented May 16, 2023

aimane-chnaif commented May 17, 2023

aimane-chnaif left a comment

neil-marcellini commented May 17, 2023

aimane-chnaif commented May 17, 2023

aimane-chnaif commented May 17, 2023

mountiny left a comment

mountiny left a comment

OSBotify commented May 18, 2023

OSBotify commented May 18, 2023

OSBotify commented May 22, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

Use push to page for report settings #16910

Use push to page for report settings #16910

Conversation

Gonals commented Apr 4, 2023 • edited by neil-marcellini Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 4, 2023

Gonals commented Apr 4, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini left a comment • edited Loading

Choose a reason for hiding this comment

shawnborton commented Apr 4, 2023

Gonals commented Apr 5, 2023

neil-marcellini commented Apr 5, 2023

neil-marcellini commented May 16, 2023

aimane-chnaif commented May 17, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

neil-marcellini commented May 17, 2023

aimane-chnaif commented May 17, 2023

aimane-chnaif commented May 17, 2023

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented May 18, 2023

OSBotify commented May 18, 2023

OSBotify commented May 22, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 23, 2023

Gonals commented Apr 4, 2023 •

edited by neil-marcellini

Loading

neil-marcellini left a comment •

edited

Loading