Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TS Migration] Remove EmptyObject type #42851

Merged
merged 37 commits into from
Jun 26, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented May 30, 2024

Details

This PR investigates and removes usages of EmptyObject type.

Fixed Issues

$ #39124
PROPOSAL:

Tests

  1. Verify basic flows: IOU, chat, map, mention, task work properly
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

  1. Verify basic flows: IOU, chat, map, mention, task work properly
  • 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 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
video_2024-06-21_16-53-53.mp4
Android: mWeb Chrome
video_2024-06-21_16-53-50.mp4
iOS: Native
Untitled.mov
iOS: mWeb Safari
Screen.Recording.2024-06-21.at.16.25.38-compressed.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-21.at.16.07.58-compressed.mov
MacOS: Desktop
Screen.Recording.2024-06-21.at.16.15.22-compressed.mov

@tienifr tienifr marked this pull request as ready for review May 30, 2024 21:14
@tienifr tienifr requested a review from a team as a code owner May 30, 2024 21:14
@melvin-bot melvin-bot bot requested review from mkhutornyi and removed request for a team May 30, 2024 21:14
Copy link

melvin-bot bot commented May 30, 2024

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

Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very promising! 🚀

How about EmptyObject usage in src/components/PopoverProvider/types.ts and src/hooks/useKeyboardShortcut.ts?

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/migrations/CheckForPreviousReportActionID.ts Outdated Show resolved Hide resolved
src/libs/OptionsListUtils.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy/Policy.ts Outdated Show resolved Hide resolved
@VickyStash
Copy link
Contributor

@tienifr Could you please explain why receipt typing updates where done? Also, why do you sometimes use OnyxEntry<Receipt> and sometimes just Receipt | null during that updates?

@fabioh8010
Copy link
Contributor

@tienifr bump, and we have conflicts now

@tienifr
Copy link
Contributor Author

tienifr commented Jun 6, 2024

Do we need to write a test to make sure no one would use it in the future?

it('does not export getParentReport', () => {

@tienifr
Copy link
Contributor Author

tienifr commented Jun 6, 2024

These lints are not related to this PR.

@mkhutornyi
Copy link
Contributor

Looks good so far. @tienifr please add screen recordings, along with fixing conflict.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 21, 2024

@mkhutornyi Updated! Please prioritize this because we get more and more conflicts every day.

@srikarparsi
Copy link
Contributor

Looks like there are more conflicts already @tienifr

@tienifr
Copy link
Contributor Author

tienifr commented Jun 24, 2024

@mkhutornyi All done. Same reminder above ^.

@srikarparsi
Copy link
Contributor

@mkhutornyi please let me know after you review so that we can merge before there's conflicts again

@srikarparsi
Copy link
Contributor

Looks like there's a conflict but @mkhutornyi please review/add screenshots anyway. The conflicts look relatively small and I will also review them before merging after @tienifr fixes.

@srikarparsi
Copy link
Contributor

@mkhutornyi is there any update here?

@mkhutornyi
Copy link
Contributor

I've been testing various flows. Will complete soon

@mkhutornyi
Copy link
Contributor

create task & assign not working. Also reproducible on main so not blocker

Screenshot 2024-06-25 at 10 29 50 PM

Copy link
Contributor

@mkhutornyi mkhutornyi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good except conflict

@melvin-bot melvin-bot bot requested a review from srikarparsi June 26, 2024 04:50
@srikarparsi
Copy link
Contributor

srikarparsi commented Jun 26, 2024

Thanks @mkhutornyi, I know screenshots/videos are a little difficult for this one but if you could add some type of screenshots that would just help check off the requirement for this.

@tienifr, I'm reviewing now but if you could fix the conflict whenever you have a chance that would be great. I think you might just be able to replace the {} with null.

srikarparsi
srikarparsi previously approved these changes Jun 26, 2024
Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me as well apart from the conflict. Thanks everyone! @tienifr please let me know once you get around to resolving the conflict and I can re-approve and merge. There seems to be a couple more now.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 26, 2024

On it.

Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great thanks!

@srikarparsi srikarparsi merged commit 811f154 into Expensify:main Jun 26, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

OSBotify commented Jul 3, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants