fix: check canUseTouchScreen on each render #24356

hannojg · 2023-08-10T08:06:27Z

Details

When implementing:

Fix: Find solution to low resolution large images on Android, and the Canvas crash #20798

a change in behaviour got introduced where in the AttachmentCarousel before the DeviceCapabilities.canUseTouchScreen was checked every render, but after the PR it was only checked once on app start.
This reverts back to the old behaviour where its checked every render.

Fixed Issues

$ https://expensify.slack.com/archives/C049HHMV9SM/p1691474174723719
PROPOSAL:

Tests

Send attachment to a chat, open the attachment. Verify that no errors appear in the JS console

Offline tests

QA Steps

Send attachment to a chat, open the attachment. 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

hannojg · 2023-08-10T08:06:41Z

@chrispader

melvin-bot · 2023-08-10T08:07:06Z

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

MariaHCD

This change makes sense to me. cc: @bernhardoj @kidroca since you both were discussing this in Slack here

MariaHCD · 2023-08-10T09:03:56Z

@hannojg is testing only on web enough for this PR?

MariaHCD · 2023-08-10T09:32:54Z

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

Screen.Recording.2023-08-10.at.1.31.55.PM.mov

Screen.Recording.2023-08-10.at.1.28.24.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-08-10.at.4.55.47.PM.mov

Mobile Web - Safari

Desktop

Screen.Recording.2023-08-10.at.5.00.00.PM.mov

iOS

Android

Screen.Recording.2023-08-10.at.4.53.52.PM.mov

hannojg · 2023-08-10T09:33:41Z

@MariaHCD testing on at least one touch screen based device as well would be good(android or iOS)

kidroca

@MariaHCD

This change makes sense to me. cc: @bernhardoj @kidroca since you both were discussing this in Slack here

LGTM!

kidroca · 2023-08-10T10:19:14Z

src/components/Attachments/AttachmentCarousel/index.js

    const scrollRef = useRef(null);

    const {windowWidth, isSmallScreenWidth} = useWindowDimensions();
+    const canUseTouchScreen = DeviceCapabilities.canUseTouchScreen();


One minor concern is that we currently can't trigger a re-render when the value from DeviceCapabilities.canUseTouchScreen() changes. This means we're dependent on external factors to trigger a re-render of AttachmentCarousel before it acknowledges any change in the canUseTouchScreen() value.

However, given the context of this specific use-case, this behavior seems acceptable.

MariaHCD · 2023-08-10T12:53:40Z

@hannojg Okay, I'll test on native Android and mWeb Android. Could you test on iOS and add to your checklist?

bernhardoj · 2023-08-10T14:15:54Z

Actually, we still have one case where the canUseTouchScreen is only assigned once in useCarouselArrows

App/src/components/Attachments/AttachmentCarousel/useCarouselArrows.js

