Fix: Redundant URL param `openOnAdminRoom` on log out #17447

tienifr · 2023-04-14T07:05:02Z

Details

On logging out, the openOnAdminRoom URL param is redundant. It should be omitted if it's undefined. This PR fixes that.

Fixed Issues

$ #16452
PROPOSAL: #16452 (comment)

Tests

Case 1

Create a new free policy in OldDot
Verify that you're redirected to the Workspace #admins room in NewDot
Logout
Verify the URL is the login page, without any query parameters

Case 2

Login to an account on NewDot
Logout
Verify the URL is the login page, without any query parameters

Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Case 1

Create a new free policy in OldDot
Verify that you're redirected to the Workspace #admins room in NewDot
Logout
Verify the URL is the login page, without any query parameters

Case 2

Login to an account on NewDot
Logout
Verify the URL is the login page, without any query parameters

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screencast.from.14-04-2023.13.27.32.webm

Mobile Web - Chrome

Screenrecording_20230414_140121.mp4

Mobile Web - Safari

Screen.Recording.2023-04-14.at.16.54.02.mov

Desktop

Screen.Recording.2023-04-14.at.17.01.17.mov

iOS

original-8F3C00F9-EB09-4670-B03A-DC5505C8F5C8.mp4

Android

untitled_0eYVwBNv.mp4

MelvinBot · 2023-04-14T10:10:06Z

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

situchan · 2023-04-14T11:39:55Z

Hopefully, this would get fixed in this PR

tienifr · 2023-04-17T05:35:39Z

@situchan I think the type warning is already resolved in this PR/commit: #11565 / 394ab32. Thus I couldn't reproduce it on both the latest main branch and this PR's branch.

Before the change, openOnAdminRoom is passed as a raw string (i.e. 'true' or 'false').

src/libs/ValidationUtils.js

amyevans · 2023-04-18T13:30:02Z

@thesahindia All you 😄

thesahindia · 2023-04-18T15:41:24Z

@tienifr, can you please update the package.json in this PR?

…redundant-url-param-on-log-out

tienifr · 2023-04-18T17:21:39Z

@thesahindia Didn't think the upstream was merged that fast 😄! I've updated the package version accordingly.

thesahindia · 2023-04-18T20:14:37Z

Ahh so there is one more case, we will still see openOnAdminRoom param after logout if we create a new policy at old dot then we will be redirected to the new dot. It will set openOnAdminRoom as true so when we logout we will still see it.

@tienifr, can you look into it?

amyevans · 2023-04-24T14:22:07Z

Sounds like an improvement over resetting the whole route, let's do it 👍

tienifr · 2023-04-24T16:52:02Z

@amyevans @thesahindia Tests well with both true and false! Also notice that the 'flickering' no longer happens. Please help take a look at the implementation.

Screencast.from.24-04-2023.23.49.41.webm

Screencast.from.24-04-2023.23.50.41.webm

situchan · 2023-04-25T12:42:41Z

Hopefully, this would get fixed in this PR

This is still happening on main

tienifr · 2023-04-25T17:21:01Z

@situchan Still cannot reproduce. Can you give more context?

situchan · 2023-04-25T17:32:45Z

@situchan Still cannot reproduce. Can you give more context?

logout if already logged in
visit http://localhost:8080/?openOnAdminRoom=false in another tab
login

thesahindia · 2023-04-25T21:39:34Z

Also notice that the 'flickering' no longer happens.

Cool! It looks good. It's EOD for me. I will test it in the morning.

thesahindia · 2023-04-26T16:50:37Z

Works well!

@tienifr, can you please look into #17447 (comment)?
Also please resolve the conflicts.

thesahindia · 2023-04-27T09:44:07Z

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

Screen.Recording.2023-04-26.at.9.18.34.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-26.at.9.54.32.PM.mov

Mobile Web - Safari

Screen.Recording.2023-04-26.at.10.09.20.PM.mov

Desktop

Screen.Recording.2023-04-26.at.9.28.24.PM.mov

iOS

Screen.Recording.2023-04-26.at.9.57.52.PM.mov

Android

Screen.Recording.2023-04-26.at.9.43.51.PM.mov

thesahindia

LGTM!

All yours @amyevans

amyevans

Looks good and tests well, just the 1 comment, plus please update your QA steps to cover the second scenario as well:

Create a new free policy in OldDot
Verify that you're redirected to the Workspace #admins room in NewDot
Logout
Verify the URL is the login page, without any query parameters

src/libs/actions/SignInRedirect.js

thesahindia

Sorry for the delay. I was away.

LGTM!

OSBotify · 2023-05-01T15:12:11Z

✋ 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-05-03T00:07:53Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.9-12 🚀

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

OSBotify · 2023-05-09T04:07:52Z

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

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

tienifr added 2 commits April 14, 2023 13:15

fix: redundant url param on log out

a0ee93f

fix NA value

2d5816b

tienifr marked this pull request as ready for review April 14, 2023 10:09

tienifr requested a review from a team as a code owner April 14, 2023 10:09

melvin-bot bot requested review from amyevans and thesahindia and removed request for a team April 14, 2023 10:10

tienifr mentioned this pull request Apr 14, 2023

[HOLD for payment 2023-05-16] [$1000] Web - On logout from the app weird url parameter shows on login page #16452

Closed

6 tasks

tienifr added 2 commits April 14, 2023 17:44

refactor stringToBool function

7abb4fd

