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

Add a route for easy redirects to the start request flow #33303

Merged
merged 6 commits into from
Dec 28, 2023

Conversation

tgolen
Copy link
Contributor

@tgolen tgolen commented Dec 19, 2023

Details

This allows for easy URLs that can link straight to the request flows. These are used in promotional messages.

This is intended to only work with web and for people that are using mobile, we expect it to open on mobile web.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/352160

Tests

  1. Go to https://dev.new.expensify.com:8082/start/request/manual
  2. Verify you see the manual request start page
  3. Go to https://dev.new.expensify.com:8082/start/request/scan
  4. Verify you see the scan request start page
  5. Go to https://dev.new.expensify.com:8082/start/request/distance
  6. Verify you see the distance request start page
  • Verify that no errors appear in the JS console

Offline tests

None, this doesn't really work offline.

QA Steps

NOTE: You only need to test web and mobile web. This isn't intended to work on other platforms.

  1. Go to https://staging.new.expensify.com/start/request/manual
  2. Verify you see the manual request start page
  3. Go to https://staging.new.expensify.com/start/request/scan
  4. Verify you see the scan request start page
  5. Go to https://staging.new.expensify.com/start/request/distance
  6. Verify you see the distance request start 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:
    • Android: Native CANNOT BE TESTED
    • Android: mWeb Chrome CANNOT BE TESTED
    • iOS: Native CANNOT BE TESTED
    • iOS: mWeb Safari CANNOT BE TESTED
    • MacOS: Chrome / Safari
    • MacOS: Desktop CANNOT BE TESTED
  • 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 image
MacOS: Chrome / Safari image
MacOS: Desktop

@tgolen tgolen self-assigned this Dec 19, 2023
@tgolen tgolen requested a review from a team as a code owner December 19, 2023 16:34
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team December 19, 2023 16:34
Copy link

melvin-bot bot commented Dec 19, 2023

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

luacmartins
luacmartins previously approved these changes Dec 20, 2023
@luacmartins
Copy link
Contributor

Should we add a C+ for review?

@situchan
Copy link
Contributor

I'd be interested if requires C+ review

@tgolen
Copy link
Contributor Author

tgolen commented Dec 20, 2023

Sure, go for it.

@luacmartins luacmartins requested a review from situchan December 21, 2023 10:23
@dylanexpensify
Copy link
Contributor

@situchan do we think you'll have review done today?

@situchan
Copy link
Contributor

yes I'll

arosiclair
arosiclair previously approved these changes Dec 26, 2023
@situchan
Copy link
Contributor

@tgolen please merge main

@tgolen
Copy link
Contributor Author

tgolen commented Dec 26, 2023

I can, but is it necessary to?

@situchan
Copy link
Contributor

I can, but is it necessary to?

just for safety. as 800 commits behind

@tgolen
Copy link
Contributor Author

tgolen commented Dec 26, 2023

I think it's OK. There is nothing wrong with being 800 commits behind if there are no conflicts or changes to the areas being touched.

@situchan
Copy link
Contributor

I think it's OK. There is nothing wrong with being 800 commits behind if there are no conflicts or changes to the areas being touched.

nvm, I am pulling main locally since there was expo image PR merged in between, which requires full android re-build

@situchan
Copy link
Contributor

Please remove :8082 in QA steps

@situchan
Copy link
Contributor

RHP page is opened 2 times

Screen.Recording.2023-12-27.at.3.15.42.AM.mov

And console error:

Screenshot 2023-12-27 at 3 15 31 AM

@tgolen
Copy link
Contributor Author

tgolen commented Dec 26, 2023

Thanks for reporting the issue with the RHP opening twice. It doesn't appear like you are following the test steps, where the intention is just to modify the URL to go to those links. I guess I can add a dismissModal() aftering doing the redirect, but do you think it's necessary?

@situchan
Copy link
Contributor

Thanks for reporting the issue with the RHP opening twice. It doesn't appear like you are following the test steps, where the intention is just to modify the URL to go to those links. I guess I can add a dismissModal() aftering doing the redirect, but do you think it's necessary?

I think that should be fixed. We can try either dismissModal or navigation replace

@tgolen tgolen dismissed stale reviews from arosiclair and luacmartins via a203ca1 December 26, 2023 21:58
@tgolen
Copy link
Contributor Author

tgolen commented Dec 26, 2023

OK, fixed and updated.

@situchan
Copy link
Contributor

