[TS migration] Migrate 'withReportAndPrivateNotesOrNotFound.js' HOC to TypeScript by pac-guerreiro · Pull Request #34014 · Expensify/App

pac-guerreiro · 2024-01-05T10:09:49Z

Details

Fixed Issues

$ #31925
PROPOSAL:
N/A

Tests

Start a new chat or open an existing one.
At the top of the chat, click on the user name and their profile will slide from the right of the screen.
Click on Private notes
Create a new note and save it.
Check that it displays correctly on a list

Offline tests

Same as tests.

QA Steps

Same as tests.

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-26.at.16.17.28.mp4

Android: mWeb Chrome

Screen.Recording.2024-01-26.at.15.34.25.mp4

iOS: Native

Screen.Recording.2024-01-26.at.16.35.12.mp4

iOS: mWeb Safari

Screen.Recording.2024-01-26.at.15.37.30.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-01-26.at.15.27.04.mp4

MacOS: Desktop

Screen.Recording.2024-01-26.at.15.43.30.mp4

…privatenotesornotfound-to-typescript

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportAndPrivateNotesOrNotFound.js

melvin-bot · 2024-01-22T17:36:33Z

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

jakub-trzebiatowski · 2024-01-23T10:52:57Z

Looks good, I left a minor comment 👍

jakub-trzebiatowski

While the code looks good, the PR lacks...

QA Steps
Tests
Screenshots/Videos

In Tests, write "Same as QA Steps", but fill in QA Steps.

It seems that you modified the PR template by removing the whole bottom part, please don't do that.

fabioh8010 · 2024-01-25T08:50:29Z

cc @pac-guerreiro

pac-guerreiro · 2024-01-26T15:05:37Z

@cubuspl42

Sorry, I'll add the missing info in the PR description 😉

…privatenotesornotfound-to-typescript

pac-guerreiro · 2024-01-26T16:51:15Z

@cubuspl42 Missing info added! Thank you for your patience! 🙏

jakub-trzebiatowski · 2024-01-29T08:35:09Z

@pac-guerreiro No worries! Sadly, some more actions are required:

TypeScript Checks are failing
We've got some conflicts

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportAndPrivateNotesOrNotFound.tsx

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportOrNotFound.tsx

jakub-trzebiatowski · 2024-01-31T09:39:37Z

@pac-guerreiro Please ping me when all checks (except PR Reviewer Checklist) are passing

pac-guerreiro · 2024-01-31T16:27:21Z

@cubuspl42 Issues resolved! 😄

jakub-trzebiatowski · 2024-02-01T10:12:28Z

+            const isOtherUserNote = accountID && Number(session?.accountID) !== Number(accountID);
            const isPrivateNotesFetchFinished = isPrivateNotesFetchTriggered && !report.isLoadingPrivateNotes;
-            const isPrivateNotesEmpty = accountID ? _.has(lodashGet(report, ['privateNotes', accountID, 'note'], '')) : _.isEmpty(report.privateNotes);
+            const isPrivateNotesEmpty = accountID ? !!report?.privateNotes?.[Number(accountID)].note ?? '' : isEmptyObject(report?.privateNotes);


!!report?.privateNotes?.[Number(accountID)].note ?? ''

...and what does it mean now? I'm surprised it is accepted by the compiler and linter.

Good point, the ?? '' is not necessary as it allows isPrivateNotesEmpty to be a string

as it allows isPrivateNotesEmpty to be a string

I don't think so. That expression should parse as...

(!!report?.privateNotes?.[Number(accountID)].note) ?? ''

...and !!x should always be a boolean. As I understand it, !!x ?? y never evaluates to y.

Oh now I get what you meant, nvm 😅 I removed ?? ''

@cubuspl42 Maybe this eslint rule would detect this - https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unnecessary-condition.md

@blazejkustra Do you think we could make use of the mentioned lint?

jakub-trzebiatowski · 2024-02-01T12:55:12Z

Could you check this out? When I tried to edit an existing note, an endless spinner shows up. I tried switching between main and PR branch and it actually seems to work on main, making this a regression.

