Fix: Focus mode - User priority mode is switched back to focus automatically

[tienifr]

Details

Fixed Issues

$ #34814
PROPOSAL: #34814 (comment)

Tests

Precondition: Must be reproduced in a user who switched to Focus mode before the 'auto-switch to Focus mode' was added

1. Login with the user
2. Change the priority mode to Most recent
3. Open chat
4. Verify that priority mode is not change automatically

Note: On dev environment, we can manually set Onyx.set(ONYXKEYS.NVP_TRY_FOCUS_MODE, false) (E.g. In PriorityMode.ts), so when we reload the page, it'll be set to false

• Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Precondition: Must be reproduced in a user who switched to Focus mode before the 'auto-switch to Focus mode' was added

1. Login with the user
2. Change the priority mode to Most recent
3. Open chat
4. Verify that priority mode is not change automatically

• 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 / Chrome
  • iOS / native
  • iOS / 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 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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-30.at.15.08.55.mov

Android: mWeb Chrome

Screen.Recording.2024-01-30.at.15.04.38.mov

iOS: Native

Screen.Recording.2024-01-30.at.15.06.57.mov

iOS: mWeb Safari

Screen.Recording.2024-01-30.at.14.59.40.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-30.at.14.44.49.mp4

MacOS: Desktop

Screen.Recording.2024-01-30.at.14.54.49.mp4

[melvin-bot]

@cubuspl42 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]

[jakub-trzebiatowski]

Please merge main

[jakub-trzebiatowski]

• Login with the user
• Change the priority mode to Most recent
• Verify that priority mode is not change automatically

Isn't "Open any chat" a required step after "Change the priority mode to Most recent" to reproduce the original issue?

(#34814 (comment))

[jakub-trzebiatowski]

What are the affected platforms of the issue we're fixing?

[tienifr]

@cubuspl42 Don't we need the precondition?

[tienifr]

What are the affected platforms of the issue we're fixing?

I gotta say all platforms

[jakub-trzebiatowski]

Don't we need the precondition?

We do, I didn't mean to remove anything from the steps. I was under an impression that we need the mentioned extra step to reproduce the bug. And the tests should ensure that the bug is not reproducible under the conditions that used to trigger it.

It's not an achievement not to trigger a bug under circumstances that didn't trigger it before; you get it.

[jakub-trzebiatowski]

I gotta say all platforms

Were you able to reproduce it on Android?

I know that fixing the bug is more important than analyzing it, but before verifying that we fixed something, I often start with ensuring that I can actually trigger the bug to reduce the chance of performing leaky testing steps.

[tienifr]

@cubuspl42 I still can reproduce it on Android. I believe this bug happens on all platforms. As I mentioned on the PR description, we can use this way to reproduce the bug.

On dev environment, we can manually set Onyx.set(ONYXKEYS.NVP_TRY_FOCUS_MODE, false) (E.g. In PriorityMode.ts), so when we reload the page, it'll be set to false

1. Go to PriorityMode page
2. Reload page (NVP_TRY_FOCUS_MODE will be set to false)
3. Change to focus mode

[jakub-trzebiatowski]

We're over 1000 commits behind main; let's merge it.

[jakub-trzebiatowski]

2. Reload page (NVP_TRY_FOCUS_MODE will be set to false)

What does "reload page" mean on Native? Metro reload?

[jakub-trzebiatowski]

On top of upstream/main (8e069a3fdcf09c86451a7e6d7be268c5296ab710)...

PriorityMode.ts

let currentUserAccountID: number | undefined | null;
Onyx.connect({
    key: ONYXKEYS.SESSION,
    callback: (val) => {
        currentUserAccountID = val?.accountID;
    },
});

// I added this line:
Onyx.set(ONYXKEYS.NVP_TRY_FOCUS_MODE, false);

Test on Android: Native:

focus-mode-issue-repro-problem-1-android-compressed.mp4

Please note that I started with reloading Metro.

I cannot reproduce the issue. What am I doing wrong?

[tienifr]

@cubuspl42 We need to update the steps a bit because BE returns tryFocusMode: true though ReconnectApp or OpenApp API

1. In PriorityMode.ts

setTimeout(()=>{
    Onyx.set(ONYXKEYS.NVP_TRY_FOCUS_MODE, false) // This will override `tryFocusMode: false` 
}, 5000)

2. Update this line to

const autoSwitchToFocusMode = debounce(tryFocusModeUpdate, 18000, {leading: true}); // we should set time to 18s because on Android, it's quite lag

Screen.Recording.2024-02-15.at.14.32.41.mp4

[jakub-trzebiatowski]

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

prevent-focus-mode-switch-android-compressed.mp4

Android: mWeb Chrome

prevent-focus-mode-switch-android-web-compressed.mp4

iOS: Native

prevent-focus-mode-switch-ios-compressed.mp4

iOS: mWeb Safari

prevent-focus-mode-switch-ios-web-compressed.mp4

MacOS: Chrome / Safari

prevent-focus-mode-switch-web-converted.mp4

MacOS: Desktop

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.43-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.43-20 🚀

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