[TS Migration] Migrate EReceiptThumbnail.js component to TypeScript #32913

JKobrynski · 2023-12-12T11:47:36Z

Details

Fixed Issues

$ #31956
PROPOSAL: N/A

Tests

I think the best way to QA this in DEV is to test the component in the storybook build and look at the EReceiptThumbnail, EReceipt, and ReportPreview stories.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

(by @grgia)

As for production QA tests that cover the EReceiptThumbnail,
We can:
1 . Create a report with 1 - 3 Expensify Card Transactions

Note: you can do this in OldDot or NewDot. If done in OldDot, use the reportID from the URL and paste it into NewDot to access the report r/

Ensure that the ReportPreview in the parent chat displays the 1-3 EReceipt Previews ✅
Click on the ReportPreview to open the Expense Report.
Ensure that each expense displays the correct MCC logo ✅
Click on each expense -> Opens MoneyRequest Page -> Click on EReceipt Preview -> Opens EReceipt Page
Ensure that the color and MCC logo is consistent on all pages ✅

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/components/EReceiptThumbnail.tsx

src/styles/utils/index.ts

VickyStash

LGTM

blazejkustra · 2023-12-14T14:53:46Z

LGTM! @JKobrynski

melvin-bot · 2023-12-14T14:55:41Z

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

0xmiros · 2023-12-21T10:07:32Z

Author Checklist seems failing

0xmiros · 2023-12-21T10:07:44Z

There are 3 checklist items added recently

JKobrynski · 2023-12-21T13:04:35Z

@0xmiroslav checklist fixed!

0xmiros · 2023-12-26T05:37:32Z

Agree this is hard to test externally.
In dev, we can use test Onyx data in #29474.
And "No QA" makes sense since I don't think QA team is able to test. If assigned engineer thinks otherwise, I let them take action.

0xmiros · 2023-12-26T05:44:47Z

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 / Chrome
- iOS / native
- iOS / 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 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.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

0xmiros

LGTM!

melvin-bot · 2023-12-26T05:45:12Z

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

tgolen

I am learning a lot about TS through these migrations!

tgolen · 2023-12-26T15:35:13Z

src/components/EReceiptThumbnail.tsx

+    /** TransactionID of the transaction this EReceipt corresponds to
+     * It's used by withOnyx HOC
+     */


Suggested change

/** TransactionID of the transaction this EReceipt corresponds to

* It's used by withOnyx HOC

*/

/** TransactionID used by withOnyx of the transaction this EReceipt corresponds to */

Prop comments are preferred to be single lines.

tgolen · 2023-12-26T15:37:11Z

src/components/EReceiptThumbnail.tsx

