fix: 29378 Distance - Search is open in background on distance image preview #30556

tienifr · 2023-10-29T11:21:54Z

Details

Fixed Issues

$ #29378
PROPOSAL: #29378 (comment)

Tests

Open the app (web/mweb/desktop)
Open any distance request money report or raise one and open
Click on map image
Click on 3 dots to open replace popup
Click CTRL+K / CMD+K and observe that app changes URL to search but still displays map preview (search is open in background)
App closes map preview and open search on using search shortcut

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Open the app (web/mweb/desktop)
Open any distance request money report or raise one and open
Click on map image
Click on 3 dots to open replace popup
Click CTRL+K / CMD+K and observe that app changes URL to search but still displays map preview (search is open in background)
App closes map preview and open search on using search shortcut

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Screenrecorder-2023-10-29-18-02-59-704.mp4

iOS: Native

iOS: mWeb Safari

Screen.Recording.2023-10-29.at.18.02.27.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-29.at.17.55.06.mov

MacOS: Desktop

Screen.Recording.2023-10-29.at.18.19.44.mov

…preview

melvin-bot · 2023-10-29T11:22:08Z

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

ArekChr

I've noticed some issues in the parts of our app where we use setCloseModal. It seems like it’s not working correctly in all cases.

Also, I’m confused about why we are using a key and a count number for closing modals. I can’t find where we really need the count number or how it helps us. Can someone explain why we use this system? I think maybe we can make it simpler by rewriting closeModals object to an array.

src/libs/actions/Modal.ts

ArekChr · 2023-10-30T11:29:09Z

src/libs/actions/Modal.ts

