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

Last synced just now does not update #41310

Merged
merged 13 commits into from
May 24, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Apr 30, 2024

Details

Fixed Issues

$ #41045
PROPOSAL: #41045 (comment)

Tests

  1. Connect to QBO
  2. Observe the "Last synced just now" text
  3. Wait for several mins
  4. Navigate away from the page and back or refresh page
  5. Verify that the text changed correctly
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Connect to QBO
  2. Observe the "Last synced just now" text
  3. Wait for several mins
  4. Navigate away from the page and back or refresh page
  5. Verify that the text changed correctly
  • 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 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 Screenshot 2024-04-30 at 17 09 07
Android: mWeb Chrome Screenshot 2024-04-30 at 17 00 04
iOS: Native Screenshot 2024-04-30 at 17 14 44
iOS: mWeb Safari Screenshot 2024-04-30 at 16 55 05
MacOS: Chrome / Safari Screenshot 2024-04-30 at 16 37 49
MacOS: Desktop Screenshot 2024-04-30 at 17 02 41

@tienifr tienifr marked this pull request as ready for review April 30, 2024 10:15
@tienifr tienifr requested a review from a team as a code owner April 30, 2024 10:15
@melvin-bot melvin-bot bot requested review from Ollyws and removed request for a team April 30, 2024 10:15
Copy link

melvin-bot bot commented Apr 30, 2024

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

@Ollyws
Copy link
Contributor

Ollyws commented Apr 30, 2024

@tienifr Getting an error on the PolicyAccountingPage, also we have a lint (prettier) error.

Screenshot 2024-04-30 at 21 37 29

@tienifr
Copy link
Contributor Author

tienifr commented May 1, 2024

@aldo-expensify @mountiny @Ollyws

Here's the data returned from BE. The date format is not correct, it should be 024-04-26 08:55:57

image

@tienifr
Copy link
Contributor Author

tienifr commented May 6, 2024

@mountiny can you help take a look?

@aldo-expensify
Copy link
Contributor

aldo-expensify commented May 6, 2024

@aldo-expensify @mountiny @Ollyws

Here's the data returned from BE. The date format is not correct, it should be 024-04-26 08:55:57

image

t doesn't look incorrect to me, isn't that an ISO date string? We want to avoid changes in the backend that could cause problems with OldDot

@tienifr
Copy link
Contributor Author

tienifr commented May 7, 2024

@Ollyws I fixed the PR

