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 for: Editing workspace name to 1to3 characters adding extra line in the optional message when inviting users in Spanish #17878

Merged
merged 30 commits into from
May 5, 2023

Conversation

Ollyws
Copy link
Contributor

@Ollyws Ollyws commented Apr 24, 2023

Details

Fixed Issues

$ #17202
PROPOSAL: #17202 (comment)

Tests

  1. Go to Settings > Preferences
  2. Select Spanish as the language
  3. Go back to Settings > Workspace
  4. Select a workspace and change its name to 1-3 characters
  5. Go to the Manage members > Invite
  6. Verify there are no empty lines below the invite message
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to Settings > Preferences
  2. Select Spanish as the language
  3. Go back to Settings > Workspace
  4. Select a workspace and change its name to 1-3 characters
  5. Go to the Manage members > Invite
  6. Verify there are no empty lines below the invite message

QA Steps

  1. Go to Settings > Preferences
  2. Select Spanish as the language
  3. Go back to Settings > Workspace
  4. Select a workspace and change its name to 1-3 characters
  5. Go to the Manage members > Invite
  6. Verify there are no empty lines below the invite message
  • 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 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
MacOS_Chrome.mp4
Mobile Web - Chrome
Android_Chrome.mp4
Mobile Web - Safari
iOS_Safari.mp4
Desktop
MacOS_Desktop.mp4
iOS
iOS_Native.mp4
Android
Android_Native.mp4

@Ollyws Ollyws requested a review from a team as a code owner April 24, 2023 08:12
@MelvinBot
Copy link

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@melvin-bot melvin-bot bot requested review from fedirjh and techievivek and removed request for a team April 24, 2023 08:12
@MelvinBot
Copy link

@techievivek @fedirjh One of you needs to 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]

@Ollyws
Copy link
Contributor Author

Ollyws commented Apr 24, 2023

@fedirjh @techievivek There are a couple of lines that weren't in my proposal:

Firstly, I added this line to stop this unsightly flashing of the scrollbar that happens when you breaklines on web:
https://user-images.githubusercontent.com/11609254/233938278-4a56d91c-31b8-4748-9431-09c9fb6a34a4.mp4

Also I added this line as Android adds a tiny bit of padding to the right of the textInput which makes lines break incorrectly when typing thin characters such as l.

Without padding-right: 0:
https://user-images.githubusercontent.com/11609254/233939622-88ce6bc9-7012-4631-b046-67ba6e1ea4c6.mp4

With padding-right: 0:
https://user-images.githubusercontent.com/11609254/233939674-0f0cd903-3839-4f86-b183-5ce902a778e2.mp4

Copy link
Contributor

@fedirjh fedirjh 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. Left a few comments

src/components/TextInput/BaseTextInput.js Outdated Show resolved Hide resolved
@@ -218,21 +218,26 @@ class BaseTextInput extends Component {
!this.props.hideFocusedState && this.state.isFocused && styles.borderColorFocus,
(this.props.hasError || this.props.errorText) && styles.borderColorDanger,
], (finalStyles, s) => ({...finalStyles, ...s}), {});
const maxHeight = StyleSheet.flatten(this.props.containerStyles).maxHeight;
const autoGrowHeight = this.props.autoGrowHeight && this.props.multiline;
Copy link
Contributor

Choose a reason for hiding this comment

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

autoGrowHeight should be added to baseTextInputPropTypes. Also I think we should remove this line and use this.props.autoGrowHeight directly, and for the input's prop multiline, we can update it to :

multiline={this.props.multiline || this.props.autoGrowHeight}

Copy link
Contributor

Choose a reason for hiding this comment

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

So when autoGrowHeight is applied , multiline should automatically set to true

Comment on lines 237 to 238
// When autoGrowHeight is true calculate textinput width or when multiline
// is not supplied calculate textinput height, using onLayout.
Copy link
Contributor

Choose a reason for hiding this comment

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

