[TS migration] Migrate AttachmentCarousel to typescript #36658

SzymczakJ · 2024-02-16T09:03:38Z

Details

Fixed Issues

$ #25152
PROPOSAL: N/A

Tests

Send few attachments in report and verify they show correctly, through clicking them and switching them. Check all attachment types: image, pdf, video.
Verify that in case of having eReceipt in report, the receipt is shown correctly when clicking on it
Verify that user profile photo is showing correctly.
Create distance money request and verify that distance receipt show correctly.

Offline tests

QA Steps

Same as tests

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

android.mov

Android: mWeb Chrome

android.web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/components/Attachments/AttachmentCarousel/CarouselActions.tsx

src/components/Attachments/AttachmentCarousel/extractAttachmentsFromReport.ts

src/components/Attachments/AttachmentCarousel/index.native.tsx

src/components/Attachments/AttachmentView/AttachmentViewPdf/BaseAttachmentViewPdf.tsx

src/components/Attachments/AttachmentView/AttachmentViewPdf/types.ts

src/components/Attachments/AttachmentView/index.tsx

src/components/Attachments/AttachmentCarousel/CarouselButtons.tsx

src/components/Attachments/AttachmentCarousel/CarouselItem.tsx

kubabutkiewicz · 2024-03-11T13:49:06Z

src/components/Attachments/AttachmentCarousel/Pager/index.tsx

-                isSingleItem={items.length === 1}
-                index={index}


why those props were removed?

It's no longer used by CarouselItem, probably smb forgot to remove this.

src/components/Attachments/AttachmentView/index.tsx

s77rt · 2024-03-19T21:34:04Z

src/components/Attachments/AttachmentView/index.tsx

