[TS migration] Migrate 'ReportActionItem.js' component to TypeScript #34487

kubabutkiewicz · 2024-01-15T07:36:04Z

Details

Fixed Issues

$ #31982

Tests

Start a chat
Send a message
Add Emoji
Edit message
Create a thread
Delete message
Send money request
Edit it
Assign task
Edit task
Complete it

Verify that no errors appear in the JS console

Offline tests

QA Steps

Start a chat
Send a message
Add Emoji
Edit message
Create a thread
Delete message
Send money request
Edit it
Assign task
Edit task
Complete it

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

Android: mWeb Chrome

mchrome.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

msafari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

This reverts commit 1c13e82.

…s-migration/ReportActionItem2/component

src/pages/home/report/ReportActionItem.tsx

kubabutkiewicz · 2024-01-16T15:10:44Z

src/pages/home/report/ReportActionItem.tsx

@@ -760,75 +786,54 @@ function ReportActionItem(props) {
                )}
            </Hoverable>
            <View style={styles.reportActionSystemMessageContainer}>
-                <InlineSystemMessage message={props.action.error} />
+                {/* @ts-expect-error TODO check if there is a field on the reportAction object */}
+                <InlineSystemMessage message={action.error} />


I was not able to check if this field error exists on ReportAction type so not sure if I should add this to type of this is mistake

Maybe ask on slack, or make an artificial error to test this?

…s-migration/ReportActionItem2/component

src/ONYXKEYS.ts

src/libs/isReportMessageAttachment.ts

src/pages/home/report/ReportActionItem.tsx

fabioh8010 · 2024-01-17T08:00:19Z

src/pages/home/report/ReportActionItem.tsx

+const getDraftMessage = (drafts: OnyxCollection<OnyxTypes.ReportActionsDrafts>, reportID: string, action: OnyxTypes.ReportAction): string | undefined => {
+    const originalReportID = ReportUtils.getOriginalReportID(reportID, action);
+    const draftKey = `${ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS}${originalReportID}`;
+    const draftMessage = drafts?.[draftKey]?.[action.reportActionID];
+    return typeof draftMessage === 'string' ? draftMessage : draftMessage?.message;
+};


Please test this logic change extensively 🙂

src/pages/home/report/ReportActionItem.tsx

src/libs/isReportMessageAttachment.ts

…s-migration/ReportActionItem2/component

kubabutkiewicz · 2024-03-07T09:58:03Z

@rushatgabhane kind bump 😄

rushatgabhane · 2024-03-07T10:58:32Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(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.
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

melvin-bot · 2024-03-07T18:08:18Z

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

luacmartins · 2024-03-07T18:22:01Z

Tests were passing.

OSBotify · 2024-03-08T00:03:20Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.49-0 🚀

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

situchan

@kubabutkiewicz are you able to raise quick PR fixing them? This caused deploy blocker - #37965

situchan · 2024-03-08T12:42:04Z

src/pages/home/report/ReportActionItem.tsx

+        initialValue: {} as OnyxTypes.Report,
+    },
+    policyReportFields: {
+        key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY_REPORT_FIELDS}${report.policyID ?? ''}`,


We should avoid fallback to empty string when prefixed with onyx key. xxx_ will pull all data.

Suggested change

key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY_REPORT_FIELDS}${report.policyID ?? ''}`,

key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY_REPORT_FIELDS}${report.policyID ?? 0}`,

situchan · 2024-03-08T12:42:27Z

src/pages/home/report/ReportActionItem.tsx

+        initialValue: {},
+    },
+    policy: {
+        key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY}${report.policyID ?? ''}`,


Same here:

Suggested change

key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY}${report.policyID ?? ''}`,

key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY}${report.policyID ?? 0}`,

flodnv · 2024-03-08T15:21:36Z

Tests were passing.

@luacmartins I just got caught off guard by the same thing in another PR, they were also not passing here 😬

