[TS migration] Migrate Taskpreview.js component to TypeScript #33852

unidev727 · 2024-01-02T20:47:45Z

Details

Fixed Issues

$ #31791
PROPOSAL:

Tests

Login to the app
Open any report
- Verify that TaskPreview report actions are displayed correctly (as they was before)

Offline tests

QA Steps

Login to the app
Open any report
Verify that TaskPreview report actions are displayed correctly (as they was before)

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(theme.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: mWeb Chrome

android-web.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.-.2024-01-02.at.12.40.20.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.-.2024-01-02.at.12.43.35.mp4

MacOS: Chrome / Safari

desktop-web.webm

MacOS: Desktop

screen-capture.6.webm

melvin-bot · 2024-01-02T20:47:50Z

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

github-actions · 2024-01-02T20:47:59Z

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

…rate/ReportActionItemTaskPreview

hoangzinh · 2024-01-02T21:55:22Z

According to this issue #31971 It looks like @thesahindia is C+ for this PR. @tgolen can you help to assign him and unassign me? Thanks

tgolen · 2024-01-02T22:11:37Z

Sure, I think that should do it.

kubabutkiewicz · 2024-01-03T11:36:08Z

src/components/ReportActionItem/TaskPreview.tsx

-        /** The role of current user */
-        role: PropTypes.string,
-    }),
+    rootParentReportpolicy: OnyxEntry<{role: string}>;


could you extract this type {role: string} to seperate type?

Just added a new type. Please review again.

kubabutkiewicz · 2024-01-03T11:36:47Z

src/components/ReportActionItem/TaskPreview.tsx

