[CP Staging] Add logs to OpenApp flow #42168

jasperhuangg · 2024-05-14T19:47:37Z

Details

Adds some logs to the OpenApp flow to help with debuggin

Fixed Issues

Related to #42063
PROPOSAL:

Tests

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 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-05-14T19:48:02Z

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

jasperhuangg · 2024-05-14T19:49:36Z

src/libs/actions/App.ts

@@ -202,6 +202,7 @@ function getPolicyParamsForOpenOrReconnect(): Promise<PolicyParamsForOpenOrRecon
                    resolve({policyIDList: getNonOptimisticPolicyIDs(policies)});
                },
            });
+            Log.info('[getPolicyParamsForOpenOrReconnect] isReadyToOpenApp resolved', true, {policyIDListConnectionID: connectionID});


Not really sure why I'm logging the connectionID, I guess in case we find that the policyIDList promise isn't resolving we can see what's going on with that connection? Don't really know how to check that though, feedback would be greatly appreciated.

I don't think it will help. The connectionIDs would only help you see the connection in the Onyx mapping - which doesn't really do much except hold the callback.

Maybe put this log above the Onyx.connect() call.

marcaaron · 2024-05-14T19:57:11Z

src/libs/actions/App.ts

@@ -254,6 +255,7 @@ function getOnyxDataForOpenOrReconnect(isOpenApp = false): OnyxData {
 */
 function openApp() {
    getPolicyParamsForOpenOrReconnect().then((policyParams: PolicyParamsForOpenOrReconnect) => {
+        Log.info('[openApp] getPolicyParamsForOpenOrReconnect resolved: ', true, policyParams);
        const params: OpenAppParams = {enablePriorityModeFilter: true, ...policyParams};

        API.write(WRITE_COMMANDS.OPEN_APP, params, getOnyxDataForOpenOrReconnect(true));


My initial experience of this bug was that it looked like API.write() did get called, but we end up just stuck in the queue so the request never happens. It feels like maybe some kind of network request is happening that causes the queue to get blocked.

add logs to OpenApp flow

dc9965b

jasperhuangg self-assigned this May 14, 2024

jasperhuangg requested a review from a team as a code owner May 14, 2024 19:47

jasperhuangg changed the title ~~Add logs to OpenApp flow~~ [CP Staging] Add logs to OpenApp flow May 14, 2024

melvin-bot bot removed the request for review from a team May 14, 2024 19:48

melvin-bot bot requested a review from blimpich May 14, 2024 19:48

jasperhuangg commented May 14, 2024

View reviewed changes

marcaaron reviewed May 14, 2024

View reviewed changes

jasperhuangg added 2 commits May 14, 2024 13:08

add logs to seqqueue

2bf0ba3

add logs to isClientTheLeader

bf1d053

marcaaron approved these changes May 14, 2024

View reviewed changes

blimpich approved these changes May 14, 2024

View reviewed changes

jasperhuangg closed this May 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Add logs to OpenApp flow #42168

[CP Staging] Add logs to OpenApp flow #42168

jasperhuangg commented May 14, 2024 •

edited

melvin-bot bot commented May 14, 2024

jasperhuangg May 14, 2024 •

edited

marcaaron May 14, 2024

marcaaron May 14, 2024

marcaaron May 14, 2024

[CP Staging] Add logs to OpenApp flow #42168

[CP Staging] Add logs to OpenApp flow #42168

Conversation

jasperhuangg commented May 14, 2024 • edited

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 14, 2024

jasperhuangg May 14, 2024 • edited

Choose a reason for hiding this comment

marcaaron May 14, 2024

Choose a reason for hiding this comment

marcaaron May 14, 2024

Choose a reason for hiding this comment

marcaaron May 14, 2024

Choose a reason for hiding this comment

jasperhuangg commented May 14, 2024 •

edited

jasperhuangg May 14, 2024 •

edited