Rename shouldDisableWriteActions to canUserPerformWriteAction #29887

tgolen · 2023-10-18T17:25:46Z

Details

It ensures that our code consistently follows our style guide. The positive naming of this method will make it more clear what the intention is for referencing it.

Fixed Issues

$ #29882

Tests

Sing into NewDot
Create a workspace
Sign into staging.expensify.com (or www.expensify.com.dev for internal engineers)
Go to Settings > Workspaces and delete the workspace
Go back to NewDot
Access one of the now-archived chats from that workspace
Verify that the composer is no longer shown

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-18T17:25:51Z

@Santhosh-Sellavel 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]

cloudflare-workers-and-pages · 2023-10-19T14:11:12Z

Deploying with Cloudflare Pages

Latest commit:	`cf90f7b`
Status:	✅ Deploy successful!
Preview URL:	https://21e44a0a.helpdot.pages.dev
Branch Preview URL:	https://tgolen-rename-shoulddisablew.helpdot.pages.dev

View logs

tgolen · 2023-10-19T14:23:17Z

I am not sure why Jest is complaining about a pencil icon...

expect(screen.queryAllByTestId('Pencil Icon')).toHaveLength(1);

tgolen · 2023-10-19T14:23:56Z

Oh, actually... I could see how that might be related to these changes, if it's an edit icon associated with this permission check. I will give it a look

tgolen · 2023-10-19T15:48:17Z

src/libs/ReportUtils.js

@@ -3386,7 +3386,7 @@ function parseReportRouteParams(route) {
        parsingRoute = parsingRoute.slice(1);
    }

