Update CONSTS to direct developers to use role instead of accessibilityRole #31590

trevor-coleman · 2023-11-20T22:18:05Z

Details

This fixes the issue with ROLE and ACCESSIBLITY_ROLE identified earlier and discussed on Slack.

It makes the following changes:

Changes to `CONST.ts`

Reverts CONST.ACCESSIBILITY_ROLE.TEXT to the value 'text'
Adds deprecation warnings on CONST.ACCESSIBLITY_ROLE and all properties
Creates the CONST.ROLE object with JSDoc comments

Fixes to Components

Simple find-replace

The majority of components were fixed using a simple find and replaced that made the following change

Replace: role={CONST.ACCESSIBILITY_ROLE with role={CONST.ROLE

For example:

role={CONST.ACCESSIBILITY_ROLE.BUTTON} would become role={CONST.ROLE.BUTTON}

Non-standard Cases

Description	Why Change Was Made	Before	After
Components using `TEXT` to mean `PRESENTATION`	Aligned with correct key in CONST.ROLE	`role={CONST.ACCESSIBILITY_ROLE.TEXT}`	`role={CONST.ROLE.PRESENTATION}`
Inappropriate use of `IMAGEBUTTON`	`IMAGEBUTTON` only available in `accessibilityRole`. Corrected property to `accessibilityRole` and pointed to the right const (see note below)	`role={CONST.ACCESSIBILITY_ROLE.IMAGEBUTTON}`	`accessibilityRole={CONST.ACCESSIBILITY_ROLE.IMAGEBUTTON}`
Inappropriate use of `ADJUSTABLE`	`adjustable` is not available in `role` but is in `accessibilityRole`. Reverted the value and updated prop to reflect correct usage	`role={CONST.ACCESSIBILITY_ROLE.ADJUSTABLE}`	`role={CONST.ROLE.SLIDER}`
Use of non-existent `ACCESSIBILITY_ROLE.IMAGE`	Replaced with valid `role` value	`role={CONST.ACCESSIBILITY_ROLE.IMAGE}`	`role={CONST.ROLE.IMG}`

Note: In the IMAGEBUTTON Case, I thought it was best to preserve the imagebutton role information even though it uses the deprecated ACCESSIBILITY_ROLE. This minimizes the number of changes, rather than try to decide on a case-by-case basis what an appropriate replacement would be. ACCESSIBILITY_ROLE.IMAGEBUTTON is marked as deprecated and so it will be flagged and can be cleaned up the next time someone touches that component. In the meantime, the accessibilityRole prop is still supported in react-native (and will be for a long time) so there shouldn't be any problems.

Fixed Issues

$ #31500

Tests

This was a find-replace operation that touched a lot of components, but should not cause any changes to the app's behaviour. I tried a number of ordinary operations and there was no discernable difference or error in the log.

Open app
Open existing chat
Send message(s) to the chat.
Return home
Send a new money request
Assign a task
Open and edit existing money requests.

Verify that no errors appear in the JS console

Offline tests

This change will have no effect in offline mode as it only concerns front-end behaviour.

QA Steps

This change should not cause any changes to the app's behaviour. To test, open the app and generally test it through ordinary operations. There should be no discernable difference in the app's behaviour. or error in the log.

Open app
Open existing chat
Send message(s) to the chat.
Return home
Send a new money request
Assign a task
Open and edit existing money requests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

There should be no changes to the app's appearance or behaviour as a result of this change.

…BLITY_ROLE.TEXT` to point to `ROLE.PRESENTATION`

…g button` value by reverting them to `accessibilityRole`

…eprecatd CONST.ACCESSIBLITY_ROLE

…deprecatd CONST.ACCESSIBLITY_ROLE

…BLITY_ROLE with CONST.ROLE

Signed-off-by: Trevor Coleman <trevor@trevorcoleman.design>

Update CONSTS to direct developers to use role instead of accessibilityRole (Expensify#31500)

melvin-bot · 2023-11-20T22:18:09Z

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

github-actions · 2023-11-20T22:18:21Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

# Conflicts: # src/components/AvatarWithImagePicker.js # src/components/Banner.tsx # src/components/Checkbox.js # src/components/ParentNavigationSubtitle.tsx # src/components/ReportHeaderSkeletonView.tsx # src/pages/ReimbursementAccount/BankAccountManualStep.js # src/pages/settings/Profile/PersonalDetails/AddressPage.js

melvin-bot · 2023-11-22T22:49:28Z

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

allroundexperts · 2023-11-26T14:13:10Z

Hi @trevor-coleman!

This has conflicts. Can you please fix?

src/pages/workspace/reimburse/WorkspaceRateAndUnitPage.js

src/pages/ReimbursementAccount/ValidationStep.js

trevor-coleman · 2023-11-28T22:52:26Z

Fixed conflicts.

dangrous · 2023-12-01T16:17:42Z

Hey @allroundexperts! Will you have time for a re-review today or sometime next week? Thank you!

# Conflicts: # src/components/DatePicker/index.android.js # src/components/DatePicker/index.ios.js # src/components/DatePicker/index.js # src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.js # src/components/RoomNameInput/index.native.js

# Conflicts: # src/components/ReportActionItem/ReportActionItemImage.js # src/pages/settings/Security/CloseAccountPage.js

trevor-coleman · 2023-12-04T20:16:20Z

Resolved merge conflicts. @allroundexperts -- because this touches so many files it may be good for us to coordinate our timing so we can get it merged before more conflicts arise.

allroundexperts · 2023-12-04T23:51:37Z

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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

allroundexperts · 2023-12-05T00:31:51Z

src/components/Attachments/AttachmentView/AttachmentViewImage/index.js

@@ -28,7 +28,7 @@ function AttachmentViewImage({source, file, isAuthTokenRequired, loadComplete, o
            onPress={onPress}
            disabled={loadComplete}
            style={[styles.flex1, styles.flexRow, styles.alignSelfStretch]}
-            role={CONST.ACCESSIBILITY_ROLE.IMAGEBUTTON}
+            accessibilityRole={CONST.ACCESSIBILITY_ROLE.IMAGEBUTTON}


Wouldn't this throw a deprecation warning? If so, we should either not use it or remove the @deprecated comment from the const file where this is defined.

I covered this in the description:

Note: In the IMAGEBUTTON Case, I thought it was best to preserve the imagebutton role information even though it uses the deprecated ACCESSIBILITY_ROLE. This minimizes the number of changes, rather than try to decide on a case-by-case basis what an appropriate replacement would be. ACCESSIBILITY_ROLE.IMAGEBUTTON is marked as deprecated and so it will be flagged and can be cleaned up the next time someone touches that component. In the meantime, the accessibilityRole prop is still supported in react-native (and will be for a long time) so there shouldn't be any problems.

But if you have enough context for this component to suggest what the correct value should be then I can make the change here.

Hm... I would rather clean it up quick then let it hang around. Would you be available for the cleanup as a follow up PR?

allroundexperts

@trevor-coleman Requested one more minor change. Also, can you please make sure to upload screen recordings / shots of all platforms regardless if your code is not modifying anything related to those? This requirement was added intentionally so that we can be super confident about the stability of our application!

trevor-coleman · 2023-12-05T20:30:46Z

@trevor-coleman Requested one more minor change. Also, can you please make sure to upload screen recordings / shots of all platforms regardless if your code is not modifying anything related to those? This requirement was added intentionally so that we can be super confident about the stability of our application!

So just a recording of me opening up the app and pressing random buttons and navigating around a bit?

allroundexperts · 2023-12-06T00:07:43Z

So just a recording of me opening up the app and pressing random buttons and navigating around a bit?

Correct!

trevor-coleman · 2023-12-06T16:10:19Z

Ok, I've got another PR open at the moment, so this will probably be a few days.

allroundexperts · 2023-12-10T23:20:15Z

Completed the checklist. Should be good to merge after conflicts are resolved!

allroundexperts

Looks good to me. I am approving it so that merging is not delayed after conflicts are fixed (This is catching conflicts real fast).

trevor-coleman · 2023-12-11T23:07:52Z

Merge conflicts resolved

dangrous

Looks good! Agreed that it would be ideal to fix that IMAGEBUTTON workaround in a follow up PR. Thanks!

dangrous · 2023-12-12T21:11:09Z

oh, and one more thing, I think we added a couple new consts to ACCESSIBILITY_ROLE (for example SWITCH). Do we need those? It didn't look like it was used anywhere, but figured it couldn't hurt. I know you put all the possibilities for ROLE in the consts which is great, so I think we either remove the ones no longer used in ACCESSIBILITY_ROLE or do the full list there too. What do you think?

OSBotify · 2023-12-12T21:13:09Z

✋ 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-12-13T11:28:58Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T11:49:41Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T12:17:15Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-14T15:23:58Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.12-2 🚀

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

trevor-coleman added 17 commits November 17, 2023 17:10

fix(ACCESSIBILITY_ROLE): Deprecate ACCESSIBLITY_ROLE

977257a

fix(ACCESSIBILITY_ROLE): Add CONST.ROLE

0b1c973

fix(ACCESSIBILITY_ROLE): fix formatting in JSDoc comment

9fbda55

fix(ACCESSIBILITY_ROLE): redirect role props that point to `ACCESSI…

7743c4c

…BLITY_ROLE.TEXT` to point to `ROLE.PRESENTATION`

fix(ACCESSIBILITY_ROLE): fix role attributes being passed invalid `im…

30335de

…g button` value by reverting them to `accessibilityRole`

fix(ACCESSIBILITY_ROLE): reset ADJUSTABLE TO 'adjustable'

ce403f1

fix(ACCESSIBILITY_ROLE): set role prop to use CONST.ROLE instead of d…

b72ac43

…eprecatd CONST.ACCESSIBLITY_ROLE

fix(ACCESSIBILITY_ROLE): set role prop to use CONST.ROLE instead of d…

5811816

…eprecatd CONST.ACCESSIBLITY_ROLE

fix(ACCESSIBILITY_ROLE): set role prop to use CONST.ROLE instead of d…

911c4b3

…eprecatd CONST.ACCESSIBLITY_ROLE

fix(ACCESSIBILITY_ROLE): set role props to use CONST.ROLE instead of …

f3a8a4e

…deprecatd CONST.ACCESSIBLITY_ROLE

fix(ACCESSIBILITY_ROLE): replace reference to deprecatd CONST.ACCESSI…

c2892ec

…BLITY_ROLE with CONST.ROLE

fix(ACCESSIBILITY_ROLE): replace accessibilityRole with role

6931552

fix(ACCESSIBILITY_ROLE): replace accessibilityRole with role

35eae47

fix(ACCESSIBILITY_ROLE): replace accessibilityRole with role

de4b4c0

prettier

b60079b

Merge branch 'main' into trevorcoleman/accessibility-role

0639e66

Signed-off-by: Trevor Coleman <trevor@trevorcoleman.design>

Merge pull request #74 from infinitered/trevorcoleman/accessibility-role

2336f3b

Update CONSTS to direct developers to use role instead of accessibilityRole (Expensify#31500)

trevor-coleman mentioned this pull request Nov 20, 2023

[HOLD for payment 2023-12-21][$500] Update CONSTS to direct developers to use role instead of accessibilityRole #31500

Closed

aimane-chnaif mentioned this pull request Nov 21, 2023

Fix wrong cursor style based on accessibility role #31605

Merged

50 tasks

trevor-coleman marked this pull request as ready for review November 22, 2023 22:49

trevor-coleman requested a review from a team as a code owner November 22, 2023 22:49

melvin-bot bot requested review from allroundexperts and removed request for a team November 22, 2023 22:49

allroundexperts reviewed Nov 26, 2023

View reviewed changes

src/pages/workspace/reimburse/WorkspaceRateAndUnitPage.js Outdated Show resolved Hide resolved

allroundexperts reviewed Nov 26, 2023

View reviewed changes

src/pages/ReimbursementAccount/ValidationStep.js Outdated Show resolved Hide resolved

trevor-coleman added 3 commits November 27, 2023 14:29

test commit

0c8e6b4

revert test commit

1214c03

Merge branch 'main' into accessibility-role

fe947d3

trevor-coleman added 2 commits December 4, 2023 15:12

Merge remote-tracking branch 'upstream/main' into accessibility-role

054eb86

# Conflicts: # src/components/ReportActionItem/ReportActionItemImage.js # src/pages/settings/Security/CloseAccountPage.js

allroundexperts reviewed Dec 5, 2023

View reviewed changes

allroundexperts suggested changes Dec 5, 2023

View reviewed changes

allroundexperts approved these changes Dec 10, 2023

View reviewed changes

melvin-bot bot requested a review from dangrous December 10, 2023 23:36

Merge branch 'main' of github.com:Expensify/App into accessibility-role

4ad45b3

trevor-coleman force-pushed the accessibility-role branch from ef072ce to 4ad45b3 Compare December 11, 2023 23:03

dangrous approved these changes Dec 12, 2023

View reviewed changes

dangrous merged commit ae25d9a into Expensify:main Dec 12, 2023
15 checks passed

github-actions bot mentioned this pull request Dec 13, 2023

[$500] Deploy Checklist: New Expensify 2023-12-13 #32963

Closed

64 tasks

dangrous mentioned this pull request Aug 22, 2024

fix: Chat - Unable to deselect user using The Tab key. #47705

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update CONSTS to direct developers to use role instead of accessibilityRole #31590

Update CONSTS to direct developers to use role instead of accessibilityRole #31590

trevor-coleman commented Nov 20, 2023 •

edited

Loading

melvin-bot bot commented Nov 20, 2023

github-actions bot commented Nov 20, 2023 •

edited

Loading

melvin-bot bot commented Nov 22, 2023

allroundexperts commented Nov 26, 2023

trevor-coleman commented Nov 28, 2023

dangrous commented Dec 1, 2023

trevor-coleman commented Dec 4, 2023 •

edited

Loading

allroundexperts commented Dec 4, 2023 •

edited

Loading

allroundexperts Dec 5, 2023

trevor-coleman Dec 5, 2023

allroundexperts Dec 6, 2023

allroundexperts left a comment

trevor-coleman commented Dec 5, 2023

allroundexperts commented Dec 6, 2023 •

edited

Loading

trevor-coleman commented Dec 6, 2023

allroundexperts commented Dec 10, 2023

allroundexperts left a comment

trevor-coleman commented Dec 11, 2023

dangrous left a comment

dangrous commented Dec 12, 2023

OSBotify commented Dec 12, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

Update CONSTS to direct developers to use role instead of accessibilityRole #31590

Update CONSTS to direct developers to use role instead of accessibilityRole #31590

Conversation

trevor-coleman commented Nov 20, 2023 • edited Loading

Details

Changes to CONST.ts

Fixes to Components

Simple find-replace

Non-standard Cases

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 20, 2023

github-actions bot commented Nov 20, 2023 • edited Loading

melvin-bot bot commented Nov 22, 2023

allroundexperts commented Nov 26, 2023

trevor-coleman commented Nov 28, 2023

dangrous commented Dec 1, 2023

trevor-coleman commented Dec 4, 2023 • edited Loading

allroundexperts commented Dec 4, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts Dec 5, 2023

Choose a reason for hiding this comment

trevor-coleman Dec 5, 2023

Choose a reason for hiding this comment

allroundexperts Dec 6, 2023

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

trevor-coleman commented Dec 5, 2023

allroundexperts commented Dec 6, 2023 • edited Loading

trevor-coleman commented Dec 6, 2023

allroundexperts commented Dec 10, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

trevor-coleman commented Dec 11, 2023

dangrous left a comment

Choose a reason for hiding this comment

dangrous commented Dec 12, 2023

OSBotify commented Dec 12, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

trevor-coleman commented Nov 20, 2023 •

edited

Loading

Changes to `CONST.ts`

github-actions bot commented Nov 20, 2023 •

edited

Loading

trevor-coleman commented Dec 4, 2023 •

edited

Loading

allroundexperts commented Dec 4, 2023 •

edited

Loading

allroundexperts commented Dec 6, 2023 •

edited

Loading