Add offline status log by nkdengineer · Pull Request #41719 · Expensify/App

nkdengineer · 2024-05-07T03:24:42Z

Details

Add offline status log

Fixed Issues

$ #40250
PROPOSAL: #40250 (comment)

Tests

Open the App
Open the log and filter by offlineStatus
Verify that we have the log about NetInfo.addEventListener
Go to Settings > Troubleshoot > Force offline
Verify that we have the log about force offline

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

Open the App
Open the log and filter by offlineStatus
Verify that we have the log about NetInfo.addEventListener
Go to Settings > Troubleshoot > Force offline
Verify that we have the log about force offline

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android-2.mov

Android: mWeb Chrome

Screen.Recording.2024-05-07.at.10.04.46.mov

iOS: Native

Uploading ios-1.mov…

iOS: mWeb Safari

Screen.Recording.2024-05-07.at.10.07.06.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-07.at.10.03.42.mov

MacOS: Desktop

Screen.Recording.2024-05-07.at.10.20.17.mov

melvin-bot · 2024-05-07T03:25:02Z

@Santhosh-Sellavel 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]

Santhosh-Sellavel · 2024-05-07T17:21:17Z

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

Noting UI so just added logs recording for Web & Desktop

MacOS: Chrome / Safari

Screen.Recording.2024-05-07.at.10.39.44.PM.mov

MacOS: Desktop

Screen.Recording.2024-05-07.at.10.44.54.PM.mov

Santhosh-Sellavel

LGTM, tests well!

hayata-suenaga · 2024-05-08T15:58:21Z

src/libs/NetworkConnection.ts

+                Log.info(
+                    `[NetworkStatus] The user is not under force offline, calling NetInfo.fetch, setting "offlineStatus" to ${
+                        (state.isInternetReachable ?? false) === false
+                    } with network state: ${JSON.stringify(state)}`,
+                );


Suggested change

Log.info(

`[NetworkStatus] The user is not under force offline, calling NetInfo.fetch, setting "offlineStatus" to ${

(state.isInternetReachable ?? false) === false

} with network state: ${JSON.stringify(state)}`,

);

src/libs/NetworkConnection.ts

Co-authored-by: Hayata Suenaga <hayata.suenaga111@gmail.com>

src/libs/NetworkConnection.ts

hayata-suenaga

thanks for addressing the review 🙇

nkdengineer · 2024-05-15T08:54:13Z

@hayata-suenaga Please help to review again when you have a chance. Thanks.

src/libs/NetworkConnection.ts

Co-authored-by: Hayata Suenaga <hayata.suenaga111@gmail.com>

nkdengineer · 2024-05-20T09:02:14Z

@hayata-suenaga Can we merge the PR now?

hayata-suenaga · 2024-05-20T21:58:59Z

@nkdengineer thank you for asking. we're imposing a merge freeze right now. I'll let you know when we can merge the PR 😄

nkdengineer · 2024-05-28T02:38:26Z

@hayata-suenaga Can we merge this PR now?

hayata-suenaga · 2024-05-28T17:53:18Z

The merge freeze is being gradually being lifted now

I know this is a PR that just adds a logging but it touches the offline status part of the code so I prefer waiting for the complete end to the merge freeze 😄

nkdengineer · 2024-05-28T18:03:48Z

Thanks.

mountiny · 2024-05-30T22:59:30Z

@nkdengineer can you please sync with main?

@hayata-suenaga the freeze is over now, lets get the merge party started 🎉

nkdengineer · 2024-05-31T02:37:10Z

@mountiny I merged main.

hayata-suenaga

thank you!

OSBotify · 2024-06-03T13:15:25Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

pecanoro · 2024-06-05T18:37:40Z

@nkdengineer This PR caused a deploy blocker here when changing the unreachable condition 😅 #43116

OSBotify · 2024-06-06T12:33:45Z

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

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

Add offline status log

a5ad81d

nkdengineer marked this pull request as ready for review May 7, 2024 03:24

nkdengineer requested a review from a team as a code owner May 7, 2024 03:24

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team May 7, 2024 03:25