-    if (!parsingRoute.startsWith(Url.addTrailingForwardSlash('r'))) {
+    if (!parsingRoute.startsWith(Url.addTrailingForwardSlash(ROUTES.REPORT))) {


I've been wanting to fix this for a while, so I'm sneaking it into this PR.

tgolen · 2023-10-19T15:51:10Z

OK, I got that sorted. Thanks Jest!

Santhosh-Sellavel · 2023-10-20T17:26:30Z

@tgolen Please resolve conflicts here!

tgolen · 2023-10-20T18:28:06Z

All sorted, thanks.

Santhosh-Sellavel · 2023-10-20T21:48:28Z

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

Web & Desktop

Screen.Recording.2023-10-21.at.3.07.58.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-10-21.at.3.11.31.AM.mov

iOS & Android

Screen.Recording.2023-10-21.at.3.13.06.AM.mov

Santhosh-Sellavel · 2023-10-20T21:50:27Z

@tgolen You missed renaming here

App/src/libs/ReportUtils.js

Lines 3732 to 3733 in 15aee9d

    
           const participantAccountIDs = lodashGet(report, 'participantAccountIDs', []); 
        
           if (shouldDisableWriteActions(report)) {

Santhosh-Sellavel · 2023-10-23T18:57:50Z

bump @tgolen

tgolen · 2023-10-24T14:34:55Z

Oh, great catch. I must have missed that when I merged main into the branch. All updated!

Santhosh-Sellavel · 2023-10-24T19:10:06Z

Ah conflicts again @tgolen!

tgolen · 2023-10-26T13:49:40Z

Updated

tgolen · 2023-10-27T14:39:30Z

I have updated this again to solve more conflicts. Would it be possible to merge this soon, please @Santhosh-Sellavel?

situchan · 2023-10-27T14:46:51Z

@Santhosh-Sellavel is OOO for a few days

Santhosh-Sellavel · 2023-10-29T12:50:20Z

@tgolen There is a lint error otherwise looks good to me!

tgolen · 2023-10-30T14:51:47Z

Ugh, this is like the PR that refuses to be merged. I've merged main into the branch and ran npm run prettier, so hopefully that should fix the error.

Santhosh-Sellavel

LGTM!

melvin-bot · 2023-10-30T17:49:06Z

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

chiragsalian

LGTM

OSBotify · 2023-10-30T23:15:25Z

✋ 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-10-31T21:59:52Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-01T08:51:51Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-02T10:15:12Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

OSBotify · 2023-11-02T10:39:59Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.95-0 🚀

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

OSBotify · 2023-11-06T22:10:02Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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

Rename shouldDisableWriteActions to canUserPerformWriteAction

3d0b045

tgolen self-assigned this Oct 18, 2023

tgolen requested a review from a team as a code owner October 18, 2023 17:25

melvin-bot bot removed the request for review from a team October 18, 2023 17:25

melvin-bot bot requested a review from Santhosh-Sellavel October 18, 2023 17:25

tgolen mentioned this pull request Oct 18, 2023

[HOLD for payment 2023-12-20] [DISTANCE] LOW: PHASE 1: Wave 5 CLEANUP Refactor navigation among screens related to money request features #26538

Closed

Fix lint

6b401e0

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

bb1ab4b

tgolen marked this pull request as draft October 19, 2023 14:24

Negate logic for the referenced variable

cf90f7b

tgolen commented Oct 19, 2023

View reviewed changes

tgolen marked this pull request as ready for review October 19, 2023 15:50

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

1376be8

tgolen added 2 commits October 24, 2023 08:33

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

272b0dd

Rename a missed spot

51fa6ed

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

86086d6

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

f974fa1

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

37dd0d6

Merge branch 'main' into tgolen-rename-shouldDisableWriteActions

08be55a

Santhosh-Sellavel approved these changes Oct 30, 2023

View reviewed changes

melvin-bot bot requested a review from chiragsalian October 30, 2023 17:49

chiragsalian approved these changes Oct 30, 2023

View reviewed changes

chiragsalian merged commit ec7fb3c into main Oct 30, 2023
13 checks passed

chiragsalian deleted the tgolen-rename-shouldDisableWriteActions branch October 30, 2023 23:10

OSBotify mentioned this pull request Oct 31, 2023

Deploy Checklist: New Expensify 2023-10-31 #30662

Closed

97 tasks

OSBotify mentioned this pull request Nov 2, 2023

Deploy Checklist: New Expensify 2023-11-02 #30752

Closed

melvin-bot bot mentioned this pull request Nov 2, 2023

[HOLD for payment 2023-11-09] Rename shouldDisableWriteActions to canUserPerformWriteAction #29882

Closed

hungvu193 mentioned this pull request Nov 7, 2023

Fix: Add not allowed sign for archived workspace. #30229

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename shouldDisableWriteActions to canUserPerformWriteAction #29887

Rename shouldDisableWriteActions to canUserPerformWriteAction #29887

tgolen commented Oct 18, 2023 •

edited

Loading

melvin-bot bot commented Oct 18, 2023

cloudflare-workers-and-pages bot commented Oct 19, 2023 •

edited

Loading

tgolen commented Oct 19, 2023

tgolen commented Oct 19, 2023

tgolen Oct 19, 2023

tgolen commented Oct 19, 2023

Santhosh-Sellavel commented Oct 20, 2023

tgolen commented Oct 20, 2023

Santhosh-Sellavel commented Oct 20, 2023 •

edited

Loading

Santhosh-Sellavel commented Oct 20, 2023 •

edited

Loading

Santhosh-Sellavel commented Oct 23, 2023

tgolen commented Oct 24, 2023

Santhosh-Sellavel commented Oct 24, 2023

tgolen commented Oct 26, 2023

tgolen commented Oct 27, 2023

situchan commented Oct 27, 2023

Santhosh-Sellavel commented Oct 29, 2023

tgolen commented Oct 30, 2023

Santhosh-Sellavel left a comment

melvin-bot bot commented Oct 30, 2023

chiragsalian left a comment

OSBotify commented Oct 30, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

OSBotify commented Nov 2, 2023

OSBotify commented Nov 6, 2023

Rename shouldDisableWriteActions to canUserPerformWriteAction #29887

Rename shouldDisableWriteActions to canUserPerformWriteAction #29887

Conversation

tgolen commented Oct 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 18, 2023

cloudflare-workers-and-pages bot commented Oct 19, 2023 • edited Loading

Deploying with Cloudflare Pages

tgolen commented Oct 19, 2023

tgolen commented Oct 19, 2023

tgolen Oct 19, 2023

Choose a reason for hiding this comment

tgolen commented Oct 19, 2023

Santhosh-Sellavel commented Oct 20, 2023

tgolen commented Oct 20, 2023

Santhosh-Sellavel commented Oct 20, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel commented Oct 20, 2023 • edited Loading

Santhosh-Sellavel commented Oct 23, 2023

tgolen commented Oct 24, 2023

Santhosh-Sellavel commented Oct 24, 2023

tgolen commented Oct 26, 2023

tgolen commented Oct 27, 2023

situchan commented Oct 27, 2023

Santhosh-Sellavel commented Oct 29, 2023

tgolen commented Oct 30, 2023

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 30, 2023

chiragsalian left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 30, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

OSBotify commented Nov 2, 2023

OSBotify commented Nov 6, 2023

tgolen commented Oct 18, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 19, 2023 •

edited

Loading

Santhosh-Sellavel commented Oct 20, 2023 •

edited

Loading

Santhosh-Sellavel commented Oct 20, 2023 •

edited

Loading