Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

show not found page for invalid links #13027

Merged
merged 2 commits into from
Nov 30, 2022
Merged

Conversation

aimane-chnaif
Copy link
Contributor

@aimane-chnaif aimane-chnaif commented Nov 24, 2022

Details

show generic not found page when go to invalid links

Fixed Issues

$ #9818
PROPOSAL: #9818 (comment)

Tests

Scenario 1:

  1. Go to any chat room
  2. Send any message containing invalid links (i.e. https://staging.new.expensify.com/test, https://staging.new.expensify.com/r/4599960897843771/test)
  3. Click that link
  4. Verify that app shows full not found page

Scenario 2: (web, mWeb)

  1. Go to https://staging.new.expensify.com
  2. Login with any account
  3. Enter any invalid Expensify link (i.e. https://staging.new.expensify.com/test, https://staging.new.expensify.com/r/4599960897843771/test) in address bar
  4. Verify that app shows full not found page
  • Verify that no errors appear in the JS console

Offline tests

Scenario 1:

  1. Go to any chat room
  2. Turn off network
  3. Send any message containing invalid links (i.e. https://staging.new.expensify.com/test, https://staging.new.expensify.com/r/4599960897843771/test)
  4. Click that link
  5. Verify that app shows full not found page

Scenario 2: (web, mWeb)
This can't be tested in offline mode

QA Steps

Scenario 1:

  1. Go to any chat room
  2. Send any message containing invalid links (i.e. https://staging.new.expensify.com/test, https://staging.new.expensify.com/r/4599960897843771/test)
  3. Click that link
  4. Verify that app shows full not found page

Scenario 2: (web, mWeb)

  1. Go to https://staging.new.expensify.com
  2. Login with any account
  3. Enter any invalid Expensify link (i.e. https://staging.new.expensify.com/test, https://staging.new.expensify.com/r/4599960897843771/test) in address bar
  4. Verify that app shows full not found page
  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and 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 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 expected offline behavior are in the Offline steps 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 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 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and 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
  • 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 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 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.
  • 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

android

Mobile Web - Safari
msafari.mp4
Desktop
desktop.mov
iOS
ios.mp4
Android

android

@aimane-chnaif aimane-chnaif requested a review from a team as a code owner November 24, 2022 22:04
@melvin-bot melvin-bot bot requested review from pecanoro and Santhosh-Sellavel and removed request for a team November 24, 2022 22:04
@melvin-bot
Copy link

melvin-bot bot commented Nov 24, 2022

@pecanoro @Santhosh-Sellavel 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]

@Santhosh-Sellavel
Copy link
Collaborator

Seems to be working well. One doubt url alone is not persisted in address bar here when clicking link from message. Are we good with this @pecanoro
Screenshot 2022-11-27 at 11 53 17 PM

@pecanoro
Copy link
Contributor

@aimane-chnaif Is there a way to keep the original URL in the navigation instead of showing /NotFound?

@aimane-chnaif
Copy link
Contributor Author

@aimane-chnaif Is there a way to keep the original URL in the navigation instead of showing /NotFound?

I already researched that but found no way yet in react-navigation

@pecanoro
Copy link
Contributor

@aimane-chnaif Ok! One last thing, is https://staging.new.expensify.com/r/4599960897843771 still working as before? We used to handle invalid chats properly already, just making sure we didn't remove it here.

@Santhosh-Sellavel
Copy link
Collaborator

@pecanoro

@aimane-chnaif Ok! One last thing, is https://staging.new.expensify.com/r/4599960897843771 still working as before? We used to handle invalid chats properly already, just making sure we didn't remove it here.

This is working fine!

@aimane-chnaif
Copy link
Contributor Author

@aimane-chnaif Ok! One last thing, is https://staging.new.expensify.com/r/4599960897843771 still working as before? We used to handle invalid chats properly already, just making sure we didn't remove it here.

yes, my PR doesn't affect original behavior for that link

@pecanoro
Copy link
Contributor

@marcaaron Just doubling checking, are you ok if we show /NotFound for the new route when we click a link that does not exist?

@marcaaron
Copy link
Contributor

Oh hmm /NotFound is kind of a strange path. I would think we can make that whatever we want with a custom path like /404 or change it to /not-found, but if not then I don't think it's that big of a deal. The docs for this are here, but don't seem to mention customizing the path. Maybe it's possible to do something like this:

const config = {
  screens: {
    Home: {
      initialRouteName: 'Feed',
      screens: {
        Profile: 'users/:id',
        Settings: 'settings',
      },
    },
    'not-found': '*', // or 404: '*'
  },
};

@aimane-chnaif
Copy link
Contributor Author

yeah different naming is possible. I also think NotFound is bad path in url.
What do you prefer? 'not-found' or '404' or any other else?

@pecanoro
Copy link
Contributor

pecanoro commented Nov 28, 2022

I prefer /not-found just because it is more descriptive, but not super strong opinion either way.

@aimane-chnaif
Copy link
Contributor Author

updated to /not-found and pushed
since it's better naming than /NotFound

@aimane-chnaif
Copy link
Contributor Author

@pecanoro please check

@pecanoro
Copy link
Contributor

Can you update the videos to show the updated URL? I will review tomorrow morning!

@aimane-chnaif
Copy link
Contributor Author

Can you update the videos to show the updated URL? I will review tomorrow morning!

@pecanoro updated videos

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 29, 2022

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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and 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 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 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.
  • 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.2022-11-29.at.11.23.24.PM.mov
Mobile Web - Chrome & Safari
Screen.Recording.2022-11-29.at.11.19.46.PM.mov
Desktop
Screen.Recording.2022-11-29.at.11.22.19.PM.mov
iOS & Android
Screen.Recording.2022-11-29.at.11.16.03.PM.mov

@Santhosh-Sellavel
Copy link
Collaborator

Noticed one weird behavior, while clicking an invalid report URL from the message. Chat Not Found is shown on the Desktop. But in mWeb/native navigated to the chat list the behavior is the same on staging/production. It's not introduced here should we report this in slack?

ReportInvalid.mp4

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, and tests well. Just a doubt here

@pecanoro
Copy link
Contributor

Noticed one weird behavior, while clicking an invalid report URL from the message. Chat Not Found is shown on the Desktop. But in mWeb/native navigated to the chat list the behavior is the same on staging/production. It's not introduced here should we report this in slack?

I feel it should be part of the solution, do we know why the left navigation gets opened?

@aimane-chnaif
Copy link
Contributor Author

I think that's out of scope for this GH. /r/xxx is considered valid url assuming xxx is report id but the issue is that user doesn't have access to that chat room or that report id doesn't exist.
So I think it can be handled in a separated GH

@aimane-chnaif
Copy link
Contributor Author

Actually, we don't need to worry about that case.
@Santhosh-Sellavel that happens because you tested staging url in localhost.
If you test that url in staging, it should work as expected.

@aimane-chnaif
Copy link
Contributor Author

Not sure thanksgiving holidays period are considered as business days but I'd like to get this sorted asap considering bonus/penalty timeline.

@pecanoro pecanoro merged commit 6a50344 into Expensify:main Nov 30, 2022
@OSBotify
Copy link
Contributor

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

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 30, 2022

Actually, we don't need to worry about that case. @Santhosh-Sellavel that happens because you tested staging url in localhost. If you test that url in staging, it should work as expected.

Check here as I mentioned

But in mWeb/native navigated to the chat list the behavior is the same on staging/production.

It already occurs on staging also.

@OSBotify
Copy link
Contributor

OSBotify commented Dec 1, 2022

🚀 Deployed to staging by @pecanoro in version: 1.2.35-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 2, 2022

🚀 Deployed to production by @luacmartins in version: 1.2.35-0 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants