Change SendPerformanceTiming to be a read so it is not retried and ge… by iwiznia · Pull Request #21457 · Expensify/App

iwiznia · 2023-06-23T20:48:12Z

…ts stuck in a loop

Details

Fixed Issues

#21444

Tests

Add throw new ExpError('asdsad', 'caca', '', [], false, 407); to the backend code of SendPerformanceTiming

Comment out this code

App/src/libs/actions/Timing.js

Lines 49 to 52 in 2cd9b78

    
           if (Environment.isDevelopment()) { 
        
               // Don't create traces on dev as this will mess up the accuracy of data in release builds of the app 
        
               return; 
        
           }

Load the site, check it does not call SendPerformanceTiming over and over till forever

Offline tests

No

QA Steps

No

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…ts stuck in a loop

melvin-bot · 2023-06-23T20:48:18Z

@aimane-chnaif 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]

iwiznia · 2023-06-23T20:48:47Z

        }

-        API.write('SendPerformanceTiming', {
+        API.read('SendPerformanceTiming', {


By making it a read it does not get retried nor saved in onyx nor anyhing like that, which for a stats command makes total sense.

This won't call api again when back online from offline. You meant that?

Yeah, this is tracking metrics on speed, it's not really important to save every piece of data. And by removing this it means it does not block other actually important requests (both in normal conditions and especially after coming back online since that's when the app becomes unresponsive or outdated)
So it's kind of the solution. I do need to investigate why this failure was not triggering our reauthentication mechanism, when it should've, but that's work for another PR.

aimane-chnaif · 2023-06-23T21:23:28Z

        }

-        API.write('SendPerformanceTiming', {
+        API.read('SendPerformanceTiming', {


This won't call api again when back online from offline. You meant that?

aimane-chnaif · 2023-06-23T21:25:22Z

            value: eventTime,
            platform: `${getPlatform()}`,
-        });
+        }, {});


3rd param is Onyx data and it already defaults to {} here 👇 so I think this change is redundant.

App/src/libs/API.js

Line 93 in 67f627d

function makeRequestWithSideEffects(command, apiCommandParameters = {}, onyxData = {}, apiRequestType = CONST.API_REQUEST_TYPE.MAKE_REQUEST_WITH_SIDE_EFFECTS) {

But there's no default in the API.read method which is the one I am calling...

That's fine. It's just redirected to makeRequestWithSideEffects. Btw NAB

App/src/libs/API.js

Lines 129 to 134 in 820fa93

function read(command, apiCommandParameters, onyxData) {

// Ensure all write requests on the sequential queue have finished responding before running read requests.

// Responses from read requests can overwrite the optimistic data inserted by

// write requests that use the same Onyx keys and haven't responded yet.

SequentialQueue.waitForIdle().then(() => makeRequestWithSideEffects(command, apiCommandParameters, onyxData, CONST.API_REQUEST_TYPE.READ));

}

aimane-chnaif

Please fill checklist

iwiznia · 2023-06-26T16:28:24Z

Done

aimane-chnaif · 2023-06-26T16:42:40Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

aimane-chnaif · 2023-06-26T16:45:09Z

Oh no engineer assigned as a reviewer.
@iwiznia can you please link the issue correctly? Maybe this broke automation. $ is missing.

$ https://github.com/Expensify/App/issues/21444

iwiznia · 2023-06-26T17:01:49Z

It does not have the $ because it is not fixing the issue, that is correct

melvin-bot · 2023-06-26T17:02:26Z

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

amyevans

👍

OSBotify · 2023-06-26T19:52:37Z

✋ 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 · 2023-06-26T21:06:01Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.33-0 🚀

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

OSBotify · 2023-06-28T14:06:25Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.33-4 🚀

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

Change SendPerformanceTiming to be a read so it is not retried and ge…

2cd9b78

…ts stuck in a loop

iwiznia requested a review from a team as a code owner June 23, 2023 20:48

iwiznia self-assigned this Jun 23, 2023

melvin-bot Bot requested review from aimane-chnaif and removed request for a team June 23, 2023 20:48

iwiznia commented Jun 23, 2023

View reviewed changes

aimane-chnaif reviewed Jun 23, 2023

View reviewed changes

iwiznia added 2 commits June 23, 2023 20:42

Prettier

2e598af

Pretttier

38756dd

aimane-chnaif reviewed Jun 25, 2023

View reviewed changes

aimane-chnaif approved these changes Jun 26, 2023

View reviewed changes

iwiznia requested a review from a team June 26, 2023 17:01

melvin-bot Bot requested review from amyevans and removed request for a team June 26, 2023 17:02

amyevans approved these changes Jun 26, 2023

View reviewed changes

amyevans merged commit 5c6b751 into main Jun 26, 2023

amyevans deleted the ionatan_perfomancetiming_notblocking branch June 26, 2023 19:48

OSBotify mentioned this pull request Jun 26, 2023

Deploy Checklist: New Expensify 2023-06-26 #21650

Closed

23 tasks

bernhardoj mentioned this pull request Jul 6, 2023

[$1000] Web - Chat - 'Uploading attachment' shows infinitely after reconnecting network #20715

Closed

6 tasks

aimane-chnaif mentioned this pull request Jul 11, 2023

[Performance] Loading chats takes 10+ minutes for guides and can often fail altogether #21444

Closed

6 tasks

	if (Environment.isDevelopment()) {
	// Don't create traces on dev as this will mess up the accuracy of data in release builds of the app
	return;
	}

	function read(command, apiCommandParameters, onyxData) {
	// Ensure all write requests on the sequential queue have finished responding before running read requests.
	// Responses from read requests can overwrite the optimistic data inserted by
	// write requests that use the same Onyx keys and haven't responded yet.
	SequentialQueue.waitForIdle().then(() => makeRequestWithSideEffects(command, apiCommandParameters, onyxData, CONST.API_REQUEST_TYPE.READ));
	}

Conversation

iwiznia commented Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jun 23, 2023

Uh oh!

iwiznia Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

aimane-chnaif Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

iwiznia Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

aimane-chnaif Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

aimane-chnaif Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iwiznia Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

aimane-chnaif Jun 25, 2023

Choose a reason for hiding this comment

Uh oh!

aimane-chnaif left a comment

Choose a reason for hiding this comment

Uh oh!

iwiznia commented Jun 26, 2023

Uh oh!

aimane-chnaif commented Jun 26, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

aimane-chnaif commented Jun 26, 2023

Uh oh!

iwiznia commented Jun 26, 2023

Uh oh!

melvin-bot Bot commented Jun 26, 2023

Uh oh!

amyevans left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 26, 2023

Uh oh!

OSBotify commented Jun 26, 2023

Uh oh!

OSBotify commented Jun 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iwiznia commented Jun 23, 2023 •

edited

Loading

aimane-chnaif Jun 23, 2023 •

edited

Loading