[TS migration] Migrate 'SidebarUtils.js' lib to TypeScript by blazejkustra · Pull Request #28596 · Expensify/App

blazejkustra · 2023-10-02T11:01:16Z

Details

Migration of 'SidebarUtils.js' to Typescript.

Fixed Issues

$ #24915
PROPOSAL: N/A

Tests

Verify that sidebar works as before, all chats are displayed correctly and clicking on chats opens them as before.
Click and interact with the app main flows (sending messages, login, request money) - this lib is used across the app so any regression should be visible immediately

Offline tests

N/A

QA Steps

Same as tests

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

web.mov

Mobile Web - Chrome

a-web.mov

Mobile Web - Safari

i-web.mov

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

src/libs/SidebarUtils.ts

kubabutkiewicz

LGTM

melvin-bot · 2023-10-13T15:30:45Z

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

Santhosh-Sellavel

I didn't review this if C+ review required reassign thanks

melvin-bot · 2023-10-16T19:38:59Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #24915 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

blazejkustra · 2023-10-17T10:05:46Z

@Santhosh-Sellavel TS process was changed recently and now C+ are responsible for the reviewer checklist:

Santhosh-Sellavel · 2023-10-19T17:23:44Z

Will review this by today/tomorrow. Sorry for the delay.

Santhosh-Sellavel · 2023-10-20T17:18:59Z

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

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

Mobile Web - Chrome & Mobile Web - Safari

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

Desktop

Desktop.mov

iOS & Android

Android.IOS.mov

Santhosh-Sellavel

LGTM

bondydaa · 2023-10-20T20:50:22Z

src/libs/ReportActionsUtils.ts

+import _ from 'lodash';
+import lodashFindLast from 'lodash/findLast';
+import Onyx, {OnyxCollection, OnyxEntry, OnyxUpdate} from 'react-native-onyx';
+import {ValueOf} from 'type-fest';


why are these string or number now? I'd thought the API should be returning reportActionIDs as strings all the time so if they aren't we need to fix that in the API.

Here actionKey is number that's why. Which is passed to shouldReportActionBeVisible which invoked isReportActionDeprecated with the same type.

App/src/libs/SidebarUtils.js

Lines 32 to 36 in 1c31bf7

