[TS Migration] Migrate Image to TypeScript #31296

JKobrynski · 2023-11-14T08:41:04Z

Details

Fixed Issues

$ #25107
PROPOSAL: N/A

Tests

Log into the app
Navigate to any conversation
Send an image (alternatively you can open a conversation that already has some images sent)
Make sure the image looks correctly and there are no errors

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(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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/components/Image/index.native.tsx

src/components/Image/index.tsx

src/components/Image/index.native.tsx

src/components/Image/index.tsx

src/components/Image/types.ts

src/components/Image/index.native.tsx

src/components/Image/index.tsx

src/components/Image/index.native.tsx

BartoszGrajdek

LGTM!

JKobrynski · 2024-02-27T07:26:35Z

@aimane-chnaif kindly bump 😄

aimane-chnaif · 2024-02-28T10:16:52Z

ok so before final review, I'd like to confirm if it's fine to merge this PR before #36560
cc: @kidroca

kidroca · 2024-02-28T15:39:51Z

ok so before final review, I'd like to confirm if it's fine to merge this PR before #36560 cc: @kidroca

I don't mind

aimane-chnaif · 2024-02-29T09:05:17Z

@JKobrynski please merge main

aimane-chnaif · 2024-02-29T10:32:45Z

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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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-2.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

JKobrynski · 2024-02-29T10:33:45Z

@aimane-chnaif main merged!

melvin-bot · 2024-02-29T10:42:06Z

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

aimane-chnaif · 2024-02-29T10:43:07Z

ok so TS error happening after merge main. Please fix it

aimane-chnaif · 2024-02-29T11:32:40Z

src/components/MoneyRequestConfirmationList.tsx

+        }
+
+        return typeof receiptData?.image === 'string' ? {uri: receiptData.image} : receiptData?.image;
+    }, []);


React Hook useMemo has missing dependencies: 'receiptData.image' and 'receiptData.thumbnail'. Either include them or remove the dependency array

aimane-chnaif · 2024-02-29T19:35:07Z

Conflicts!

JKobrynski · 2024-03-01T07:29:50Z

@aimane-chnaif resolved!

roryabraham · 2024-03-01T17:09:34Z

src/components/Image/index.tsx

@@ -56,21 +52,19 @@ function Image(props) {
    );
 }

