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

Fix: Cannot paste magic code on mWeb iOS #23254

Merged

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Jul 20, 2023

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

  1. Navigate to Magic code input screen
  2. Copy an arbitrary code 123456
  3. Long press the code input
  4. Verify that a context menu pops up
  5. Press Paste
  6. Verify that the copied code is pasted
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

  1. Navigate to Magic code input screen
  2. Copy an arbitrary code 123456
  3. Long press the code input
  4. Verify that a context menu pops up
  5. Press Paste
  6. Verify that the copied code is pasted
  • 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
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

inputStyle={[isMobileSafari ? styles.magicCodeInputTransparent : undefined]}
caretHidden
textInputContainerStyles={[styles.borderNone]}
inputStyle={[styles.magicCodeInputTransparent, isBrowser ? styles.magicCodeInputTransparentWebKit : undefined]}
Copy link
Contributor Author

@tienifr tienifr Jul 21, 2023

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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

@@ -2536,6 +2536,9 @@ const styles = {
magicCodeInputTransparent: {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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:

image

Copy link
Contributor

Choose a reason for hiding this comment

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

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?

@tienifr tienifr marked this pull request as ready for review July 21, 2023 06:20
@tienifr tienifr requested a review from a team as a code owner July 21, 2023 06:20
@melvin-bot melvin-bot bot removed the request for review from a team July 21, 2023 06:20
@melvin-bot
Copy link

melvin-bot bot commented Jul 21, 2023

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

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

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

src/components/MagicCodeInput.js Show resolved Hide resolved
@Santhosh-Sellavel
Copy link
Collaborator

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

@marcaaron
Copy link
Contributor

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

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 29, 2023

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.

@@ -323,7 +320,7 @@ function MagicCodeInput(props) {
>
<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]}>
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a comment here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@tienifr bump!

Copy link
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel Aug 3, 2023

Choose a reason for hiding this comment

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

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!

src/components/MagicCodeInput.js Show resolved Hide resolved
inputStyle={[isMobileSafari ? styles.magicCodeInputTransparent : undefined]}
caretHidden
textInputContainerStyles={[styles.borderNone]}
inputStyle={[styles.magicCodeInputTransparent, isBrowser ? styles.magicCodeInputTransparentWebKit : undefined]}
Copy link
Contributor

Choose a reason for hiding this comment

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

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

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

Choose a reason for hiding this comment

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

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
Copy link
Contributor

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
Copy link
Contributor Author

tienifr commented Jul 31, 2023

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

@Santhosh-Sellavel
Copy link
Collaborator

@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
Copy link
Collaborator

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
    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
Copy link
Contributor

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
Copy link
Contributor Author

tienifr commented Aug 1, 2023

Bump @Santhosh-Sellavel. Wait for your conclusion.

@Santhosh-Sellavel
Copy link
Collaborator

@marcaaron Ensuring our expectations are aligned

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

@marcaaron
Copy link
Contributor

@Santhosh-Sellavel yes

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Aug 3, 2023

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 Screenshot 2023-08-04 at 12 20 23 AM
Mobile Web - Chrome Screenshot 2023-08-04 at 12 32 49 AM
Mobile Web - Safari
Simulator.Screen.Recording.-.iPhone.14.-.2023-08-04.at.00.24.29.mp4

iOS Chrome

RPReplay_Final1691091661.MP4
Desktop Screenshot 2023-08-04 at 12 28 21 AM
iOS
Simulator.Screen.Recording.-.iPhone.14.-.2023-08-04.at.00.42.08.mp4
Android Screenshot 2023-08-04 at 12 58 06 AM

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Looks good and tests well, just waiting for this!

@tienifr
Copy link
Contributor Author

tienifr commented Aug 3, 2023

Sorry I've missed that. Please check again.

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the changes.

@@ -323,7 +320,7 @@ function MagicCodeInput(props) {
>
<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]}>
Copy link
Contributor

Choose a reason for hiding this comment

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

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

@marcaaron marcaaron merged commit 3c5994c into Expensify:main Aug 3, 2023
13 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

✋ 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
Copy link
Contributor

OSBotify commented Aug 7, 2023

🚀 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
Copy link
Contributor

OSBotify commented Aug 9, 2023

🚀 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
Copy link
Contributor

OSBotify commented Aug 9, 2023

🚀 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
Copy link
Contributor

OSBotify commented Aug 9, 2023

🚀 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
Copy link
Contributor

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

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.

4 participants