const reportActionsForDisplay = _.filter(

actionsArray,

(reportAction, actionKey) =>

ReportActionsUtils.shouldReportActionBeVisible(reportAction, actionKey) &&

reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED &&

Hmm think I understand.

so actionKey is an int because in that code for _.filter we're looping over an array which is going to be keyed by an integer?

Yes index is number!

hm okay.

It looks like this is mostly there just for checking if the deprecated sequenceNumbers exist which I think should be fully killed by now but I don't think we should do too much in this refactor so I think it's probably fine to leave as is for now.

but after we merge this we should probably clean up that code, i don't think we need to pass key ever and should be able to only pass reportAction but I'm no the most involved on this side of things either.

bondydaa · 2023-10-20T23:35:45Z

I'm approving this but going to hold on merging until after Money2020 is over

OSBotify · 2023-10-26T18:21:48Z

✋ 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-26T22:59:14Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.92-0 🚀

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

OSBotify · 2023-10-30T07:42:32Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.92-4 🚀

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

OSBotify · 2023-10-30T08:03:29Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.93-0 🚀

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

OSBotify · 2023-10-31T21:36:39Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

blazejkustra added 2 commits September 27, 2023 11:09

Initial work

f38e0e5

[TS migration] Migrate 'SidebarUtils.js' lib to TypeScript

f42364d

blazejkustra commented Oct 3, 2023

View reviewed changes

src/libs/SidebarUtils.ts Show resolved Hide resolved

blazejkustra added 2 commits October 3, 2023 10:01

Self review the code

08da8c0

Merge branch 'main' into ts-migration/SidebarUtils

bf4c2f1

BartoszGrajdek reviewed Oct 3, 2023

View reviewed changes

src/libs/SidebarUtils.ts Show resolved Hide resolved

src/libs/SidebarUtils.ts Outdated Show resolved Hide resolved

src/libs/SidebarUtils.ts Outdated Show resolved Hide resolved

blazejkustra added 5 commits October 12, 2023 16:12

Merge branch 'main' into ts-migration/SidebarUtils

56abdce

Address code review

1715578

Add errors to ReportActionBase

2a25290

Add optional chaining to fix tests

0e7d40d

Fix remaining tests

ccd959e

kubabutkiewicz approved these changes Oct 13, 2023

View reviewed changes

blazejkustra marked this pull request as ready for review October 13, 2023 15:30

blazejkustra requested a review from a team as a code owner October 13, 2023 15:30

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team October 13, 2023 15:30

Merge branch 'main' into ts-migration/SidebarUtils

24f858d

Santhosh-Sellavel approved these changes Oct 16, 2023

View reviewed changes

melvin-bot bot requested a review from bondydaa October 16, 2023 19:39

Merge branch 'main' into ts-migration/SidebarUtils

c22c8c9

bondydaa previously approved these changes Oct 17, 2023

View reviewed changes

Merge branch 'main' into ts-migration/SidebarUtils

bbb35e8

blazejkustra dismissed bondydaa’s stale review via bbb35e8 October 19, 2023 15:24

blazejkustra added 2 commits October 20, 2023 08:09

Bring back test

233d703

Add comments to onyx types

f137763

Santhosh-Sellavel approved these changes Oct 20, 2023

View reviewed changes

melvin-bot bot requested a review from bondydaa October 20, 2023 20:45

bondydaa reviewed Oct 20, 2023

View reviewed changes

bondydaa previously approved these changes Oct 20, 2023

View reviewed changes

bondydaa changed the title ~~[TS migration] Migrate 'SidebarUtils.js' lib to TypeScript~~ [Hold m2020][TS migration] Migrate 'SidebarUtils.js' lib to TypeScript Oct 20, 2023

Merge branch 'main' into ts-migration/SidebarUtils

47647d5

blazejkustra dismissed bondydaa’s stale review via 47647d5 October 24, 2023 13:39

blazejkustra added 3 commits October 24, 2023 15:40

Remove isLastMessageDeletedParentAction from getOptionData

a224678

Merge branch 'main' into ts-migration/SidebarUtils

b7c5aec

Resolve conflicts

8d42d7f

bondydaa changed the title ~~[Hold m2020][TS migration] Migrate 'SidebarUtils.js' lib to TypeScript~~ [TS migration] Migrate 'SidebarUtils.js' lib to TypeScript Oct 26, 2023

bondydaa approved these changes Oct 26, 2023

View reviewed changes

bondydaa merged commit 9802795 into Expensify:main Oct 26, 2023

OSBotify mentioned this pull request Oct 26, 2023

Deploy Checklist: New Expensify 2023-10-26 #30469

Closed

64 tasks

izarutskaya mentioned this pull request Oct 27, 2023

[$500] Android-App crashes while viewing applause.expensifail.com chat #30494

Closed

6 tasks

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

melvin-bot bot mentioned this pull request Oct 30, 2023

[HOLD for payment 2023-11-06] [TS migration] Migrate 'SidebarUtils.js' lib to TypeScript #24915

Closed

	const reportActionsForDisplay = _.filter(
	actionsArray,
	(reportAction, actionKey) =>
	ReportActionsUtils.shouldReportActionBeVisible(reportAction, actionKey) &&
	reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED &&

Conversation

blazejkustra commented Oct 2, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kubabutkiewicz left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Oct 13, 2023

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Oct 16, 2023

Uh oh!

blazejkustra commented Oct 17, 2023

Uh oh!

Santhosh-Sellavel commented Oct 19, 2023

Uh oh!

Santhosh-Sellavel commented Oct 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

bondydaa Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

Santhosh-Sellavel Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

bondydaa Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

Santhosh-Sellavel Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

bondydaa Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

bondydaa commented Oct 20, 2023

Uh oh!

OSBotify commented Oct 26, 2023

Uh oh!

OSBotify commented Oct 26, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 31, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

blazejkustra commented Oct 2, 2023 •

edited

Loading

Santhosh-Sellavel commented Oct 20, 2023 •

edited

Loading