Make OpenApp a write command #37062

youssef-lr · 2024-02-22T02:33:17Z

cc @iwiznia @tgolen @roryabraham @marcochavezf

Details

This PR makes OpenApp a write command so that for anonymous users we make sure to process OpenApp first before any requests that are made after it.

Summary of my findings from this thread

The first request an anonymous user makes is OpenReport of the parent room, OpenReport is processed first and does not return a lastUpdateID

The app then makes a call to OpenApp as usual, but its response is not processed immediately as it’s a read command, the sequential queue must process write commands first, and in this case it’s still processing OpenReport

Anon clicks quickly on a thread and triggers another call to OpenReport which we will process before OpenApp ’s response

Once we attempt to save the response of the 2ndOpenReport , the sequential queue finds out we don’t have a lastUpdateID set here and calls ReconnectApp

The sequential queue is paused until we process ReconnectApp which comes back with a lastUpdateID equal to OpenReport ’s

We unpause the queue to apply the update from OpenReport but since it has the same update ID we now have in the client we don’t apply its response and we end up with the component not having a report set.

So in conclusion, I think this is due to navigating to the thread quickly before OpenApp has finished, so if we make it a write, it’ll be processed first before we process OpenReport when opening the thread

Fixed Issues

$ #36430

Tests

Verify that no errors appear in the JS console

To reproduce locally add a sleep(3) to openApp here, as to reproduce this bug OpenReport needs to finish before OpenApp.
Create a workspace room with visibility set to public, create a thread inside the room.
Open the room as an anonymous user in an incognito window, and click on the thread as fast as you can.
Make sure it loads properly.

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-02-21.at.23.10.24.mov

MacOS: Desktop

melvin-bot · 2024-02-22T02:33:45Z

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

marcochavezf · 2024-02-22T03:47:51Z

Seems we'd need to update the unit test cases and types too

youssef-lr · 2024-02-22T03:49:14Z

Yeah I'm looking into it now

tgolen

In theory, I am not a fan of this change. I think it blurs the lines between why something is a read/write in the first place. If something is being made a read/write only to have some kind of effect in the UI, and it is not based on the command actually "reading or writing" to the database, then I think it's an indication that we are doing something wrong.

Since it sounds like the real intention is to have OpenApp go into the synchronous blocking queue, I'd be much more in favor of us opening up an option for that so that we can be explicit that this is still a READ command, but the request needs to go into the synchronous queue for X reason.

youssef-lr · 2024-02-22T15:24:42Z

@tgolen I agree and I thought about that, but OpenApp can actually be a write command as it creates a chat report here as @marcochavezf pointed out in the thread. Also, in Web-E openApp eventually calls reconnectApp, which is a write command, so I'm not really sure why we're having it as a read command.

but the request needs to go into the synchronous queue for X reason.

It's still a bit blurry for me what exactly the reason is, but I'll try to figure it out again today so we can be confident about this change.

tgolen · 2024-02-22T15:55:08Z

OK, thanks! That's great if OpenApp results in WRITEs being done.

iwiznia · 2024-02-22T19:34:07Z

Web-E openApp eventually calls reconnectApp, which is a write command

reconnectApp is a write command??? What does it write?

youssef-lr · 2024-02-22T20:08:09Z

reconnectApp is a write command??? What does it write?

I'm not sure, if it doesn't actually write anything, it seems like we made it a write solely to have it block the queue? cc @tgolen I can see it was added here. Also cc'ing @danieldoglas as you might have context as well

tgolen · 2024-02-22T21:45:15Z

The design doc said: "It will call `API.write` (doing this so that it blocks all other calls)" So yeah, I think your assumption is correct. No wonder why I didn't like manipulating read/write like that!

…