Lines 5 to 7 in 774b78c

    
           const canUseTouchScreen = DeviceCapabilities.canUseTouchScreen(); 
        
           function useCarouselArrows() {

However, looking at the commit message, this is done to fix arrows not showing on the web 🤔, but from my testing the arrow is showing fine on the web/mWeb.

hannojg · 2023-08-11T15:31:56Z

@MariaHCD tested on iOS and added iOS screenshot to the checklist 👍

hannojg · 2023-08-11T15:32:53Z

@bernhardoj You mean when you revert the changes from the commit (so that canUseTouchScreen is inside the FC) you can still see the arrows?

bernhardoj · 2023-08-11T15:57:04Z

@hannojg yep.

I found that the one that makes the arrow doesn't show is this specific change

Julesssss

Thanks for fixing!

mountiny · 2023-08-15T13:58:12Z

~~There is no QA steps listed, should this be noQA or are they missing?~~

I see them its just oddly formatted.

mountiny · 2023-08-15T14:01:33Z

Triggered a build so we can test on the device more easily

MariaHCD

This looks good to me and tests well!

@hannojg, is there any follow up regarding the arrow keys that @bernhardoj brought up here?

hannojg · 2023-08-21T07:24:17Z

Not sure, I want @chrispader to double check since its his original PR!

chrispader · 2023-08-28T07:54:44Z

I added a useCanUseTouchScreen hook, which will check for updates of the canUseTouchScreen value on every render and update the boolean accordingly. This way, we're not dependent on external factors to trigger the update.

MariaHCD

That makes sense to me! We've just got some lint errors now.

chrispader · 2023-08-28T12:13:06Z

That makes sense to me! We've just got some lint errors now.

Sorry, done 👍

src/hooks/useCanUseTouchScreen.js

bernhardoj · 2023-08-28T12:18:19Z

I have a question. If we are updating canUseTouchScreen inside useEffect, won't that mean we still depend on external factors to trigger the useEffect?

kidroca · 2023-08-28T15:25:09Z

@bernhardoj

I have a question. If we are updating canUseTouchScreen inside useEffect, won't that mean we still depend on external factors to trigger the useEffect?

Yes, as it currently stands, it seems we've opted for a polling approach. We're checking DeviceCapabilities.canUseTouchScreen during each render of the component that utilizes this hook, as explained by @chrispader.

I added a useCanUseTouchScreen hook, which will check for updates of the canUseTouchScreen value on every render and update the boolean accordingly. This way, we're not dependent on external factors to trigger the update.

No offense, but I'm curious about why we chose to create a useCanUseTouchScreen hook for several reasons:

It needs to poll, running an effect on each render to function correctly.
The likelihood of this device capability changing dynamically seems low, so is there a need for constant monitoring? In my opinion, fetching the current value directly from DeviceCapabilities.canUseTouchScreen at the time of component render should suffice.
The name useCanUse... feels a bit awkward to me. :)

kidroca · 2023-08-28T15:32:55Z

src/hooks/useCanUseTouchScreen.js

+    const [canUseTouchScreen, setCanUseTouchScreen] = useState(DeviceCapabilities.canUseTouchScreen());
+
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    useEffect(() => {
+        const newCanUseTouchScreen = DeviceCapabilities.canUseTouchScreen();
+        if (canUseTouchScreen === newCanUseTouchScreen) return;
+        setCanUseTouchScreen();
+    });
+
+    return canUseTouchScreen;


You can achieve the same outcome with a more straightforward approach:

Suggested change

const [canUseTouchScreen, setCanUseTouchScreen] = useState(DeviceCapabilities.canUseTouchScreen());

// eslint-disable-next-line react-hooks/exhaustive-deps

useEffect(() => {

const newCanUseTouchScreen = DeviceCapabilities.canUseTouchScreen();

if (canUseTouchScreen === newCanUseTouchScreen) return;

setCanUseTouchScreen();

});

return canUseTouchScreen;

return DeviceCapabilities.canUseTouchScreen();

Here's why this alternative is equivalent:

The current implementation uses a useEffect that runs logic on each render (since there's no dependencies array).

In such a scenario, you could simply execute the logic in the hook body, eliminating the need for a useEffect and state

Co-authored-by: Bernhard Owen Josephus <50919443+bernhardoj@users.noreply.github.com>

Co-authored-by: Maria D'Costa <mariahcdcosta@gmail.com>

chrispader · 2023-08-28T18:13:06Z

@bernhardoj

I have a question. If we are updating canUseTouchScreen inside useEffect, won't that mean we still depend on external factors to trigger the useEffect?

Yes, as it currently stands, it seems we've opted for a polling approach. We're checking DeviceCapabilities.canUseTouchScreen during each render of the component that utilizes this hook, as explained by @chrispader.

I added a useCanUseTouchScreen hook, which will check for updates of the canUseTouchScreen value on every render and update the boolean accordingly. This way, we're not dependent on external factors to trigger the update.

No offense, but I'm curious about why we chose to create a useCanUseTouchScreen hook for several reasons:

It needs to poll, running an effect on each render to function correctly.

The likelihood of this device capability changing dynamically seems low, so is there a need for constant monitoring? In my opinion, fetching the current value directly from DeviceCapabilities.canUseTouchScreen at the time of component render should suffice.

The name useCanUse... feels a bit awkward to me. :)

Yes, you're right. This was a silly mistake on my side...

chrispader · 2023-09-12T12:34:53Z

@kidroca @MariaHCD could we get another review on this so we can merge it. @hannojg is on holiday right now, so he cannot trigger it right now 😄

