Add cancel function when you select an option in search and navigate away from the optionList #42471

rinej · 2024-05-22T13:25:57Z

Details

Issue:
Currently, when you use search in New Expensify, we show results progressively and put the "best result" at the top. However a query for the full optionList always finishes after you've started it, even if you navigate away from the page that is performing the command.

Proposal
We implemented the feature using the AbortController mechanism, which is part of the Fetch API. We created a dedicated AbortController for the SearchForReports command. This allows us to precisely control the cancellation of requests associated with this particular operation without affecting other asynchronous tasks. When selecting a report and initiating navigation, the AbortController associated with SearchForReports is triggered to cancel the requests. This ensures that ONLY pending search operations are stopped immediately.

If necessary this feature can be extended in the future by adding additional abort controllers.

Cancel_Api.mp4

Fixed Issues

$ #42384
PROPOSAL: https://callstack-hq.slack.com/archives/C05R2V5GM1S/p1716455384907969

Tests

Offline tests

QA Steps

Open search in Report Screen
Type something in the Search Input
Remove some characters and type again
Click on Report
Report should load properly

Additionally you can check that any pending requests for SearchForReports are cancelled (see the above video for details)

Repeat above steps for RHL

Click on big plus button
Click on start chat
Proceed with report search

PR Author Checklist

Screenshots/Videos

Android: Native

cancel-android.mp4

Android: mWeb Chrome

cancel-android-web.mp4

iOS: Native

cancel-ios.mp4

iOS: mWeb Safari

cancel-ios-web.mp4

MacOS: Chrome / Safari

cancel-web.mp4

MacOS: Desktop

cancel-desktop.mp4

adhorodyski · 2024-05-22T21:54:04Z

src/libs/HttpUtils.ts

@@ -14,6 +14,8 @@ import HttpsError from './Errors/HttpsError';
 let shouldFailAllRequests = false;
 let shouldForceOffline = false;

+type AbortCommand = 'All' | 'SearchForReports';


I think you can infer this based on API commands (typeof consts) OR 'All'?

gedu · 2024-05-23T06:30:32Z

src/pages/ChatFinderPage/index.tsx

@@ -143,6 +144,8 @@ function ChatFinderPage({betas, isSearchingForReports, navigation}: ChatFinderPa
            return;
        }

+        HttpUtils.cancelPendingRequests('SearchForReports');


I would use the READ_COMMANDS.SEARCH_FOR_REPORTS

gedu · 2024-05-23T06:31:06Z

src/libs/HttpUtils.ts

 }