On Thu, Feb 22, 2024 at 1:08 PM Youssef Lourayad ***@***.***> wrote: reconnectApp is a write command??? What does it write? I'm not sure, if it doesn't actually write anything, it seems like we made it solely to have it block the queue? cc @tgolen <https://github.com/tgolen> I can see it was added here <#23516> — Reply to this email directly, view it on GitHub <#37062 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJMAB2ECJFK2PIMR3WPSCDYU6QTLAVCNFSM6AAAAABDUEGEPWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRQGIYDONBQHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

iwiznia · 2024-02-23T15:45:57Z

Can someone exlpain why ReconnectApp needs to block other calls? I can understand it for OpenApp but not for ReconnectApp.

youssef-lr · 2024-02-25T04:24:12Z

tests/unit/NetworkTest.js

-                App.openApp();
-                App.openApp();
-                App.openApp();
+                PersonalDetails.openPersonalDetails();


I had to use a READ command here to make the test pass. It seems like this behaves differently when we call a write command.

I tested this scenario though of a write command with an expired authToken and I was re-authenticated properly.

Could you please update the comment above here that says "make 3 API requests" to specifically say that they are READ requests?

tgolen · 2024-02-26T17:15:24Z

tests/unit/NetworkTest.js

-                App.openApp();
-                App.openApp();
-                App.openApp();
+                PersonalDetails.openPersonalDetails();


Could you please update the comment above here that says "make 3 API requests" to specifically say that they are READ requests?

youssef-lr · 2024-02-27T01:38:09Z

cc'ing @marcaaron as well

marcaaron

These changes seem fine as far as I understand them. The "skew" stuff I am not sure about tbh still need to catch up on why we added that.

marcaaron · 2024-02-27T01:53:53Z

src/libs/HttpUtils.ts

