[TS Migration] Migrate Composer to TypeScript #31912

JKobrynski · 2023-11-27T13:41:16Z

Details

Fixed Issues

$ #25141
PROPOSAL: N/A

Tests

Log into the app
Navigate to any chat
Test the Composer thoroughly:

Writing messages (short and long)
Pasting text
Pasting html
Editing messages
Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests section above

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 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 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 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.

Screenshots/Videos

Android: Native

android-compressed.webm

Android: mWeb Chrome

chrome-compressed.webm

iOS: Native

ios-compressed.mp4

iOS: mWeb Safari

safari-compressed.mp4

MacOS: Chrome / Safari

web-compressed.mov

MacOS: Desktop

desktop-compressed.mov

src/components/Composer/index.android.tsx

src/components/Composer/index.tsx

src/components/Composer/index.android.tsx

src/components/Composer/index.ios.tsx

src/components/Composer/index.tsx

rezkiy37

Left a couple comments.

src/components/Composer/index.android.tsx

src/components/Composer/index.ios.tsx

src/components/Composer/index.android.tsx

src/components/Composer/index.ios.tsx

src/components/Composer/index.tsx

src/libs/ComposerUtils/types.ts

src/types/modules/react-native.d.ts

src/components/Composer/index.android.tsx

src/components/Composer/index.tsx

src/components/Composer/index.android.tsx

src/components/Composer/index.ios.tsx

BartoszGrajdek

LGTM!

melvin-bot · 2023-11-30T12:32:21Z

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

situchan · 2023-12-04T17:52:37Z

src/components/Composer/index.ios.tsx

+        autoFocus = false,
+        isFullComposerAvailable = false,
+        style,
+        ...props


selection default value is missing

Is it necessary? It's not used in this file, see line 69:

const {selection, ...propsToPass} = props;

That's why I suggested to extract selection here. Then const {selection, ...propsToPass} = props; will not be necessary

Can you also check this comment? 🙏

const {A, ...rest} = props; const {B, ...propsToPass} = rest;

This equals to

const {A, B, ...propsToPass} = props;

Here, B = selection

Ok, I get it now!

src/components/Composer/index.ios.tsx

src/components/Composer/index.tsx

JKobrynski · 2023-12-08T08:10:16Z

@situchan kindly bump 😄

JKobrynski · 2023-12-11T07:19:17Z

@situchan PR updated!

JKobrynski · 2023-12-13T13:35:08Z

@situchan kindly bump 😄

situchan · 2023-12-13T14:57:48Z

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

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

melvin-bot · 2023-12-13T14:58:30Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #32972.

JKobrynski · 2023-12-15T08:20:16Z

@mountiny could you help with progressing on this one? 🙏

mountiny · 2023-12-15T11:21:12Z

@NikkiWines got assigned to the issue so I will leave this one to her :)

NikkiWines

two very small comments, otherwise looks great

NikkiWines · 2023-12-16T02:19:23Z

src/components/Composer/index.tsx

+        // start: initialValue.length,
+        // end: initialValue.length,


Let's remove these if they're unused

NikkiWines · 2023-12-16T02:20:36Z

src/components/Composer/index.tsx

+ * @param str - The input string.
+ * @param cursorPos - The position of the cursor within the input string.


NAB: inputString and cursorPosition instead of abbreviated variable names (same with subString on line 32 if you do end up changing this)

Great idea, always an improvement 😄

JKobrynski · 2023-12-18T12:51:32Z

@NikkiWines PR updated!

NikkiWines

Nice, looks great

OSBotify · 2023-12-18T15:43:44Z

✋ 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:45Z

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

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

OSBotify · 2023-12-19T03:46:06Z

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

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

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

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

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

JKobrynski and others added 9 commits November 22, 2023 09:51

migrate index.ios.tsx to TypeScript

f1c060b

migrate index.android.js to TypeScript

32f4140

start migrating index.js

ef6cbd6

fix forwarded ref

bc23a01

Fixes in refs and events

3b27bf8

remove unsupported multiline prop

0a02f93

remove mutliline prop

dc94cd7

Merge branch 'main' into migrateComposerToTypeScript

2aac63a

cleanup the code

000fc54

VickyStash suggested changes Nov 27, 2023

View reviewed changes

rezkiy37 reviewed Nov 27, 2023

View reviewed changes

src/components/Composer/index.android.tsx Outdated Show resolved Hide resolved

src/components/Composer/index.ios.tsx Outdated Show resolved Hide resolved