-    /** URL to full-sized attachment, SVG function, or numeric static image on native platforms */
-    source: AttachmentsPropTypes.attachmentSourcePropType.isRequired,
+type AttachmentViewProps = AttachmentViewOnyxProps &
+    Omit<Attachment, 'isAuthTokenRequired'> & {


Instead of omitting isAuthTokenRequired from Attachment. Make that prop optional in Attachment

s77rt · 2024-03-19T21:36:55Z

src/components/Attachments/AttachmentView/index.tsx

-    /** The id of the report action related to the attachment */
-    reportActionID: PropTypes.string,
+        /** Extra styles to pass to View wrapper */
+        containerStyles?: Array<StyleProp<ViewStyle>>;


Suggested change

containerStyles?: Array<StyleProp<ViewStyle>>;

containerStyles?: StyleProp<ViewStyle>;

s77rt · 2024-03-19T21:38:10Z

src/components/Attachments/AttachmentView/index.tsx

+        /** The id of the transaction related to the attachment */
+        transactionID?: string;


Suggested change

/** The id of the transaction related to the attachment */

transactionID?: string;

Already defined in Attachment

s77rt · 2024-03-19T21:38:54Z

src/components/Attachments/AttachmentView/index.tsx

+
+        isHovered?: boolean;
+
+        optionalVideoDuration?: number;


Suggested change

optionalVideoDuration?: number;

Attachment has prop duration let's use it instead

s77rt · 2024-03-19T21:41:39Z

src/components/Attachments/AttachmentView/AttachmentViewVideo/index.tsx


    /** Whether the video is currently being hovered over */
-    isHovered: PropTypes.bool,
+    isHovered?: boolean;


Suggested change

isHovered?: boolean;

Pick from AttachmentViewProps

s77rt · 2024-03-19T21:43:26Z

src/components/Attachments/AttachmentView/AttachmentViewPdf/types.ts

+
+type AttachmentViewPdfProps = Pick<AttachmentViewProps, 'file' | 'onPress' | 'isUsedInCarousel' | 'isFocused' | 'onToggleKeyboard'> & {
+    encryptedSourceUrl: string;
+    onToggleKeyboard?: (shouldFadeOut: boolean) => void;


Suggested change

onToggleKeyboard?: (shouldFadeOut: boolean) => void;

Already defined

s77rt · 2024-03-20T15:19:51Z

@SzymczakJ We have a failing performance test. Can you please merge main see if that fixes it

SzymczakJ · 2024-03-21T15:11:10Z

@s77rt had to merge it twice but it passed 😄

s77rt · 2024-03-21T17:38:18Z

@SzymczakJ Thank you!

melvin-bot · 2024-03-21T17:38:35Z

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

puneetlath

Just some minor comments/questions.

src/components/Attachments/AttachmentView/AttachmentViewPdf/index.android.tsx

puneetlath · 2024-03-21T17:57:03Z

src/components/Attachments/types.ts

+import type {FileObject} from '@components/AttachmentModal';
+import type IconAsset from '@src/types/utils/IconAsset';
+
+// This can be either a string, function, or number


This comment doesn't really add any value. The line below makes that clear. If we think this is an interesting or important point, it'd be good to add "why".

src/components/Attachments/types.ts

src/components/Attachments/AttachmentCarousel/types.ts

src/components/Attachments/AttachmentView/index.tsx

SzymczakJ · 2024-03-25T08:35:44Z

@puneetlath fixed your comments!

melvin-bot · 2024-03-25T16:56:14Z

@puneetlath looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

puneetlath · 2024-03-25T16:56:42Z

All the tests did pass.

SzymczakJ added 6 commits February 15, 2024 16:42

migrate AttachmentView

a9315c4

migrate AttachmentCarousel

0f696ce

migrate attachmentCarousel

de7619a

Merge branch 'main' into @szymczak/AttachmentCarousel

4146104

fix merge bugs

e8ab36f

clean up code

b46b1c0

BartoszGrajdek reviewed Feb 16, 2024

View reviewed changes

SzymczakJ added 7 commits February 26, 2024 11:02

Merge branch 'main' into @szymczak/AttachmentCarousel

ca34bcc

fix AttachmentView memo

b51d1c9

fix PR comments

e6d06bf

Merge branch 'main' into @szymczak/AttachmentCarousel

eba12a9

fix ts errors

d60d76b

Merge branch 'main' into @szymczak/AttachmentCarousel

5a29704

fix AttachmentView crash

7560f8b

SzymczakJ requested a review from BartoszGrajdek February 27, 2024 12:51

BartoszGrajdek approved these changes Feb 27, 2024

View reviewed changes

SzymczakJ added 5 commits February 28, 2024 11:12

Merge branch 'main' into @szymczak/AttachmentCarousel

adbfc65

fix lint error

ca76ff6

merge main

f188c8c

fix type errors

7a9853a

fix lint

a8b03df

kubabutkiewicz reviewed Mar 11, 2024

View reviewed changes

SzymczakJ added 2 commits March 13, 2024 11:33

fix comments

b7ad3e2

fix comments

f51a489

SzymczakJ requested a review from kubabutkiewicz March 13, 2024 11:12

kubabutkiewicz approved these changes Mar 13, 2024

View reviewed changes

SzymczakJ marked this pull request as ready for review March 13, 2024 12:02

SzymczakJ requested a review from a team as a code owner March 13, 2024 12:02

melvin-bot bot requested review from s77rt and removed request for a team March 13, 2024 12:03

fix type error

8a5c9c5

s77rt suggested changes Mar 19, 2024

View reviewed changes

SzymczakJ added 2 commits March 20, 2024 12:10

fix pr comments

efbdf5c

fix type errors

b8d4a61

SzymczakJ requested a review from s77rt March 20, 2024 11:40

SzymczakJ added 2 commits March 21, 2024 09:21

Merge branch 'main' into @szymczak/AttachmentCarousel

b63dcdc

Merge branch 'main' into @szymczak/AttachmentCarousel

ad79213

s77rt approved these changes Mar 21, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath March 21, 2024 17:39

puneetlath requested changes Mar 21, 2024

View reviewed changes

fabioh8010 mentioned this pull request Mar 22, 2024

[TS migration] Migrate 'AttachmentView' component to TypeScript #25150

Closed

SzymczakJ added 2 commits March 24, 2024 17:41

Merge branch 'main' into @szymczak/AttachmentCarousel

40a3688

fi pr comments

0844b82

SzymczakJ requested a review from puneetlath March 25, 2024 08:34

Merge branch 'main' into @szymczak/AttachmentCarousel

f5a6712

puneetlath approved these changes Mar 25, 2024

View reviewed changes

puneetlath merged commit bcd4878 into Expensify:main Mar 25, 2024
16 checks passed

melvin-bot bot added the Emergency label Mar 25, 2024

puneetlath removed the Emergency label Mar 25, 2024

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

Deploy Checklist: New Expensify 2024-03-27 #39033

Closed

AndrewGable mentioned this pull request Mar 27, 2024

[$250] mWeb/Safari - Chat - Space appears above chat header after opening and closing attachment #39065

Closed

6 tasks

melvin-bot bot mentioned this pull request Mar 29, 2024

[HOLD for payment 2024-04-05] [TS migration] Migrate 'AttachmentCarousel' component to TypeScript #25152

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate AttachmentCarousel to typescript #36658

[TS migration] Migrate AttachmentCarousel to typescript #36658

SzymczakJ commented Feb 16, 2024 •

edited

Loading

kubabutkiewicz Mar 11, 2024

SzymczakJ Mar 12, 2024

s77rt Mar 19, 2024

s77rt Mar 19, 2024

s77rt Mar 19, 2024

s77rt Mar 19, 2024

s77rt Mar 19, 2024

s77rt Mar 19, 2024

s77rt commented Mar 20, 2024

SzymczakJ commented Mar 21, 2024

s77rt commented Mar 21, 2024

melvin-bot bot commented Mar 21, 2024

puneetlath left a comment

puneetlath Mar 21, 2024

SzymczakJ commented Mar 25, 2024

melvin-bot bot commented Mar 25, 2024

puneetlath commented Mar 25, 2024

	containerStyles?: Array<StyleProp<ViewStyle>>;
	containerStyles?: StyleProp<ViewStyle>;

		/** The id of the transaction related to the attachment */
		transactionID?: string;

[TS migration] Migrate AttachmentCarousel to typescript #36658

[TS migration] Migrate AttachmentCarousel to typescript #36658

Conversation

SzymczakJ commented Feb 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt commented Mar 20, 2024

SzymczakJ commented Mar 21, 2024

s77rt commented Mar 21, 2024

melvin-bot bot commented Mar 21, 2024

puneetlath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SzymczakJ commented Mar 25, 2024

melvin-bot bot commented Mar 25, 2024

puneetlath commented Mar 25, 2024

SzymczakJ commented Feb 16, 2024 •

edited

Loading