[No QA] Create platform specific syncBrowserHistory function #50719

adamgrzybowski · 2024-10-14T11:24:56Z

Details

I created platform specific syncBrowserHistory function because we only want to manipulate the history object in the browser. There is no easy way to record videos for that so I am not including videos. The change is quite simple and I tested it by changing some code to see if it works.

Fixed Issues

$ #50713
PROPOSAL:

Tests

Verify that no errors appear in the JS console

To test this PR you need to make some changes in the code

Change the hasCompletedGuidedSetupFlowSelector in onboardingSelectors.ts to always return false.
Add a button that triggers the reset on BaseOnboardingPurpose.tsx

<Pressable
  style={{height: 50, width: 50, backgroundColor: 'red'}}
  onPress={() => {
    navigationRef.resetRoot(getStateFromPath('/home', linkingConfig.config));
  }}
  accessibilityRole="button"
/>

Open the Android app and press the red Pressable.
Verify that there is no error/crash related to history and that the user stays on the onboarding screen.
Verify that the text "Please finish the setup questions to start using the app" is visible.

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

MacOS: Desktop

melvin-bot · 2024-10-14T11:25:01Z

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

mountiny · 2024-10-14T11:27:14Z

cc @kirillzyusko this might be something to not forget in the native stack pr

s77rt · 2024-10-14T11:29:40Z

src/libs/Navigation/AppNavigator/createCustomStackNavigator/CustomRouter.ts

There is another file that requires same fix src/libs/Navigation/AppNavigator/createResponsiveStackNavigator/CustomRouter.ts

Right, I forgot that we merged the native stack. Thanks!

Yeah, probably need to replicate these changes in native-stack navigator as well 👍

@adamgrzybowski will you do that in this PR?

Hmm actually isn't this some leftover after merging the native stack? I think that createResponsiveStackNavigator isn't used anywhere

Hmm actually isn't this some leftover after merging the native stack? I think that createResponsiveStackNavigator isn't used anywhere

@adamgrzybowski it's not used at the moment, because we decided to split PR in two parts (the first one is with all basic work (i. e. creation of new navigators), new patches etc.) and the other one that actually starts to use it: #49937

But I think it would be better to synchronize all new changes between various navigators, right?

Yes, in that case, I will apply the changes for both routers. Thanks!

adamgrzybowski · 2024-10-14T11:36:04Z

ooops wrong import 😄

s77rt · 2024-10-14T12:24:59Z

src/libs/Navigation/AppNavigator/createResponsiveStackNavigator/CustomRouter.ts

        return true;
    }
+
+    return true;


Suggested change

return true;

return false;

Hah, thanks 😄

s77rt · 2024-10-14T13:00:42Z

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

android.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

s77rt · 2024-10-14T13:07:14Z

@adamgrzybowski I think we should add [No QA] to the title

OSBotify · 2024-10-14T17:30:15Z

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

github-actions · 2024-10-15T03:32:17Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.49-0 🚀

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

github-actions · 2024-10-17T01:47:12Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.49-2 🚀

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

create platform specific syncBrowserHistory function

1a11962

adamgrzybowski requested a review from a team as a code owner October 14, 2024 11:24

melvin-bot bot requested review from alitoshmatov and removed request for a team October 14, 2024 11:24

mountiny self-requested a review October 14, 2024 11:26

mountiny assigned adamgrzybowski Oct 14, 2024

s77rt reviewed Oct 14, 2024

View reviewed changes

adamgrzybowski added 2 commits October 14, 2024 13:37

fix import

8a7bf7b

add syncBrowserHistory in the second router

0d28d11

s77rt reviewed Oct 14, 2024

View reviewed changes

fix return

87fc33b

s77rt approved these changes Oct 14, 2024

View reviewed changes

adamgrzybowski changed the title ~~Create platform specific syncBrowserHistory function~~ [No QA] Create platform specific syncBrowserHistory function Oct 14, 2024

mountiny approved these changes Oct 14, 2024

View reviewed changes

mountiny merged commit d5a108d into Expensify:main Oct 14, 2024
18 checks passed

mountiny removed the request for review from alitoshmatov October 15, 2024 02:39

github-actions bot mentioned this pull request Oct 15, 2024

Deploy Checklist: New Expensify 2024-10-15 #50764

Closed

71 tasks

melvin-bot bot mentioned this pull request Oct 17, 2024

[PAID] Render Error in android emulator #50713

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Create platform specific syncBrowserHistory function #50719

[No QA] Create platform specific syncBrowserHistory function #50719

adamgrzybowski commented Oct 14, 2024 •

edited

Loading

melvin-bot bot commented Oct 14, 2024

mountiny commented Oct 14, 2024

s77rt Oct 14, 2024

adamgrzybowski Oct 14, 2024

kirillzyusko Oct 14, 2024

adamgrzybowski Oct 14, 2024

kirillzyusko Oct 14, 2024

adamgrzybowski Oct 14, 2024

adamgrzybowski commented Oct 14, 2024

s77rt Oct 14, 2024

adamgrzybowski Oct 14, 2024

s77rt commented Oct 14, 2024

s77rt commented Oct 14, 2024

OSBotify commented Oct 14, 2024

github-actions bot commented Oct 15, 2024

github-actions bot commented Oct 17, 2024

[No QA] Create platform specific syncBrowserHistory function #50719

[No QA] Create platform specific syncBrowserHistory function #50719

Conversation

adamgrzybowski commented Oct 14, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 14, 2024

mountiny commented Oct 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamgrzybowski commented Oct 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt commented Oct 14, 2024

Reviewer Checklist

Screenshots/Videos

s77rt commented Oct 14, 2024

OSBotify commented Oct 14, 2024

github-actions bot commented Oct 15, 2024

github-actions bot commented Oct 17, 2024

adamgrzybowski commented Oct 14, 2024 •

edited

Loading