[TS Migration] migrate PopoverWithoutOverlay.js to TypeScript #32171

JKobrynski · 2023-11-29T09:57:37Z

Details

Fixed Issues

$ #25051
PROPOSAL: N/A

Tests

Log into the app (web or desktop, make sure the window is big)
Navigate to any chat
Test the popover that appears when you click on the + button (to add an attachment, task etc.)
Make sure the popover works as expected

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests section above

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

This component is only rendered on big screens, so it doesn't exist on mobile devices

MacOS: Chrome / Safari

web-compressed.mov

MacOS: Desktop

desktop-compressed.mov

rezkiy37

Left comments.

src/components/Modal/BaseModal.tsx

src/components/PopoverWithoutOverlay/index.tsx

rezkiy37

LGTM.

src/components/PopoverWithoutOverlay/types.ts

src/components/PopoverWithoutOverlay/index.tsx

JKobrynski · 2023-11-30T14:24:21Z

@fabioh8010 PR updated!

melvin-bot · 2023-12-04T13:55:46Z

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

JKobrynski · 2023-12-13T13:35:36Z

@mountiny could you help with assigning this to a reviewer? 😄

situchan · 2023-12-13T15:11:56Z

Interested in reviewing this

src/components/Modal/BaseModal.tsx

mountiny · 2023-12-14T11:05:42Z

@situchan lets complete the checklist on this one thanks!

situchan · 2023-12-27T11:14:16Z

src/components/PopoverWithoutOverlay/types.ts

+        disableAnimation?: boolean;
+
+        /** The ref of the popover */
+        withoutOverlayRef: React.RefObject<HTMLElement & View>;


Any issue with this suggestion?

Suggested change

withoutOverlayRef: React.RefObject<HTMLElement & View>;

withoutOverlayRef?: React.RefObject<HTMLElement>;

@situchan I've found only one PopoverWithoutOverlay component usage and it's not optional. If we get rid of View in withoutOverlayRef typing we will have TS issue since this ref is then passed to the View. What do you think?

ok and what about & View part?
No issue itself but just asking because it's inconsistent with other ref typings

@situchan As I mentioned, if we get rid of & View part we will have TS issue in the place where we pass withoutOverlayRef to the View ref.

We also have similar cases in the code: one, two

ok no problem

situchan · 2023-12-27T12:34:17Z

Please complete missing checklist items

VickyStash · 2023-12-27T12:37:54Z

The author checklist is failing due to missed checkboxes, but I can't add it since I'm not the author...

mountiny · 2023-12-27T13:03:30Z

I have updated the checklist @situchan can you please proceed with the review? Seems like there is something odd with this one and its not worth digging into now

situchan · 2023-12-27T13:22:18Z

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

Not affected. Though tested on iOS for safety

Android: mWeb Chrome

Not affected. Though tested on mSafari for safety

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

mountiny

Thank you!

mountiny · 2023-12-27T15:24:33Z

src/components/PopoverWithoutOverlay/types.ts

+        /** The anchor ref of the popover */
+        anchorRef: React.RefObject<HTMLElement>;
+
+        /** A react-native-animatable animation timing for the modal display animation. */


NAB

Suggested change

/** A react-native-animatable animation timing for the modal display animation. */

/** A react-native-animatable animation timing for the modal display animation */

OSBotify · 2023-12-28T21:18:54Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.18-8 🚀

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

JKobrynski added 2 commits November 29, 2023 10:56

migrate PopoverWithoutOverlay.js to TypeScript

a763f00

fix type error in BaseModal

e1afa7c

rezkiy37 reviewed Nov 29, 2023

View reviewed changes

import hooks from react

cd4167d

JKobrynski requested a review from rezkiy37 November 29, 2023 12:16

rezkiy37 reviewed Nov 29, 2023

View reviewed changes

fabioh8010 reviewed Nov 30, 2023

View reviewed changes

make anchorRef a required prop, conditional onOpen call

c5a6418

JKobrynski requested review from fabioh8010 and rezkiy37 November 30, 2023 14:07

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

eb67796

fabioh8010 approved these changes Dec 1, 2023

View reviewed changes

JKobrynski added 2 commits December 1, 2023 09:46

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

37e25e6

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

1902913

