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

[VIP-Travel] Create a New Travel Page and Terms and Conditions Modal (NewDot) #41493

Merged
merged 54 commits into from
May 3, 2024

Conversation

rushatgabhane
Copy link
Member

@rushatgabhane rushatgabhane commented May 2, 2024

Details

Copied from #38469 because i can't edit that PR

Fixed Issues

$ #37102
$ #37103

Tests

  1. Make sure you are using an account with the travel beta enabled or in the Permissions.ts file set the canUseAllBetas function to always return true.
  2. Press the + sign to go into the menu and then go into Book travel.
  3. In the newly displayed modal / page press the Book travel button to go further into the flow.
  4. On the Terms & Conditions page press the checkbox to accept and proceed with the flow by pressing the Continue button.
  5. In the network tab check that a correct data package AcceptSpontanaTerms has been sent as a resolution of this flow.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Screenshots/Videos

Android: Native image image image
Android: mWeb Chrome image image
iOS: Native image image
iOS: mWeb Safari image image image
MacOS: Chrome / Safari image image image image
MacOS: Desktop image

@rushatgabhane
Copy link
Member Author

rushatgabhane commented May 2, 2024

@shawnborton updated the icon size to 48 x 48

image image

@shawnborton
Copy link
Contributor

Nice, I think that looks better. What is the gap between the icon and text out of curiosity?

@rushatgabhane
Copy link
Member Author

rushatgabhane commented May 2, 2024

@shawnborton it's margin 12.

It should be 16, right?

image

@shawnborton
Copy link
Contributor

Hmm can you check that the parent wrapper isn't using 40px width? I can spin up a new test build but seems like we have the same problem as before, even with the new icon size change.

@dannymcclain
Copy link
Contributor

Looks like maybe the alert illustration is kinda goofed? In Figma it looks like it has some space around it (inside it's own bounding box) but in that screenshot it looks like it's edge-to-edge. It feels quite a bit bigger than the piggy right now.

CleanShot 2024-05-02 at 11 50 59@2x

@rushatgabhane
Copy link
Member Author

rushatgabhane commented May 2, 2024

@dannymcclain downloaded the latest assets from figma to fix that. Nice catch!

image

@rushatgabhane
Copy link
Member Author

rushatgabhane commented May 2, 2024

@shawnborton looking at code, i don't think there is a parent wrapper problem.
The icons are 48x48 and the padding is from the svg. What do you think?

Screen.Recording.2024-05-02.at.22.30.05.mov

@shawnborton
Copy link
Contributor

shawnborton commented May 2, 2024

Okay cool, maybe the illustration was just borked. Glad it's sorted!

@dubielzyk-expensify
Copy link
Contributor

@Expensify/design according to our guidelines, the cards were meant to have 60x60 illustrations. Should I change this to 48x48 then?

@shawnborton
Copy link
Contributor

I think we should, yup! This way we basically only have our simple illustrations at 48x48 in the app, anywhere they may appear. Thoughts?

@shubham1206agra
Copy link
Contributor

@twisterdotcom https://use.expensify.com/travelterms is giving 404. Can you check if the link is correct?

@rushatgabhane
Copy link
Member Author

@shubham1206agra yes that is expected. The terms page will be live in a few days

@shubham1206agra
Copy link
Contributor

@rushatgabhane Thanks.
I will post the checklist in 20 mins.

@shubham1206agra
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 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: mWeb Chrome
Screen.Recording.2024-05-03.at.11.03.48.AM.mov
iOS: Native
Screen.Recording.2024-05-03.at.11.16.28.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-05-03.at.10.54.44.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-03.at.10.38.08.AM.mov
MacOS: Desktop
Screen.Recording.2024-05-03.at.11.09.26.AM.mov

@twisterdotcom twisterdotcom merged commit cb39a54 into Expensify:main May 3, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented May 3, 2024

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

@pecanoro
Copy link
Contributor

pecanoro commented May 3, 2024

@twisterdotcom Any specific reason why you merge this without following the process? It's missing the internal engineer to finish review it and merge it 🥲

setError(false);
}, [hasAcceptedTravelTerms]);

const AgreeToTheLabel = useCallback(
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we have used useMemo insetad of useCallback here? I am not fully sure why we need to use useCallback in this case

@twisterdotcom
Copy link
Contributor

Ah sorry, I didn't realise this needed another review. Misunderstood a conversation I had with @puneetlath earlier this week, my bad.

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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

Comment on lines +3 to +4
// Styling lottie animations for the ManageTrips component requires different margin values depending on the platform.
export default function getTripIllustrationStyle(): ViewStyle {
Copy link
Contributor

@tienifr tienifr May 22, 2024

Choose a reason for hiding this comment

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

@WojtekBoman Hi. I wonder why we need to add a separate style in web and native here? I see that with other illustrations, we do not need to do like this.

Copy link
Contributor

Choose a reason for hiding this comment

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

This illustration is styled differently dependent on the platform, I think it might be related to the structure of this specific .lottie file, so I handled it this way. I believe it's worth checking these .lottie files for any errors. However, if you decide to do a platform-specific repair, avoid checking Platform.OS, try to deal with that as described here. This is how it looks without additional styling:

Screenshot 2024-05-23 at 13 02 43

Copy link
Contributor

Choose a reason for hiding this comment

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

In that particular case though, that's just an .svg and not a little file because it's a static image and not an illustration. Any reason why that isn't implemented as just a normal svg image?

Copy link
Contributor

Choose a reason for hiding this comment

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

I've implemented it this way, because the component that we use to display this image it's the same which is used on pages like: About, Troubleshoot etc. and it accepts only assets in .lottie format so this solution didn't require modifying this component. But you're right, I think that we should refactor this component to allow displaying it in the future with static assets. Could you create an issue for that?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I really don't see a good reason why we would force a static svg to be shown as some kind of lottie file - that seems odd to me. I'll create a new issue and tag you.

Copy link
Contributor

Choose a reason for hiding this comment

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

Issue created here: #42560

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, does the image on the right here exist in production? Notice how the padding/spacing is off? We should fix that too.

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

Successfully merging this pull request may close these issues.