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

Search result duplication #43164

Conversation

gedu
Copy link
Contributor

@gedu gedu commented Jun 6, 2024

Details

Fixed Issues

$ #43094
PROPOSAL: #43094 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

Case 1:

  • Create Workspace as Alice
  • Add couple members including Bob
  • Create couple rooms on that workspace
  • Sign into an Bob's account
  • Search for the rooms created
  • One rooms should appear, never duplicated

Case 2:

  • Create a Workspace with any name, like Testin1234
  • Search for a Room in that workspace
  • Change the name of the created Workspace, like Testing
  • Search for the Room again
  • The workspace name should be updated

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
duplicateSearch_android.mp4
Android: mWeb Chrome
duplicateSearch_androidChrome.mp4
iOS: Native
duplicateSearch_ios.mp4
iOS: mWeb Safari
duplicateSearch_iosSafari.mp4
MacOS: Chrome / Safari
duplicateSearch_chrome.mp4
duplicateSearch_safari.mp4
MacOS: Desktop
duplicateSearch_desktop.mp4

@gedu gedu marked this pull request as ready for review June 12, 2024 13:14
@gedu gedu requested a review from a team as a code owner June 12, 2024 13:14
@melvin-bot melvin-bot bot removed the request for review from a team June 12, 2024 13:14
Copy link

melvin-bot bot commented Jun 12, 2024

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

