[TS migration] Migrate 'ExceededCommentLength.js' component to TypeScript #31520

BartoszGrajdek · 2023-11-19T14:11:45Z

Details

Migrate 'ExceededCommentLength.js' component file to TypeScript

Fixed Issues

$ #25018

Tests

Open up chat
Write a message with >10.000 characters.
Make sure an error is displayed, and that you can't send the message
Remove additional characters
Check if the error disappeared and whether you can send the message now

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open up chat
Write a message with >10.000 characters.
Make sure an error is displayed, and that you can't send the message
Remove additional characters
Check if the error disappeared and whether you can send the message now

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

chrome.mov

iOS: Native

iOS: mWeb Safari

safari.mov

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…-comment-length

…ript

blazejkustra

One small comment, LGTM!

src/components/ExceededCommentLength.tsx

fabioh8010 · 2023-11-27T13:00:04Z

src/components/ExceededCommentLength.tsx


    /** Text Comment */
-    comment: PropTypes.string,
+    comment: string;


Suggested change

comment: string;

comment?: string;

fabioh8010 · 2023-11-27T13:01:04Z

src/components/ExceededCommentLength.tsx

    const styles = useThemeStyles();
    const {numberFormat, translate} = useLocalize();
    const [commentLength, setCommentLength] = useState(0);
    const updateCommentLength = useMemo(
        () =>
-            debounce((comment, onExceededMaxCommentLength) => {
-                const newCommentLength = ReportUtils.getCommentLength(comment);
+            debounce((newComment, onExceededMaxCommentLengthCallabck) => {


Suggested change

debounce((newComment, onExceededMaxCommentLengthCallabck) => {

debounce((newComment, onExceededMaxCommentLengthCallback) => {

typo 😅

BartoszGrajdek · 2023-11-30T13:10:26Z

Done! @fabioh8010

…-comment-length

melvin-bot · 2023-12-11T18:56:08Z

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

mollfpr · 2023-12-12T16:57:35Z

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 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(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 a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

31520.Android.mp4

Android: mWeb Chrome

31520.mWeb-Android.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.17.2.-.2023-12-16.at.03.55.57.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.17.2.-.2023-12-16.at.03.57.31.mp4

MacOS: Chrome / Safari

31520.Web.mp4

MacOS: Desktop

31520.Desktop.mp4

mollfpr · 2023-12-14T15:17:58Z

@BartoszGrajdek Could you resolve the conflicts? Thank you!

blazejkustra · 2023-12-14T16:08:57Z

@mollfpr Done!

mollfpr

LGTM 👍

melvin-bot · 2023-12-15T20:58:31Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25018 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

cead22

Approving since I don't know if you wanna make the updates I'm suggesting in this PR, or if we should do it separately. Let me know and I can merge

cead22 · 2023-12-15T21:41:32Z

src/components/ExceededCommentLength.tsx

-const defaultProps = {};
-
-function ExceededCommentLength(props) {
+function ExceededCommentLength({shouldShowError}: ExceededCommentLengthProps) {


I know this is a migration issue, but If feel like a component called ExceededCommentLength shouldn't check on a shouldShowError boolean to display a message about a comment exceeding the max length.

Instead, we should check shouldShowError outside of the component, and only render it if it's true

Suggested change

function ExceededCommentLength({shouldShowError}: ExceededCommentLengthProps) {

function ExceededCommentLength() {

src/components/ExceededCommentLength.tsx

cead22 · 2023-12-15T21:41:51Z

src/components/ExceededCommentLength.tsx

+    if (!shouldShowError) {
        return null;
    }
+


Suggested change

if (!shouldShowError) {

return null;

}

cead22 · 2023-12-15T21:42:27Z

src/components/ExceededCommentLength.tsx

+type ExceededCommentLengthProps = {
+    /** Show error when comment length is exceeded */
+    shouldShowError: boolean;
 };



Suggested change

type ExceededCommentLengthProps = {

/** Show error when comment length is exceeded */

shouldShowError: boolean;

};

blazejkustra · 2023-12-17T14:31:03Z

Approving since I don't know if you wanna make the updates I'm suggesting in this PR, or if we should do it separately. Let me know and I can merge

It is a fairly easy change, let's do it in this PR 👍 cc @BartoszGrajdek

BartoszGrajdek · 2023-12-18T12:22:21Z

@cead22 I've added the changes you suggested, let me know if it's alright 😄

cead22 · 2023-12-18T17:03:56Z

Thank you

OSBotify · 2023-12-18T20:49:37Z

✋ 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-12-19T02:42:27Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-19T03:45:48Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.4.14-0 🚀

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

OSBotify · 2023-12-21T05:13:23Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

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

BartoszGrajdek added 6 commits October 20, 2023 14:13

Rename ExceededCommentLength

40cb3d8

Merge remote-tracking branch 'origin/main' into ts-migration/exceeded…

7365fc1

…-comment-length

[TS migration] Migrate 'ExceededCommentLength.js' component to TypeSc…

8b13df9

…ript

fix: onyx types

8f4c659

Resolve merge conflicts

ac7eb62

fix: prettier

72da8a9

blazejkustra reviewed Nov 20, 2023

View reviewed changes

src/components/ExceededCommentLength.tsx Outdated Show resolved Hide resolved

fix: reorganize types

250d93a

fabioh8010 reviewed Nov 27, 2023

View reviewed changes

Fix: typo & optional prop

af41cf8

fabioh8010 approved these changes Dec 1, 2023

View reviewed changes

Merge remote-tracking branch 'origin/main' into ts-migration/exceeded…

59c60a6

…-comment-length

BartoszGrajdek marked this pull request as ready for review December 11, 2023 18:56

BartoszGrajdek requested a review from a team as a code owner December 11, 2023 18:56

melvin-bot bot requested review from mollfpr and removed request for a team December 11, 2023 18:56

Merge branch 'main' into ts-migration/exceeded-comment-length

285b87a

mollfpr approved these changes Dec 15, 2023

View reviewed changes

melvin-bot bot requested a review from cead22 December 15, 2023 20:58

cead22 previously approved these changes Dec 15, 2023

View reviewed changes

fix: remove shouldShowError

eae6241

BartoszGrajdek dismissed cead22’s stale review via eae6241 December 18, 2023 12:15

fix: lint

790b602

cead22 approved these changes Dec 18, 2023

View reviewed changes

cead22 merged commit d297354 into Expensify:main Dec 18, 2023
15 checks passed

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2023-12-28] [TS migration] Migrate 'ExceededCommentLength.js' component to TypeScript #25018

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'ExceededCommentLength.js' component to TypeScript #31520

[TS migration] Migrate 'ExceededCommentLength.js' component to TypeScript #31520

BartoszGrajdek commented Nov 19, 2023 •

edited

Loading

blazejkustra left a comment

fabioh8010 Nov 27, 2023

fabioh8010 Nov 27, 2023

BartoszGrajdek commented Nov 30, 2023

melvin-bot bot commented Dec 11, 2023

mollfpr commented Dec 12, 2023 •

edited

Loading

mollfpr commented Dec 14, 2023

blazejkustra commented Dec 14, 2023

mollfpr left a comment

melvin-bot bot commented Dec 15, 2023

cead22 left a comment

cead22 Dec 15, 2023

cead22 Dec 15, 2023

cead22 Dec 15, 2023

blazejkustra commented Dec 17, 2023

BartoszGrajdek commented Dec 18, 2023

cead22 commented Dec 18, 2023

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

	debounce((newComment, onExceededMaxCommentLengthCallabck) => {
	debounce((newComment, onExceededMaxCommentLengthCallback) => {

	function ExceededCommentLength({shouldShowError}: ExceededCommentLengthProps) {
	function ExceededCommentLength() {

[TS migration] Migrate 'ExceededCommentLength.js' component to TypeScript #31520

[TS migration] Migrate 'ExceededCommentLength.js' component to TypeScript #31520

Conversation

BartoszGrajdek commented Nov 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra left a comment

Choose a reason for hiding this comment

fabioh8010 Nov 27, 2023

Choose a reason for hiding this comment

fabioh8010 Nov 27, 2023

Choose a reason for hiding this comment

BartoszGrajdek commented Nov 30, 2023

melvin-bot bot commented Dec 11, 2023

mollfpr commented Dec 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented Dec 14, 2023

blazejkustra commented Dec 14, 2023

mollfpr left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 15, 2023

cead22 left a comment

Choose a reason for hiding this comment

cead22 Dec 15, 2023

Choose a reason for hiding this comment

cead22 Dec 15, 2023

Choose a reason for hiding this comment

cead22 Dec 15, 2023

Choose a reason for hiding this comment

blazejkustra commented Dec 17, 2023

BartoszGrajdek commented Dec 18, 2023

cead22 commented Dec 18, 2023

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

BartoszGrajdek commented Nov 19, 2023 •

edited

Loading

mollfpr commented Dec 12, 2023 •

edited

Loading