-    const onContainerLayout = (event) => {
+    const backgroundImage = useMemo(() => backgroundImages[StyleUtils.getEReceiptColorCode(transaction)], [StyleUtils, transaction]);
+
+    // Get receipt colorway, or default to Yellow.


Suggested change

// Get receipt colorway, or default to Yellow.

I think this comment can be removed, it is not valuable and I don't think it's accurate anymore.

tgolen · 2023-12-26T15:39:08Z

src/components/EReceiptThumbnail.tsx

+    const backgroundImage = useMemo(() => backgroundImages[StyleUtils.getEReceiptColorCode(transaction)], [StyleUtils, transaction]);
+
+    // Get receipt colorway, or default to Yellow.
+    const colorStyles = StyleUtils.getEReceiptColorStyles(StyleUtils.getEReceiptColorCode(transaction));


Why don't these consts (and many others in this file) have type declarations?

Typescript is automatically inferring it from the the return type of getEReceiptColorStyles function:

tgolen · 2023-12-26T15:40:47Z

Oh, also, please do add QA tests. I would suggest looking through the git blame to find when the feature was implemented and see how it was originally QAed. That might give you some insight into how to test it.

blazejkustra · 2023-12-28T10:21:11Z

@JKobrynski Bump for once you are back 😄

JKobrynski · 2024-01-02T08:22:26Z

@tgolen this is the PR that introduced this component, it also describes quite a tricky way of testing it 😅 do you think we should do the same for this one?

tgolen · 2024-01-02T15:12:00Z

Thanks for finding that. I am pretty worried that we have a flow that isn't covered by any QA tests or regression tests. There would be no way for us to know whether this is working or not until we hear about it from our customers. @grgia Could you please help write up some QA tests that Applause can perform for testing e-receipts?

grgia · 2024-01-03T17:15:56Z

@tgolen
I think the best way to QA this in DEV is to test the component in the storybook build and look at the EReceiptThumbnail, EReceipt, and ReportPreview stories.

As for production QA tests that cover the EReceiptThumbnail,
We can:
1 . Create a report with 1 - 3 Expensify Card Transactions
- Note: you can do this in OldDot or NewDot. If done in OldDot, use the reportID from the URL and paste it into NewDot to access the report r/<reportID>
2. Ensure that the ReportPreview in the parent chat displays the 1-3 EReceipt Previews ✅
3. Click on the ReportPreview to open the Expense Report.
4. Ensure that each expense displays the correct MCC logo ✅
5. Click on each expense -> Opens MoneyRequest Page -> Click on EReceipt Preview -> Opens EReceipt Page
6. Ensure that the color and MCC logo is consistent on all pages ✅

tgolen · 2024-01-04T15:40:04Z

Thanks, Georgia! @JKobrynski Can you work those into the QA tests, please? Also, it looks like you picked up a conflict.

JKobrynski · 2024-01-08T08:45:02Z

@tgolen updated, conflicts resolved!

tgolen · 2024-01-08T15:50:23Z

Thanks for adding the QA tests. Can you please clean them up a little?

Put the local testing steps in the "Test" section
Put the production testing steps in the "QA Steps" section

JKobrynski · 2024-01-09T07:40:12Z

@tgolen done!

0xmiros · 2024-01-09T07:40:51Z

Lint failing

OSBotify · 2024-01-09T16:52:05Z

✋ 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-10T06:20:41Z

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

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

OSBotify · 2024-01-11T08:52:21Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.24-3 🚀

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

JKobrynski added 2 commits December 12, 2023 12:46

migrate EReceiptThumbnail to TypeScript

d96c046

apply minor improvements

5845c36

VickyStash suggested changes Dec 12, 2023

View reviewed changes

apply suggested changes

730d681

JKobrynski requested a review from VickyStash December 12, 2023 15:10

VickyStash reviewed Dec 12, 2023

View reviewed changes

src/components/EReceiptThumbnail.tsx Outdated Show resolved Hide resolved

src/styles/utils/index.ts Outdated Show resolved Hide resolved

JKobrynski added 2 commits December 13, 2023 10:13

Merge branch 'main' into migrateEReceiptThumbnailToTypeScript

3ec7530

apply suggested changes

12aa175

JKobrynski requested a review from VickyStash December 13, 2023 09:26

VickyStash approved these changes Dec 13, 2023

View reviewed changes

JKobrynski changed the title ~~[TS Migration] Migrate EReceiptThumbnail.js component to TypeScript~~ [No QA] [TS Migration] Migrate EReceiptThumbnail.js component to TypeScript Dec 13, 2023

Merge branch 'main' into migrateEReceiptThumbnailToTypeScript

008d2ad

blazejkustra approved these changes Dec 14, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review December 14, 2023 14:55

JKobrynski requested a review from a team as a code owner December 14, 2023 14:55

melvin-bot bot requested review from 0xmiros and removed request for a team December 14, 2023 14:55

JKobrynski mentioned this pull request Dec 14, 2023

[HOLD for payment 2024-01-18] [TS migration] Migrate 'EReceiptThumbnail.js' component to TypeScript #31956

Closed

JKobrynski added 2 commits December 18, 2023 14:06

xMerge branch 'main' into migrateEReceiptThumbnailToTypeScript

0c298d6

Merge branch 'main' into migrateEReceiptThumbnailToTypeScript

81a1c64

0xmiros approved these changes Dec 26, 2023

View reviewed changes

melvin-bot bot requested a review from tgolen December 26, 2023 05:46

tgolen requested changes Dec 26, 2023

View reviewed changes

apply suggested changes

4964077

Merge branch 'main' into migrateEReceiptThumbnailToTypeScript

ea0ddea

JKobrynski changed the title ~~[No QA] [TS Migration] Migrate EReceiptThumbnail.js component to TypeScript~~ [TS Migration] Migrate EReceiptThumbnail.js component to TypeScript Jan 8, 2024

JKobrynski requested a review from tgolen January 9, 2024 07:40

fix linting

3f67d65

tgolen approved these changes Jan 9, 2024

View reviewed changes

tgolen merged commit 108b5e0 into Expensify:main Jan 9, 2024
15 checks passed

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

Deploy Checklist: New Expensify 2024-01-10 #34203

Closed

54 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate EReceiptThumbnail.js component to TypeScript #32913

[TS Migration] Migrate EReceiptThumbnail.js component to TypeScript #32913

JKobrynski commented Dec 12, 2023 •

edited

Loading

VickyStash left a comment

blazejkustra commented Dec 14, 2023

melvin-bot bot commented Dec 14, 2023

0xmiros commented Dec 21, 2023

0xmiros commented Dec 21, 2023

JKobrynski commented Dec 21, 2023

0xmiros commented Dec 26, 2023

0xmiros commented Dec 26, 2023

0xmiros left a comment

melvin-bot bot commented Dec 26, 2023

tgolen left a comment

tgolen Dec 26, 2023

JKobrynski Jan 2, 2024

tgolen Dec 26, 2023

JKobrynski Jan 2, 2024

tgolen Dec 26, 2023

blazejkustra Dec 28, 2023

tgolen commented Dec 26, 2023

blazejkustra commented Dec 28, 2023

JKobrynski commented Jan 2, 2024

tgolen commented Jan 2, 2024

grgia commented Jan 3, 2024

tgolen commented Jan 4, 2024

JKobrynski commented Jan 8, 2024

tgolen commented Jan 8, 2024

JKobrynski commented Jan 9, 2024

0xmiros commented Jan 9, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

[TS Migration] Migrate EReceiptThumbnail.js component to TypeScript #32913

[TS Migration] Migrate EReceiptThumbnail.js component to TypeScript #32913

Conversation

JKobrynski commented Dec 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

VickyStash left a comment

Choose a reason for hiding this comment

blazejkustra commented Dec 14, 2023

melvin-bot bot commented Dec 14, 2023

0xmiros commented Dec 21, 2023

0xmiros commented Dec 21, 2023

JKobrynski commented Dec 21, 2023

0xmiros commented Dec 26, 2023

0xmiros commented Dec 26, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 26, 2023

tgolen left a comment

Choose a reason for hiding this comment

tgolen Dec 26, 2023

Choose a reason for hiding this comment

JKobrynski Jan 2, 2024

Choose a reason for hiding this comment

tgolen Dec 26, 2023

Choose a reason for hiding this comment

JKobrynski Jan 2, 2024

Choose a reason for hiding this comment

tgolen Dec 26, 2023

Choose a reason for hiding this comment

blazejkustra Dec 28, 2023

Choose a reason for hiding this comment

tgolen commented Dec 26, 2023

blazejkustra commented Dec 28, 2023

JKobrynski commented Jan 2, 2024

tgolen commented Jan 2, 2024

grgia commented Jan 3, 2024

tgolen commented Jan 4, 2024

JKobrynski commented Jan 8, 2024

tgolen commented Jan 8, 2024

JKobrynski commented Jan 9, 2024

0xmiros commented Jan 9, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

JKobrynski commented Dec 12, 2023 •

edited

Loading