17016 migrate switch #18512

robertKozik · 2023-05-05T23:01:38Z

Details

This PR changes the soon-to-be deprecated TouchableOpacity used in Switch component to PressableWithFeedback. In addition this PR fixes two warnings which come from OpacityView

Fixed Issues

$ #17016
PROPOSAL: #17016

Tests

You can find switch component on the RHN inside preferences tab and on the Timezone initial page

Navigate to the page which has switch component
Hover and press the switch
Verify that switch works fine and is dimming on press

Test changes in PressableWithFeedback:

Add disabled prop for PressableWithFeedback inside Switch
Switch should be disabled and no dimming can be encountered on hover and pressing
No errors on pressing should appear

Verify that no errors appear in the JS console

Offline tests

Same as Tests steps

QA Steps

Same as Tests steps

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

Screenshots/Videos

Web

Switch.Web.mov

Mobile Web - Chrome

Switch.-.Android.Web.mov

Mobile Web - Safari

RPReplay_Final1683281078.MP4

Desktop

Switch.-.Desktop.mov

iOS

Switch.iOS.mov

Android

Switch.Android.mov

melvin-bot · 2023-05-05T23:02:10Z

@sobitneupane @deetergp 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]

sobitneupane · 2023-05-08T03:20:39Z

src/components/Switch.js


 const propTypes = {
    /** Whether the switch is toggled to the on position */
    isOn: PropTypes.bool.isRequired,

    /** Callback to fire when the switch is toggled */
    onToggle: PropTypes.func.isRequired,
+
+    /** Accessibility label for the switch */
+    accessibilityLabel: PropTypes.string.isRequired,


accessibilityLabel is declared as Required but it's value is undefined as it not passed from components using Switch.

Filled, good catch
Thanks

@robertKozik accessibilityLabel should be added in TimezoneInitialPage as well.

App/src/pages/settings/Profile/TimezoneInitialPage.js

Lines 61 to 64 in e52c1e2

<Switch

isOn={timezone.automatic}

onToggle={updateAutomaticTimezone}

/>

sobitneupane

When hovered the Switch is dimmed which was not the case while using TochableOpacity. Is it expected behaviour? Was it discussed before? If we hover the switch when it is toggled off, it is too dark.

Screen.Recording.2023-05-08.at.09.13.52.mov

robertKozik · 2023-05-08T22:28:48Z

When hovered the Switch is dimmed which was not the case while using TochableOpacity. Is it expected behaviour? Was it discussed before? If we hover the switch when it is toggled off, it is too dark.

Screen.Recording.2023-05-08.at.09.13.52.mov

PressableWithFeedback has now implemented hover and press dimming out-of-the box as stated inside the design doc. As there was no dimming for hover before, I've removed it.

sobitneupane

Screenshots/Videos

Web

Screen.Recording.2023-05-11.at.13.26.07.mov

Mobile Web - Chrome

Screen.Recording.2023-05-11.at.13.45.54.mov

Mobile Web - Safari

Screen.Recording.2023-05-11.at.13.41.00.mov

Desktop

Screen.Recording.2023-05-09.at.18.24.59.mov

iOS

Screen.Recording.2023-05-11.at.13.38.33.mov

Android

Screen.Recording.2023-05-11.at.13.43.05.mov

robertKozik · 2023-05-09T12:56:32Z

Sorry for the problem, as I pushed additional fix for BaseGenericPressable component – it's not changing behaviour of the Switch, but removes the error when disabled state is passed to it (not used in the switch component), so it's worth to include it imo. Sorry for the inconvenience as you already reviewed the changes :/

sobitneupane

Differences with staging:

OnLongPress event toggles the switch on staging which is not the case in this PR.
On press or On long press, the switch dimmed too much which is not the case in staging. Can we decreasing the dimming for onpress and onlongpress event as well?

@robertKozik Can you please handle above issues as well?

Screen.Recording.2023-05-09.at.18.35.50.mov

sobitneupane · 2023-05-09T13:03:11Z

No worries @robertKozik. I will re-review it once you fixed these issues.

sobitneupane · 2023-05-09T13:06:33Z

Also, Please include the test steps for these changes as well.

deetergp · 2023-05-09T20:30:55Z

src/components/Pressable/PressableWithFeedback.js

@@ -29,7 +29,7 @@ const PressableWithFeedback = forwardRef((props, ref) => {
        <GenericPressable ref={ref} style={props.wrapperStyle} {...propsWithoutStyling}>
            {state => (
                <OpacityView
-                    shouldDim={state.pressed || state.hovered}
+                    shouldDim={state.pressed || state.hovered || false}


Won't the first two conditions return false if neither are true?

if both pressed and hovered is undefined it will return undefined and cause warning

Ugh. undefined Right.

robertKozik · 2023-05-10T21:10:14Z

Hello, I changed the dimming value to the one present before this PR – 0.8, hoisted the press callbeck wrapper in order to use it for press and long press, disabled dimming on pressing disabled component, updated the test steps and merged main to this PR

sobitneupane

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.

deetergp

Looks good, but you've got a merge conflict, unfortunately.

robertKozik · 2023-05-15T16:47:12Z

Conflicts has been resolved 👌🏼

deetergp

Code looks good and mostly works as advertised. Your testing steps mention that it should dim on over on web, but when I tested it, there was no dimming. I don't think it's a blocker though, since the switches don't currently dim on hover on production.

All yours, @sobitneupane!

robertKozik · 2023-05-15T20:21:06Z

Good catch, I forgot to change the test steps to not involve dimming on hover. I did this exactly to mimic the production environment (#18512 (comment))

sobitneupane

Changes look good and tests well.

cc: @deetergp

OSBotify · 2023-05-16T18:40:51Z

✋ 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-17T01:07:54Z

🚀 Deployed to staging by https://github.com/deetergp in version: 1.3.15-0 🚀

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

mvtglobally · 2023-05-17T19:41:42Z

@robertKozik @deetergp We are not seeing Dimming on the switches. Is this something that need to be enabled in the backend? Should it be internal QA?

Recording.602.mp4

robertKozik · 2023-05-17T19:47:47Z

@mvtglobally dimming was removed during the PR review process (comment).

OSBotify · 2023-05-18T06:51:05Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

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

robertKozik added 2 commits May 4, 2023 12:59

migrate switch to PressableWithFeedback, add accessibility props

fe4e915

fix warnings which come from OpacityView

a2f35e1

robertKozik requested a review from a team as a code owner May 5, 2023 23:01

melvin-bot bot requested review from deetergp and sobitneupane and removed request for a team May 5, 2023 23:02

sobitneupane reviewed May 8, 2023

View reviewed changes

robertKozik added 2 commits May 8, 2023 23:49

remove dimming from switch component

d5d38f5

add required accessibility labels for all switches

d6238f2

robertKozik added 2 commits May 9, 2023 13:08

Add remaining accessibilityLabel for switch in TimezoneInitialPage.js

fd4e931

fix error when GenericPressable tries to call onPress when disabled

5bf6f9a

sobitneupane reviewed May 9, 2023

View reviewed changes

deetergp requested changes May 9, 2023

View reviewed changes

robertKozik added 4 commits May 10, 2023 11:34

press dim value for switch is set to 0.8

cb7eef6

trigger the same callback on press and longPress for switch

611e44d

Merge remote-tracking branch 'upstream/main' into 17016_migrate_switch

8e18d04

Merge branch 'main' into 17016_migrate_switch

b3b53c7

robertKozik added 2 commits May 10, 2023 23:11

disable dimming of PressableWithFeedback when is disabled

ccbe9a9

run prettier on changed files

b2b4d0d

sobitneupane previously approved these changes May 11, 2023

View reviewed changes

roryabraham requested a review from deetergp May 11, 2023 20:54

robertKozik mentioned this pull request May 12, 2023

[$1000] [HOLD for payment 2023-05-25] [Group 2][Accessible Pressable] Migrate Switch #17016

Closed

deetergp previously approved these changes May 12, 2023

View reviewed changes

Merge branch 'main' into 17016_migrate_switch

273629a

robertKozik dismissed stale reviews from deetergp and sobitneupane via 273629a May 15, 2023 07:45

robertKozik requested review from deetergp and sobitneupane May 15, 2023 16:47

deetergp approved these changes May 15, 2023

View reviewed changes

sobitneupane approved these changes May 16, 2023

View reviewed changes

deetergp merged commit 865893c into Expensify:main May 16, 2023

OSBotify mentioned this pull request May 16, 2023

Deploy Checklist: New Expensify 2023-05-16 #19088

Closed

71 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

17016 migrate switch #18512

17016 migrate switch #18512

robertKozik commented May 5, 2023 •

edited

Loading

melvin-bot bot commented May 5, 2023

sobitneupane May 8, 2023

robertKozik May 8, 2023

sobitneupane May 9, 2023

sobitneupane left a comment •

edited

Loading

robertKozik commented May 8, 2023

sobitneupane left a comment •

edited

Loading

robertKozik commented May 9, 2023

sobitneupane left a comment

sobitneupane commented May 9, 2023

sobitneupane commented May 9, 2023

deetergp May 9, 2023

robertKozik May 9, 2023

deetergp May 9, 2023

robertKozik commented May 10, 2023

sobitneupane left a comment

deetergp left a comment

robertKozik commented May 15, 2023

deetergp left a comment

robertKozik commented May 15, 2023

sobitneupane left a comment •

edited

Loading

OSBotify commented May 16, 2023

OSBotify commented May 17, 2023

mvtglobally commented May 17, 2023

robertKozik commented May 17, 2023 •

edited

Loading

OSBotify commented May 18, 2023

	<Switch
	isOn={timezone.automatic}
	onToggle={updateAutomaticTimezone}
	/>

17016 migrate switch #18512

17016 migrate switch #18512

Conversation

robertKozik commented May 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 5, 2023

sobitneupane May 8, 2023

Choose a reason for hiding this comment

robertKozik May 8, 2023

Choose a reason for hiding this comment

sobitneupane May 9, 2023

Choose a reason for hiding this comment

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

robertKozik commented May 8, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

robertKozik commented May 9, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

sobitneupane commented May 9, 2023

sobitneupane commented May 9, 2023

deetergp May 9, 2023

Choose a reason for hiding this comment

robertKozik May 9, 2023

Choose a reason for hiding this comment

deetergp May 9, 2023

Choose a reason for hiding this comment

robertKozik commented May 10, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

deetergp left a comment

Choose a reason for hiding this comment

robertKozik commented May 15, 2023

deetergp left a comment

Choose a reason for hiding this comment

robertKozik commented May 15, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

OSBotify commented May 16, 2023

OSBotify commented May 17, 2023

mvtglobally commented May 17, 2023

robertKozik commented May 17, 2023 • edited Loading

OSBotify commented May 18, 2023

robertKozik commented May 5, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading

sobitneupane left a comment •

edited

Loading

sobitneupane left a comment •

edited

Loading

robertKozik commented May 17, 2023 •

edited

Loading