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

Send mostRecentReportActionLastModified with ReconnectApp #18807

Merged
merged 32 commits into from
Jul 4, 2023

Conversation

marcaaron
Copy link
Contributor

@marcaaron marcaaron commented May 12, 2023

Related to: https://github.com/Expensify/Auth/pull/7902

Details

This is the final PR that will implement fast ReconnectApp by sending the mostRecentReportActionLastModified.

It is holding on:

All must be deployed to production before we merge this...

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/282035

Tests

  1. Sign into the app
  2. Verify the chats load correctly and OpenApp API call is functioning normally and loads the LHN correctly
  3. In Chrome Dev Tools Network tab - Note how long the OpenApp API call takes and check the response to see how many reports are returned in onyxData update with a key of report_.
  4. Go offline
  5. On another account add a comment to a report the offline user would see
  6. As the offline user go online
  7. Check the API response of ReconnectApp and verify that there are many less reports (really should be just one unless there are pinned reports) returned and that the request is faster than OpenApp
  8. Verify the report that they missed an update for is updated in the LHN
  9. Go offline again
  10. As the other user edit the last message from the chat
  11. As the offline user go online again and verify that the chat updates with the edited content in the LHN
  12. Repeat these tests, but instead of going offline and returning online do:
    • Desktop - Quit the app and reopen it
    • mWeb - Refresh the page
    • Android/iOS - Kill the app and reopen it
    • Android/iOS - Background the app and reopen it
  • Verify that no errors appear in the JS console

Offline tests

This is covered above as there are

QA Steps

Same as tests

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

2023-06-16_11-06-21
2023-06-16_11-06-08

Mobile Web - Chrome

2023-06-16_11-38-46

Mobile Web - Safari

2023-06-16_11-27-37

Desktop

2023-06-16_11-13-01

iOS 2023-06-16_11-24-38
Android 2023-06-16_11-36-40

@marcaaron marcaaron self-assigned this May 19, 2023
@marcaaron marcaaron changed the title Send mostRecentReportActionLastModified with ReconnectApp [HOLD Auth/Web-E] Send mostRecentReportActionLastModified with ReconnectApp May 19, 2023
@marcaaron marcaaron marked this pull request as ready for review June 16, 2023 17:26
@marcaaron marcaaron requested a review from a team as a code owner June 16, 2023 17:26
@melvin-bot melvin-bot bot removed the request for review from a team June 16, 2023 17:26
@melvin-bot
Copy link

melvin-bot bot commented Jun 16, 2023

@mananjadhav 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 mananjadhav June 16, 2023 17:26
@marcaaron
Copy link
Contributor Author

Still holding on Web-E deploy, but ready for review and I will run through the testing on all platforms now.

@marcaaron
Copy link
Contributor Author

Oh hmm @mananjadhav this won't be ready to test until the API is updated, but we can use some help after it is.

@marcaaron marcaaron requested a review from a team June 16, 2023 17:28
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team June 16, 2023 17:28
@mananjadhav
Copy link
Collaborator

Yes I will. I can see some lint issues now?

@marcaaron
Copy link
Contributor Author

Updated

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Filling up the checklist now.

@melvin-bot
Copy link

melvin-bot bot commented Jun 28, 2023

🎯 @mananjadhav, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #21797.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jun 28, 2023

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 / Chrome
    • iOS / native
    • iOS / 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 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

Web
web-reconnect-app_onsikUWX.mp4
Mobile Web - Chrome
mweb-chrome-reconnect-app_HojGqr0I.mp4
Mobile Web - Safari
mweb-safari-reconnect-app_2zHZbT9p.mp4
Desktop
desktop-reconnect-app.mov
iOS
ios-reconnect-app_G8vxZPkF.mp4
ios-reconnect-app-lhs
Android
android-reconnect-app_YnFg50do.mp4

@flodnv All yours. Took sometime to compress the video. But tests well.

🎀 👀 🎀 C+ reviewed

Copy link
Contributor

@flodnv flodnv left a comment

Choose a reason for hiding this comment

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

Thanks!

@@ -150,11 +136,9 @@ function cancelPendingRequests() {
// We create a new instance because once `abort()` is called any future requests using the same controller would
// automatically get rejected: https://dom.spec.whatwg.org/#abortcontroller-api-integration
cancellationController = new AbortController();
cancelPendingReconnectAppRequest();
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you clarify why you removed this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

More context here: #18807 (comment)

Lmk if you want to discuss further? I am going to cause a regression with this - but the original solution is a hack.

src/libs/actions/App.js Outdated Show resolved Hide resolved
src/libs/actions/Timing.js Outdated Show resolved Hide resolved
src/libs/actions/Timing.js Outdated Show resolved Hide resolved
@marcaaron
Copy link
Contributor Author

Updated.

@flodnv
Copy link
Contributor

flodnv commented Jul 3, 2023

Conflicts 😞

/**
* @returns {boolean}
*/
function didUserLogInDuringSession() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Looking at this again, would it make more sense / be better to have some other system, like "isOnyxDataEmpty"? Maybe not?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a good question since all sorts of data could be "empty" and any could be used to signify that we have not yet called OpenApp yet. On the one hand, it's a bit arbitrary, but on the other hand it is easy to reason about the "when" and "why" we would call OpenApp (post sign in) over ReconnectApp (all other times).

Looking whether Onyx data is entirely empty or not would present a new challenge. This gets pretty complicated, but the gist of it is that Onyx can initialize with various default states and when cleared we will reapply those default states. So, there really is no way for Onyx data to ever truly be "empty" as far as the App code is concerned.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the explanation, makes sense 👍

@marcaaron
Copy link
Contributor Author

Conflicts fixed and retested!

@flodnv flodnv merged commit c38a336 into main Jul 4, 2023
@flodnv flodnv deleted the marcaaron-addLastModified branch July 4, 2023 13:05
@OSBotify
Copy link
Contributor

OSBotify commented Jul 4, 2023

✋ 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

OSBotify commented Jul 5, 2023

🚀 Deployed to staging by https://github.com/flodnv in version: 1.3.37-0 🚀

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

@mvtglobally
Copy link

@marcaaron We will only be able to run Web and Desktop for console verification in Staging. Can you pls check mWeb/Native Apps internally?

@marcaaron
Copy link
Contributor Author

@mvtglobally Of course, thanks for letting me know. I will look into it right now.

@marcaaron
Copy link
Contributor Author

Just going to post requestID for the testing logs as I go through the various platforms (if anyone is curious). And grabbed a before/after timing for my marc@expensifail.com account to confirm the speed improvement.

iOS Safari: 7e21b64e4e15f4cc-HNL
iOS native: 7e21bc910faabc7b-HNL
Android Chrome: 7e21e3776ab6bc69-HNL
Android: 7e21e9107badf4d0-HNL

Profile ~~ {"total":2448,"cmd":"OpenApp"...
Profile ~~ {"total":1212,"cmd":"ReconnectApp"...

@OSBotify
Copy link
Contributor

OSBotify commented Jul 7, 2023

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.37-7 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants