[TS migration] Migrate 'OptionsListUtils.js' lib to TypeScript #32470

kubabutkiewicz · 2023-12-05T09:32:03Z

Details

Fixed Issues

$ #24921

Tests

Click on Search icon
Check if you are able to search for users and select
Make a Money Request
Check if you are able to search for users
Go to Workspace Settings
Go to Members
Invite users to Workspace
Create a Room
Invite users to Room

Verify that no errors appear in the JS console

Offline tests

QA 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: 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 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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

mchrome.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

msafari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…s-migration/OptionsListUtils-lib

src/libs/ReportUtils.ts

src/types/onyx/Report.ts

src/libs/OptionsListUtils.ts

src/types/onyx/IOU.ts

fabioh8010

forgot these ones

src/libs/OptionsListUtils.ts

…s-migration/OptionsListUtils-lib

src/libs/OptionsListUtils.ts

kubabutkiewicz · 2024-01-25T09:17:46Z

@getusha Done!

melvin-bot · 2024-01-25T13:04:44Z

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

deetergp

Looks good and tests well. Thanks!

situchan

TS check failing on latest main. Seems like came from this PR

ntdiary · 2024-01-26T06:46:48Z

src/libs/OptionsListUtils.ts

-    const personalDetailList = _.values(personalDetailMap);
-    const personalDetail = personalDetailList[0] || {};
+    const personalDetailList = Object.values(personalDetailMap).filter((details): details is PersonalDetails => !!details);
+    const personalDetail = personalDetailList[0];


Hi, @kubabutkiewicz, personalDetail might be undefined, and this could lead to a crash when later code attempts to access personalDetail.login later.

App/src/libs/OptionsListUtils.ts

Line 660 in 7962905

result.alternateText = showChatPreviewLine && lastMessageText ? lastMessageText : LocalePhoneNumber.formatPhoneNumber(personalDetail.login ?? '');

App/src/libs/OptionsListUtils.ts

Line 665 in 7962905

reportName = ReportUtils.getDisplayNameForParticipant(accountIDs[0]) || LocalePhoneNumber.formatPhoneNumber(personalDetail.login ?? '');

@ntdiary agree .. it's failing in the new/chat page in my account we need to change it to personalDetail?.login in all occurrences

cc @deetergp

Hi @ntdiary !
I think this

App/src/libs/OptionsListUtils.ts

Line 588 in 7962905

const personalDetailList = Object.values(personalDetailMap).filter((details): details is PersonalDetails => !!details);

is filterning falsy values from personalDetailList right? so personalDetail should always be defined in my opinion.
Is the crash already happend, or this was just a assumption?

Yeah, it did happen. 😂

It seems that accountIDs might be an empty array.

test.mp4

hmm its weird because I even run this is TS playground and it should filter those falsy values

but yeah I will make a PR with a fix.

@ntdiary do you know if there is an issue for that created?

@ntdiary do you know if there is an issue for that created?

I'm not sure if there is a created issue, I just happened to encounter this error while reviewing another PR #32665, so I left a comment here. 😂

Let's fix this asap. This blocks testing important parts of the app.
This happens because const personalDetailMap = getPersonalDetailsForAccountIDs(accountIDs, personalDetails); can be empty json {}

Screen.Recording.2024-01-28.at.9.05.49.PM.mov

situchan · 2024-01-29T07:23:14Z

src/libs/OptionsListUtils.ts