+type TaskPreviewProps = WithCurrentUserPersonalDetailsProps &
+    TaskPreviewOnyxProps & {
+        /** The ID of the associated policy */
+        // eslint-disable-next-line


why this is needed ?

There is a lint error that shows policyId is defined but not used anywhere so I added it.

A few things:

If the prop is not used anywhere, remove it

If the eslint-disable-next-line needs to stay, disable the specific rule instead of all rules and also add a code comment for why the prop needs to be there even though it isn't used anywhere

I believe the reason policyID is here is because it is used in withOnyx to fetch rootParentReportpolicy. Since ESLint won't detect it's usage in withOnyx, that's why it throws the error.

Please do one of the options I posted in my previous comment, I don't see that either of them were followed.

kubabutkiewicz · 2024-01-03T11:42:19Z

src/components/ReportActionItem/TaskPreview.tsx


-function TaskPreview(props) {
+function TaskPreview(props: TaskPreviewProps) {


please destructure props

Please review again.

kubabutkiewicz

lgtm!

…rate/ReportActionItemTaskPreview

tgolen · 2024-01-03T15:13:24Z

src/components/ReportActionItem/TaskPreview.tsx

+type TaskPreviewProps = WithCurrentUserPersonalDetailsProps &
+    TaskPreviewOnyxProps & {
+        /** The ID of the associated policy */
+        // eslint-disable-next-line


A few things:

If the prop is not used anywhere, remove it

If the eslint-disable-next-line needs to stay, disable the specific rule instead of all rules and also add a code comment for why the prop needs to be there even though it isn't used anywhere

I believe the reason policyID is here is because it is used in withOnyx to fetch rootParentReportpolicy. Since ESLint won't detect it's usage in withOnyx, that's why it throws the error.

tgolen · 2024-01-03T15:17:48Z

src/components/ReportActionItem/TaskPreview.tsx

+    const taskTitle = Str.htmlEncode(TaskUtils.getTaskTitle(taskReportID, action?.childReportName ?? ''));
+    const taskAssigneeAccountID = Task.getTaskAssigneeAccountID(taskReport ?? {}) ?? action?.childManagerAccountID ?? '';
+    const assigneeLogin = taskAssigneeAccountID ? personalDetails[taskAssigneeAccountID]?.login ?? '' : '';
+    const assigneeDisplayName = taskAssigneeAccountID ? personalDetails[taskAssigneeAccountID]?.displayName ?? '' : '';


I understand that we've said in these migrations that lodash and underscore should be removed, but I can't help but think that the end result is so much less readable and understandable than it was before. These four variables are perfect examples where it appears very confusing and the lodash implementation was much better.

I'd like to open up a discussion about this.

cc @puneetlath @cead22 @AndrewGable @roryabraham @iwiznia

Suggested change

const taskTitle = Str.htmlEncode(TaskUtils.getTaskTitle(taskReportID, action?.childReportName ?? ''));

const taskAssigneeAccountID = Task.getTaskAssigneeAccountID(taskReport ?? {}) ?? action?.childManagerAccountID ?? '';

const assigneeLogin = taskAssigneeAccountID ? personalDetails[taskAssigneeAccountID]?.login ?? '' : '';

const assigneeDisplayName = taskAssigneeAccountID ? personalDetails[taskAssigneeAccountID]?.displayName ?? '' : '';

const taskTitle = Str.htmlEncode(TaskUtils.getTaskTitle(taskReportID, action?.childReportName ?? ''));

const taskAssigneeAccountID = Task.getTaskAssigneeAccountID(taskReport ?? {}) ?? action?.childManagerAccountID ?? '';

const assigneeLogin = personalDetails?.[taskAssigneeAccountID]?.login ?? '';

const assigneeDisplayName = personalDetails?.[taskAssigneeAccountID]?.displayName ?? '';

That looks better, thanks for the suggestion!

…rate/ReportActionItemTaskPreview

blazejkustra · 2024-01-05T11:07:40Z

Kind request, change PR title so it reflects issue title: [TS migration] Migrate 'X.js' component to TypeScript

blazejkustra · 2024-01-05T11:09:35Z

src/components/ReportActionItem/TaskPreview.tsx

                />
            </PressableWithoutFeedback>
        </View>
    );
 }

-TaskPreview.propTypes = propTypes;
-TaskPreview.defaultProps = defaultProps;
 TaskPreview.displayName = 'TaskPreview';

 export default compose(


Please refer to TS guidelines, unfortunately we have to remove compose here, as it isn't working as expected. link

Just updated.

blazejkustra · 2024-01-05T11:10:09Z

src/components/ReportActionItem/TaskPreview.tsx

            >
                <View style={[styles.flex1, styles.flexRow, styles.alignItemsStart]}>
                    <Checkbox
                        style={[styles.mr2]}
                        containerStyle={[styles.taskCheckbox]}
                        isChecked={isTaskCompleted}
-                        disabled={!Task.canModifyTask(props.taskReport, props.currentUserPersonalDetails.accountID, lodashGet(props.rootParentReportpolicy, 'role', ''))}
+                        disabled={!Task.canModifyTask(taskReport ?? {}, currentUserPersonalDetails.accountID, rootParentReportpolicy ? rootParentReportpolicy.role : '')}


Suggested change

disabled={!Task.canModifyTask(taskReport ?? {}, currentUserPersonalDetails.accountID, rootParentReportpolicy ? rootParentReportpolicy.role : '')}

disabled={!Task.canModifyTask(taskReport ?? {}, currentUserPersonalDetails.accountID, rootParentReportpolicy?.role ?? '')}

Just applied.

tgolen · 2024-01-05T15:01:14Z

src/components/ReportActionItem/TaskPreview.tsx

-    /** The linked reportAction */
-    action: PropTypes.shape(reportActionPropTypes).isRequired,
+type PolicyRole = {
+    role: string;


It looks like some comments are getting dropped. I find the comments very helpful, is it a standard process to remove them? I'd like to keep them.

@tgolen We preserve all comments, and sometimes we even add new ones for better clarity :)

tgolen · 2024-01-05T15:01:49Z

src/components/ReportActionItem/TaskPreview.tsx

-        /** AccountID of the creator of this iou report */
-        ownerAccountID: PropTypes.number,
-    }),
+    taskReport: OnyxEntry<Report>;


Please add a comment for this one.

tgolen · 2024-01-05T15:02:49Z

src/components/ReportActionItem/TaskPreview.tsx

+type TaskPreviewProps = WithCurrentUserPersonalDetailsProps &
+    TaskPreviewOnyxProps & {
+        /** The ID of the associated policy */
+        // eslint-disable-next-line


Please do one of the options I posted in my previous comment, I don't see that either of them were followed.

tgolen · 2024-01-05T15:05:48Z

src/components/ReportActionItem/TaskPreview.tsx

+function TaskPreview({
+    taskReport,
+    taskReportID,
+    action,


@blazejkustra Is there a general rule about when to use destructuring with defaults and when not to? It feels to me like it would make the code easier to follow if we used defaults in the destructuring. The only case I think it won't work is when you need to know if the value was undefined or null, but a simple fasly check like action ?? {} should be fine, right?

so may I update the code to use default value in destructuring if possible?

The rule of thumb is to avoid unnecessary default values such as undefined, null, {}, [], '' and () => {} - when we started migration we left some of these, but we can clean them as a follow up once whole TS migration is finished.

Two examples for useful default values:

function Avatar({ size = CONST.AVATAR_SIZE.DEFAULT, fallbackIcon = Expensicons.FallbackAvatar, type = CONST.ICON_TYPE_AVATAR, }: AvatarProps) {} function GenericPressable( { shouldUseHapticsOnLongPress = false, shouldUseHapticsOnPress = false, shouldUseAutoHitSlop = false, enableInScreenReaderStates = CONST.SCREEN_READER_STATES.ALL, accessible = true, ...rest }: PressableProps) {}

blazejkustra · 2024-01-05T15:45:33Z

src/components/ReportActionItem/TaskPreview.tsx

+    contextMenuAnchor,
+    chatReportID,
+    checkIfContextMenuActive,
+    isHovered,


Missing default value here:

Suggested change

isHovered,

isHovered = false,

blazejkustra · 2024-01-05T15:51:35Z

src/components/ReportActionItem/TaskPreview.tsx

+function TaskPreview({
+    taskReport,
+    taskReportID,
+    action,


The rule of thumb is to avoid unnecessary default values such as undefined, null, {}, [], '' and () => {} - when we started migration we left some of these, but we can clean them as a follow up once whole TS migration is finished.

Two examples for useful default values:

function Avatar({ size = CONST.AVATAR_SIZE.DEFAULT, fallbackIcon = Expensicons.FallbackAvatar, type = CONST.ICON_TYPE_AVATAR, }: AvatarProps) {} function GenericPressable( { shouldUseHapticsOnLongPress = false, shouldUseHapticsOnPress = false, shouldUseAutoHitSlop = false, enableInScreenReaderStates = CONST.SCREEN_READER_STATES.ALL, accessible = true, ...rest }: PressableProps) {}

blazejkustra · 2024-01-05T15:53:06Z

src/components/ReportActionItem/TaskPreview.tsx

-    const taskAssigneeAccountID = Task.getTaskAssigneeAccountID(props.taskReport) || props.action.childManagerAccountID;
-    const assigneeLogin = lodashGet(personalDetails, [taskAssigneeAccountID, 'login'], '');
-    const assigneeDisplayName = lodashGet(personalDetails, [taskAssigneeAccountID, 'displayName'], '');
+    const isTaskCompleted = isNotEmptyObject(taskReport)


We want to deprecate isNotEmptyObject, let's use !isEmptyObject instead

blazejkustra · 2024-01-05T15:53:43Z

src/components/ReportActionItem/TaskPreview.tsx

+    const isTaskCompleted = isNotEmptyObject(taskReport)
+        ? taskReport?.stateNum === CONST.REPORT.STATE_NUM.SUBMITTED && taskReport.statusNum === CONST.REPORT.STATUS.APPROVED
+        : action?.childStateNum === CONST.REPORT.STATE_NUM.SUBMITTED && action?.childStatusNum === CONST.REPORT.STATUS.APPROVED;
+    const taskTitle = Str.htmlEncode(TaskUtils.getTaskTitle(taskReportID, action?.childReportName ?? ''));


Please make sure these implementations give the same result:

const taskTitle = _.escape(TaskUtils.getTaskTitle(props.taskReportID, props.action.childReportName));

Same result.

tgolen · 2024-01-10T16:30:20Z

Looks like this has conflicts. Do those just need to be cleaned up and then this can be merged? I don't think I was officially included on the original reviewer list.

blazejkustra · 2024-01-10T17:08:05Z

CLA Assistant is failing @unicorndev-727

unidev727 · 2024-01-10T17:52:55Z

I have read the CLA Document and I hereby sign the CLA

…rate/ReportActionItemTaskPreview

OSBotify · 2024-01-11T20:27:23Z

✋ 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 · 2024-01-15T11:57:23Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.25-0 🚀

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

OSBotify · 2024-01-17T01:15:07Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.25-10 🚀

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

unidev727 added 4 commits December 28, 2023 20:20

copy TaskPreview

4423fbd

policy Id unused error

d35f4b4

fix policyId unused lint error

3057c00

replace escape to htmlEncode

20a2eed

unidev727 requested a review from a team as a code owner January 2, 2024 20:47

melvin-bot bot requested review from hoangzinh and removed request for a team January 2, 2024 20:47

unidev727 mentioned this pull request Jan 2, 2024

[Pay Jan 24] [$250] [TS migration] Migrate 'ReportActionItemTaskPreview.js' component to TypeScript #31971

Closed

Merge branch 'main' of https://github.com/unicorndev-727/App into mig…

3b8b9bc

…rate/ReportActionItemTaskPreview

tgolen requested a review from thesahindia January 2, 2024 22:11

kubabutkiewicz reviewed Jan 3, 2024

View reviewed changes

unidev727 added 2 commits January 3, 2024 12:39

add PolicyRole type and destrcuture props

580eb89

fix lint error

6c7f1df

kubabutkiewicz approved these changes Jan 3, 2024

View reviewed changes

Merge branch 'main' of https://github.com/unicorndev-727/App into mig…

0f73d5d

…rate/ReportActionItemTaskPreview

tgolen requested changes Jan 3, 2024

View reviewed changes

unidev727 added 2 commits January 3, 2024 15:53

update the code by suggestion

4e80d27

Merge branch 'main' of https://github.com/unicorndev-727/App into mig…

e83676e

…rate/ReportActionItemTaskPreview

blazejkustra suggested changes Jan 5, 2024

View reviewed changes

unidev727 changed the title ~~Migrate/report action item task preview~~ [TS migration] Migrate Taskpreview.js component to TypeScript Jan 5, 2024

unidev727 added 2 commits January 5, 2024 14:18

remove compose

dcf28b9

apply suggestion

3e46f69

tgolen requested changes Jan 5, 2024

View reviewed changes

unidev727 added 2 commits January 5, 2024 15:19

add a commnet for props

b125365

limit eslint-disable

b8913f2

blazejkustra suggested changes Jan 5, 2024

View reviewed changes

unidev727 added 2 commits January 5, 2024 16:22

add default value for isHovered

b1ddad9

use isEmptyObject instead of isNotEmptyObject

3b87005

blazejkustra approved these changes Jan 5, 2024

View reviewed changes

resolve conflict

5397fca

Merge branch 'main' of https://github.com/unicorndev-727/App into mig…

eef967d

…rate/ReportActionItemTaskPreview

unidev727 requested a review from tgolen January 10, 2024 17:58

unidev727 added 2 commits January 10, 2024 18:12

Merge branch 'main' of https://github.com/unicorndev-727/App into mig…

7e78240

…rate/ReportActionItemTaskPreview

fix lint error

825b702

tgolen approved these changes Jan 11, 2024

View reviewed changes

tgolen merged commit 6aa4540 into Expensify:main Jan 11, 2024
14 checks passed

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

Deploy Checklist: New Expensify 2024-01-15 #34493

Closed

83 tasks

lanitochka17 mentioned this pull request Jan 15, 2024

[HOLD for payment 2024-01-25] [HOLD for payment 2024-01-24] [$500] Task - Unable to add Assignee when creating a task #34518

Closed

6 tasks

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

[HOLD for payment 2024-01-24] Refactor and Fix Attachment Handling in File Download and Carousel #31791

Merged

45 tasks


		function TaskPreview(props) {
		function TaskPreview(props: TaskPreviewProps) {

	disabled={!Task.canModifyTask(taskReport ?? {}, currentUserPersonalDetails.accountID, rootParentReportpolicy ? rootParentReportpolicy.role : '')}
	disabled={!Task.canModifyTask(taskReport ?? {}, currentUserPersonalDetails.accountID, rootParentReportpolicy?.role ?? '')}

[TS migration] Migrate Taskpreview.js component to TypeScript #33852

[TS migration] Migrate Taskpreview.js component to TypeScript #33852

Conversation

unidev727 commented Jan 2, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 2, 2024

github-actions bot commented Jan 2, 2024 • edited Loading

hoangzinh commented Jan 2, 2024

tgolen commented Jan 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kubabutkiewicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blazejkustra commented Jan 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen Jan 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen commented Jan 10, 2024

blazejkustra commented Jan 10, 2024

unidev727 commented Jan 10, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

OSBotify commented Jan 17, 2024

github-actions bot commented Jan 2, 2024 •

edited

Loading

blazejkustra Jan 3, 2024 •

edited

Loading

tgolen Jan 5, 2024 •

edited

Loading