Julesssss · 2023-09-13T02:24:11Z

Just holding on a final @kidroca approval

kidroca

LGTM!

OSBotify · 2023-09-14T01:24:49Z

✋ 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-09-14T10:52:13Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:10:12Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

check canUseTouchScreen on each render

2a7eb7d

hannojg requested a review from a team as a code owner August 10, 2023 08:06

melvin-bot bot removed the request for review from a team August 10, 2023 08:07

melvin-bot bot requested a review from MariaHCD August 10, 2023 08:07

MariaHCD reviewed Aug 10, 2023

View reviewed changes

kidroca approved these changes Aug 10, 2023

View reviewed changes

Julesssss assigned hannojg Aug 15, 2023

Julesssss previously approved these changes Aug 15, 2023

View reviewed changes

MariaHCD previously approved these changes Aug 16, 2023

View reviewed changes

Christoph Pader added 2 commits August 28, 2023 09:44

Merge branch 'main' into fix/attachment-caruousel-canusetouchscreen

50c516e

add "useCanUseTouchScreen" hook

15c8704

chrispader dismissed stale reviews from MariaHCD and Julesssss via 15c8704 August 28, 2023 07:53

MariaHCD reviewed Aug 28, 2023

View reviewed changes

remove unused import

fb4b3e1

bernhardoj reviewed Aug 28, 2023

View reviewed changes

src/hooks/useCanUseTouchScreen.js Outdated Show resolved Hide resolved

MariaHCD reviewed Aug 28, 2023

View reviewed changes

src/hooks/useCanUseTouchScreen.js Outdated Show resolved Hide resolved

kidroca reviewed Aug 28, 2023

View reviewed changes

chrispader and others added 2 commits August 28, 2023 20:08

Update src/hooks/useCanUseTouchScreen.js

2b9cb82

Co-authored-by: Bernhard Owen Josephus <50919443+bernhardoj@users.noreply.github.com>

Update src/hooks/useCanUseTouchScreen.js

05f22e5

Co-authored-by: Maria D'Costa <mariahcdcosta@gmail.com>

revert "useCanUseTouchScreen" changes

15fc3a7

MariaHCD approved these changes Sep 13, 2023

View reviewed changes

MariaHCD requested review from bernhardoj and kidroca September 13, 2023 01:34

Julesssss approved these changes Sep 13, 2023

View reviewed changes

kidroca approved these changes Sep 13, 2023

View reviewed changes

MariaHCD merged commit 3e2723c into Expensify:main Sep 14, 2023

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

fix: check canUseTouchScreen on each render #24356

fix: check canUseTouchScreen on each render #24356

Uh oh!

Conversation

hannojg commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

hannojg commented Aug 10, 2023

Uh oh!

melvin-bot bot commented Aug 10, 2023

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

MariaHCD commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MariaHCD commented Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hannojg commented Aug 10, 2023

Uh oh!

kidroca left a comment

Choose a reason for hiding this comment

Uh oh!

kidroca Aug 10, 2023

Choose a reason for hiding this comment

Uh oh!

MariaHCD commented Aug 10, 2023

Uh oh!

bernhardoj commented Aug 10, 2023

Uh oh!

hannojg commented Aug 11, 2023

Uh oh!

hannojg commented Aug 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bernhardoj commented Aug 11, 2023

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Aug 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Aug 15, 2023

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

hannojg commented Aug 21, 2023

Uh oh!

chrispader commented Aug 28, 2023

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

chrispader commented Aug 28, 2023

Uh oh!

Uh oh!

Uh oh!

bernhardoj commented Aug 28, 2023

Uh oh!

kidroca commented Aug 28, 2023

Uh oh!

kidroca Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrispader commented Aug 28, 2023

Uh oh!

hannojg commented Aug 10, 2023 •

edited

Loading

MariaHCD commented Aug 10, 2023 •

edited

Loading

MariaHCD commented Aug 10, 2023 •

edited

Loading

hannojg commented Aug 11, 2023 •

edited

Loading

mountiny commented Aug 15, 2023 •

edited

Loading

kidroca Aug 28, 2023 •

edited

Loading