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

Feat: Share QR Code #18636

Merged
merged 44 commits into from
May 15, 2023
Merged

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented May 9, 2023

Details

Fixed Issues

$ #18630
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

  • Verify that no errors appear in the JS console

QR Code in Personal Settings

  1. Visit the Personal Profile Settings menu
  2. Under your profile name and picture, verify that there is a new "Show QR Code" button.
  3. Click/Tap on the button.
  4. Verify that you are brought to a page with a QR code
  5. Verify that your profile picture is displayed within the QR code
  6. Using another phone, scan the QR code on the page and verify that it takes you to New Dot to view the profile page of the user.

Sharing QR Code from Personal Settings

  1. Visit the Personal Profile Settings menu
  2. Tap the "Show QR Code" button under your profile name and picture
  3. Verify that you see two menu items: Share and Download
  4. Tap on "Download" and verify that a QR code image is saved to your phone.

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 / Chrome
    • iOS / native
    • iOS / 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screenshot 2023-05-12 at 14 12 50

Screenshot 2023-05-12 at 14 13 43

Screenshot 2023-05-12 at 14 12 46

Screenshot 2023-05-12 at 14 13 36

Mobile Web - Chrome

Screenshot_1683892799

Screenshot_1683806736

Screenshot_1683892809

Screenshot_1683806750

Mobile Web - Safari

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-12 at 13 55 50

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-11 at 14 03 38

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-12 at 13 55 58

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-11 at 14 04 00

Desktop Screenshot 2023-05-12 at 14 11 28 Screenshot 2023-05-11 at 14 19 12 Screenshot 2023-05-12 at 14 11 33 Screenshot 2023-05-11 at 14 19 25
iOS

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-12 at 13 37 01

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-10 at 18 33 48

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-12 at 13 36 54

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-10 at 18 32 53

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-11 at 11 10 19

Simulator Screen Shot - iPhone 14 Pro (16 2) - 2023-05-11 at 14 13 34

Android

Screenshot_1683893139

Screenshot_1683893142

Screenshot_1683893133

Screenshot_1683893127

Screenshot_1683806556

@chrispader
Copy link
Contributor Author

@robertjchen Updated the screenshots in "iOS" and "Web"

Copy link
Contributor

@robertjchen robertjchen left a comment

Choose a reason for hiding this comment

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

Perfect, thanks!! 🙇

@robertjchen robertjchen merged commit 83d9ac3 into Expensify:main May 15, 2023
@melvin-bot melvin-bot bot added the Emergency label May 15, 2023
@melvin-bot
Copy link

melvin-bot bot commented May 15, 2023

@robertjchen looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@robertjchen
Copy link
Contributor

All checks were passing at time of merge. No cherry-pick label was present, so that check is not applicable.

Screenshot 2023-05-15 at 5 28 56 PM

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.3.14-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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

Comment on lines +49 to +53
style={{
alignSelf: 'stretch',
height: 27,
marginBottom: 20,
}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi everyone, coming from a follow-up PR for this component. Just wanted to note that as per our styling guidelines, let's remember to avoid inline styles. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

got it, thanks for the feedback! 👍

render() {
const isReport = this.props.report != null && this.props.report.reportID != null;

const url = isReport ? `${CONST.NEW_EXPENSIFY_URL}r/${this.props.report.reportID}` : `${CONST.NEW_EXPENSIFY_URL}details?login=${this.props.session.email}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

👋 Heads up that this has caused a couple of regressions: #19076 #19062 #19344 #19039
All of those were caused by this.props.session.email not being encoded and some characters being lost, which made the link invalid.
We resolved this by encoding this.props.session.email with encodeURIComponent

Copy link
Collaborator

Choose a reason for hiding this comment

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

We used a fixed CONST.NEW_EXPENSIFY_URL here, which caused an issue as it didn't set the URL based on the environment.

Comment on lines +74 to +80
<Text
family="EXP_NEW_KANSAS_MEDIUM"
fontSize={22}
style={{marginTop: 15}}
>
{this.props.title}
</Text>
Copy link
Collaborator

Choose a reason for hiding this comment

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

This PR caused a regression here

@sobitneupane
Copy link
Contributor

We expect menu item along with the icon to turn white when hovered. But we missed to implement it for Share Code.

Issue: #19067

url={url}
title={isReport ? this.props.report.reportName : this.props.currentUserPersonalDetails.displayName}
subtitle={isReport ? ReportUtils.getPolicyName(this.props.report) : this.props.session.email}
logo={isReport ? roomAvatar : this.props.currentUserPersonalDetails.avatar}
Copy link
Contributor

Choose a reason for hiding this comment

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

This line caused a regression in #19211. When we delete the avatar, the optimistic avatar is set to the oldDot default avatar. After a second, the avatar is updated to the newDot default avatar. We fixed this issue by using a utility function that always returns the newDot default avatar.

{this.props.title}
</Text>

{this.props.subtitle && (
Copy link
Collaborator

@mananjadhav mananjadhav Jun 21, 2023

Choose a reason for hiding this comment

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

@chrispader @robertjchen Because we didn't use boolean for conditional render, it caused a regression (although dev), here. It is essential for conditional render to use boolean expressions to avoid console errors.

I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && .

We also have an item in the checklist which was marked but we missed highlighting this one.

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it, thanks for the feedback! 🙇

@sobitneupane
Copy link
Contributor

While adding this feature of sharing QR code, we missed to handle the case where an user might not have access to the page. This issue was reported #21157.

Issue: Web - random QR code is generated on opening share code of room using URL

const url = isReport ? `${CONST.NEW_EXPENSIFY_URL}r/${this.props.report.reportID}` : `${CONST.NEW_EXPENSIFY_URL}details?login=${this.props.session.email}`;

const platform = getPlatform();
const isNative = platform === CONST.PLATFORM.IOS || platform === CONST.PLATFORM.ANDROID;
Copy link
Contributor

Choose a reason for hiding this comment

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

@chrispader This is against our guide on how to do platform code. Please refer to https://github.com/Expensify/App#platform-specific-file-extensions and submit a PR that refactors this appropriately.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is actually just a temporary solution until QR code downloads are also available on web. We're currently working on that here.

Once this is possible, the platform-specific code will be removed.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, we unfortunately had to push this out in time for EC3- but, we're cleaning it up as soon as possible once we figure out the CORs issue.

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.

10 participants