apply suggested improvements

205469a

JKobrynski requested review from rezkiy37 and VickyStash November 28, 2023 08:00

fabioh8010 reviewed Nov 28, 2023

View reviewed changes

apply improvements, unify ComposerProps type

d70b49d

JKobrynski requested a review from fabioh8010 November 28, 2023 10:37

fabioh8010 reviewed Nov 29, 2023

View reviewed changes

src/components/Composer/index.android.tsx Show resolved Hide resolved

src/components/Composer/index.tsx Show resolved Hide resolved

fabioh8010 approved these changes Nov 29, 2023

View reviewed changes

BartoszGrajdek reviewed Nov 29, 2023

View reviewed changes

src/components/Composer/index.android.tsx Show resolved Hide resolved

src/components/Composer/index.ios.tsx Show resolved Hide resolved

JKobrynski added 2 commits November 30, 2023 10:04

Merge branch 'main' into migrateComposerToTypeScript

da409ec

Merge branch 'main' into migrateComposerToTypeScript

c8ec585

BartoszGrajdek approved these changes Nov 30, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review November 30, 2023 12:32

JKobrynski requested a review from a team as a code owner November 30, 2023 12:32

melvin-bot bot removed request for a team, VickyStash and rezkiy37 November 30, 2023 12:32

JKobrynski mentioned this pull request Nov 30, 2023

[HOLD for payment 2023-12-28] [TS migration] Migrate 'Composer' component to TypeScript #25141

Closed

situchan reviewed Dec 4, 2023

View reviewed changes

JKobrynski added 2 commits December 5, 2023 08:49

remove ref from if statement

40de00c

add optional chaining to onFocus call

76c7334

JKobrynski requested a review from situchan December 5, 2023 08:09

JKobrynski added 2 commits December 7, 2023 16:13

Merge branch 'main' into migrateComposerToTypeScript

5370049

Merge branch 'main' into migrateComposerToTypeScript

49e358c

move selection destructuring to the top

0a91ea7

situchan approved these changes Dec 13, 2023

View reviewed changes

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

Payment issue for E/App PR#31912 #32972

Closed

Merge branch 'main' into migrateComposerToTypeScript

4114784

mountiny assigned JKobrynski Dec 15, 2023

mountiny requested a review from NikkiWines December 15, 2023 11:20

NikkiWines requested changes Dec 16, 2023

View reviewed changes

change variable names

1c26c3e

JKobrynski requested a review from NikkiWines December 18, 2023 12:51

NikkiWines approved these changes Dec 18, 2023

View reviewed changes

NikkiWines merged commit b2c713e into Expensify:main Dec 18, 2023
16 checks passed

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

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

Closed

98 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate Composer to TypeScript #31912

[TS Migration] Migrate Composer to TypeScript #31912

JKobrynski commented Nov 27, 2023 •

edited by mountiny

Loading

rezkiy37 left a comment

BartoszGrajdek left a comment

melvin-bot bot commented Nov 30, 2023

situchan Dec 4, 2023

JKobrynski Dec 5, 2023

situchan Dec 5, 2023

JKobrynski Dec 5, 2023

situchan Dec 11, 2023

JKobrynski Dec 11, 2023

JKobrynski commented Dec 8, 2023

JKobrynski commented Dec 11, 2023

JKobrynski commented Dec 13, 2023

situchan commented Dec 13, 2023

situchan left a comment

melvin-bot bot commented Dec 13, 2023

JKobrynski commented Dec 15, 2023

mountiny commented Dec 15, 2023

NikkiWines left a comment

NikkiWines Dec 16, 2023

NikkiWines Dec 16, 2023

JKobrynski Dec 18, 2023

JKobrynski commented Dec 18, 2023

NikkiWines left a comment

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

		* @param str - The input string.
		* @param cursorPos - The position of the cursor within the input string.

[TS Migration] Migrate Composer to TypeScript #31912

[TS Migration] Migrate Composer to TypeScript #31912

Conversation

JKobrynski commented Nov 27, 2023 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

BartoszGrajdek left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JKobrynski commented Dec 8, 2023

JKobrynski commented Dec 11, 2023

JKobrynski commented Dec 13, 2023

situchan commented Dec 13, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 13, 2023

JKobrynski commented Dec 15, 2023

mountiny commented Dec 15, 2023

NikkiWines left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JKobrynski commented Dec 18, 2023

NikkiWines left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

JKobrynski commented Nov 27, 2023 •

edited by mountiny

Loading