Add displaying svg logos inside QR code

[Kicu]

Details

This PR is PoC that uses Expensify fork of react-native-qrcode-svg to display Svg avatars inside generated QR code. The PR that introduces required changes to the library is here: Kicu/react-native-qrcode-svg#1

This now correctly handles every QR code Share page in the app.

Native and web recordings provided. I will provide more recordings soon (these 2 I hope are enough to show that it works).

Fixed Issues

$ #27288
PROPOSAL:

• update react-native-qrcode-svg library (provided we get ownership of it) to support displaying SVGs (done in my PR in the fork, needs reviewing)
• use the new version here
• update our QRSharing components to use new props to display correct avatars

Tests

1. Go to Profile > workspaces
2. Go to details of a workspace with user uploaded avatar (or upload one yourself) and click Share, avatar should be shown
3. Go to details of a workspace with default avatar (which is a svg) and click Share, avatar should be shown
4. Go to any workspace room in chats, click on the workspace logo on top and then click Share from the details page (popup)
5. Go to any room belonging to a specific workspace that uses default logo and click Share there
6. go to any IOU/transaction > Details and then click Share - for this case we expect that Expensify logo is in the QR code

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

rec-svg-avtr-final-android.mp4

Android: mWeb Chrome

iOS: Native

rec-svg-avtr-final-ios2.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

rec-svg-avtr-final-web.mp4

MacOS: Desktop

[blazejkustra]

LGTM!

[melvin-bot]

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

[sobitneupane]

Thanks for the update @Kicu.

There are some places like Task page and MoneyRequest Page where we don't show logo at all. We used to show Expensify logo earlier. TBH, I am not sure what we want to show.

[Kicu]

