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 back qr code download feature #49595

Merged
merged 6 commits into from
Sep 27, 2024
Merged

Conversation

lakchote
Copy link
Contributor

@lakchote lakchote commented Sep 23, 2024

Details

QR code download feature was removed since it wasn't compatible with the new arch (Fabric #13767) when it got merged.

We can add it again since #37374 got merged.

Fixed Issues

$ #40110
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Test 1: workspace's settings

  1. Go to a workspace's settings
  2. Click on Profile
  3. Click on Share
  4. Click on Download
  5. Verify the QR code with the workspace name is added to your gallery

Test 2: report's details

  1. Go to a report
  2. Click on it's name
  3. Click on Share
  4. Click on Download
  5. Verify the QR code with the workspace name is added to your gallery

QA Steps

  • Verify that no errors appear in the JS console

Same as in tests

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 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.
  • I verified that similar component doesn't exist in the codebase
  • I verified that all props are defined accurately and each prop has a /** comment above it */
  • I verified that each file is named correctly
  • I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • I verified that the only data being stored in component state is data necessary for rendering and nothing else
  • In component if we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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)
  • I verified that component 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)
  • I verified that all JSX used for rendering exists in the render method
  • I verified that each 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

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
Screen.Recording.2024-09-23.at.13.56.58.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@lakchote lakchote self-assigned this Sep 23, 2024
@lakchote lakchote requested a review from a team as a code owner September 23, 2024 12:02
@melvin-bot melvin-bot bot requested review from brunovjk and removed request for a team September 23, 2024 12:02
Copy link

melvin-bot bot commented Sep 23, 2024

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

@brunovjk
Copy link
Contributor

I will review it later today.

@brunovjk
Copy link
Contributor

On native iOS everything works just fine:

iOS: Native
ios._native.mov

However, on Android, I am unable to download. When I click the download button, nothing happens. I will check if the issue is related to my emulator and report back.

Android: Native
android_native.mov

Also on other platforms I can't see the button at all:

Android: mWeb Chrome

android_web

iOS: mWeb Safari
ios_web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@lakchote Is this expected? Thanks.

@lakchote
Copy link
Contributor Author

lakchote commented Sep 24, 2024

Also on other platforms I can't see the button at all:

Yes, that's normal @brunovjk. We only show this option on native platforms.

See https://github.com/Expensify/App/blob/lucien/add-back-qr-code-download/src/libs/shouldAllowDownloadQRCode/index.native.ts#L5-L6
(native)

vs
https://github.com/Expensify/App/blob/lucien/add-back-qr-code-download/src/libs/shouldAllowDownloadQRCode/index.ts#L5-L6

However, on Android, I am unable to download. When I click the download button, nothing happens. I will check if the issue is related to my emulator and report back.

I'm going to test this out.

@lakchote
Copy link
Contributor Author

@brunovjk I've updated code to include another area where we should add back the QR code's download feature.

Android doesn't seem to work either, I'm looking.

@lakchote
Copy link
Contributor Author

@WoLewicki I've stumbled upon your comment here.

Bumping RN version to 0.75 #37374 seemed to have make the QR code download works on iOS. But on Android, the problem remains.

Would you mind trying again if the patch works?

We're still using the old version of react-native-view-shot, which is compatible with the old arch.

@s77rt
Copy link
Contributor

s77rt commented Sep 24, 2024

You need to upgrade to the latest react-native-view-shot version v4.0.0-alpha.3. Alternatively you can also use @s77rt/react-native-viewshot which provides a similar API.

@lakchote
Copy link
Contributor Author

You need to upgrade to the latest react-native-view-shot version v4.0.0-alpha.3. Alternatively you can also use @s77rt/react-native-viewshot which provides a similar API.

Thanks, I've used version v4.0.0-alpha.3 and it have solved the issue for Android.

@brunovjk could you please retest?