nkdengineer mentioned this pull request May 7, 2024

[HOLD for payment 2024-06-13] MEDIUM: [$250] Add logging around offline state to help diagnose bugs #40250

Closed

6 tasks

Santhosh-Sellavel approved these changes May 7, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga May 7, 2024 17:22

hayata-suenaga changed the title ~~Add offline status log~~ [HOLD until May 10th] Add offline status log May 8, 2024

hayata-suenaga reviewed May 8, 2024

View reviewed changes

src/libs/NetworkConnection.ts Outdated Show resolved Hide resolved

hayata-suenaga reviewed May 8, 2024

View reviewed changes

src/libs/NetworkConnection.ts Outdated Show resolved Hide resolved

nkdengineer and others added 4 commits May 8, 2024 23:32

Update src/libs/NetworkConnection.ts

c845d3e

Co-authored-by: Hayata Suenaga <hayata.suenaga111@gmail.com>

Update src/libs/NetworkConnection.ts

3f3af72

Co-authored-by: Hayata Suenaga <hayata.suenaga111@gmail.com>

Merge branch 'main' into fix/40250

458de78

fix lint

005cfb3

hayata-suenaga reviewed May 8, 2024

View reviewed changes

src/libs/NetworkConnection.ts Show resolved Hide resolved

nkdengineer added 3 commits May 9, 2024 15:10

Merge branch 'main' into fix/40250

3ae39d1

define a new variable

c7ab997

fix lint

25f3565

hayata-suenaga previously approved these changes May 9, 2024

View reviewed changes

hayata-suenaga changed the title ~~[HOLD until May 10th] Add offline status log~~ Add offline status log May 13, 2024

merge main

38ed55c

nkdengineer dismissed hayata-suenaga’s stale review via 38ed55c May 15, 2024 08:52

hayata-suenaga reviewed May 15, 2024

View reviewed changes

src/libs/NetworkConnection.ts Outdated Show resolved Hide resolved

nkdengineer and others added 2 commits May 16, 2024 00:00

Update src/libs/NetworkConnection.ts

7619a7e

Co-authored-by: Hayata Suenaga <hayata.suenaga111@gmail.com>

fix lint

bd2cb24

Merge branch 'main' into fix/40250

65c263a

hayata-suenaga changed the title ~~Add offline status log~~ [HOLD Merge freeze] Add offline status log May 20, 2024

mountiny changed the title ~~[HOLD Merge freeze] Add offline status log~~ Add offline status log May 30, 2024

Merge branch 'main' into fix/40250

1178498

hayata-suenaga approved these changes Jun 3, 2024

View reviewed changes

hayata-suenaga merged commit 053bd17 into Expensify:main Jun 3, 2024

This was referenced Jun 3, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #42993

Closed

Deploy Checklist: New Expensify 2024-06-04 #43037

Closed

pecanoro mentioned this pull request Jun 5, 2024

[HOLD for payment 2024-06-20] Troubleshoot - App is stuck offline after "Force offline" toggled on and off #43116

Closed

6 tasks

Santhosh-Sellavel mentioned this pull request Jun 9, 2024

fix: App is stuck offline after 'Force offline' toggled on and off #43159

Merged

50 tasks

Conversation

nkdengineer commented May 7, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 7, 2024

Uh oh!

Santhosh-Sellavel commented May 7, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga May 8, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hayata-suenaga left a comment

Choose a reason for hiding this comment

Uh oh!

nkdengineer commented May 15, 2024

Uh oh!

Uh oh!

nkdengineer commented May 20, 2024

Uh oh!

hayata-suenaga commented May 20, 2024

Uh oh!

nkdengineer commented May 28, 2024

Uh oh!

hayata-suenaga commented May 28, 2024

Uh oh!

nkdengineer commented May 28, 2024

Uh oh!

mountiny commented May 30, 2024

Uh oh!

nkdengineer commented May 31, 2024

Uh oh!

hayata-suenaga left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 3, 2024

Uh oh!

pecanoro commented Jun 5, 2024

Uh oh!

OSBotify commented Jun 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants