Fix: Cannot paste magic code on mWeb iOS by tienifr · Pull Request #23254 · Expensify/App

tienifr · 2023-07-20T10:52:09Z

Details

On iOS browsers rather than Safari (Chrome for example), long pressing magic code text input to paste does not work. This PR fixes that.

Fixed Issues

$ #21708
PROPOSAL: #21708 (comment)

Tests

Navigate to Magic code input screen
Copy an arbitrary code 123456
Long press the code input
Verify that a context menu pops up
Press Paste
Verify that the copied code is pasted

Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Navigate to Magic code input screen
Copy an arbitrary code 123456
Long press the code input
Verify that a context menu pops up
Press Paste
Verify that the copied code is pasted

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

magic-code-web-compressed.mov

Mobile Web - Chrome

Chrome on iOS

original-9FFB921A-303D-4741-B919-178EB9BBE3EC.mp4

Mobile Web - Safari

original-32BAB80E-5506-4CF9-BC4E-8BFEA02FA3E6.mp4

Desktop

magic-code-desktop-compressed.mov

iOS

Screen.Recording.2023-07-21.at.11.41.11.mov

Android

Screen.Recording.2023-07-21.at.11.54.45.mov

tienifr · 2023-07-21T04:31:59Z

-                                inputStyle={[isMobileSafari ? styles.magicCodeInputTransparent : undefined]}
+                                caretHidden
+                                textInputContainerStyles={[styles.borderNone]}
+                                inputStyle={[styles.magicCodeInputTransparent, isBrowser ? styles.magicCodeInputTransparentWebKit : undefined]}


The isBrowser check is to prevent warning since WebkitTextFillColor prop is only available on Web platforms.

Let's move the isBrowser check into the styles.js code?

tienifr · 2023-07-21T04:35:10Z