+/**
+ * Get the available key that we can store the onClose callback into it
+ */
+function getAvailableKey() {


This function increases a number to make new keys. This could cause problems if we make a lot of keys over time or if many things happen at once.

src/libs/actions/Modal.ts

tienifr · 2023-11-01T09:38:29Z

@ArekChr Thanks for your review. If we use the array, how can we clear the onClose function when the modal is hidden?

ArekChr · 2023-11-06T10:40:41Z

@tienifr I think the onClose function is still there after we close the modal. We can make setOnCloseModal give back a function that clears the onClose. Then we can find this onClose by its reference instead of passing key, then remove it.

tienifr · 2023-11-07T08:45:05Z

@ArekChr Thanks for your suggestion. I just update the PR. Thanks

ArekChr · 2023-11-07T11:43:00Z

@tienifr I've noticed a regression issue with shortcuts: CMD+K or CMD+J don't open the chat or shortcuts menu as they should and only work after switching chats. On the main branch it works as expected.

src/libs/actions/Modal.ts

src/components/Modal/BaseModal.js

tienifr · 2023-11-08T04:35:43Z

@tienifr I've noticed a regression issue with shortcuts: CMD+K or CMD+J don't open the chat or shortcuts menu as they should and only work after switching chats. On the main branch it works as expected.

Ah, my bad. I forgot the case when closeModals is empty. We already implemented that case before, and I just did the same.

Thanks for your comment. I updated

ArekChr · 2023-11-08T10:42:17Z

src/libs/actions/Modal.ts

+    const reverseCloseModals = [...closeModals].reverse();
+    reverseCloseModals.forEach((onClose) => {


nit.

Suggested change

const reverseCloseModals = [...closeModals].reverse();

reverseCloseModals.forEach((onClose) => {

[...closeModals].reverse().forEach((onClose) => {

ArekChr · 2023-11-08T10:53:55Z

src/components/PopoverWithoutOverlay/index.js

-                onOpenCallback: () => Modal.setCloseModal(() => props.onClose(props.anchorRef)),
+                onCloseCallback: removeOnClose.current,
+                onOpenCallback: () => {
+                    removeOnClose.current();


Is this needed? Is this workaround associated with the logic for opening and closing modals?

Before saving onClose, we need to remove the previous one right? Although we have the logic to prevent saving duplicate onClose but we just compare the reference. It's not really correct because the reference can be changed (even they have the same mean).

ArekChr · 2023-11-08T10:59:19Z

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

mweb.chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb.safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/components/PopoverWithoutOverlay/index.js

tienifr · 2023-11-09T08:29:48Z

@ArekChr Ah I see, we can move the removeOnClose ref to useEffect and call it in cleanup function

src/components/PopoverWithoutOverlay/index.js

src/components/Modal/BaseModal.tsx

tienifr · 2023-11-17T04:55:47Z

@ArekChr Thanks for pointing that out. Updated

ArekChr

All works, skipped mobile screenshots as we don't use keyboard shortcuts here, thanks!

pecanoro · 2023-11-21T01:08:56Z

@tienifr @ArekChr The code looks good and even though we don't use the popover on mobile, the code is modifying the base modal, so please add a video or screenshot that we didn't break the modal for all platforms.

ArekChr · 2023-11-21T10:13:08Z

@pecanoro Uploaded videos for all mobile platforms. Let me know if we can test more modal use cases to ensure everything works properly.

OSBotify · 2023-11-21T16:40:46Z

✋ 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 · 2023-11-22T01:02:36Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.2-0 🚀

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

OSBotify · 2023-11-23T16:54:08Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.2-3 🚀

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

hoangzinh · 2024-02-15T10:56:46Z

src/components/PopoverWithoutOverlay/index.js

        if (props.isVisible) {
            props.onModalShow();
            onOpen({
                ref: props.withoutOverlayRef,
                close: props.onClose,
                anchorRef: props.anchorRef,
-                onCloseCallback: () => Modal.setCloseModal(null),
-                onOpenCallback: () => Modal.setCloseModal(() => props.onClose(props.anchorRef)),


Coming from #32743, it looks like we haven't removed these two callbacks completely, so it caused that bug.

fix: 29378 Distance - Search is open in background on distance image …

66b2c82

…preview

tienifr marked this pull request as ready for review October 29, 2023 11:22

tienifr requested a review from a team as a code owner October 29, 2023 11:22

melvin-bot bot requested review from ArekChr and removed request for a team October 29, 2023 11:22

ArekChr suggested changes Oct 30, 2023

View reviewed changes

refactor

a342b16

tienifr added 2 commits November 7, 2023 11:32

Merge branch 'main' into fix/29378

e0aa070

change to use list

50df7a9

ArekChr reviewed Nov 7, 2023

View reviewed changes

src/libs/actions/Modal.ts Outdated Show resolved Hide resolved

src/libs/actions/Modal.ts Outdated Show resolved Hide resolved

src/libs/actions/Modal.ts Outdated Show resolved Hide resolved

src/libs/actions/Modal.ts Outdated Show resolved Hide resolved

ArekChr reviewed Nov 7, 2023

View reviewed changes

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

ArekChr reviewed Nov 7, 2023

View reviewed changes

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

ArekChr reviewed Nov 7, 2023

View reviewed changes

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

tienifr added 3 commits November 8, 2023 11:11

Merge branch 'main' into fix/29378

b2d793b

clean code

ab389fb

prevent duplicate

d81596b

ArekChr reviewed Nov 8, 2023

View reviewed changes

src/components/PopoverWithoutOverlay/index.js Outdated Show resolved Hide resolved

clean code

f58d0ba

merge main

52bfddc

ArekChr reviewed Nov 16, 2023

View reviewed changes

src/components/PopoverWithoutOverlay/index.js Outdated Show resolved Hide resolved

ArekChr reviewed Nov 16, 2023

View reviewed changes

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

tienifr added 2 commits November 17, 2023 11:49

Merge branch 'main' into fix/29378

58d740c

add type check

2f0e1ee

ArekChr approved these changes Nov 17, 2023

View reviewed changes

melvin-bot bot requested a review from pecanoro November 17, 2023 09:26

pecanoro approved these changes Nov 21, 2023

View reviewed changes

pecanoro merged commit 6507621 into Expensify:main Nov 21, 2023
16 checks passed

github-actions bot mentioned this pull request Nov 22, 2023

Deploy Checklist: New Expensify 2023-11-22 #31667

Closed

62 tasks

melvin-bot bot mentioned this pull request Nov 23, 2023

[HOLD for payment 2023-11-30] [$500] Distance - Search is open in background on distance image preview #29378

Closed

6 tasks

trjExpensify mentioned this pull request Nov 24, 2023

[HOLD for payment 2024-02-07] [$500] Search Page opens in Background when delete Reciept Confirm Modal is visible #29511

Closed

6 tasks

Pujan92 mentioned this pull request Dec 11, 2023

[PAID] [LOW] [$500] Web - Chat - Console error shows up when opening emoji picker and then clicking on send button #32743

Closed

6 tasks

hoangzinh reviewed Feb 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: 29378 Distance - Search is open in background on distance image preview #30556

fix: 29378 Distance - Search is open in background on distance image preview #30556

tienifr commented Oct 29, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Oct 29, 2023

ArekChr left a comment

ArekChr Oct 30, 2023

tienifr commented Nov 1, 2023

ArekChr commented Nov 6, 2023 •

edited

Loading

tienifr commented Nov 7, 2023

ArekChr commented Nov 7, 2023

tienifr commented Nov 8, 2023 •

edited

Loading

ArekChr Nov 8, 2023

ArekChr Nov 8, 2023

tienifr Nov 8, 2023

ArekChr commented Nov 8, 2023 •

edited

Loading

tienifr commented Nov 9, 2023

tienifr commented Nov 17, 2023

ArekChr left a comment

pecanoro commented Nov 21, 2023

ArekChr commented Nov 21, 2023

OSBotify commented Nov 21, 2023

OSBotify commented Nov 22, 2023

OSBotify commented Nov 23, 2023

hoangzinh Feb 15, 2024

		const reverseCloseModals = [...closeModals].reverse();
		reverseCloseModals.forEach((onClose) => {

	const reverseCloseModals = [...closeModals].reverse();
	reverseCloseModals.forEach((onClose) => {
	[...closeModals].reverse().forEach((onClose) => {

fix: 29378 Distance - Search is open in background on distance image preview #30556

fix: 29378 Distance - Search is open in background on distance image preview #30556

Conversation

tienifr commented Oct 29, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 29, 2023

ArekChr left a comment

Choose a reason for hiding this comment

ArekChr Oct 30, 2023

Choose a reason for hiding this comment

tienifr commented Nov 1, 2023

ArekChr commented Nov 6, 2023 • edited Loading

tienifr commented Nov 7, 2023

ArekChr commented Nov 7, 2023

tienifr commented Nov 8, 2023 • edited Loading

ArekChr Nov 8, 2023

Choose a reason for hiding this comment

ArekChr Nov 8, 2023

Choose a reason for hiding this comment

tienifr Nov 8, 2023

Choose a reason for hiding this comment

ArekChr commented Nov 8, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

tienifr commented Nov 9, 2023

tienifr commented Nov 17, 2023

ArekChr left a comment

Choose a reason for hiding this comment

pecanoro commented Nov 21, 2023

ArekChr commented Nov 21, 2023

OSBotify commented Nov 21, 2023

OSBotify commented Nov 22, 2023

OSBotify commented Nov 23, 2023

hoangzinh Feb 15, 2024

Choose a reason for hiding this comment

tienifr commented Oct 29, 2023 •

edited by github-actions bot

Loading

ArekChr commented Nov 6, 2023 •

edited

Loading

tienifr commented Nov 8, 2023 •

edited

Loading

ArekChr commented Nov 8, 2023 •

edited

Loading