Add supportal navigation by danieldoglas · Pull Request #35410 · Expensify/App

danieldoglas · 2024-01-30T14:55:58Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/363810
PROPOSAL:

Tests

This will be tested with internal tools. Follow QA steps here: https://github.com/Expensify/Web-Expensify/pull/40720
Verify that no errors appear in the JS console

Offline tests

QA Steps

for the QA team: please test all transitions from Old Dot to new Dot
This will be tested with internal tools. Follow QA steps here: https://github.com/Expensify/Web-Expensify/pull/40720
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 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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/libs/actions/Session/index.ts

danieldoglas · 2024-02-06T17:22:48Z

That lint error was not introduced in this PR

melvin-bot · 2024-02-06T17:36:14Z

@ishpaul777 @ One of you needs to 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]

danieldoglas · 2024-02-06T17:36:37Z

This PR can only be tested internally

…logic

danieldoglas · 2024-03-04T15:29:57Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

+        const isSupportalTransition = currentUrl.includes('authTokenType=support');
        if (isLoggingInAsNewUser && isTransitioning) {
-            Session.signOutAndRedirectToSignIn();
+            Session.signOutAndRedirectToSignIn(false, isSupportalTransition);


I thought it was strange we had to add this here, but while testing, around 30% of the times we called signOutAndRedirectToSignIn from here instead of LogoutPreviousUserPage

danieldoglas · 2024-03-04T15:57:03Z

Ok @roryabraham I think this is finally ready. Can you please also test it with the instructions on https://github.com/Expensify/Web-Expensify/pull/40720 to be sure I'm not missing something on my own tests?

src/libs/Navigation/AppNavigator/AuthScreens.tsx

src/libs/Navigation/types.ts

src/libs/Network/enhanceParameters.ts

roryabraham · 2024-03-04T21:47:09Z

src/libs/actions/Session/index.ts

    callback: (val) => (preferredLocale = val),
 });

+function isSupportalToken(): boolean {


this seems like it's effectively the same as NetworkStore.isSupportAuthToken. Can we DRY this up?

hm, there was a reason why this was added in both places when we first implemented this. I think it was something related to cyclical imports and that the middleware couldn't use the place where we kept isSupportAuthToken before. But it's been a while since the first version, so I don't remember why anymore, and looks like I can use the Session. isSupportAuthToken everywhere.

Nope, it actually fails to execute if I try to use Session.isSupportAuthToken here.

src/libs/actions/Session/index.ts

roryabraham

kk, no more blockers and this is testing well for me

roryabraham · 2024-03-04T23:43:21Z

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

web.mov

MacOS: Desktop

OSBotify · 2024-03-04T23:53:43Z

✋ 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-03-06T22:04:37Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.48-0 🚀

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

OSBotify · 2024-03-07T23:50:36Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.48-0 🚀

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

danieldoglas added 5 commits January 30, 2024 14:37

adding new properties

eb42af8

adding new logic for setting supportal token on public pages

fe65f54

adding logic in case you already have a session

ad993ab

converting accountID to Number

f5acfa8

adding type of auth token to setSupportAuthToken

9020de7

danieldoglas added the InternalQA This pull request required internal QA label Jan 30, 2024

danieldoglas self-assigned this Jan 30, 2024

danieldoglas added 2 commits February 2, 2024 16:02

Merge branch 'main' into dsilva_addSupportalNavigation

214590e

Merge branch 'main' into dsilva_addSupportalNavigation

9343f30

mountiny reviewed Feb 6, 2024

View reviewed changes

src/libs/actions/Session/index.ts Outdated Show resolved Hide resolved

danieldoglas added 2 commits February 6, 2024 17:35

adding logs

28c567f

fixing linter

0b896fd

danieldoglas force-pushed the dsilva_addSupportalNavigation branch from 480a17e to 0b896fd Compare February 6, 2024 17:07

Merge branch 'main' into dsilva_addSupportalNavigation

a4a6ab1

danieldoglas requested a review from roryabraham February 6, 2024 17:36

danieldoglas marked this pull request as ready for review February 6, 2024 17:36

danieldoglas requested a review from a team as a code owner February 6, 2024 17:36

melvin-bot bot requested review from ishpaul777 and removed request for a team February 6, 2024 17:36

danieldoglas removed the request for review from ishpaul777 February 6, 2024 17:36

danieldoglas added 2 commits February 6, 2024 18:43

Merge branch 'main' into dsilva_addSupportalNavigation

72391f0

prettier

9b015a2

danieldoglas requested review from a team and mountiny February 7, 2024 16:08

melvin-bot bot requested review from mananjadhav and removed request for a team February 8, 2024 13:27

danieldoglas removed the request for review from mananjadhav February 8, 2024 13:28

danieldoglas added 6 commits March 4, 2024 16:01

Add propertitieson authscreen to guarantee we're executing the right …

61ec184

…logic

adding spanish translation

ffb1d56

prettier

eed0aaf

Merge branch 'main' into dsilva_addSupportalNavigation

e7b135f

linter

f06e890

setting settion import as type

573bbb5

danieldoglas commented Mar 4, 2024

View reviewed changes

danieldoglas added 2 commits March 4, 2024 16:55

refactor function for simplicity

6d63941

prettier again

a5f45b2

danieldoglas requested a review from roryabraham March 4, 2024 15:56

danieldoglas changed the title ~~[WIP] Add supportal navigation~~ Add supportal navigation Mar 4, 2024

roryabraham reviewed Mar 4, 2024

View reviewed changes

danieldoglas added 8 commits March 4, 2024 23:22

renaming property to clearer name

114aee3

removing check if it's supportal call when enhancing the parameters

4af67a9

setting parameters as optional

20b943d

DRYing functions

6fd8978

DRYing functions

992ed3a

getting function back to network

2931b5e

Merge branch 'main' into dsilva_addSupportalNavigation

9904a01

fix comment after merge

205cb7f

danieldoglas requested a review from roryabraham March 4, 2024 23:02

roryabraham approved these changes Mar 4, 2024

View reviewed changes

roryabraham merged commit 2a89743 into main Mar 4, 2024

roryabraham deleted the dsilva_addSupportalNavigation branch March 4, 2024 23:48

github-actions bot mentioned this pull request Mar 6, 2024

Deploy Checklist: New Expensify 2024-03-06 #37845

Closed

63 tasks

Conversation

danieldoglas commented Jan 30, 2024 • 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!

Uh oh!

danieldoglas commented Feb 6, 2024

Uh oh!

melvin-bot bot commented Feb 6, 2024

Uh oh!

danieldoglas commented Feb 6, 2024

Uh oh!

danieldoglas Mar 4, 2024

Choose a reason for hiding this comment

Uh oh!

danieldoglas commented Mar 4, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

roryabraham Mar 4, 2024

Choose a reason for hiding this comment

Uh oh!

danieldoglas Mar 4, 2024

Choose a reason for hiding this comment

Uh oh!

danieldoglas Mar 4, 2024 • 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Mar 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Mar 4, 2024

Uh oh!

OSBotify commented Mar 6, 2024

Uh oh!

OSBotify commented Mar 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

danieldoglas commented Jan 30, 2024 •

edited

Loading

danieldoglas Mar 4, 2024 •

edited

Loading

roryabraham commented Mar 4, 2024 •

edited

Loading