@@ -31,7 +31,7 @@ let cancellationController = new AbortController();
 /**
 * The API commands that require the skew calculation


probably unrelated, but I am completely confused about what a "skew calculation" refers to here. I see these changes, but did not have an opportunity to make sense of them yet.

marcaaron · 2024-02-27T01:57:09Z

tests/unit/NetworkTest.js

@@ -101,8 +101,7 @@ describe('NetworkTests', () => {
                );

            // This should first trigger re-authentication and then a Failed to fetch
-            App.confirmReadyToOpenApp();
-            App.openApp();
+            PersonalDetails.openPersonalDetails();


Ah I see we just picked a flow arbitrarily to confirm the re-auth behavior? Looks good!

youssef-lr · 2024-02-27T08:33:29Z

Looks like we just need a checklist, since this is hard to reproduce on mobile, I think we can just do web screenshots.

marcochavezf · 2024-02-27T23:20:08Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-02-27.at.5.42.37.p.m.mov

MacOS: Desktop

OSBotify · 2024-02-27T23:50:46Z

✋ 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 · 2024-02-29T00:07:22Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.45-0 🚀

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

OSBotify · 2024-02-29T23:31:50Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

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

Make OpenApp a write command

0a926b4

youssef-lr self-assigned this Feb 22, 2024

youssef-lr requested a review from a team as a code owner February 22, 2024 02:33

melvin-bot bot requested review from Gonals and removed request for a team February 22, 2024 02:33

Lint

456cc9f

iwiznia previously approved these changes Feb 22, 2024

View reviewed changes

tgolen previously approved these changes Feb 22, 2024

View reviewed changes

youssef-lr added 2 commits February 24, 2024 21:52

Merge branch 'main' into youssef_make_OpenApp_write

80312e1

Fix test

1869a6b

youssef-lr dismissed stale reviews from tgolen and iwiznia via 1869a6b February 25, 2024 04:23

youssef-lr commented Feb 25, 2024

View reviewed changes

Fix another test

53feadb

iwiznia previously approved these changes Feb 26, 2024

View reviewed changes

tgolen requested changes Feb 26, 2024

View reviewed changes

Update comment

e22fa7d

youssef-lr dismissed iwiznia’s stale review via e22fa7d February 27, 2024 01:39

marcaaron approved these changes Feb 27, 2024

View reviewed changes

tgolen approved these changes Feb 27, 2024

View reviewed changes

iwiznia approved these changes Feb 27, 2024

View reviewed changes

marcochavezf approved these changes Feb 27, 2024

View reviewed changes

marcochavezf merged commit b447c11 into main Feb 27, 2024
15 of 20 checks passed

marcochavezf deleted the youssef_make_OpenApp_write branch February 27, 2024 23:45

github-actions bot mentioned this pull request Feb 28, 2024

Deploy Checklist: New Expensify 2024-02-28 #37459

Closed

91 tasks

melvin-bot bot mentioned this pull request Feb 29, 2024

[HOLD for payment 2024-03-07] HIGH: Navigating to a thread in a public room immediately as an anonymous user shows "it's not here" page #36430

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make OpenApp a write command #37062

Make OpenApp a write command #37062

youssef-lr commented Feb 22, 2024 •

edited

Loading

melvin-bot bot commented Feb 22, 2024

marcochavezf commented Feb 22, 2024

youssef-lr commented Feb 22, 2024

tgolen left a comment

youssef-lr commented Feb 22, 2024 •

edited

Loading

tgolen commented Feb 22, 2024 •

edited

Loading

iwiznia commented Feb 22, 2024

youssef-lr commented Feb 22, 2024 •

edited

Loading

tgolen commented Feb 22, 2024 via email

iwiznia commented Feb 23, 2024

youssef-lr Feb 25, 2024

youssef-lr Feb 25, 2024

tgolen Feb 26, 2024 •

edited

Loading

youssef-lr Feb 27, 2024

tgolen Feb 26, 2024 •

edited

Loading

youssef-lr commented Feb 27, 2024

marcaaron left a comment

marcaaron Feb 27, 2024

marcaaron Feb 27, 2024

youssef-lr commented Feb 27, 2024

marcochavezf commented Feb 27, 2024 •

edited

Loading

OSBotify commented Feb 27, 2024

OSBotify commented Feb 29, 2024

OSBotify commented Feb 29, 2024

		@@ -31,7 +31,7 @@ let cancellationController = new AbortController();
		/**
		* The API commands that require the skew calculation

Make OpenApp a write command #37062

Make OpenApp a write command #37062

Conversation

youssef-lr commented Feb 22, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 22, 2024

marcochavezf commented Feb 22, 2024

youssef-lr commented Feb 22, 2024

tgolen left a comment

Choose a reason for hiding this comment

youssef-lr commented Feb 22, 2024 • edited Loading

tgolen commented Feb 22, 2024 • edited Loading

iwiznia commented Feb 22, 2024

youssef-lr commented Feb 22, 2024 • edited Loading

tgolen commented Feb 22, 2024 via email

iwiznia commented Feb 23, 2024

youssef-lr Feb 25, 2024

Choose a reason for hiding this comment

youssef-lr Feb 25, 2024

Choose a reason for hiding this comment

tgolen Feb 26, 2024 • edited Loading

Choose a reason for hiding this comment

youssef-lr Feb 27, 2024

Choose a reason for hiding this comment

tgolen Feb 26, 2024 • edited Loading

Choose a reason for hiding this comment

youssef-lr commented Feb 27, 2024

marcaaron left a comment

Choose a reason for hiding this comment

marcaaron Feb 27, 2024

Choose a reason for hiding this comment

marcaaron Feb 27, 2024

Choose a reason for hiding this comment

youssef-lr commented Feb 27, 2024

marcochavezf commented Feb 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Feb 27, 2024

OSBotify commented Feb 29, 2024

OSBotify commented Feb 29, 2024

youssef-lr commented Feb 22, 2024 •

edited

Loading

youssef-lr commented Feb 22, 2024 •

edited

Loading

tgolen commented Feb 22, 2024 •

edited

Loading

youssef-lr commented Feb 22, 2024 •

edited

Loading

tgolen Feb 26, 2024 •

edited

Loading

tgolen Feb 26, 2024 •

edited

Loading

marcochavezf commented Feb 27, 2024 •

edited

Loading