withReportAndPrivateNotesOrNotFound-ts-issue-1-web-converted.mp4

…privatenotesornotfound-to-typescript

pac-guerreiro · 2024-02-05T18:23:05Z

@cubuspl42 Great catch! Found the culprit and just pushed the fix! Thanks 😄

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportOrNotFound.tsx

jakub-trzebiatowski · 2024-02-06T08:52:58Z

@pac-guerreiro Checks, mate!

pac-guerreiro · 2024-02-07T17:00:41Z

@cubuspl42 Typechecks are now passing! Thanks @VickyStash 🙏

jakub-trzebiatowski · 2024-02-08T10:12:35Z

@pac-guerreiro Are you sure the spinner problem is fixed?

On the latest code:

withReportAndPrivateNotesOrNotFound-ts-issue-2-web-converted.mp4

I checked again that it works on main.

pac-guerreiro · 2024-02-08T11:08:45Z

@cubuspl42 Sorry, it seems I only fixed part of the problem, which was when the user already had private notes.

I just applied a fix for the situation you reported when there are no private notes yet.

Let me know if there's any remaining problem here and thanks for your patience! 😄

jakub-trzebiatowski · 2024-02-08T16:35:26Z

Let us take a step back here. As GitHub is not displaying the diff side-by-side, I'll post a screenshot from the IDE:

Why is the shouldShowFullScreenLoadingIndicator condition so different?

As I understand it, TypeScript migrations should be relatively 1:1 regarding the business logic unless we have good reasons to act otherwise.

I understand that it was a "fix" to the code not working (9b6db94), but can't we achieve working code with a 1:1 migration? If it is impossible or difficult, could you explain why?

jakub-trzebiatowski · 2024-02-12T10:40:38Z

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

withReportAndPrivateNotesOrNotFound-ts-android-compressed.mp4

Android: mWeb Chrome

withReportAndPrivateNotesOrNotFound-ts-android-web-compressed.mp4

iOS: Native

withReportAndPrivateNotesOrNotFound-ts-ios-compressed.mp4

iOS: mWeb Safari

withReportAndPrivateNotesOrNotFound-ts-ios-web-compressed.mp4

MacOS: Chrome / Safari

withReportAndPrivateNotesOrNotFound-ts-web-converted.mp4

MacOS: Desktop

melvin-bot · 2024-02-12T10:40:49Z

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

jakub-trzebiatowski · 2024-02-12T10:41:27Z

@pac-guerreiro Could you also maybe merge main one last time? We're over 1000 commits behind

…privatenotesornotfound-to-typescript

pac-guerreiro · 2024-02-12T16:24:33Z

@cubuspl42 Main rebased 😄

jakub-trzebiatowski · 2024-02-13T08:46:29Z

@cristipaval Would you please review this PR, as you were assigned to #31925?

cristipaval · 2024-02-13T10:03:59Z

Sure I will

OSBotify · 2024-02-13T10:10:38Z

✋ 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-02-15T05:23:07Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.41-12 🚀

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

pac-guerreiro added 4 commits January 3, 2024 15:46

refactor(typescript): migrate withreportandprivatenotesornotfound

53fd25f

refactor: apply suggestions

77ce449

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

70cebb0

…privatenotesornotfound-to-typescript

chore(typescript): add missing import type

6689538

fabioh8010 reviewed Jan 10, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

6318542

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportAndPrivateNotesOrNotFound.js

fabioh8010 reviewed Jan 12, 2024

View reviewed changes

Comment thread src/pages/home/report/withReportAndPrivateNotesOrNotFound.tsx Outdated

refactor(typescript): apply pull request feedback

3fd6d5d

fabioh8010 approved these changes Jan 16, 2024

View reviewed changes

filip-solecki approved these changes Jan 22, 2024

View reviewed changes

pac-guerreiro marked this pull request as ready for review January 22, 2024 17:36

pac-guerreiro requested a review from a team as a code owner January 22, 2024 17:36

melvin-bot Bot removed the request for review from a team January 22, 2024 17:36