@brunovjk
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
49595_android_native.mov
Android: mWeb Chrome
49595_android_web.mov
iOS: Native
49595_ios_native.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
49595_web_chorme.mov
MacOS: Desktop
49595_web_desktop.mov

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

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

LGTM :D

@melvin-bot melvin-bot bot requested a review from carlosmiceli September 25, 2024 12:00
Copy link

melvin-bot bot commented Sep 25, 2024

@carlosmiceli 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
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

We only show this option on native platforms.

Why is this?

@lakchote
Copy link
Contributor Author

We only show this option on native platforms.

Why is this?

For this reason

@Julesssss
Copy link
Contributor

Odd but fair enough. Not sure why I was subscribed to this PR 😄

@@ -82,6 +84,8 @@ function ShareCodePage({report, policy}: ShareCodePageProps) {
}, [report, currentUserPersonalDetails, isReport]);

const title = isReport ? ReportUtils.getReportName(report) : currentUserPersonalDetails.displayName ?? '';
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.

If this hasn't been discussed previously, why didn't we follow the no specific platform conditions rule?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't have the answer to that question. It is preexisting code, I think that's @robertjchen that did this feature.

I just didn't want to introduce potential side effects that may make this feature broken, since this PR aims to put back code that was present before.

(You've subscribed to this PR since I've chatted with you yesterday about react-native-view-shot)

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh right lol, had already forgotten

Copy link
Contributor

Choose a reason for hiding this comment

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

I know its annoying, but if we do ship the isMobile condition we should state the reason why. The more we have, the more people will use it as justification to introduce more.

Copy link
Contributor

@robertjchen robertjchen Sep 26, 2024

Choose a reason for hiding this comment

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

Ah, this was from a while back- IIRC we added this hack due to limitations with the QR library, in order to get the feature working in time for a conference. 🤔

Since there's no time pressure anymore- maybe we can look into fixing this by seeing if the limitation still exists, and if we still need this check?

Copy link
Contributor Author

@lakchote lakchote Sep 26, 2024

Choose a reason for hiding this comment

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

Here are the errors:

image image

And the warnings:
image

Copy link
Contributor Author

@lakchote lakchote Sep 27, 2024

Choose a reason for hiding this comment

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

cc @Julesssss @robertjchen I think we still need to keep the platform check for now.

We'll remove the condition once #19834 is done.

Copy link
Contributor

Choose a reason for hiding this comment

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

:sadcat_okay: Yep, that would be the proper issue to handle this.

Could we make a big comment there noting that this is a bad thing and that it'll be addressed in #19834 🙏

Copy link
Contributor

Choose a reason for hiding this comment

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

Fair enough, thanks for investigating

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added comments to make sure we don't follow the same logic elsewhere in our codebase.

Thank you both @Julesssss @robertjchen for checking!

@carlosmiceli
Copy link
Contributor

Sorry, back from OOO, will wait for response to @Julesssss question above and review!

Julesssss
Julesssss previously approved these changes Sep 27, 2024
@lakchote lakchote merged commit 21f6a04 into main Sep 27, 2024
20 checks passed
@lakchote lakchote deleted the lucien/add-back-qr-code-download branch September 27, 2024 14:29
@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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.41-0 🚀

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

@roryabraham
Copy link
Contributor

Looks like there are some cases where this code doesn't work as expected: #49868. Weird because it looks like it worked in the screenshots of this PR. Maybe it was a difference between debug and release builds?

@lakchote
Copy link
Contributor Author

Looks like there are some cases where this code doesn't work as expected: #49868. Weird because it looks like it worked in the screenshots of this PR. Maybe it was a difference between debug and release builds?

Yes, it did work both for the C+ and myself. Also I've just retested on main and it worked correctly (iPhone 16 Pro Max with iOS 18.0). However, I've tested on my real device on staging and I have the same problem as in #49868, so there must be some kind of difference indeed between debug and release.

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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.

8 participants