@@ -2536,6 +2536,9 @@ const styles = {
    magicCodeInputTransparent: {


Separating magicCodeInputTransparent and magicCodeTransparentWebkit since color: transparent is required on all platforms while the rest are for Web & mWeb only. Without color: transparent we may get this:

Ok so my suggestion, is to take the isBrowser check and put it in styles and make this name more generic

inputTransparent: { color: 'transparent', ...(Browser.getBrowser() ? { caretColor: 'transparent', ...etc } : {}), },

Can we do something like this?

melvin-bot · 2023-07-21T06:20:07Z

@Santhosh-Sellavel 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]

marcaaron

What's the status here? Can someone summarize and if there are questions let's take one at a time?

Santhosh-Sellavel · 2023-07-28T22:08:24Z

@marcaaron We are waiting for this #21708 (comment)

marcaaron · 2023-07-29T00:33:32Z

@Santhosh-Sellavel What do you mean? We are here in the PR right - let's ask some questions?

Santhosh-Sellavel · 2023-07-29T00:40:02Z

Yes @marcaaron, we have the PR here. But we had an ongoing discussion that's waiting for your input on the issue. It's better to discuss it there (As we clear history there) and come back.

marcaaron · 2023-07-29T00:34:30Z

                            <Text style={[styles.magicCodeInput, styles.textAlignCenter]}>{decomposeString(props.value, props.maxLength)[index] || ''}</Text>
                        </View>
-                        <View style={[StyleSheet.absoluteFillObject, styles.w100, isMobileSafari ? styles.bgTransparent : styles.opacity0]}>
+                        <View style={[StyleSheet.absoluteFillObject, styles.w100, styles.bgTransparent]}>


Why are we always passing styles.bgTransparent here? Can you add some comment in the code above this to explain what purpose that serves?

Please add a comment here.

@tienifr bump!

Reading the comment made me wonder why would we need this now in the first place, what does it do?

My understanding is that we're basically doing a "hidden input" trick here.

I'm just curious. Because now we do the trick with styles and props on the TextInput itself. So I don't understand why would need this, let me know if am missing anything thanks!

marcaaron · 2023-07-29T00:39:24Z

-                                inputStyle={[isMobileSafari ? styles.magicCodeInputTransparent : undefined]}
+                                caretHidden
+                                textInputContainerStyles={[styles.borderNone]}
+                                inputStyle={[styles.magicCodeInputTransparent, isBrowser ? styles.magicCodeInputTransparentWebKit : undefined]}


Let's move the isBrowser check into the styles.js code?

marcaaron · 2023-07-29T00:42:12Z

@@ -2536,6 +2536,9 @@ const styles = {
    magicCodeInputTransparent: {


Ok so my suggestion, is to take the isBrowser check and put it in styles and make this name more generic

inputTransparent: { color: 'transparent', ...(Browser.getBrowser() ? { caretColor: 'transparent', ...etc } : {}), },

Can we do something like this?

marcaaron · 2023-07-29T01:23:26Z

It's better to discuss it there (As we clear history there) and come back.

That's ok. I specifically asked if we can discuss it here. So let's do that? Thanks.

tienifr · 2023-07-31T07:47:46Z

@Santhosh-Sellavel @marcaaron I have moved the isBrowser check to styles.js and added comments.

Santhosh-Sellavel · 2023-07-31T18:02:35Z

@Santhosh-Sellavel @marcaaron I have moved the isBrowser check to styles.js and added comments.

Again this is not something we want, It's better to keep how it was before. Just improve the check.

Santhosh-Sellavel · 2023-07-31T18:17:34Z

It's better to discuss it there (As we clear history there) and come back.

That's ok. I specifically asked if we can discuss it here. So let's do that? Thanks.

Yeah, we can do it here then.

@marcaaron

We want something like this to eliminate platform-specific checks and make it a reusable style for the future.

export function getTransparentStyle() {return isMobileSafari ? styles.bgTransparent : styles.opacity0;}

But we can't do that here,

styles.opacity0 hide's the view and its contents
styles.bgTransparent just makes the background of the view transparent.

IMO it does make any sense to keep it styles.js or any utils, we can't reuse it anywhere else.

Coming to the MagicCodeComponent

Here styles.opacity0 is used to hide the view and its child. This works for all the platforms, but mobile web safari we handle it quite differently

With the help of check isMobileSafari,

used styles.bgTransparent to make the bg of the view transparent.
Also here we hide input & caret separately using the inputStyle & props

App/src/components/MagicCodeInput.js

Lines 351 to 352 in cd851d0

caretHidden={isMobileSafari}

inputStyle={[isMobileSafari ? styles.magicCodeInputTransparent : undefined]}

So I think it's better to improve the check of isMobileSafari to handle it correctly for the iOS Chrome browser too. And leave the rest untouched, as it works for other platforms already.

Let me know your thoughts @marcaaron

marcaaron · 2023-07-31T21:47:06Z

We want something like this to eliminate platform-specific checks and make it a reusable style for the future.

Not exactly a requirement if it's not possible. I mainly want that logic out of the component itself and abstracted away a bit.

IMO it does make any sense to keep it styles.js or any utils, we can't reuse it anywhere else.

It might be unlikely that this gets reused. But I'd prefer to have this logic outside of the component. The app philosophy suggests we have platform specific details abstracted away whenever possible.

I think it's better to improve the check of isMobileSafari to handle it correctly for the iOS Chrome browser too. And leave the rest untouched, as it works for other platforms already.

Let's keep moving. We have to strike a balance between code reuse and cross platform first specific guidance so it's a compromise.

tienifr · 2023-08-01T23:08:44Z

Bump @Santhosh-Sellavel. Wait for your conclusion.

Santhosh-Sellavel · 2023-08-01T23:51:56Z

@marcaaron Ensuring our expectations are aligned

We are just moving forward with refactoring to make the isMobileSafariCheck out side the component, right?

marcaaron · 2023-08-02T21:10:11Z

@Santhosh-Sellavel yes

Santhosh-Sellavel · 2023-08-03T20:19:02Z

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

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.14.-.2023-08-04.at.00.24.29.mp4

iOS Chrome

RPReplay_Final1691091661.MP4

Desktop

iOS

Simulator.Screen.Recording.-.iPhone.14.-.2023-08-04.at.00.42.08.mp4

Android

Santhosh-Sellavel

Looks good and tests well, just waiting for this!

tienifr · 2023-08-03T20:38:07Z

Sorry I've missed that. Please check again.

marcaaron

LGTM, thanks for the changes.

marcaaron · 2023-08-03T21:08:09Z

                            <Text style={[styles.magicCodeInput, styles.textAlignCenter]}>{decomposeString(props.value, props.maxLength)[index] || ''}</Text>
                        </View>
-                        <View style={[StyleSheet.absoluteFillObject, styles.w100, isMobileSafari ? styles.bgTransparent : styles.opacity0]}>
+                        <View style={[StyleSheet.absoluteFillObject, styles.w100, styles.bgTransparent]}>


My understanding is that we're basically doing a "hidden input" trick here.

OSBotify · 2023-08-03T21:15:55Z

✋ 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 · 2023-08-07T18:55:52Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.51-0 🚀

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

OSBotify · 2023-08-09T08:45:00Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:14:05Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:52:48Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:11:14Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

tienifr added 2 commits July 20, 2023 17:44

fix: cannot paste magic code on mWeb iOS

6783d35

fix double border

9007984

tienifr commented Jul 20, 2023

View reviewed changes

Comment thread src/components/MagicCodeInput.js

tienifr added 2 commits July 21, 2023 03:14

restore caretColor

623de6a

fix dev warnings webkit prop

137f9b6

tienifr commented Jul 21, 2023

View reviewed changes

tienifr added 2 commits July 21, 2023 13:11

hide caret

0e77b18

fix dev warning caretColor

fc7ac21

tienifr commented Jul 21, 2023

View reviewed changes

Comment thread src/components/MagicCodeInput.js

tienifr marked this pull request as ready for review July 21, 2023 06:20

tienifr requested a review from a team as a code owner July 21, 2023 06:20

melvin-bot Bot removed the request for review from a team July 21, 2023 06:20

melvin-bot Bot requested a review from Santhosh-Sellavel July 21, 2023 06:20

tienifr mentioned this pull request Jul 21, 2023

[HOLD for payment 2023-08-16] [$1000] mWeb - Can't paste magic code on text input #21708

Closed

6 tasks

make caret transparent

b5a35a1

marcaaron reviewed Jul 28, 2023

View reviewed changes

Comment thread src/components/MagicCodeInput.js

marcaaron requested changes Jul 29, 2023

View reviewed changes

tienifr added 2 commits July 31, 2023 14:34

Merge branch 'main' into fix/21708

642ddf6

move isBrowser to styles and add comment

9f171bc

fix lint

87caa9a

Santhosh-Sellavel reviewed Aug 3, 2023

View reviewed changes

add comment for bgTransparent

b3c50af

marcaaron approved these changes Aug 3, 2023

View reviewed changes

marcaaron merged commit 3c5994c into Expensify:main Aug 3, 2023

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

		@@ -2536,6 +2536,9 @@ const styles = {
		magicCodeInputTransparent: {

Uh oh!

Conversation

tienifr commented Jul 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

tienifr Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melvin-bot Bot commented Jul 21, 2023

Uh oh!

marcaaron left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Santhosh-Sellavel commented Jul 28, 2023

Uh oh!

marcaaron commented Jul 29, 2023

Uh oh!

Santhosh-Sellavel commented Jul 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Santhosh-Sellavel Aug 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Jul 29, 2023

Uh oh!

tienifr commented Jul 31, 2023

Uh oh!

Santhosh-Sellavel commented Jul 31, 2023

Uh oh!

Santhosh-Sellavel commented Jul 31, 2023

Uh oh!

marcaaron commented Jul 31, 2023

Uh oh!

tienifr commented Aug 1, 2023

Uh oh!

Santhosh-Sellavel commented Aug 1, 2023

Uh oh!

marcaaron commented Aug 2, 2023

Uh oh!

Santhosh-Sellavel commented Aug 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

iOS Chrome

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

tienifr commented Jul 20, 2023 •

edited

Loading

tienifr Jul 21, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 29, 2023 •

edited

Loading

Santhosh-Sellavel Aug 3, 2023 •

edited

Loading

Santhosh-Sellavel commented Aug 3, 2023 •

edited

Loading

tienifr commented Aug 3, 2023 •

edited

Loading