Refactor workspace settings #11615

mollfpr · 2022-10-05T18:15:30Z

Details

Refactoring workspace settings form to use Form.js and dismiss keyboard after form submission.

Fixed Issues

$ #11195
$ #11195 (comment)

Tests

UI looks as it did before the refactor
Values can be added and edited
Errors are highlighted correctly (input border)
Error messages show up correctly
Form alerts are displayed correctly
Clicking the fix the errors link focuses the first input with error
No duplicate submission of the form occurs (when it's already submitting)

Saving a workspace name should close the keyboard

Go to the workspace section
Click on the workspace name
Form input will come to address the change in the name
Once the desired name is input, press the save button
On the native app and mWeb verified that the keyboard is closed after pressing the save button

Verify that no errors appear in the JS console

QA Steps

UI looks as it did before the refactor
Values can be added and edited
Errors are highlighted correctly (input border)
Error messages show up correctly
Form alerts are displayed correctly
Clicking the fix the errors link focuses the first input with error
No duplicate submission of the form occurs (when it's already submitting)

Saving a workspace name should close the keyboard

Go to the workspace section
Click on the workspace name
Form input will come to address the change in the name
Once the desired name is input, press the save button
On the native app and mWeb verified that the keyboard is closed after pressing the save button

Verify that no errors appear in the JS console

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

5BWorkspaceSettings.5D-Web.mov

Mobile Web - Chrome

WorkspaceSettings.-mWeb.Chrome.Android.mov

Mobile Web - Safari

5BWorkspaceSettings.5D-mWeb.20Safari-iOS.mov

Desktop

WorkspaceSettings.-Desktop.mov

iOS

WorkspaceSettings.-iOS.mov

Android

WorkspaceSettings.-Android.mov

melvin-bot · 2022-10-05T18:15:34Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

rushatgabhane · 2022-10-05T23:11:37Z

Holding on review until #11039 is merged

…orkspace-settings

mollfpr · 2022-10-10T15:38:07Z

Pulled main!

@rushatgabhane Whenever you ready 👍

rushatgabhane · 2022-10-11T21:11:01Z

src/pages/workspace/WorkspacePageWithSections.js

@@ -56,6 +56,9 @@ const propTypes = {
        name: PropTypes.string,
    }).isRequired,

+    /** Option to not use the default scroll view  */
+    shouldNotUseScrollView: PropTypes.bool,


question: wanted to understand a bit more about this prop, why is it needed?

is form being nested inside a ScrollView causing a problem?

is form being nested inside a ScrollView causing a problem?

Yes. The ScrollView in WorkspacePageWithSections makes the submit button of Form.js not placed on the bottom.

@mollfpr okay, thanks!

If my understanding is correct, if we refactor all pages to use Form.js then we won't be needing this prop and we can directly return the children.

@rushatgabhane Yup, we won’t need that eventually.

Thought: after all pages have been refactored, we'll have to follow by with removing shouldNotUseScrollView from all pages.

Suggestion: create a shouldUseScrollView prop that is used by old pages not using Form. This way everything gets removed automatically.

@rushatgabhane the only other solution I came up with was to not use WorkspacePageWithSections, but I don't think that's better.

alright, thanks for looking into this @luacmartins
@mollfpr please ping me once you've made the changes 🙇‍♂️

@rushatgabhane I guess we can use shouldUseScrollView instead but need to update the other pages that use WorkspacePageWithSections. Are you on board with this?

@mollfpr yes, that'd be my suggestion. Feel free to disagree/provide your input

#11615 (comment)

@rushatgabhane I agree with your suggestion! I'll update the PR, thanks!

…orkspace-settings

mollfpr · 2022-10-18T04:04:59Z

@rushatgabhane I updated the PR and also reverted the Form.js changes because the issue is fixed here.

rushatgabhane

@mollfpr bug: clicking fix the error message doesn't focus the text input

Screen.Recording.2022-10-20.at.1.59.59.AM.mov

rushatgabhane · 2022-10-19T23:12:45Z

This PR also fixes #12008 (but it should be closed as a dupe as it would have been converted to a refactor issue too)

…orkspace-settings

mollfpr · 2022-10-19T23:40:24Z

@rushatgabhane I just pulled the latest main, it should be fixed the issue by clicking the error text to focus the input.

src/pages/workspace/WorkspaceSettingsPage.js

rushatgabhane · 2022-10-20T00:49:58Z

src/pages/workspace/WorkspaceSettingsPage.js

        const errors = {};
-        if (!this.state.name.trim().length) {
-            errors.nameError = true;
+        if (!values.name.trim().length) {


same thing here

I just add more conditions to the name validation. It will catch the null or undefined value.

rushatgabhane · 2022-10-20T15:25:36Z

@mollfpr can you please add tests for the original issue as well?

mollfpr · 2022-10-20T15:38:13Z

@rushatgabhane Added the original issue test and update the checklist with the latest template!

…orkspace-settings

rushatgabhane · 2022-10-20T15:54:54Z

Web

Screen.Recording.2022-10-20.at.6.24.36.AM.mov

mWeb

Screen.Recording.2022-10-20.at.8.59.57.PM.mov

Desktop

Screen.Recording.2022-10-20.at.9.04.33.PM.mov

Android

Screen.Recording.2022-10-20.at.9.16.16.PM.mov

iOS

Screen.Recording.2022-10-20.at.9.17.00.PM.mov

PR 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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

rushatgabhane

@Luke9389 LGTM! 🎉

luacmartins

LGTM

melvin-bot · 2022-10-20T16:56:42Z

@luacmartins looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

luacmartins · 2022-10-20T16:56:54Z

Tests passed. Removing Emergency label.

OSBotify · 2022-10-20T17:00:55Z

✋ 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 · 2022-10-25T00:14:08Z

🚀 Deployed to staging by @luacmartins in version: 1.2.19-0 🚀

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

Luke9389 · 2022-10-25T21:38:23Z

src/pages/workspace/WorkspacePageWithSections.js

-
-                    </View>
-                </ScrollView>
+                {this.props.shouldUseScrollView


I think this.props.shouldUseScrollView could use a better name.
It should indicate why we want to use scroll view.

Yeah

What do you think of something like isNotUsingForm? Because we're going to remove this prop whenever all the pages get refactored.

OSBotify · 2022-10-26T22:33:32Z

🚀 Deployed to production by @chiragsalian in version: 1.2.19-2 🚀

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

mollfpr added 3 commits October 6, 2022 01:06

fix error link pressed callback

26452c9

adding option to use scrollview

89e66a2

refactoring workspace settings form

6369026

mollfpr marked this pull request as ready for review October 5, 2022 18:15

mollfpr requested a review from a team as a code owner October 5, 2022 18:15

melvin-bot bot requested review from Luke9389 and rushatgabhane and removed request for a team October 5, 2022 18:15

Merge branch 'main' of https://github.com/mollfpr/App into refactor-w…

6934983

…orkspace-settings

rushatgabhane reviewed Oct 11, 2022

View reviewed changes

mollfpr added 4 commits October 18, 2022 10:45

Merge branch 'main' of https://github.com/mollfpr/App into refactor-w…

1bc71cb

…orkspace-settings

replacing shouldNotUseScrollView with shouldUseScrollView

8ef56ca

Adding shouldUseScrollView to current workspace pages

48626aa

reverting Form.js changes

4238ed8

rushatgabhane suggested changes Oct 19, 2022

View reviewed changes

rushatgabhane mentioned this pull request Oct 19, 2022

Workspace editor - 'Save' button is not grayed out while offline after changing the name #12008

Closed

Merge branch 'main' of https://github.com/mollfpr/App into refactor-w…

0688e27

…orkspace-settings

rushatgabhane reviewed Oct 20, 2022

View reviewed changes

adding check values.name

20ce566

Merge branch 'main' of https://github.com/mollfpr/App into refactor-w…

8f45c98

…orkspace-settings

rushatgabhane approved these changes Oct 20, 2022

View reviewed changes

luacmartins approved these changes Oct 20, 2022

View reviewed changes

luacmartins merged commit 5369f78 into Expensify:main Oct 20, 2022

melvin-bot bot added the Emergency label Oct 20, 2022

luacmartins removed the Emergency label Oct 20, 2022

OSBotify mentioned this pull request Oct 24, 2022

Deploy Checklist: New Expensify 2022-10-24 #12108

Closed

45 tasks

Luke9389 reviewed Oct 25, 2022

View reviewed changes

melvin-bot bot mentioned this pull request Oct 26, 2022

[HOLD for payment 2022-11-02] [$250] Saving a workspace name should close the keyboard - reported by @chauchausoup #11195

Closed

neil-marcellini mentioned this pull request Nov 4, 2022

[HOLD for payment 2022-11-16] [$250] Workspace settings - The "Save" button is unavailable offline #12453

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor workspace settings #11615

Refactor workspace settings #11615

mollfpr commented Oct 5, 2022 •

edited

Loading

melvin-bot bot commented Oct 5, 2022

rushatgabhane commented Oct 5, 2022

mollfpr commented Oct 10, 2022

rushatgabhane Oct 11, 2022

mollfpr Oct 12, 2022

rushatgabhane Oct 17, 2022 •

edited

Loading

mollfpr Oct 17, 2022

rushatgabhane Oct 17, 2022

luacmartins Oct 17, 2022

rushatgabhane Oct 18, 2022 •

edited

Loading

mollfpr Oct 18, 2022

rushatgabhane Oct 18, 2022

mollfpr Oct 18, 2022

mollfpr commented Oct 18, 2022

rushatgabhane left a comment

rushatgabhane commented Oct 19, 2022 •

edited

Loading

mollfpr commented Oct 19, 2022

rushatgabhane Oct 20, 2022

mollfpr Oct 20, 2022

rushatgabhane commented Oct 20, 2022

mollfpr commented Oct 20, 2022

rushatgabhane commented Oct 20, 2022 •

edited

Loading

PR Reviewer Checklist

rushatgabhane left a comment •

edited

Loading

luacmartins left a comment

melvin-bot bot commented Oct 20, 2022

luacmartins commented Oct 20, 2022

OSBotify commented Oct 20, 2022

OSBotify commented Oct 25, 2022

Luke9389 Oct 25, 2022

rushatgabhane Oct 28, 2022 •

edited

Loading

OSBotify commented Oct 26, 2022

Refactor workspace settings #11615

Refactor workspace settings #11615

Conversation

mollfpr commented Oct 5, 2022 • edited Loading

Details

Fixed Issues

Tests

QA Steps

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot bot commented Oct 5, 2022

rushatgabhane commented Oct 5, 2022

mollfpr commented Oct 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mollfpr commented Oct 18, 2022

rushatgabhane left a comment

Choose a reason for hiding this comment

rushatgabhane commented Oct 19, 2022 • edited Loading

mollfpr commented Oct 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane commented Oct 20, 2022

mollfpr commented Oct 20, 2022

rushatgabhane commented Oct 20, 2022 • edited Loading

Web

mWeb

Desktop

Android

iOS

PR Reviewer Checklist

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 20, 2022

luacmartins commented Oct 20, 2022

OSBotify commented Oct 20, 2022

OSBotify commented Oct 25, 2022

Choose a reason for hiding this comment

rushatgabhane Oct 28, 2022 • edited Loading

Choose a reason for hiding this comment

OSBotify commented Oct 26, 2022

mollfpr commented Oct 5, 2022 •

edited

Loading

rushatgabhane Oct 17, 2022 •

edited

Loading

rushatgabhane Oct 18, 2022 •

edited

Loading

rushatgabhane commented Oct 19, 2022 •

edited

Loading

rushatgabhane commented Oct 20, 2022 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane Oct 28, 2022 •

edited

Loading