@melvin-bot melvin-bot bot requested a review from ahmedGaber93 June 12, 2024 13:14
@@ -787,9 +787,7 @@ function openReport(
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT}${reportID}`,
value: {
errorFields: {
notFound: null,
},
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you commit this change by false.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, sorry I should add a comment on the PR, this change is because of this discussion: https://callstack-hq.slack.com/archives/C05LX9D6E07/p1717509334788509?thread_ts=1717508731.782149&cid=C05LX9D6E07

Copy link
Contributor

Choose a reason for hiding this comment

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

I didn't have access to this channel. Is there is any test steps for it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, it was a bug that happen to David, and with @mountiny didn't know well how it happens. But it seems that not all the errors were cleaned up successfully.

Copy link
Contributor

Choose a reason for hiding this comment

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

@gedu this change seems wrong and is incorrectly clearing all report errors. I'm intending on reverting it. I'm not sure which issue you were trying to fix with this change (I don't have access to that slack conversation either) but this is probably not the right way to fix it.

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented Jun 13, 2024

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
20240613150721241.mp4
Android: mWeb Chrome
aw.mp4
iOS: Native
i.mp4
iOS: mWeb Safari
iw.mp4
MacOS: Chrome / Safari
w.mp4
MacOS: Desktop
d.mp4

@ahmedGaber93
Copy link
Contributor

@gedu Could you please add tests step?

Copy link
Contributor

@ahmedGaber93 ahmedGaber93 left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from Beamanator June 13, 2024 15:03
@Beamanator
Copy link
Contributor

Sorry is this still WIP or ready for final review?

@ahmedGaber93
Copy link
Contributor

@Beamanator, it is ready for final review

@jasperhuangg
Copy link
Contributor

jasperhuangg commented Jun 14, 2024

Hey @ahmedGaber93 @Beamanator @gedu Looks like you're removing a good amount of logic from #40730, let's make sure we repeat the testing steps from that PR to verify we're not causing any regressions 🙇

  1. Open app.
  2. Create a new account
  3. Go to your space
  4. Create a manual track expense
  5. Click on Categorize it
  6. Click on Learn more and create a new workspace
  7. Go to your space and click on Categorize it again
  8. Verify the newly created workspace should show up

@jasperhuangg jasperhuangg changed the title [WIP] Search result duplication Search result duplication Jun 14, 2024
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Questions about test steps:

  • Sign into an account off Bob means "Sign in to Bob's account", right?
  • One rooms should appear -> "One room should appear for each result, never duplicated"
  • Create a Workspace as Testin1234 -> Is that a specific username or email? Why is that needed? Or is this the name of the workspace? If it's just a random name, maybe say "Create a Workspace with any name, like Testin1234"
  • I don't see any specific tests for the error message cleanup, is one of the existing tests specifically for making sure the error messages work better?

@gedu I also don't see any videos of you testing other than MacOS: Chrome / Safari.

Also @gedu it looks like your branch https://github.com/callstack-internal/Expensify-App/tree/gedu/43094_duplicate_search_result is 1.5k commits behind E/App main, can you pull in main so we can make sure this is being tested with most up to date code? 🙏

And finally, I agree with @jasperhuangg can we get some more test steps to cover changes from this PR (#40730) so we make sure there's no regressions?

@gedu
Copy link
Contributor Author

gedu commented Jun 14, 2024

Questions about test steps:

  • Sign into an account off Bob means "Sign in to Bob's account", right?
  • One rooms should appear -> "One room should appear for each result, never duplicated"
  • Create a Workspace as Testin1234 -> Is that a specific username or email? Why is that needed? Or is this the name of the workspace? If it's just a random name, maybe say "Create a Workspace with any name, like Testin1234"
  • I don't see any specific tests for the error message cleanup, is one of the existing tests specifically for making sure the error messages work better?

Yes, Bob's account or any account you have.
Yep, never duplicated
Yes, any name I can rephrase it
For the error not sure how to reproduce it, happen to David once

@gedu I also don't see any videos of you testing other than MacOS: Chrome / Safari.

For Chorme and Safari are there, I will record for the other platforms

Also @gedu it looks like your branch https://github.com/callstack-internal/Expensify-App/tree/gedu/43094_duplicate_search_result is 1.5k commits behind E/App main, can you pull in main so we can make sure this is being tested with most up to date code? 🙏

Yes, on may way

And finally, I agree with @jasperhuangg can we get some more test steps to cover changes from this PR (#40730) so we make sure there's no regressions?

Adding them

@gedu
Copy link
Contributor Author

gedu commented Jun 14, 2024

@Beamanator @jasperhuangg
I was looking into PR, isn't working for me in local but also isn't working on prod:

Screen.Recording.2024-06-14.at.13.32.57.mov

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented Jun 14, 2024

I think this PR changes shouldn't case regression here #43164 (comment)

Looks like you're removing a good amount of logic from #40730

we arn't use missingReportIds now because this useEffect will create the whole list items when any count of items are updated/added/removed. this because PR #41636 remove the return early in the useEffect when no item need to updated like add/remove cases, that make it cover updated/added/removed.

@gedu PR just remove the second useEffect as no need for it now (the first useEffect handling its job now) . the only bad effect is the performance and we disscuss it in the issue page and in slack here but not found any way can help us keep the performance before #41636 changes.

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented Jun 14, 2024

I confirm @gedu test for #43164 (comment), we have other issue here IOU steps not ask to create a new workspace. (tested in latest main)

20240614155913197.mp4

@gedu
Copy link
Contributor Author

gedu commented Jun 14, 2024

Added videos for all the platforms

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented Jun 14, 2024

is 1.5k commits behind E/App main

@gedu Please merge main into your branch

I think we can simplify test steps to

  1. Open the App

  2. Click Account Settings > Workspaces > and create new workspace

  3. Click fab icon > Start chat > Room tab

  4. Fill room name and select the workspace you create it in step 1 then click create room

  5. Open Search page and Verify that the room you created in step 4 appear once in search result

  6. Click Account Settings > Workspaces > open the workspace you create it step 1

  7. Edit the workspace name

  8. Open Search page and verify that workspace name is changed to the new name in workspace item title and in room subtitle.

@gedu
Copy link
Contributor Author

gedu commented Jun 17, 2024

Please merge main into your branch

Done, I though I did it, but never pushed sorry

@Beamanator Beamanator self-requested a review June 18, 2024 05:39
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Nice, looking good! @ahmedGaber93 can you please do another quick test now that main is up to date? 🙏

@ahmedGaber93
Copy link
Contributor

@gedu I think we need to merge main again, because the latest main add some changes after you merge it, and this changes include fix for this issue #43164 (comment).

Also, I think it will be more clear if you use the test steps here #43164 (comment)

@ahmedGaber93
Copy link
Contributor

I merge main into this locally and test this issue #43164 (comment) and it works well.

20240618093040712.mp4

@ahmedGaber93
Copy link
Contributor

I found a bug, but it reproduced also on the main branch.

  1. Logout
  2. login with a new account

App sometimes not load all default reports and just load invalid Concierge chat 'Concierge in unavailable workspace'

20240618093402947.mp4

@Beamanator
Copy link
Contributor

Amazing, ok ya @gedu if you could merge main 1 last time, i think we'll be good to merge 🙏

@gedu
Copy link
Contributor Author

gedu commented Jun 18, 2024

@Beamanator updated

@Beamanator Beamanator merged commit b278b8f into Expensify:main Jun 18, 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

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.86-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.86-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.86-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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.

6 participants