BartoszGrajdek approved these changes Dec 4, 2023

View reviewed changes

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

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

melvin-bot bot removed request for a team and rezkiy37 December 4, 2023 13:55

JKobrynski mentioned this pull request Dec 4, 2023

[HOLD for payment 2024-01-04] [TS migration] Migrate 'PopoverWithoutOverlay' component to TypeScript #25051

Closed

JKobrynski added 2 commits December 7, 2023 16:03

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

e930f45

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

8c62fe2

JKobrynski marked this pull request as draft December 11, 2023 06:56

JKobrynski marked this pull request as ready for review December 11, 2023 06:56

situchan reviewed Dec 13, 2023

View reviewed changes

src/components/Modal/BaseModal.tsx Outdated Show resolved Hide resolved

src/components/Modal/BaseModal.tsx Outdated Show resolved Hide resolved

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

a9b2af2

apply suggested change

5c0950d

JKobrynski requested a review from situchan December 14, 2023 10:01

situchan reviewed Dec 27, 2023

View reviewed changes

Merge branch 'main' into migratePopoverWithoutOverlayToTypeScript

3aaecb1

mountiny assigned JKobrynski Dec 27, 2023

situchan approved these changes Dec 27, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny December 27, 2023 13:25

mountiny previously approved these changes Dec 27, 2023

View reviewed changes

Remove extra dot in the comment

030d6b3

VickyStash dismissed mountiny’s stale review via 030d6b3 December 27, 2023 15:30

mountiny approved these changes Dec 27, 2023

View reviewed changes

mountiny merged commit 68b3f22 into Expensify:main Dec 27, 2023
16 checks passed

github-actions bot mentioned this pull request Dec 27, 2023

Deploy Checklist: New Expensify 2023-12-27 #33644

Closed

41 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] migrate PopoverWithoutOverlay.js to TypeScript #32171

[TS Migration] migrate PopoverWithoutOverlay.js to TypeScript #32171

JKobrynski commented Nov 29, 2023 •

edited by mountiny

Loading

rezkiy37 left a comment

rezkiy37 left a comment

JKobrynski commented Nov 30, 2023

melvin-bot bot commented Dec 4, 2023

JKobrynski commented Dec 13, 2023

situchan commented Dec 13, 2023

mountiny commented Dec 14, 2023

situchan Dec 27, 2023

VickyStash Dec 27, 2023

situchan Dec 27, 2023

VickyStash Dec 27, 2023

situchan Dec 27, 2023

situchan commented Dec 27, 2023

VickyStash commented Dec 27, 2023

mountiny commented Dec 27, 2023

situchan commented Dec 27, 2023

mountiny left a comment

mountiny Dec 27, 2023

OSBotify commented Dec 28, 2023

	withoutOverlayRef: React.RefObject<HTMLElement & View>;
	withoutOverlayRef?: React.RefObject<HTMLElement>;

	/** A react-native-animatable animation timing for the modal display animation. */
	/** A react-native-animatable animation timing for the modal display animation */

[TS Migration] migrate PopoverWithoutOverlay.js to TypeScript #32171

[TS Migration] migrate PopoverWithoutOverlay.js to TypeScript #32171

Conversation

JKobrynski commented Nov 29, 2023 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

rezkiy37 left a comment

Choose a reason for hiding this comment

JKobrynski commented Nov 30, 2023

melvin-bot bot commented Dec 4, 2023

JKobrynski commented Dec 13, 2023

situchan commented Dec 13, 2023

mountiny commented Dec 14, 2023

situchan Dec 27, 2023

Choose a reason for hiding this comment

VickyStash Dec 27, 2023

Choose a reason for hiding this comment

situchan Dec 27, 2023

Choose a reason for hiding this comment

VickyStash Dec 27, 2023

Choose a reason for hiding this comment

situchan Dec 27, 2023

Choose a reason for hiding this comment

situchan commented Dec 27, 2023

VickyStash commented Dec 27, 2023

mountiny commented Dec 27, 2023

situchan commented Dec 27, 2023

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny Dec 27, 2023

Choose a reason for hiding this comment

OSBotify commented Dec 28, 2023

JKobrynski commented Nov 29, 2023 •

edited by mountiny

Loading