Migrate search page to chat finder page by adamgrzybowski · Pull Request #40129 · Expensify/App

adamgrzybowski · 2024-04-11T16:12:26Z

Details

This PR request renames the current search page to ChatFinder.

Fixed Issues

$ #39885
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

First test

Open url: /chat-finder and see if the right page is opened

Second test

Open home
Press magnifying glass icon and see if the right page is opened

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

luacmartins

Looking good. Left a few minor comments and asked for marketing input.

luacmartins · 2024-04-15T15:39:48Z

 const tests: Tests = {
    [E2EConfig.TEST_NAMES.AppStartTime]: require('./tests/appStartTimeTest.e2e').default,
-    [E2EConfig.TEST_NAMES.OpenSearchPage]: require('./tests/openSearchPageTest.e2e').default,
+    // ASK: Should we also update this name?


Yes, I think we can update this one since it's just a require``

luacmartins · 2024-04-15T15:40:04Z

 const test = () => {
    // check for login (if already logged in the action will simply resolve)
-    console.debug('[E2E] Logging in for search');
+    console.debug('[E2E] Logging in for chat finding');


Suggested change

console.debug('[E2E] Logging in for chat finding');

console.debug('[E2E] Logging in for chat finder');

luacmartins · 2024-04-15T15:40:12Z

        }

-        console.debug('[E2E] Logged in, getting search metrics and submitting them…');
+        console.debug('[E2E] Logged in, getting chat finding metrics and submitting them…');


Suggested change

console.debug('[E2E] Logged in, getting chat finding metrics and submitting them…');

console.debug('[E2E] Logged in, getting chat finder metrics and submitting them…');

luacmartins · 2024-04-15T16:00:49Z

+        // ASK: Should we also update this name?
+        CHAT_FINDER_RENDER: 'chat_finder',


Hmm it seems like we save this metric to Firebase and Grafana. So Maybe we should just rename the key, but leave the value as is.

Suggested change

// ASK: Should we also update this name?

CHAT_FINDER_RENDER: 'chat_finder',

CHAT_FINDER_RENDER: 'search_render',

luacmartins · 2024-04-15T16:03:55Z

+    // ASK: Should we also update this name?
+    Timing.end(CONST.TIMING.CHAT_FINDER_RENDER);
+    Performance.markEnd(CONST.TIMING.CHAT_FINDER_RENDER);


Yea, I think we should update the key, but leave the value of the key as is.

Suggested change

// ASK: Should we also update this name?

Timing.end(CONST.TIMING.CHAT_FINDER_RENDER);

Performance.markEnd(CONST.TIMING.CHAT_FINDER_RENDER);

Timing.end(CONST.TIMING.CHAT_FINDER_RENDER);

Performance.markEnd(CONST.TIMING.CHAT_FINDER_RENDER);

luacmartins · 2024-04-15T16:04:09Z

+        // ASK: Should we also update this name?
+        Timing.start(CONST.TIMING.CHAT_FINDER_RENDER);
+        Performance.markStart(CONST.TIMING.CHAT_FINDER_RENDER);


Suggested change

// ASK: Should we also update this name?

Timing.start(CONST.TIMING.CHAT_FINDER_RENDER);

Performance.markStart(CONST.TIMING.CHAT_FINDER_RENDER);

Timing.start(CONST.TIMING.CHAT_FINDER_RENDER);

Performance.markStart(CONST.TIMING.CHAT_FINDER_RENDER);

luacmartins · 2024-04-15T16:06:56Z

            navigation={navigation}
        >
            <HeaderWithBackButton
+                // ASK: What text do we want to use for the title?


@Expensify/marketing could you take a look at this one? We're introducing a new search page, so the current search page will need to be renamed. I suggested to use Find here, but would love your opinion. For reference, this is the page

Once we resolve that, I'll record videos for this PR :)

@luacmartins can you actually bring this question out into #marketing? This seems like a slightly larger change that we should discuss and align on first in Slack. Thanks!

luacmartins · 2024-04-15T16:10:15Z

+    // ASK: Should we also update this name?
+    OpenChatFinderPage: 'Open chat finder page TTI',


Yea, we should. I don't think this value is being saved anywhere (at least I couldn't find that in code)

melvin-bot · 2024-04-15T16:34:09Z

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

luacmartins

LGTM! I won't block on the copy for the search page title as that's an easy thing to update as a follow up.