@sobitneupane thanks for finding this views, I have somehow missed them (still don't know the app that well 😅). I will make sure that they look decent.
I think displaying expensify logo on them sounds like a good idea for now. Especially if that was what was happening in the past

[Kicu]

@sobitneupane pushed a commit that fixes what you described.
More general we will now always display expensifyLogo as a fallback for any other possible case when sharing something that is considered a report but is not connected to a policy.

recheck please 🙏

[sobitneupane]

Thanks for the update @Kicu

Instead of Expensify logo, a different logo is displayed in personal IOU Money Request Page. I cannot reproduce the issue in some of the IOUs but mostly I can. Can you please test it in your end?

[Kicu]

@sobitneupane thank you for testing 🙏 I am still sometimes surprised by parts of the app functionality and I can miss these cases.

I have pushed a small commit that fixes this and I now tested much more cases.
We will get the workspace logo if: it's an actual chat (report.type === chat) within the context of a workspace (policy).
Otherwise we get Expensify logo if it's:

• IOU
• task
• group chat between multiple people

Verified that all the old cases still work.

[sobitneupane]

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[sobitneupane]

Thanks @Kicu. Changes look good and tests well. I am not sure about the next step and raised it here.

[luacmartins]

@Kicu we created our fork. @Kicu could you open a PR with your changes against our fork and update this one please?

[Kicu]

status update: Im awaiting for @luacmartins to manage to give me the push rights to the fork, so that I can open my PR on the expensify for of qr-code library

[luacmartins]

Pinged infra again. Here's the internal issue for reference

[Kicu]

Update on this:
I have noticed that the fork that was created a while ago: https://github.com/Expensify/react-native-qr-svg is of a package called: react-native-qr-svg.

What we need is a fork of this package: react-native-qrcode-svg - because this is the one we use in Expensify App 😄

So please take a look at this and I'm waiting on further updates.

[Kicu]

@nathanmetcalf is this ☝️ something that you could help with? creating the fork of correct package?
@luacmartins told me to ping you

[dubielzyk-expensify]

That being said, @Expensify/design could we map out all the different share codes we have an the logo that should be displayed in each of them?

I'm sure @shawnborton will have context here, but I thought we only had one with the Expensify logo in the middle?

[shawnborton]

My rough understanding is that if you have uploaded a custom avatar to either your profile or your workspace, we display that avatar in the QR code:

However, the problems I see:

Even after the custom avatar is uploaded, we aren't showing that in the QR code for sharing a room:

When you upload a custom avatar to a Group chat, we don't show that custom avatar for the group chat's share code:

And if you have no custom avatar uploaded (anywhere), then we are not showing the default avatars in the share code either:

Same with groups:

So I think the general goal here: whatever avatar we use in the chat header should also be found in the share code. No matter if it's a custom avatar, or a default avatar.

[Kicu]

@dubielzyk-expensify

but I thought we only had one with the Expensify logo in the middle?

for the logo inside QRCode can have:

• when Sharing user code - either one of the colorful default avatars OR user uploaded avatar
• when Sharing workspace code - either the default SVG workspace logo (this PR adds it) OR user uploaded
• when Sharing room code - either user uploaded or the same as workspace
• when Sharing expense, IOU, or any kind of report - we used to have expensify logo (the green one)

So the question is mostly about the different kinds of reports - what do we show there?

some context:
Before this PR (so still right now on main or staging) we couldn't display default SVG logos for workspaces, so most of the time we showed expensify logo (screen 1).
But now with this PR we can finally display policy logos (screen 2)

[shawnborton]

For workspaces or #rooms on workspaces, is it possible to use a rounded square instead of a circle for the avatar? Not sure if that will break the QR code functionality, but I like the idea of trying to reuse exactly what's found in the chat report header for these.

[Kicu]

Honestly - a substantial amount of work was put (by me 😅) to make them rounded, and I've been trying to add this functionality since March. I'd prefer to leave it as is. The colors and the initial letter are 100% the same, its just the shape.

Technically it would be possible to make them squared, however I would prefer to not add this, at least not in this PR. Right now at least all logos inside qr code have the same shape and size.

[shawnborton]

Heh, I do appreciate how much work you've put into this, but do you agree that the rounded workspace avatars in QR codes create an inconsistency with how we display workspace avatars literally everywhere else in the product? I think we should avoid that inconsistency if we can.

[Kicu]

@shawnborton yeah I totally get it. Originally the visual aspect was not specified in the issue at all, and the main job of this PR was to allow us to display SVG Avatars (images) inside the QR code.

So when I saw the other cases of avatars inside QR being circle, then I made this one a circle as well. We can definitely change this.

That being said, if it's not a problem that for a few days these workspace avatars would be displayed as a circle, then I'd prefer first merging this PR and upgrading how they look in a separate one.

[shawnborton]

Cool cool, thanks for understanding. Totally down to change the shape in a follow up PR if you think that approach is best.

[luacmartins]

@sobitneupane can you continue with your review please. Let's get this one merged!

[luacmartins]

Looking good. Left a few small comments

[shawnborton]

Also I just wanted to confirm - even though this PR title focuses on svg, do we agree that we always want the avatar found in the chat header to be used in the Share QR Code as well? Just want to make sure we address that, regardless of whether or not it's an svg or an uploaded image. Thanks!

[Kicu]

@shawnborton at least to me this is clear now and I'm happy to continue working on these avatars.

However this PR might not handle all the cases the way you want it right now.
I think we should create a clean GH issue for the cleanup/alignment of avatars in QR code and then we can fix everything in the new issue.

Even right now in the app we don't have this behaviour correctly for every case. For example an expense thats split between several people will have the "multiple people" avatar in header but expensify logo in ShareCode.
Hence separate issue, because this is a bigger change.

[shawnborton]

That works for me - @dylanexpensify since we chatted about this briefly in Slack, do you mind doing the honors of creating the clean issue for this? Otherwise I am happy to do it as well.

[Kicu]

@luacmartins implemented all but 2 of your suggestions, please take a look.

[sobitneupane]

Screenshots/Videos

Android: Native

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[sobitneupane]

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.

[luacmartins]

LGTM!

[luacmartins]

@dylanexpensify @shawnborton please tag @Kicu and I when the new issue is created. Thank you!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.10-2 🚀

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

[OSBotify]

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.10-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.10-7 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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