-    } else if (ReportUtils.isReportMessageAttachment({text: report.lastMessageText, html: report.lastMessageHtml, translationKey: report.lastMessageTranslationKey})) {
-        lastMessageTextFromReport = `[${Localize.translateLocal(report.lastMessageTranslationKey || 'common.attachment')}]`;
+    } else if (ReportUtils.isReportMessageAttachment({text: report?.lastMessageText ?? '', html: report?.lastMessageHtml, translationKey: report?.lastMessageTranslationKey, type: ''})) {
+        lastMessageTextFromReport = `[${Localize.translateLocal((report?.lastMessageTranslationKey ?? 'common.attachment') as TranslationPaths)}]`;


This caused regression. We should keep ||

BUG: Crash on LHN for non-expensify email domain, [MISSING TRNSLATION] for expensify domain
[Attachment] is the expected string

Repro step: send any attachment to any chat on iOS app

getusha · 2024-01-29T07:48:07Z

@kubabutkiewicz Should we revert this or fix the raised regressions.

kubabutkiewicz · 2024-01-29T08:08:03Z

I am publishing the fix now

kubabutkiewicz · 2024-01-29T08:20:29Z

PR: #35300 @getusha @situchan
I dont see any issues created for those regressions yet

situchan · 2024-01-29T08:26:57Z

I dont see any issues created for those regressions yet

That's because this PR didn't hit staging yet. Only QA team is reporting bugs. Not contributors

OSBotify · 2024-01-29T19:23:24Z

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

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

situchan · 2024-01-30T19:41:55Z

src/libs/OptionsListUtils.ts

+        .map((tag) => ({name: tag, enabled: true}));
+    const filteredTags = enabledTags.filter((tag) => !selectedOptionNames.includes(tag.name));
+
+    if (selectedOptions) {


This caused regression. selectedOptions is array and always truthy.
Should be selectedOptions.length.
Issue created for this: #35423

OSBotify · 2024-01-31T02:30:15Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

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

alitoshmatov · 2024-04-04T20:26:06Z

src/libs/OptionsListUtils.ts

+            if (name) {
+                const categoryObject: Category = {
+                    name,
+                    enabled: categories[name].enabled ?? false,


Category should have been accessed safely, rare case where categories[name] is undefined. ref: #36622

kubabutkiewicz added 17 commits October 2, 2023 16:28

ref: move OptionsListUtils to TS

1c2690a

Merge branch 'main' into ts-migration/OptionsListUtils-lib

71c71bb

fix: removed loadshGet usage

d67f9f7

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

8f8f2c0

…s-migration/OptionsListUtils-lib

fix: types

ff9ef80

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

3afff90

…s-migration/OptionsListUtils-lib

fix: types

1cc23ca

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

4bd6c2e

…s-migration/OptionsListUtils-lib

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

59e5bf5

…s-migration/OptionsListUtils-lib

fix: types

b255727

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

8c315e8

…s-migration/OptionsListUtils-lib

fix: types

905b5e3

fix: tests

5e92f73

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

b0c7f4c

…s-migration/OptionsListUtils-lib

fix: tests

feadbf2

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

dae570c

…s-migration/OptionsListUtils-lib

fix: added return type

60a94cc

rezkiy37 reviewed Dec 11, 2023

View reviewed changes

src/libs/ReportUtils.ts Show resolved Hide resolved

rezkiy37 reviewed Dec 11, 2023

View reviewed changes

src/types/onyx/Report.ts Show resolved Hide resolved

rezkiy37 reviewed Dec 11, 2023

View reviewed changes

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

rezkiy37 reviewed Dec 11, 2023

View reviewed changes

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

fabioh8010 reviewed Dec 12, 2023

View reviewed changes

src/libs/OptionsListUtils.ts Show resolved Hide resolved

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

kubabutkiewicz added 2 commits December 12, 2023 15:22

fix: adressing comments

f919766

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

f6e8063

…s-migration/OptionsListUtils-lib

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

src/libs/OptionsListUtils.ts Show resolved Hide resolved

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

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

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

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

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

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

pac-guerreiro reviewed Dec 12, 2023

View reviewed changes

src/libs/OptionsListUtils.ts Show resolved Hide resolved

fix: typecheck

691fef8

getusha approved these changes Jan 25, 2024

View reviewed changes

melvin-bot bot requested a review from deetergp January 25, 2024 13:06

deetergp approved these changes Jan 25, 2024

View reviewed changes

deetergp merged commit ac94dc5 into Expensify:main Jan 25, 2024
17 checks passed

situchan reviewed Jan 25, 2024

View reviewed changes

situchan mentioned this pull request Jan 25, 2024

fixes typescript mistake with type assertion in ReportActionItemMessage #35204

Merged

50 tasks

thienlnam mentioned this pull request Jan 26, 2024

[No QA] Fix onLayout type error on main #35216

Merged

51 tasks

ntdiary reviewed Jan 26, 2024

View reviewed changes

ntdiary mentioned this pull request Jan 26, 2024

Fix Black Screen Transition Issue by Reusing didScreenTransitionEnd in MoneyRequestParticipantsSelector #32665

Merged

50 tasks

ishpaul777 mentioned this pull request Jan 26, 2024

[TS migration] Migrate 'ReportActionItemTaskView.js' component to TypeScript #34276

Merged

50 tasks

situchan reviewed Jan 29, 2024

View reviewed changes

situchan mentioned this pull request Jan 29, 2024

Fix crash when searching and missing translation when adding attachment on iOS #35300

Merged

50 tasks

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

bernhardoj mentioned this pull request Jan 30, 2024

Send money - Unexpected error when sending money to a Hidden contact #35394

Closed

6 tasks

FitseTLT mentioned this pull request Jan 30, 2024

[$500] Tag - Extra padding above Recent section in Tag list #35423

Closed

6 tasks

situchan reviewed Jan 30, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Jan 31, 2024

[HOLD for payment 2024-02-07] [TS migration] Migrate 'OptionsListUtils.js' lib to TypeScript #24921

Closed

FitseTLT mentioned this pull request Feb 15, 2024

[HOLD for payment 2024-04-05] [$125] App crashes when click on Category while creating Money request #36622

Closed

6 tasks

alitoshmatov reviewed Apr 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'OptionsListUtils.js' lib to TypeScript #32470

[TS migration] Migrate 'OptionsListUtils.js' lib to TypeScript #32470

kubabutkiewicz commented Dec 5, 2023 •

edited

Loading

fabioh8010 left a comment

kubabutkiewicz commented Jan 25, 2024

melvin-bot bot commented Jan 25, 2024

deetergp left a comment

situchan left a comment

ntdiary Jan 26, 2024 •

edited

Loading

abzokhattab Jan 26, 2024 •

edited

Loading

kubabutkiewicz Jan 26, 2024

ntdiary Jan 26, 2024 •

edited

Loading

kubabutkiewicz Jan 26, 2024

kubabutkiewicz Jan 26, 2024

ntdiary Jan 26, 2024

situchan Jan 28, 2024

situchan Jan 29, 2024

getusha commented Jan 29, 2024

kubabutkiewicz commented Jan 29, 2024

kubabutkiewicz commented Jan 29, 2024

situchan commented Jan 29, 2024

OSBotify commented Jan 29, 2024

situchan Jan 30, 2024 •

edited

Loading

OSBotify commented Jan 31, 2024

alitoshmatov Apr 4, 2024

[TS migration] Migrate 'OptionsListUtils.js' lib to TypeScript #32470

[TS migration] Migrate 'OptionsListUtils.js' lib to TypeScript #32470

Conversation

kubabutkiewicz commented Dec 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

fabioh8010 left a comment

Choose a reason for hiding this comment

kubabutkiewicz commented Jan 25, 2024

melvin-bot bot commented Jan 25, 2024

deetergp left a comment

Choose a reason for hiding this comment

situchan left a comment

Choose a reason for hiding this comment

ntdiary Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

abzokhattab Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

kubabutkiewicz Jan 26, 2024

Choose a reason for hiding this comment

ntdiary Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

kubabutkiewicz Jan 26, 2024

Choose a reason for hiding this comment

kubabutkiewicz Jan 26, 2024

Choose a reason for hiding this comment

ntdiary Jan 26, 2024

Choose a reason for hiding this comment

situchan Jan 28, 2024

Choose a reason for hiding this comment

situchan Jan 29, 2024

Choose a reason for hiding this comment

getusha commented Jan 29, 2024

kubabutkiewicz commented Jan 29, 2024

kubabutkiewicz commented Jan 29, 2024

situchan commented Jan 29, 2024

OSBotify commented Jan 29, 2024

situchan Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

OSBotify commented Jan 31, 2024

alitoshmatov Apr 4, 2024

Choose a reason for hiding this comment

kubabutkiewicz commented Dec 5, 2023 •

edited

Loading

ntdiary Jan 26, 2024 •

edited

Loading

abzokhattab Jan 26, 2024 •

edited

Loading

ntdiary Jan 26, 2024 •

edited

Loading

situchan Jan 30, 2024 •

edited

Loading