-function cancelPendingRequests() {
-    cancellationController.abort();
+function cancelPendingRequests(command: AbortCommand = 'All') {


Probably would be good to add a new const in I would use the READ_COMMANDS object

mountiny · 2024-05-23T09:55:21Z

Running a build https://github.com/Expensify/App/actions/runs/9205926408

gedu · 2024-05-24T05:21:52Z

src/libs/HttpUtils.ts

+    SearchForReports: READ_COMMANDS.SEARCH_FOR_REPORTS,
+} as const;
+
+type AbortCommand = (typeof ABORT_COMMANDS)[keyof typeof ABORT_COMMANDS];


I think this can be simplified with

type AbortCommand = keyof typeof ABORT_COMMANDS;

gedu · 2024-05-24T05:29:55Z

src/libs/HttpUtils.ts

 import * as ApiUtils from './ApiUtils';
 import HttpsError from './Errors/HttpsError';

 let shouldFailAllRequests = false;
 let shouldForceOffline = false;

+const ABORT_COMMANDS = {
+    All: 'All',
+    SearchForReports: READ_COMMANDS.SEARCH_FOR_REPORTS,


Do we want to keep the names in sync? if true probably something like this is better

const ABORT_COMMANDS = { All: 'All', [READ_COMMANDS.SEARCH_FOR_REPORTS]: READ_COMMANDS.SEARCH_FOR_REPORTS, } as const;

thanks! Good point!

melvin-bot · 2024-05-24T14:24:08Z

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

shubham1206agra · 2024-05-28T11:47:11Z

@rinej Can you merge main please?

…option-in-search

shubham1206agra · 2024-05-30T11:34:27Z

@mountiny Can you run an ad hoc build here to test this on physical device?

mountiny · 2024-05-30T11:50:25Z

https://github.com/Expensify/App/actions/runs/9302013073

github-actions · 2024-05-30T12:23:39Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/42471/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/42471/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/42471/NewExpensify.dmg	https://42471.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

shubham1206agra · 2024-05-30T14:35:11Z

@rinej I am unable to see any API request for SearchForReports in Desktop. Can you please check this?

Edit - nvm, now it is showing API request.

shubham1206agra · 2024-05-30T15:47:23Z

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 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 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 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.
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: mWeb Chrome

Screen.Recording.2024-05-30.at.5.25.16.PM.mov

iOS: Native

Screen.Recording.2024-05-30.at.8.35.03.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-05-30.at.5.11.44.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-30.at.5.02.24.PM.mp4

MacOS: Desktop

Screen.Recording.2024-05-30.at.8.07.58.PM.mov

mountiny

Thanks @rinej changes look good to me

OSBotify · 2024-06-06T12:34:52Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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

feat: add specific api abort controller

c8a404f

adhorodyski reviewed May 22, 2024

View reviewed changes

gedu reviewed May 23, 2024

View reviewed changes

mountiny assigned rinej May 23, 2024

mountiny added the Ready To Build label May 23, 2024

mountiny requested a review from shubham1206agra May 23, 2024 09:53

This comment has been minimized.

Sign in to view

rinej added 3 commits May 23, 2024 13:40

refactor: use read_commands const

e61b980

fix: fix typescript

e0b0ec6

feat: add hook for canceling search request

c0ce318

gedu reviewed May 24, 2024

View reviewed changes

refactor: adjust types

aba3b93

rinej marked this pull request as ready for review May 24, 2024 14:24

rinej requested a review from a team as a code owner May 24, 2024 14:24

melvin-bot bot requested review from mountiny and removed request for a team May 24, 2024 14:24

feat: add cancel function to all right modal panels

56989c9

rinej added 2 commits May 28, 2024 16:07

Merge branch 'main' into feat/Add-cancel-function-when-you-select-an-…

e7d0ceb

…option-in-search

Merge branch 'main' into feat/Add-cancel-function-when-you-select-an-…

fd3a6eb

…option-in-search

shubham1206agra approved these changes May 30, 2024

View reviewed changes

mountiny approved these changes May 30, 2024

View reviewed changes

mountiny merged commit b4c7110 into Expensify:main May 30, 2024
16 checks passed

github-actions bot mentioned this pull request Jun 4, 2024

Deploy Checklist: New Expensify 2024-06-04 #43037

Closed

melvin-bot bot mentioned this pull request Jun 6, 2024

[$250] [HOLD for payment 2024-06-13] HIGH: [API Reliability] Add cancel function when you select an option in search and navigate away from the optionList #42384

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cancel function when you select an option in search and navigate away from the optionList #42471

Add cancel function when you select an option in search and navigate away from the optionList #42471

rinej commented May 22, 2024 •

edited

Loading

adhorodyski May 22, 2024

gedu May 23, 2024

gedu May 23, 2024

mountiny commented May 23, 2024

This comment has been minimized.

gedu May 24, 2024

gedu May 24, 2024

rinej May 24, 2024

melvin-bot bot commented May 24, 2024

shubham1206agra commented May 28, 2024

shubham1206agra commented May 30, 2024

mountiny commented May 30, 2024

github-actions bot commented May 30, 2024

shubham1206agra commented May 30, 2024 •

edited

Loading

shubham1206agra commented May 30, 2024

mountiny left a comment

OSBotify commented Jun 6, 2024

Add cancel function when you select an option in search and navigate away from the optionList #42471

Add cancel function when you select an option in search and navigate away from the optionList #42471

Conversation

rinej commented May 22, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

adhorodyski May 22, 2024

Choose a reason for hiding this comment

gedu May 23, 2024

Choose a reason for hiding this comment

gedu May 23, 2024

Choose a reason for hiding this comment

mountiny commented May 23, 2024

This comment has been minimized.

gedu May 24, 2024

Choose a reason for hiding this comment

gedu May 24, 2024

Choose a reason for hiding this comment

rinej May 24, 2024

Choose a reason for hiding this comment

melvin-bot bot commented May 24, 2024

shubham1206agra commented May 28, 2024

shubham1206agra commented May 30, 2024

mountiny commented May 30, 2024

github-actions bot commented May 30, 2024

shubham1206agra commented May 30, 2024 • edited Loading

shubham1206agra commented May 30, 2024

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 6, 2024

rinej commented May 22, 2024 •

edited

Loading

shubham1206agra commented May 30, 2024 •

edited

Loading