[TS migration] Migrate 'InlineCodeBlock' component to TypeScript #32477

VickyStash · 2023-12-05T14:28:54Z

Details

[TS migration] Migrate 'InlineCodeBlock' component to TypeScript

Fixed Issues

$ #25092
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Open the app.
Open any chat.
Send a normal single backtick code block e.g. Hello and make sure it displays same way as before.

Backtick code block input example

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Open the app.
Open any chat.
Send a normal single backtick code block e.g. Hello and make sure it displays same way as before.

Backtick code block input example

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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

kubabutkiewicz

one nit besides lgtm :D

src/components/InlineCodeBlock/WrappedText.tsx

src/components/InlineCodeBlock/types.ts

rezkiy37

Left a comment, after LGTM.

src/components/InlineCodeBlock/types.ts

fabioh8010 · 2023-12-06T08:10:01Z

src/components/InlineCodeBlock/WrappedText.tsx

+
+    const textMatrix = getTextMatrix(children);
+
+    return textMatrix.map((rowText, rowIndex) => (


I see you removed the outer fragment <></> and are returning the map directly, please let's test this to ensure there is no regressions.

Retested all of the platforms 👌

src/components/InlineCodeBlock/WrappedText.tsx

src/components/InlineCodeBlock/types.ts

src/components/InlineCodeBlock/index.tsx

blazejkustra · 2023-12-08T09:43:47Z

src/styles/codeStyles/types.ts

@@ -1,7 +1,7 @@
 import {TextStyle, ViewStyle} from 'react-native';

 type CodeWordWrapperStyles = ViewStyle;
-type CodeWordStyles = TextStyle;
+type CodeWordStyles = ViewStyle;


Why was this changed?

@blazejkustra Otherwise there is a TS error in this line

Weird typing issues, I'm not sure I get them...

@cubuspl42 More detailed clarification, let me know if it makes more sense to you:

CodeWordStyles type is used for typing styles.codeWordStyle

styles.codeWordStyle is passed to the WrappedText component as a part of wordStyles param

wordStyles param in WrappedText is used for View component styling

so it expects that styles.codeWordStyle will have ViewStyle type instead of TextStyle, which means CodeWordStyles type should be ViewStyle

Ok, thanks. So I understand that we don't pass any text-specific styles, and we stick to the View-supported style properties subset

src/components/InlineCodeBlock/types.ts

melvin-bot · 2023-12-08T11:47:15Z

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

src/components/InlineCodeBlock/WrappedText.tsx

cubuspl42

If we move or refactor the code, we are responsible for ensuring this code meets the checklist requirements (correct English, proper JSDoc comments, etc.).

src/components/InlineCodeBlock/WrappedText.tsx

VickyStash · 2023-12-11T16:02:57Z

@cubuspl42 Thank you! Updated

cubuspl42 · 2023-12-12T15:39:18Z

Please merge main

cubuspl42 · 2023-12-12T15:45:41Z

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

cubuspl42

Looks good

melvin-bot · 2023-12-12T15:46:48Z

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

marcochavezf

LGTM, thank you guys!

OSBotify · 2023-12-12T18:01:23Z

✋ 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-13T11:29:52Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T11:50:35Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-13T12:18:09Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.12-0 🚀

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

OSBotify · 2023-12-14T15:24:52Z

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

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

[TS migration] Migrate 'InlineCodeBlock' component

7bceb50

kubabutkiewicz approved these changes Dec 5, 2023

View reviewed changes

src/components/InlineCodeBlock/WrappedText.tsx Outdated Show resolved Hide resolved

rezkiy37 reviewed Dec 5, 2023

View reviewed changes

src/components/InlineCodeBlock/WrappedText.tsx Outdated Show resolved Hide resolved

rezkiy37 reviewed Dec 5, 2023

View reviewed changes

src/components/InlineCodeBlock/types.ts Outdated Show resolved Hide resolved

rezkiy37 reviewed Dec 5, 2023

View reviewed changes

VickyStash added 3 commits December 5, 2023 17:26

Update type import

29e8e63

Remove fragment

0d77578

Merge branch 'main' into ts-migration/inlineCodeBlock-component

9076fb5

fabioh8010 reviewed Dec 6, 2023

View reviewed changes

Update InlineCodeBlockProps typing

b75f513

fabioh8010 approved these changes Dec 6, 2023

View reviewed changes

blazejkustra suggested changes Dec 8, 2023

View reviewed changes

Update boxModelStyle typing

0c300b9

blazejkustra approved these changes Dec 8, 2023

View reviewed changes

VickyStash marked this pull request as ready for review December 8, 2023 11:47

VickyStash requested a review from a team as a code owner December 8, 2023 11:47

melvin-bot bot requested review from cubuspl42 and removed request for a team December 8, 2023 11:47

cubuspl42 reviewed Dec 11, 2023

View reviewed changes

src/components/InlineCodeBlock/WrappedText.tsx Outdated Show resolved Hide resolved

cubuspl42 reviewed Dec 11, 2023

View reviewed changes

src/components/InlineCodeBlock/WrappedText.tsx Outdated Show resolved Hide resolved

cubuspl42 suggested changes Dec 11, 2023

View reviewed changes

VickyStash commented Dec 11, 2023

View reviewed changes

src/components/InlineCodeBlock/WrappedText.tsx Outdated Show resolved Hide resolved

Improve comments

9a6f7a4

cubuspl42 approved these changes Dec 12, 2023

View reviewed changes

melvin-bot bot requested a review from marcochavezf December 12, 2023 15:46

Merge branch 'main' into ts-migration/inlineCodeBlock-component

729ae12

marcochavezf approved these changes Dec 12, 2023

View reviewed changes

marcochavezf merged commit d5ff8f8 into Expensify:main Dec 12, 2023

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

[$500] Deploy Checklist: New Expensify 2023-12-13 #32963

Closed

64 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'InlineCodeBlock' component to TypeScript #32477

[TS migration] Migrate 'InlineCodeBlock' component to TypeScript #32477

VickyStash commented Dec 5, 2023 •

edited

Loading

kubabutkiewicz left a comment

rezkiy37 left a comment

fabioh8010 Dec 6, 2023

VickyStash Dec 6, 2023

blazejkustra Dec 8, 2023

VickyStash Dec 8, 2023

cubuspl42 Dec 11, 2023

VickyStash Dec 11, 2023

cubuspl42 Dec 11, 2023

melvin-bot bot commented Dec 8, 2023

cubuspl42 left a comment

VickyStash commented Dec 11, 2023

cubuspl42 commented Dec 12, 2023

cubuspl42 commented Dec 12, 2023

cubuspl42 left a comment

melvin-bot bot commented Dec 12, 2023

marcochavezf left a comment

OSBotify commented Dec 12, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023


		const textMatrix = getTextMatrix(children);

		return textMatrix.map((rowText, rowIndex) => (

[TS migration] Migrate 'InlineCodeBlock' component to TypeScript #32477

[TS migration] Migrate 'InlineCodeBlock' component to TypeScript #32477

Conversation

VickyStash commented Dec 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kubabutkiewicz left a comment

Choose a reason for hiding this comment

rezkiy37 left a comment

Choose a reason for hiding this comment

fabioh8010 Dec 6, 2023

Choose a reason for hiding this comment

VickyStash Dec 6, 2023

Choose a reason for hiding this comment

blazejkustra Dec 8, 2023

Choose a reason for hiding this comment

VickyStash Dec 8, 2023

Choose a reason for hiding this comment

cubuspl42 Dec 11, 2023

Choose a reason for hiding this comment

VickyStash Dec 11, 2023

Choose a reason for hiding this comment

cubuspl42 Dec 11, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Dec 8, 2023

cubuspl42 left a comment

Choose a reason for hiding this comment

VickyStash commented Dec 11, 2023

cubuspl42 commented Dec 12, 2023

cubuspl42 commented Dec 12, 2023

Reviewer Checklist

Screenshots/Videos

cubuspl42 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 12, 2023

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 12, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

VickyStash commented Dec 5, 2023 •

edited

Loading