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

Add filtering to the reports data in the Focus mode switch logic #34624

Merged
merged 8 commits into from
Jan 26, 2024

Conversation

marcaaron
Copy link
Contributor

@marcaaron marcaaron commented Jan 17, 2024

Coming from https://expensify.slack.com/archives/C049HHMV9SM/p1705439950975899

Details

Seems like there is some number of invalid reports that are persisting from one session to the next.

Long term fix: Figure out what is preventing Onyx data from clearing and fix it
Short term fix: Apply some sane filtering to to the reports since the only thing we are checking is if there is a report key in Onyx. This is not really correct now since you can search for reports (e.g. workspace rooms) where you are not a participant yet - these do not show up in the LHN but are stored in the Onyx reports data. So even if we figure out what is causing this data to exist we still need some front end solution to cover reports where you are not a participant.

cc @AndrewGable

Fixed Issues

$ #34778

Tests

Verify focus mode switch still works and there are no regressions

  1. Ensure signed out of both OldDot and NewDot
  2. Sign into a NewDot account that has 30+ chats (must be a new account)
  3. Verify the focus mode alert still works correctly

Verify focus mode modal is not incorrectly showed for brand new account after signing out of large account

  1. Ensure signed out of both OldDot and NewDot
  2. Sign into an account that has many hundreds of chats in NewDot
  3. Sign out
  4. Create new account on a public domain in OldDot
  5. Verify you are redirected to NewDot
  6. Verify the Focus mode modal does not show incorrectly
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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

Android: Native

Unable to test

Android: mWeb Chrome

2024-01-18_17-28-30

iOS: Native

Unable to test

iOS: mWeb Safari

2024-01-18_17-23-51

MacOS: Chrome / Safari

2024-01-18_17-17-00

MacOS: Desktop

2024-01-18_17-19-08

@marcaaron marcaaron self-assigned this Jan 17, 2024
Add some methods to check if the report is valid

Fix ts stuff
@marcaaron marcaaron marked this pull request as ready for review January 19, 2024 03:38
@marcaaron marcaaron requested a review from a team as a code owner January 19, 2024 03:38
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team January 19, 2024 03:38
Copy link

melvin-bot bot commented Jan 19, 2024

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

@marcaaron
Copy link
Contributor Author

I am having trouble building the native apps so kicked off an adhoc build.

@marcaaron
Copy link
Contributor Author

@sobitneupane Can you please kindly give an ETA on when you will be reviewing this PR?

@sobitneupane
Copy link
Contributor

Sorry for the delay @marcaaron. I won't be able to review it soon. I will ask someone else to take over.
https://expensify.slack.com/archives/C02NK2DQWUX/p1705978166747029

@sobitneupane
Copy link
Contributor

@c3024 will review the PR.

@c3024
Copy link
Contributor

c3024 commented Jan 23, 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 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
focusTest1Android.mp4
focusTest2Android.mp4
Android: mWeb Chrome
focusTest1AndroidChrome.mov
focusTest2AndroidChrome.mov
iOS: Native
focusTest1iOS.mp4
focusTest2iOS.mp4
iOS: mWeb Safari
focusTest1iOSSafari.mp4
focusTest2iOSSafari.mp4
MacOS: Chrome / Safari
focusTest1Chrome.mp4
focusTest2Chrome.mp4
MacOS: Desktop focusTest1Desktop
focusTest2iDesktop.mov

}

// We are not the owner or the manager or a participant
if (report?.ownerAccountID !== accountID && report?.managerID !== accountID && !(report?.participantAccountIDs ?? []).includes(accountID)) {
Copy link
Contributor

@c3024 c3024 Jan 23, 2024

Choose a reason for hiding this comment

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

BE returns ownerAccountID as 0 and this check is failing for report owner
Screenshot 2024-01-23 at 12 03 53 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh I see. In the case of a DM - you would not be in the participantAccountIDs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

DMs are supposed to have an ownerAccountID of 0 that is expected.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But the problem is that they won't be in there... have a solution one sec.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me know if the latest commit looks better!

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, this gets correct valid report length,

@c3024
Copy link
Contributor

c3024 commented Jan 25, 2024

Tests
Verify focus mode switch still works and there are no regressions

Ensure signed out of both OldDot and NewDot
Sign into a NewDot account that has 30+ chats (must be a new account)

In this step here

Sign into a NewDot account that has 30+ chats (must be a new account)

After logging into a new account and adding chats one by one, at the 30th chat it switches to focus mode immediately. So, logging in with 30+ chats to see the focus mode popup is not possible I think because it is already switched to focus mode. We can verify only that.

@c3024
Copy link
Contributor

c3024 commented Jan 25, 2024

Can you please help me with these?

  1. Not related to this but I can login to an account using Old Dot URL and consequent redirect to New Dot without any one time code
directLogin.mp4
  1. How do I force redirect to Dev Environment when visiting Old Dot to check this on Dev

Create new account on a public domain in OldDot
Verify you are redirected to NewDot
Verify the Focus mode modal does not show incorrectly

@marcaaron
Copy link
Contributor Author

After logging into a new account and adding chats one by one, at the 30th chat it switches to focus mode immediately. So, logging in with 30+ chats to see the focus mode popup is not possible I think because it is already switched to focus mode. We can verify only that.

Could add 29 then have someone invite you to a DM to make 30 then leave a comment on it?

Also feel free to lower the threshhold to make testing more bearable 😄

@marcaaron marcaaron removed the request for review from sobitneupane January 25, 2024 02:31
@marcaaron
Copy link
Contributor Author

How do I force redirect to Dev Environment when visiting Old Dot to check this on Dev

Oh hmm that is probably not possible - but signing in should have the same effect so maybe fine to skip this until QA.

@marcaaron marcaaron changed the title Add sane filtering to the reports data in the Focus mode switch logic Add filtering to the reports data in the Focus mode switch logic Jan 25, 2024
@c3024
Copy link
Contributor

c3024 commented Jan 25, 2024

Please merge main as the Android build is failing.

@c3024
Copy link
Contributor

c3024 commented Jan 25, 2024

Could not identify the exact steps that are causing this but sometimes I am getting this crash on web when I run both npm run desktop and npm run web one after another.

Screen.Recording.2024-01-25.at.10.10.04.PM.mov

@marcaaron
Copy link
Contributor Author

What's the crash? Can you look at the logs or share them? I can't tell from that video. I will merge main and check it out too.

@Expensify Expensify deleted a comment from github-actions bot Jan 26, 2024
@c3024
Copy link
Contributor

c3024 commented Jan 26, 2024

I am not able to reproduce the Chrome crash again. In the crashes in the video it said window.electron is undefined or null.

Perhaps this was caused due to opening both of them quickly or perhaps it got fixed with merging main.

Copy link
Contributor

@c3024 c3024 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 cristipaval January 26, 2024 04:27
Copy link

melvin-bot bot commented Jan 26, 2024

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

Copy link
Contributor

@cristipaval cristipaval left a comment

Choose a reason for hiding this comment

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

Code looks good. Could you make Typescript style pass?

@cristipaval cristipaval merged commit feb516a into main Jan 26, 2024
15 checks passed
@cristipaval cristipaval deleted the marcaaron-fixReportCount branch January 26, 2024 22:22
@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/cristipaval in version: 1.4.33-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants