Fix can't save workspace name using ENTER key after creating a new workspace from workspace switcher page #37069

bernhardoj · 2024-02-22T05:46:01Z

Details

The ENTER key is captured by the workspace switcher page ENTER key shortcut. The shortcut shouldn't be active anymore and this PR fix it.

Fixed Issues

$ #36923
PROPOSAL: #36923 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open workspace switcher page
Press the new workspace button (+ icon)
Open workspace profile page
Press the workspace name to edit it
Press ENTER to save
Verify the name is saved and the page is closed

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

Screen.Recording.2024-02-22.at.13.34.06.mov

Android: mWeb Chrome

Screen.Recording.2024-02-22.at.13.34.52.mov

iOS: Native

Screen.Recording.2024-02-22.at.13.36.17.mov

iOS: mWeb Safari

Screen.Recording.2024-02-22.at.13.35.36.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-22.at.13.31.37.mov

MacOS: Desktop

Screen.Recording.2024-02-22.at.13.32.47.mov

melvin-bot · 2024-02-22T05:46:05Z

@getusha Please 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]

getusha · 2024-02-23T05:39:09Z

src/components/OptionsSelector/BaseOptionsSelector.js

@@ -125,8 +125,11 @@ class BaseOptionsSelector extends Component {
            // Unregister the shortcut before registering a new one to avoid lingering shortcut listener
            this.unSubscribeFromKeyboardShortcut();
            if (this.props.isFocused) {
+                this.subscribeActiveElement();


why is this needed?

To resubscribe when the screen is refocused, otherwise, active element listener won't work anymore.

getusha · 2024-02-23T06:02:30Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-03-03.at.11.10.50.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-03-03.at.8.22.19.in.the.evening.mov

iOS: Native

Screen.Recording.2024-03-03.at.10.40.30.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-02-23.at.8.56.25.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-23.at.8.48.32.AM.mov

MacOS: Desktop

Screen.Recording.2024-03-03.at.8.05.52.in.the.evening.mov

getusha · 2024-02-23T06:05:33Z

@bernhardoj pressing enter reloads the app on android mWeb.

Screen.Recording.2024-02-23.at.9.01.38.AM.mov

bernhardoj · 2024-02-23T06:15:35Z

Oh yeah, I can reproduce it when using the soft keyboard button. Most likely related to #36401, but after applying the solution there, I can't use ENTER anymore on mWeb (maybe it's expected based on this comment).

cc: @shubham1206agra

shubham1206agra · 2024-02-23T07:29:03Z

@bernhardoj Can you help me give context related to this component you are trying to fix, and I will tell you the solution to this?

bernhardoj · 2024-02-23T07:35:43Z

@shubham1206agra The issue we have here is that the ENTER key doesn't work after creating a new workspace from the workspace switcher page because the ENTER event is still captured in BaseOptionsSelector.

@getusha then found that pressing ENTER on Android mWeb reloads the web.

But since this happens on main too, I think we can still proceed with the PR.

shubham1206agra · 2024-02-23T07:42:25Z

Oh yeah, I can reproduce it when using the soft keyboard button. Most likely related to #36401, but after applying the solution there, I can't use ENTER anymore on mWeb (maybe it's expected based on this comment).

Nope, this is not ideal @bernhardoj. You may need to fix this if this PR changes the previous behaviour. The ideal behaviour was for that component only, not in general.

getusha · 2024-02-23T07:49:41Z

Nope, this is not ideal @bernhardoj. You may need to fix this if this PR changes the previous behaviour. The ideal behaviour was for that component only, not in general.

I think there is a bit of misunderstanding here, i think @bernhardoj meant to say after applying the solution from your PR.

bernhardoj · 2024-02-23T07:54:45Z

@getusha +1, also it's not limited to this page, but to every page that is wrapped with a form

shubham1206agra · 2024-02-23T09:50:40Z

@getusha Can you give me the final behaviour here after applying both this and #36401? This might help us to fix this correctly.

getusha · 2024-02-26T11:50:38Z

@bernhardoj turns out only applying this change will fix the refresh issue, could you check if we can apply it?

index dc2f8ebb45..f6beb569a9 100644
--- a/src/pages/workspace/WorkspaceNamePage.tsx
+++ b/src/pages/workspace/WorkspaceNamePage.tsx
@@ -71,6 +71,7 @@ function WorkspaceNamePage({policy}: Props) {
                 validate={validate}
                 onSubmit={submit}
                 enabledWhenOffline
+                disablePressOnEnter={false}
             >
                 <View style={styles.mb4}>
                     <InputWrapper

shubham1206agra · 2024-02-26T12:36:51Z

@bernhardoj turns out only applying this change will fix the refresh issue, could you check if we can apply it?

index dc2f8ebb45..f6beb569a9 100644
--- a/src/pages/workspace/WorkspaceNamePage.tsx
+++ b/src/pages/workspace/WorkspaceNamePage.tsx
@@ -71,6 +71,7 @@ function WorkspaceNamePage({policy}: Props) {
                 validate={validate}
                 onSubmit={submit}
                 enabledWhenOffline
+                disablePressOnEnter={false}
             >
                 <View style={styles.mb4}>
                     <InputWrapper

Please don't apply this workaround. There seems to be another issue since TextInput should not occur refresh at all.

getusha · 2024-02-26T12:42:59Z

Please don't apply this workaround. There seems to be another issue since TextInput should not occur refresh at all.

@shubham1206agra could you explain a bit more, on why? i also see it being used in your PR https://github.com/Expensify/App/pull/36401/files#diff-5e02d6b48ee46a9077d2d4f5db2f7253199d570550fb4d81a906ff2b1bcd9b0eR95

shubham1206agra · 2024-02-26T12:47:41Z

That is a special case, as it uses BNP on mobile devices. So there's no Enter key. And one more thing, it was not used for handling refresh. It was to enable enter submission for web devices.

In your case, please try using the same in Native devices. It might not work as expected.

getusha · 2024-02-29T18:28:12Z

@bernhardoj Looks like @shubham1206agra's PR is merged, can you pull main and retest please?

bernhardoj · 2024-03-01T03:13:08Z

Merged with main.

As mentioned before, can't use Enter from soft keyboard

Screen.Recording.2024-03-01.at.11.03.19.mov

Happens on other forms

Screen.Recording.2024-03-01.at.11.03.47.mov

OSBotify · 2024-03-04T05:43:33Z

✋ 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 · 2024-03-04T21:03:44Z

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.47-0 🚀

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

OSBotify · 2024-03-06T21:52:46Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

unsubs from active element when out of focus

aab8e31

bernhardoj requested a review from a team as a code owner February 22, 2024 05:46

melvin-bot bot removed the request for review from a team February 22, 2024 05:46

melvin-bot bot requested a review from getusha February 22, 2024 05:46

getusha reviewed Feb 23, 2024

View reviewed changes

Merge branch 'main' into fix/36923-cant-save-workspace-name

e892ac3

getusha approved these changes Mar 3, 2024

View reviewed changes

melvin-bot bot requested a review from francoisl March 3, 2024 20:15

francoisl approved these changes Mar 4, 2024

View reviewed changes

francoisl merged commit f55b779 into Expensify:main Mar 4, 2024
16 checks passed

github-actions bot mentioned this pull request Mar 4, 2024

Deploy Checklist: New Expensify 2024-03-04 #37698

Closed

97 tasks

melvin-bot bot mentioned this pull request Mar 6, 2024

[HOLD for payment 2024-03-13] [$500] Workspace – Unable to save edited WS name using Enter key in newly created WS. #36923

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix can't save workspace name using ENTER key after creating a new workspace from workspace switcher page #37069

Fix can't save workspace name using ENTER key after creating a new workspace from workspace switcher page #37069

bernhardoj commented Feb 22, 2024

melvin-bot bot commented Feb 22, 2024

getusha Feb 23, 2024

bernhardoj Feb 23, 2024

getusha commented Feb 23, 2024 •

edited

Loading

getusha commented Feb 23, 2024

bernhardoj commented Feb 23, 2024 •

edited

Loading

shubham1206agra commented Feb 23, 2024

bernhardoj commented Feb 23, 2024

shubham1206agra commented Feb 23, 2024

getusha commented Feb 23, 2024

bernhardoj commented Feb 23, 2024

shubham1206agra commented Feb 23, 2024

getusha commented Feb 26, 2024

shubham1206agra commented Feb 26, 2024

getusha commented Feb 26, 2024 •

edited

Loading

shubham1206agra commented Feb 26, 2024

getusha commented Feb 29, 2024 •

edited

Loading

bernhardoj commented Mar 1, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 6, 2024

Fix can't save workspace name using ENTER key after creating a new workspace from workspace switcher page #37069

Fix can't save workspace name using ENTER key after creating a new workspace from workspace switcher page #37069

Conversation

bernhardoj commented Feb 22, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 22, 2024

getusha Feb 23, 2024

Choose a reason for hiding this comment

bernhardoj Feb 23, 2024

Choose a reason for hiding this comment

getusha commented Feb 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Feb 23, 2024

bernhardoj commented Feb 23, 2024 • edited Loading

shubham1206agra commented Feb 23, 2024

bernhardoj commented Feb 23, 2024

shubham1206agra commented Feb 23, 2024

getusha commented Feb 23, 2024

bernhardoj commented Feb 23, 2024

shubham1206agra commented Feb 23, 2024

getusha commented Feb 26, 2024

shubham1206agra commented Feb 26, 2024

getusha commented Feb 26, 2024 • edited Loading

shubham1206agra commented Feb 26, 2024

getusha commented Feb 29, 2024 • edited Loading

bernhardoj commented Mar 1, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 4, 2024

OSBotify commented Mar 6, 2024

getusha commented Feb 23, 2024 •

edited

Loading

bernhardoj commented Feb 23, 2024 •

edited

Loading

getusha commented Feb 26, 2024 •

edited

Loading

getusha commented Feb 29, 2024 •

edited

Loading