These comments are not so clear. Could you please update it ?

@Ollyws
Copy link
Contributor Author

Ollyws commented Apr 24, 2023

@fedirjh Thanks for the suggestions, all updated.

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Just few comments

src/pages/workspace/WorkspaceInvitePage.js Outdated Show resolved Hide resolved
]}
multiline={this.props.multiline}
multiline={this.props.multiline || this.props.autoGrowHeight}
Copy link
Contributor

@fedirjh fedirjh Apr 24, 2023

Choose a reason for hiding this comment

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

Could you please update all other instances of this.props.multiline to also include this.props.autoGrowHeight, since the same rules that apply to multiline should also apply to autoGrowHeight? Perhaps we could create a local variable for this:

isMultiline = this.props.multiline || this.props.autoGrowHeight

Comment on lines 238 to 239
onLayout={event => (this.props.autoGrowHeight && this.setState({width: event.nativeEvent.layout.width}))
|| (!this.props.multiline && this.setState({height: event.nativeEvent.layout.height}))}
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be simplified to :

onLayout = event => {
  if (!this.props.autoGrowHeight && this.props.multiline){
    return;
  }

  this.setState(prevState => ({
    width: this.props.autoGrowHeight ? event.nativeEvent.layout.width : prevState.width,
    height: !this.props.multiline ? event.nativeEvent.layout.height : prevState.height
  }));
}

@Ollyws
Copy link
Contributor Author

Ollyws commented Apr 24, 2023

@fedirjh Updated, thanks.

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Code LGTM

@fedirjh
Copy link
Contributor

fedirjh commented Apr 24, 2023

@Ollyws we missed implementing the AutoGrowHeightInput inside TextInput.stories.js

const AutoGrowInput = Template.bind({});

@fedirjh
Copy link
Contributor

fedirjh commented Apr 25, 2023

I get this error on IOS native

Screenshot 2023-04-25 at 1 11 26 AM

@Ollyws
Copy link
Contributor Author

Ollyws commented Apr 25, 2023

@fedirjh This last commit should fix the layout error.

@Ollyws
Copy link
Contributor Author

Ollyws commented Apr 25, 2023

@fedirjh One thing I missed earlier is that the textInput ignores whitespace at the end of the line, but with the zero-width space appended this doesn't happen in the hidden text, causing this issue:

whitespaceissue.mp4

The last commit fixes this by only adding the zero-width space if the last character is \n.

Copy link
Contributor

@fedirjh fedirjh 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 , left few comments

src/components/TextInput/BaseTextInput.js Outdated Show resolved Hide resolved
src/stories/TextInput.stories.js Show resolved Hide resolved
src/styles/styles.js Show resolved Hide resolved
@Ollyws
Copy link
Contributor Author

Ollyws commented May 3, 2023

@fedirjh And updated as you suggested.

@Ollyws
Copy link
Contributor Author

Ollyws commented May 3, 2023

@fedirjh And updated as per the latest suggestion.

@fedirjh
Copy link
Contributor

fedirjh commented May 3, 2023

@Ollyws There are some inconsistencies:

  1. On native input is shaking when expanded
  2. On web/mobile web , the line break doesn’t work This is not working on production either
Native

IOS

Screen.Recording.2023-05-03.at.8.10.49.PM.mov
Screen.Recording.2023-05-03.at.8.11.35.PM.mov

Android

Screen.Recording.2023-05-03.at.8.16.38.PM.mov
Web/ Mobile web

Safari

Screen.Recording.2023-05-03.at.8.09.47.PM.mov

Chrome

Screen.Recording.2023-05-03.at.8.19.52.PM.mov

@Ollyws
Copy link
Contributor Author

Ollyws commented May 3, 2023

On web/mobile web , the line break doesn’t work

@fedirjh The line break doesn't work on production for me either.