add unit test for stringToBool

31b5c78

amyevans assigned tienifr Apr 14, 2023

thesahindia reviewed Apr 17, 2023

View reviewed changes

src/libs/ValidationUtils.js Outdated Show resolved Hide resolved

amyevans requested changes Apr 18, 2023

View reviewed changes

src/libs/ValidationUtils.js Outdated Show resolved Hide resolved

tienifr mentioned this pull request Apr 18, 2023

Make Str.toBool case insensitive Expensify/expensify-common#518

Merged

tienifr added 3 commits April 18, 2023 12:06

replace ValidationUtils with expensify-common Str.toBool

574372a

remove ValidationUtils.stringToBool

8d07f30

fix lint error

498c797

amyevans previously approved these changes Apr 18, 2023

View reviewed changes

update expensify-common version

89c6303

tienifr dismissed amyevans’s stale review via 89c6303 April 18, 2023 17:13

tienifr added 2 commits April 19, 2023 00:13

Merge branch 'main' of https://github.com/tienifr/App into fix/16452-…

7d096f9

…redundant-url-param-on-log-out

Merge branch 'main' of Expensify/App into fix/16452

8de6d26

amyevans previously approved these changes Apr 18, 2023

View reviewed changes

reset all params of Home route

7339b95

tienifr dismissed amyevans’s stale review via 7339b95 April 24, 2023 16:38

reset params by undefined value

4e605c0

tienifr added 4 commits April 24, 2023 23:56

fix navigationRef null error

857b787

fix undefined key homeRoute

e9076e0

default key homeRoute

1a11eee

fix unit test

45e7dfc

Merge main into fix/16542

a15cf37

thesahindia previously approved these changes Apr 27, 2023

View reviewed changes

amyevans requested changes Apr 28, 2023

View reviewed changes

src/libs/actions/SignInRedirect.js Outdated Show resolved Hide resolved

replace lodash with underscore

bed7f47

tienifr dismissed thesahindia’s stale review via bed7f47 April 28, 2023 16:04

fix lint

6c6feab

amyevans approved these changes Apr 28, 2023

View reviewed changes

thesahindia approved these changes May 1, 2023

View reviewed changes

amyevans merged commit e765eb5 into Expensify:main May 1, 2023

OSBotify mentioned this pull request May 2, 2023

Deploy Checklist: New Expensify 2023-05-02 #18315

Closed

marcaaron mentioned this pull request May 3, 2023

Deploy Checklist: New Expensify 2023-05-02 #18322

Closed

59 tasks

kbecciv mentioned this pull request May 3, 2023

[HOLD for payment 2023-07-20] [$1000] Web - Workspace - Workspace settings and chat on the background instead of #admins room #18351

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Redundant URL param `openOnAdminRoom` on log out #17447

Fix: Redundant URL param `openOnAdminRoom` on log out #17447

tienifr commented Apr 14, 2023 •

edited

Loading

MelvinBot commented Apr 14, 2023

situchan commented Apr 14, 2023

tienifr commented Apr 17, 2023 •

edited

Loading

amyevans commented Apr 18, 2023

thesahindia commented Apr 18, 2023

tienifr commented Apr 18, 2023 •

edited

Loading

thesahindia commented Apr 18, 2023

amyevans commented Apr 24, 2023

tienifr commented Apr 24, 2023 •

edited

Loading

situchan commented Apr 25, 2023

tienifr commented Apr 25, 2023

situchan commented Apr 25, 2023 •

edited

Loading

thesahindia commented Apr 25, 2023

thesahindia commented Apr 26, 2023

thesahindia commented Apr 27, 2023

thesahindia left a comment

amyevans left a comment

thesahindia left a comment

OSBotify commented May 1, 2023

OSBotify commented May 3, 2023

OSBotify commented May 9, 2023

Fix: Redundant URL param openOnAdminRoom on log out #17447

Fix: Redundant URL param openOnAdminRoom on log out #17447

Conversation

tienifr commented Apr 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 14, 2023

situchan commented Apr 14, 2023

tienifr commented Apr 17, 2023 • edited Loading

amyevans commented Apr 18, 2023

thesahindia commented Apr 18, 2023

tienifr commented Apr 18, 2023 • edited Loading

thesahindia commented Apr 18, 2023

amyevans commented Apr 24, 2023

tienifr commented Apr 24, 2023 • edited Loading

situchan commented Apr 25, 2023

tienifr commented Apr 25, 2023

situchan commented Apr 25, 2023 • edited Loading

thesahindia commented Apr 25, 2023

thesahindia commented Apr 26, 2023

thesahindia commented Apr 27, 2023

Reviewer Checklist

Screenshots/Videos

thesahindia left a comment

Choose a reason for hiding this comment

amyevans left a comment

Choose a reason for hiding this comment

thesahindia left a comment

Choose a reason for hiding this comment

OSBotify commented May 1, 2023

OSBotify commented May 3, 2023

OSBotify commented May 9, 2023

Fix: Redundant URL param `openOnAdminRoom` on log out #17447

Fix: Redundant URL param `openOnAdminRoom` on log out #17447

tienifr commented Apr 14, 2023 •

edited

Loading

tienifr commented Apr 17, 2023 •

edited

Loading

tienifr commented Apr 18, 2023 •

edited

Loading

tienifr commented Apr 24, 2023 •

edited

Loading

situchan commented Apr 25, 2023 •

edited

Loading