-function imagePropsAreEqual(prevProps, nextProps) {
+function imagePropsAreEqual(prevProps: ImageOwnProps, nextProps: ImageOwnProps) {


NAB but idk why this function isn't just inlined as an arrow function since it's so simple

roryabraham · 2024-03-01T17:10:40Z

src/components/Image/types.ts

+    resizeMode?: ImageResizeMode;
+
+    /** Event for when the image begins loading */
+    onLoadStart?: () => void;


NAB but wouldn't unknown make more sense than void here (and for onLoadEnd, onError, onLoad, onProgress) since we just don't know or care about the return type?

roryabraham · 2024-03-01T17:18:06Z

not sure why the reviewer checklist check isn't passing, but I double-checked that it's filled out completely, so I'm going to ignore that and merge. Maybe caused by the current GitHub incident?

aimane-chnaif · 2024-03-01T17:19:49Z

not sure why the reviewer checklist check isn't passing, but I double-checked that it's filled out completely, so I'm going to ignore that and merge. Maybe caused by the current GitHub incident?

@roryabraham it's because of old checklist here

roryabraham · 2024-03-01T17:21:17Z

Yeah, but I updated the checklist with the version from main and then re-ran the check, and it failed again. Anyways, nabd. The checklist was complete

OSBotify · 2024-03-01T17:24:22Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

aimane-chnaif · 2024-03-01T17:24:35Z

Yeah, but I updated the checklist with the version from main and then re-ran the check, and it failed again. Anyways, nabd. The checklist was complete

Melvin finds first checklist and ignores later ones. So to make last checklist work, all previous checklists should be removed

OSBotify · 2024-03-04T21:02:29Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.47-0 🚀

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

youssef-lr · 2024-03-05T10:46:14Z

This is a long shot, but is there any chance this PR could have caused #37725?

OSBotify · 2024-03-06T21:51:31Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

JKobrynski added 4 commits November 13, 2023 09:11

migrate resizeModes to TypeScript

f67e753

start migrating Image to TypeScript

ba4eda8

migrate index.js to TypeScript

98bd9e1

migrate index.native.js to TypeScript

1e95421

JKobrynski changed the title ~~Migrate image to type script~~ [TS Migration] Migrate image to type script Nov 14, 2023

JKobrynski added 3 commits November 14, 2023 10:36

remove unnecessary js files

ed90b35

extract map type

c1d0c2c

Merge branch 'main' into migrateImageToTypeScript

b423c06

JKobrynski changed the title ~~[TS Migration] Migrate image to type script~~ [TS Migration] Migrate Image to TypeScript Nov 14, 2023

bring back optional props

46c9f92

VickyStash suggested changes Nov 14, 2023

View reviewed changes

src/components/Image/index.native.tsx Outdated Show resolved Hide resolved

src/components/Image/index.native.tsx Outdated Show resolved Hide resolved

src/components/Image/index.tsx Outdated Show resolved Hide resolved

destructure props, add return types

0041ba8

JKobrynski requested a review from VickyStash November 14, 2023 11:17

BartoszGrajdek reviewed Nov 14, 2023

View reviewed changes

src/components/Image/index.tsx Outdated Show resolved Hide resolved

src/components/Image/index.native.tsx Outdated Show resolved Hide resolved

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

extract source type, improve if statements

b446609

JKobrynski requested a review from BartoszGrajdek November 15, 2023 07:44

fabioh8010 reviewed Nov 15, 2023

View reviewed changes

JKobrynski added 4 commits November 15, 2023 12:48

change Image prop types names

21c7980

bring back imageSource to if statement

f115914

remove resolveDimensions from native Image

e2508f9

remove references to Image.resizeModes

3f260bc

JKobrynski requested a review from fabioh8010 November 17, 2023 07:40

fabioh8010 reviewed Nov 20, 2023

View reviewed changes

src/components/Image/index.tsx Outdated Show resolved Hide resolved

src/components/Image/index.native.tsx Outdated Show resolved Hide resolved

remove RESIZE_MODES from Image

3a76fb0

JKobrynski requested a review from fabioh8010 November 20, 2023 11:37

fabioh8010 approved these changes Nov 20, 2023

View reviewed changes

BartoszGrajdek approved these changes Nov 20, 2023

View reviewed changes

JKobrynski marked this pull request as ready for review November 20, 2023 14:53

JKobrynski requested a review from a team as a code owner November 20, 2023 14:53

melvin-bot bot removed the request for review from a team November 20, 2023 14:53

JKobrynski added 2 commits February 23, 2024 12:08

Merge branch 'main' into migrateImageToTypeScript

1e582b6

revert tmp.xcconfig

065c27c

JKobrynski requested a review from aimane-chnaif February 23, 2024 11:32

Merge branch 'main' into migrateImageToTypeScript

05919f2

aimane-chnaif approved these changes Feb 29, 2024

View reviewed changes

fix type errors

cc78940

aimane-chnaif reviewed Feb 29, 2024

View reviewed changes

fill the dependency array in MoneyRequestCOnfirmationList

c0f10cd

Merge branch 'main' into migrateImageToTypeScript

3476ef1

roryabraham approved these changes Mar 1, 2024

View reviewed changes

roryabraham merged commit 65086be into Expensify:main Mar 1, 2024
14 of 17 checks passed

github-actions bot mentioned this pull request Mar 4, 2024

Deploy Checklist: New Expensify 2024-03-04 #37698

Closed

97 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate Image to TypeScript #31296

[TS Migration] Migrate Image to TypeScript #31296

JKobrynski commented Nov 14, 2023 •

edited

Loading

BartoszGrajdek left a comment

JKobrynski commented Feb 27, 2024

aimane-chnaif commented Feb 28, 2024

kidroca commented Feb 28, 2024

aimane-chnaif commented Feb 29, 2024

aimane-chnaif commented Feb 29, 2024 •

edited by roryabraham

Loading

JKobrynski commented Feb 29, 2024

melvin-bot bot commented Feb 29, 2024

aimane-chnaif commented Feb 29, 2024 •

edited

Loading

aimane-chnaif Feb 29, 2024

JKobrynski Feb 29, 2024

aimane-chnaif commented Feb 29, 2024

JKobrynski commented Mar 1, 2024

roryabraham Mar 1, 2024

roryabraham Mar 1, 2024

roryabraham commented Mar 1, 2024

aimane-chnaif commented Mar 1, 2024

roryabraham commented Mar 1, 2024

OSBotify commented Mar 1, 2024

aimane-chnaif commented Mar 1, 2024

OSBotify commented Mar 4, 2024

youssef-lr commented Mar 5, 2024

OSBotify commented Mar 6, 2024

[TS Migration] Migrate Image to TypeScript #31296

[TS Migration] Migrate Image to TypeScript #31296

Conversation

JKobrynski commented Nov 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

BartoszGrajdek left a comment

Choose a reason for hiding this comment

JKobrynski commented Feb 27, 2024

aimane-chnaif commented Feb 28, 2024

kidroca commented Feb 28, 2024

aimane-chnaif commented Feb 29, 2024

aimane-chnaif commented Feb 29, 2024 • edited by roryabraham Loading

Reviewer Checklist

Screenshots/Videos

JKobrynski commented Feb 29, 2024

melvin-bot bot commented Feb 29, 2024

aimane-chnaif commented Feb 29, 2024 • edited Loading

aimane-chnaif Feb 29, 2024

Choose a reason for hiding this comment

JKobrynski Feb 29, 2024

Choose a reason for hiding this comment

aimane-chnaif commented Feb 29, 2024

JKobrynski commented Mar 1, 2024

roryabraham Mar 1, 2024

Choose a reason for hiding this comment

roryabraham Mar 1, 2024

Choose a reason for hiding this comment

roryabraham commented Mar 1, 2024

aimane-chnaif commented Mar 1, 2024

roryabraham commented Mar 1, 2024

OSBotify commented Mar 1, 2024

aimane-chnaif commented Mar 1, 2024

OSBotify commented Mar 4, 2024

youssef-lr commented Mar 5, 2024

OSBotify commented Mar 6, 2024

JKobrynski commented Nov 14, 2023 •

edited

Loading

aimane-chnaif commented Feb 29, 2024 •

edited by roryabraham

Loading

aimane-chnaif commented Feb 29, 2024 •

edited

Loading