Discussion here: https://expensify.slack.com/archives/C01GTK53T8Q/p1709911998098289

luacmartins · 2024-03-08T16:56:12Z

hmm interesting, I did not see that before the merge. Thanks for pointing that out!

flodnv · 2024-03-08T17:31:28Z

I did not see that before the merge

Same for me in my other PR 😕

rlinoz · 2024-03-11T15:49:21Z

This PR is causing this regression #38049

OSBotify · 2024-03-12T18:37:24Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

mallenexpensify · 2024-03-23T00:16:12Z

Commented on the issue

@rushatgabhane are you due compensation here? If so, is it 50% cuz of #34487 (comment)?

@rushatgabhane , if you're due compensation, please comment on the issue, otherwise I'll close next week. Thx

alitoshmatov · 2024-12-16T16:39:31Z

src/components/createOnyxContext.tsx

@@ -86,7 +86,7 @@ export default <TOnyxKey extends OnyxKey>(onyxKeyName: TOnyxKey): CreateOnyxCont
        if (value === null) {
            throw new Error(`useOnyxContext must be used within a OnyxProvider [key: ${onyxKeyName}]`);
        }
-        return value;
+        return value as NonNullable<OnyxValue<TOnyxKey>>;


We have a case where we create a context hook from createOnyxContext it might return undefined sometimes and we are not covering this case in our code, that is why app is crashing in specific scenario. More info on proposal: #52633 (comment)

kubabutkiewicz added 13 commits January 12, 2024 08:56

ref: wip

1c13e82

Merge branch 'Expensify:main' into main

b257c3e

Revert "ref: wip"

457ad4c

This reverts commit 1c13e82.

ref: wip

0882361

Merge branch 'Expensify:main' into main

6b4fe34

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

10eefa0

…s-migration/ReportActionItem2/component

ref: wip

36f3081

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

4074619

…s-migration/ReportActionItem2/component

fix: wip

d3a184a

fix: wip

f291344

fix: wip

f8b01bf

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

ff4c7a8

…s-migration/ReportActionItem2/component

fix: last types problems

c4df84d

kubabutkiewicz commented Jan 16, 2024

View reviewed changes

src/pages/home/report/ReportActionItem.tsx Outdated Show resolved Hide resolved

kubabutkiewicz commented Jan 16, 2024

View reviewed changes

kubabutkiewicz added 3 commits January 16, 2024 16:26

fix: remove unnecessary comment

8b88e30

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

e5c32ee

…s-migration/ReportActionItem2/component

fix: typecheck

62c72a7

fabioh8010 reviewed Jan 17, 2024

View reviewed changes

fix: resolve comments

e1deff2

rezkiy37 reviewed Jan 17, 2024

View reviewed changes

src/libs/isReportMessageAttachment.ts Show resolved Hide resolved

kubabutkiewicz added 9 commits January 17, 2024 14:32

fix: types in OnyxKeys and migration files

d54eef9

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

16e8c9d

…s-migration/ReportActionItem2/component

fix :resolve conflicts

e3bd929

fix: typecheck and lint

8f599e5

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

fea6b71

…s-migration/ReportActionItem2/component

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

8cf1b3e

…s-migration/ReportActionItem2/component

fix: typecheck

36bbd18

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

ad074de

…s-migration/ReportActionItem2/component

fix: typecheck

fcaaa64

kubabutkiewicz added 5 commits March 4, 2024 10:32

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

ff903d3

…s-migration/ReportActionItem2/component

fix: resolve comments

02d23b1

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

c8357cd

…s-migration/ReportActionItem2/component

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

429a111

…s-migration/ReportActionItem2/component

fix: typecheck

329c724

luacmartins approved these changes Mar 7, 2024

View reviewed changes

rushatgabhane approved these changes Mar 7, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins March 7, 2024 15:52

luacmartins approved these changes Mar 7, 2024

View reviewed changes