useEffect(() => {
const locale = preferredLocale ?? CONST.LOCALES.DEFAULT;
setDateTimeToRelative(DateUtils.datetimeToRelative(locale, formatedDate));
const interval = setInterval(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to use setInterval here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we don't use setInterval, we have to refresh page to see the new relativeTime

Copy link
Contributor

Choose a reason for hiding this comment

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

Wouldn't any change in formattedDate trigger the useEffect though?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with Olly, shouldn't this already be handled by the useEffect dependency?

Copy link
Contributor

Choose a reason for hiding this comment

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

@tienifr i dont think this is a requirement @trjExpensify i think its fine to not update the sync date until we get pusher update or user navigates away and back to the page.

I dont think there is much value in having the text auto update when user stays on the page

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, agreed. Pretty sure with OldDot we do that too.

@Ollyws
Copy link
Contributor

Ollyws commented May 8, 2024

I'm getting "in about 2 hours" immeditaely after syncing:

Screenshot 2024-05-08 at 11 55 04

@mountiny mountiny changed the title Last synced just now does n't update Last synced just now does not update May 8, 2024
@mountiny
Copy link
Contributor

mountiny commented May 8, 2024

Agree with Aldo, that seems correct to me, lets try to work with this format returned by BE

useEffect(() => {
const locale = preferredLocale ?? CONST.LOCALES.DEFAULT;
setDateTimeToRelative(DateUtils.datetimeToRelative(locale, formatedDate));
const interval = setInterval(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with Olly, shouldn't this already be handled by the useEffect dependency?

@tienifr
Copy link
Contributor Author

tienifr commented May 9, 2024

Wouldn't any change in formattedDate trigger the useEffect though?

@mountiny @Ollyws I thought it was not updated in real time, that why I added the setInterval logic to trigger updating relativeTime. I need to test this API again to see if successfulDate is updated in real time. Unfortunately, I can't setup the QBO for now. Can you help this case?

Screen.Recording.2024-05-09.at.10.13.28.mov

@mountiny
Copy link
Contributor

mountiny commented May 9, 2024

@tienifr the route is incorrect, there should not be expensify.com.dev for you. Did you have this set up working before?

@s77rt
Copy link
Contributor

s77rt commented May 9, 2024

@tienifr Just manually update the domain part to dev.new.expensify.com:8082

@tienifr
Copy link
Contributor Author

tienifr commented May 10, 2024

@mountiny If we don't use setInterval how can we update relativeTime after several minutes? For example, after connecting QBO, the text should be Last synced just now, then users stay in this page for a while -> I need setInterval to update this text to 11 minutes ago

@Ollyws
Copy link
Contributor

Ollyws commented May 10, 2024

@tienifr Ahh I see what you're saying, formattedDate is only the date of the last sync so ofcourse we need to calculate the difference between the current date and the last synced date to get a message like Last synced 15 minutes ago using setInterval if we want it to update in realtime.
Unless we wanted to simply show a timestamp like Last synced at 2pm or something.

@Ollyws
Copy link
Contributor

Ollyws commented May 10, 2024

@tienifr when I change my timezone I get an incorrect time calculation:

Screenshot 2024-05-10 at 12 59 18

@tienifr
Copy link
Contributor Author

tienifr commented May 13, 2024

web-resize.mp4

@Ollyws It worked well on my side, can you pls elaborate?

@Ollyws
Copy link
Contributor

Ollyws commented May 13, 2024

@tienifr The text in your video is saying that it last synced "in about 2 hours" which is in the future.
Surely the last synced message shouldn't change atall when you change the timezone, we should be using UTC to measure both as the last synced time from the backend is in UTC.

@tienifr
Copy link
Contributor Author

tienifr commented May 13, 2024

@Ollyws Ah I see that bug. The RCA is here

return utcToZonedTime(parsedDatetime, currentSelectedTimezone);

we use utcToZonedTime that make the time is different. Pls check https://masteringjs.io/tutorials/date-fns/tz#:~:text=The%20actual%20underlying%20time%20is%20different.

I think using formatDistanceToNow is enough and it worked well

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

I think we should remove the set interval

@mountiny
Copy link
Contributor

@tienifr Requested one change and lint is failing

@tienifr
Copy link
Contributor Author

tienifr commented May 14, 2024

@mountiny I removed setInterval and fixed lint

@Ollyws
Copy link
Contributor

Ollyws commented May 14, 2024

Removing the setInterval will stop the last synced label from updating, for example it will say less than a minute ago forever, until the page is refreshed. So it's no longer fixing the issue.

@mountiny
Copy link
Contributor

@Ollyws

until the page is refreshed. So it's no longer fixing the issue.

This is not right though. It should change with each re-render or change of the last sync value that comes in through pusher.

So if user navigated away in the app and comes back to the accounting page, they will see different time.

Essentially the only flow the setInterval would be fixing is that admin will sync the connection and remains on the page for a while and the value will not update on its own. I think however this is pre-optimization and admins will not really hang on that page waiting for the text to update, they can navigate away and back to see the timestamp update.

So I think we can move ahead @Ollyws can you complete the review please?

@mountiny mountiny requested a review from Ollyws May 14, 2024 16:39
@Ollyws
Copy link
Contributor

Ollyws commented May 14, 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
01_Android_Native.mp4
Android: mWeb Chrome
02_Android_Chrome.mp4
iOS: Native
03_iOS_Native.mp4
iOS: mWeb Safari
04_iOS_Safari.mp4
MacOS: Chrome / Safari
05_MacOS_Chrome.mp4
MacOS: Desktop
06_MacOS_Desktop.mp4

Copy link
Contributor

@Ollyws Ollyws left a comment

Choose a reason for hiding this comment

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

If that's the expected behaviour then we're good to go.

Just to re-iterate the last synced label will only be updated when the user either navigates away from the page and back again, or refreshes.

@tienifr Could you update the testing steps to align with this? Thanks.

@melvin-bot melvin-bot bot requested a review from mountiny May 14, 2024 19:59
@tienifr
Copy link
Contributor Author

tienifr commented May 15, 2024

@Ollyws I updated

@hayata-suenaga hayata-suenaga changed the title Last synced just now does not update [HOLD Merge Freeze] Last synced just now does not update May 17, 2024
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks for testing thoroughly, waiting for the merge freeze to be lifted

@trjExpensify
Copy link
Contributor

trjExpensify commented May 23, 2024

@mountiny @hayata-suenaga @tienifr let's change this over to the QBO freeze branch and merge it

@mountiny mountiny changed the base branch from main to qbo-freeze-branch May 24, 2024 15:04
@mountiny mountiny changed the title [HOLD Merge Freeze] Last synced just now does not update Last synced just now does not update May 24, 2024
@mountiny mountiny merged commit 263f798 into Expensify:qbo-freeze-branch May 24, 2024
20 checks passed
@hayata-suenaga hayata-suenaga mentioned this pull request May 31, 2024
49 tasks
@OSBotify
Copy link
Contributor

OSBotify commented Jun 6, 2024

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

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.

7 participants