luacmartins · 2024-04-16T15:30:47Z

@alitoshmatov could you start the review on this one please?

alitoshmatov · 2024-04-16T19:39:49Z

There is an issue when typing, typing stops and input is losing focus unexpectedly.

Screen.Recording.2024-04-17.at.12.28.32.AM.mov

WojtekBoman · 2024-04-17T08:43:26Z

There is an issue when typing, typing stops and input is losing focus unexpectedly.

Screen.Recording.2024-04-17.at.12.28.32.AM.mov

This issue isn't caused by this PR, it also occurs on the main branch. The PR with a fix for that issue is currently in review :)

alitoshmatov · 2024-04-17T15:08: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

https://github.com/Expensify/App/assets/59907218/e36d18f4-8478-4898-81b7-0157e728d8f7

Android: mWeb Chrome

iOS: Native

find-ios.mp4

iOS: mWeb Safari

find-safari.mp4

MacOS: Chrome / Safari

MacOS: Desktop

alitoshmatov

LGTM!

luacmartins · 2024-04-17T15:24:19Z

Gonna merge this one to get things going with the Search page. I'll bump marketing on the new title for the Finder page.

OSBotify · 2024-04-17T15:31:17Z

✋ 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-04-18T04:59:38Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.63-0 🚀

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

blimpich · 2024-04-19T19:19:40Z

It looks like the e2e performance tests have been consistently failing since this PR was merged. See failed e2e test here for this PR that happened once this change hit main.

I found this out by looking at the list of builds for preDeploy.yml here and noticing that every merged PR starting with this PR fails (excluding version bump PRs which skip many of our test builds). Can we look into this?

luacmartins · 2024-04-19T23:25:40Z

@adamgrzybowski @WojtekBoman could you take a look?

OSBotify · 2024-04-22T15:00:37Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

migrate search page to chat finder page

46b6a09

adamgrzybowski force-pushed the migrate-search-page-to-chat-finder-page branch from 1777e80 to 46b6a09 Compare April 11, 2024 16:22

luacmartins self-requested a review April 11, 2024 16:33

Merge branch 'main' into migrate-search-page-to-chat-finder-page

223099a

luacmartins requested changes Apr 15, 2024

View reviewed changes

luacmartins marked this pull request as ready for review April 15, 2024 16:34

luacmartins requested a review from a team as a code owner April 15, 2024 16:34

melvin-bot Bot requested review from alitoshmatov and removed request for a team April 15, 2024 16:34

WojtekBoman added 2 commits April 16, 2024 10:23

Merge branch 'main' into migrate-search-page-to-chat-finder-page

50bcada

Remove comments

86a01f7

luacmartins approved these changes Apr 16, 2024

View reviewed changes

WojtekBoman mentioned this pull request Apr 17, 2024

[Search v1] Implement Search navigation logic #40280

Merged

50 tasks

alitoshmatov approved these changes Apr 17, 2024

View reviewed changes

melvin-bot Bot requested a review from luacmartins April 17, 2024 15:08

luacmartins approved these changes Apr 17, 2024

View reviewed changes

luacmartins merged commit 8cc40c4 into Expensify:main Apr 17, 2024

github-actions Bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

	console.debug('[E2E] Logging in for chat finding');
	console.debug('[E2E] Logging in for chat finder');

	console.debug('[E2E] Logged in, getting chat finding metrics and submitting them…');
	console.debug('[E2E] Logged in, getting chat finder metrics and submitting them…');

		// ASK: Should we also update this name?
		CHAT_FINDER_RENDER: 'chat_finder',

	// ASK: Should we also update this name?
	CHAT_FINDER_RENDER: 'chat_finder',
	CHAT_FINDER_RENDER: 'search_render',

		// ASK: Should we also update this name?
		OpenChatFinderPage: 'Open chat finder page TTI',

Uh oh!

Conversation

adamgrzybowski commented Apr 11, 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!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Apr 15, 2024

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Apr 16, 2024

Uh oh!

alitoshmatov commented Apr 16, 2024

Uh oh!

WojtekBoman commented Apr 17, 2024

Uh oh!

alitoshmatov commented Apr 17, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

alitoshmatov left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Apr 17, 2024

Uh oh!

OSBotify commented Apr 17, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

blimpich commented Apr 19, 2024

Uh oh!

luacmartins commented Apr 19, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

adamgrzybowski commented Apr 11, 2024 •

edited

Loading