Can you also please check console error? I think the logic should be moved to component mount (useEffect with empty array dependency). It's not recommended to directly call function in render.

@tgolen
Copy link
Contributor Author

tgolen commented Dec 26, 2023

Oh, sorry I forgot about that. I changed the component so that it doesn't redirect until the component has been mounted and this solves the console error. In order to prevent the "not found" page from briefly showing, I am just having the component return null so that nothing is displayed.

@situchan
Copy link
Contributor

Console error when redirect https://dev.new.expensify.com:8082/start/request/other
Also empty screen shows.
I think the expected behavior is to show not found page

Actual:
Screenshot 2023-12-27 at 4 41 36 PM

Expected:
Screenshot 2023-12-27 at 4 42 46 PM

@tgolen
Copy link
Contributor Author

tgolen commented Dec 27, 2023

OK, I added some type checking in order to show the "not found" page when there is an invalid URL param. I tested with these URLs:

I think the console prop type error is fine in these cases. The only way to make the error go away would be to relax the propType definition to accept any string, and I'd rather keep it strict.

@@ -0,0 +1,64 @@
import PropTypes from 'prop-types';
import React, {useEffect} from 'react';
import _ from 'underscore';
Copy link
Contributor

Choose a reason for hiding this comment

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

We prefer lodash to underscore.
Btw not blocker since both will be deprecated during TS migration

Comment on lines 29 to 30
const isIouTypeValid = _.values(CONST.IOU.TYPE).indexOf(iouType) > -1;
const isIouRequestTypeValid = _.values(CONST.IOU.REQUEST_TYPE).indexOf(iouRequestType) > -1;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const isIouTypeValid = _.values(CONST.IOU.TYPE).indexOf(iouType) > -1;
const isIouRequestTypeValid = _.values(CONST.IOU.REQUEST_TYPE).indexOf(iouRequestType) > -1;
const isIouTypeValid = _.values(CONST.IOU.TYPE).includes(iouType);
const isIouRequestTypeValid = _.values(CONST.IOU.REQUEST_TYPE).includes(iouRequestType);

}, []);

if (!isIouTypeValid || !isIouRequestTypeValid) {
return <FullPageNotFoundView shouldShow />;
Copy link
Contributor

@situchan situchan Dec 27, 2023

Choose a reason for hiding this comment

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

This should be wrapped with ScreenWrapper for iOS safe area to be considered.

Simulator Screenshot - iPhone 15 - 2023-12-27 at 22 23 23

@situchan situchan mentioned this pull request Dec 27, 2023
50 tasks
@tgolen
Copy link
Contributor Author

tgolen commented Dec 27, 2023

OK, I've added the screenwrapper. I was not sure which options were necessary, but I think that since the only child is the "not found" page, then none of the settings for padding or max height are needed?

@situchan
Copy link
Contributor

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.mov
Android: mWeb Chrome
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web-deep.mov
web-redirect.mov
MacOS: Desktop

@situchan
Copy link
Contributor

OK, I've added the screenwrapper. I was not sure which options were necessary, but I think that since the only child is the "not found" page, then none of the settings for padding or max height are needed?

I think not needed. Also tested. If something is required even for this simple page, maybe better to update that prop as always required in propType.

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

:shipit:

@melvin-bot melvin-bot bot requested a review from deetergp December 27, 2023 18:34
Copy link

melvin-bot bot commented Dec 27, 2023

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

Copy link

melvin-bot bot commented Dec 27, 2023

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #33655.

@tgolen
Copy link
Contributor Author

tgolen commented Dec 27, 2023

If something is required even for this simple page, maybe better to update that prop as always required in propType.

Yes, this is a good call. I was reading the comments for each of the prop types, and a lot of them left me in a very confused state. Such as:

/** Whether to include padding bottom */

Why should it have padding bottom or not??

/** Whether KeyboardAvoidingView should be enabled. Use false for screens where this functionality is not necessary */

How do I know if the functionality is necessary or not if the functionality is not explained?

/** Whether to use the maxHeight (true) or use the 100% of the height (false) */

How would I know which one I should use?

/** Whether to use the minHeight. Use true for screens where the window height are changing because of Virtual Keyboard */

Finally! This one comes pretty close to giving a proper explanation.

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

LGTM!

@Beamanator Beamanator merged commit 34a7bbd into main Dec 28, 2023
16 checks passed
@Beamanator Beamanator deleted the tgolen-scan-landingpage branch December 28, 2023 17:21
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.19-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.19-2 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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.

7 participants