melvin-bot Bot requested a review from jakub-trzebiatowski January 22, 2024 17:36

jakub-trzebiatowski reviewed Jan 23, 2024

View reviewed changes

Comment thread src/libs/actions/Report.ts Outdated

jakub-trzebiatowski suggested changes Jan 24, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

71389f8

…privatenotesornotfound-to-typescript

pac-guerreiro added 4 commits January 29, 2024 23:19

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

d1ea8c1

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportAndPrivateNotesOrNotFound.tsx

chore(typescript): resolve typing errors

8c2764a

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

3e32f66

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportOrNotFound.tsx

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

82af310

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportOrNotFound.tsx

chore(typescript): resolve typing issues

204b07b

jakub-trzebiatowski reviewed Feb 1, 2024

View reviewed changes

chore(typescript): apply pull request feedback

ca3b14a

pac-guerreiro added 3 commits February 2, 2024 22:44

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

af5eff3

…privatenotesornotfound-to-typescript

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

6e64db6

…privatenotesornotfound-to-typescript

fix: infinite loading when editing a private note

cbc0e7b

pac-guerreiro added 2 commits February 5, 2024 22:29

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

a6e4145

…privatenotesornotfound-to-typescript # Conflicts: # src/pages/home/report/withReportOrNotFound.tsx

refactor(typescript): add missing types

657dd5f

fix(typescript): route type issues

cfa5677

fix: infinite loader on private notes list

9b6db94

jakub-trzebiatowski approved these changes Feb 12, 2024

View reviewed changes

Merge branch 'main' into pac-guerreiro/refactor/migrate-withreportand…

f58d61f

…privatenotesornotfound-to-typescript

jakub-trzebiatowski mentioned this pull request Feb 13, 2024

[$250] [Hold for payment 2024-02-22][TS migration] Migrate 'withReportAndPrivateNotesOrNotFound.js' HOC to TypeScript #31925

Closed

cristipaval approved these changes Feb 13, 2024

View reviewed changes

cristipaval merged commit 22d82d5 into Expensify:main Feb 13, 2024

github-actions Bot mentioned this pull request Feb 13, 2024

Deploy Checklist: New Expensify 2024-02-13 #36429

Closed

Conversation

pac-guerreiro commented Jan 5, 2024 • 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!

Uh oh!

melvin-bot Bot commented Jan 22, 2024

Uh oh!

Uh oh!

jakub-trzebiatowski commented Jan 23, 2024

Uh oh!

jakub-trzebiatowski left a comment

Choose a reason for hiding this comment

Uh oh!

fabioh8010 commented Jan 25, 2024

Uh oh!

pac-guerreiro commented Jan 26, 2024

Uh oh!

pac-guerreiro commented Jan 26, 2024

Uh oh!

jakub-trzebiatowski commented Jan 29, 2024

Uh oh!

jakub-trzebiatowski commented Jan 31, 2024

Uh oh!

pac-guerreiro commented Jan 31, 2024

Uh oh!

Uh oh!

Uh oh!

jakub-trzebiatowski Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

jakub-trzebiatowski Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

pac-guerreiro Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

jakub-trzebiatowski Feb 6, 2024

Choose a reason for hiding this comment

Uh oh!

jakub-trzebiatowski commented Feb 1, 2024

Uh oh!

pac-guerreiro commented Feb 5, 2024

Uh oh!

jakub-trzebiatowski commented Feb 6, 2024

Uh oh!

pac-guerreiro commented Feb 7, 2024

Uh oh!

jakub-trzebiatowski commented Feb 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pac-guerreiro commented Feb 8, 2024

Uh oh!

jakub-trzebiatowski commented Feb 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakub-trzebiatowski commented Feb 12, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Feb 12, 2024

Uh oh!

jakub-trzebiatowski commented Feb 12, 2024

Uh oh!

pac-guerreiro commented Jan 5, 2024 •

edited

Loading

jakub-trzebiatowski commented Feb 8, 2024 •

edited

Loading

jakub-trzebiatowski commented Feb 8, 2024 •

edited

Loading