luacmartins merged commit 844ee32 into Expensify:main Mar 7, 2024
16 of 17 checks passed

melvin-bot bot added the Emergency label Mar 7, 2024

luacmartins removed the Emergency label Mar 7, 2024

github-actions bot mentioned this pull request Mar 7, 2024

Deploy Checklist: New Expensify 2024-03-07 #37938

Closed

43 tasks

shubham1206agra mentioned this pull request Mar 8, 2024

[HOLD for payment 2024-03-19] [HOLD for payment 2024-03-18] IOU - App crashes when navigate to IOU created offline #37965

Closed

6 tasks

situchan reviewed Mar 8, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Mar 11, 2024

[HOLD for payment 2024-03-18] [TS migration] Migrate 'ReportActionItem.js' component to TypeScript #31982

Closed

Krishna2323 mentioned this pull request Mar 11, 2024

[HOLD for payment 2024-03-22] Сhat - On selecting skin tone emoji symbol disappears #38049

Closed

6 tasks

rlinoz mentioned this pull request Mar 12, 2024

Fix missing emojis in suggestion after changing skin color #38134

Merged

50 tasks

alitoshmatov reviewed Dec 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'ReportActionItem.js' component to TypeScript #34487

[TS migration] Migrate 'ReportActionItem.js' component to TypeScript #34487

kubabutkiewicz commented Jan 15, 2024 •

edited

Loading

kubabutkiewicz Jan 16, 2024

blazejkustra Feb 20, 2024

fabioh8010 Jan 17, 2024

kubabutkiewicz commented Mar 7, 2024

rushatgabhane commented Mar 7, 2024 •

edited

Loading

melvin-bot bot commented Mar 7, 2024

luacmartins commented Mar 7, 2024

OSBotify commented Mar 8, 2024

situchan left a comment •

edited

Loading

situchan Mar 8, 2024

situchan Mar 8, 2024

flodnv commented Mar 8, 2024 •

edited

Loading

luacmartins commented Mar 8, 2024

flodnv commented Mar 8, 2024 •

edited

Loading

rlinoz commented Mar 11, 2024

OSBotify commented Mar 12, 2024

mallenexpensify commented Mar 23, 2024

alitoshmatov Dec 16, 2024

	key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY_REPORT_FIELDS}${report.policyID ?? ''}`,
	key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY_REPORT_FIELDS}${report.policyID ?? 0}`,

[TS migration] Migrate 'ReportActionItem.js' component to TypeScript #34487

[TS migration] Migrate 'ReportActionItem.js' component to TypeScript #34487

Conversation

kubabutkiewicz commented Jan 15, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kubabutkiewicz Jan 16, 2024

Choose a reason for hiding this comment

blazejkustra Feb 20, 2024

Choose a reason for hiding this comment

fabioh8010 Jan 17, 2024

Choose a reason for hiding this comment

kubabutkiewicz commented Mar 7, 2024

rushatgabhane commented Mar 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Mar 7, 2024

luacmartins commented Mar 7, 2024

OSBotify commented Mar 8, 2024

situchan left a comment • edited Loading

Choose a reason for hiding this comment

situchan Mar 8, 2024

Choose a reason for hiding this comment

situchan Mar 8, 2024

Choose a reason for hiding this comment

flodnv commented Mar 8, 2024 • edited Loading

luacmartins commented Mar 8, 2024

flodnv commented Mar 8, 2024 • edited Loading

rlinoz commented Mar 11, 2024

OSBotify commented Mar 12, 2024

mallenexpensify commented Mar 23, 2024

alitoshmatov Dec 16, 2024

Choose a reason for hiding this comment

kubabutkiewicz commented Jan 15, 2024 •

edited

Loading

rushatgabhane commented Mar 7, 2024 •

edited

Loading

situchan left a comment •

edited

Loading

flodnv commented Mar 8, 2024 •

edited

Loading

flodnv commented Mar 8, 2024 •

edited

Loading