{this.state.value || this.props.placeholder}
{/* We are appending a zero width space (\u200B) here as the browser will remove a trailing newline that doesn't
have any characters after it. This allows linebreaks to work properly on web when the user presses enter. */}
{`${this.state.value}${this.props.autoGrowHeight && (this.state.value.slice(-1) === '\n') ? '\u200B' : ''}` || this.props.placeholder}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{`${this.state.value}${this.props.autoGrowHeight && (this.state.value.slice(-1) === '\n') ? '\u200B' : ''}` || this.props.placeholder}
{this.state.value || this.props.placeholder}

The line break doesn't work on production for me either.

Since this is not working on production either , is there any need for these changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fedirjh Yeah that's for non-mobile web.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also for non-mobile web it doesn’t work either on prod

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Try pressing shift+enter

Copy link
Contributor

Choose a reason for hiding this comment

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

Not working

Screen.Recording.2023-05-03.at.11.49.05.PM.mov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fedirjh The question is, was the removal of pressing enter to linebreak intentional or is it a bug?

Copy link
Contributor

@fedirjh fedirjh May 4, 2023

Choose a reason for hiding this comment

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

I think this is a bug , but it's not related to the changes within this PR , as this can be seen in production and in different places e.g. Close account message input , I think this should be handled separately, and there is no need for these changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok I'll get rid of these then.

Copy link
Contributor

Choose a reason for hiding this comment

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

Have we reported this to the channel? But agree that this is a separate issue, so we shouldn't HOLD the PR for it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Missed this comment. We have an open ticket for this bug #18419

@Ollyws
Copy link
Contributor Author

Ollyws commented May 4, 2023

On native input is shaking when expanded

@fedirjh I resolved this issue by adding a fixed height to the textInput. It means we no longer needed scrollPaddingTop in getAutoGrowHeightInputStyle, but I had to add it to textInputContainer because else it scrolls up a bit when we start to break lines. Edit: only happens on web.

Also, as we are getting closer to the 9 day penalty, perhaps we could request to not count the days between the 26th and the 1st toward the timeline? As during this period we considered the PR to be finished.

@fedirjh
Copy link
Contributor

fedirjh commented May 4, 2023

@Ollyws Thanks for update, The native issue is fixed now , I will update the checklist with new recordings.

Also, as we are getting closer to the 9 day penalty, perhaps we could request to not count the days between #17878 (review) and #17878 (comment) toward the timeline?

I am not the one who handles this, maybe you can raise that in the linked issue.

@Ollyws
Copy link
Contributor Author

Ollyws commented May 4, 2023

@fedirjh Reverted the zero-width space.

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

The changes looks good and tests well. However, an unrelated issue was discovered during testing where the line break does not work as intended on the web. @Ollyws attempted to address the it here, albeit without success. It is recommended that this case be treated as a distinct issue and handled separately.

Over to you @techievivek

Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

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

Great work guys 🎉

@techievivek techievivek merged commit 983da48 into Expensify:main May 5, 2023
@OSBotify
Copy link
Contributor

OSBotify commented May 5, 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 May 5, 2023

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.11-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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


return {
...styles.overflowHidden,
height: maxHeight,
Copy link
Contributor

Choose a reason for hiding this comment

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

padding and borderwidth were not considered in maxHeight. It caused #18918 issue regression which is solved by https://github.com/Expensify/App/pull/19582/files

@@ -800,6 +800,11 @@ const styles = {
backgroundColor: themeColors.buttonDefaultBG,
},

autoGrowHeightInputContainer: (textInputHeight, maxHeight) => ({
height: textInputHeight >= maxHeight ? maxHeight : textInputHeight,
Copy link
Contributor

Choose a reason for hiding this comment

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

👋 Coming from #22583
We were missing a check for the minimum height when setting the input height. It only checked if the calculated height is greater than the maxHeight, but didn't consider the case where the calculated height is less than the minHeight.
We resolved this by calculating the height using

lodashClamp(textInputHeight, minHeight, maxHeight)

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