[TS migration] Migrate 'AttachmentPicker' component to TypeScript #37810

dukenv0307 · 2024-03-06T04:56:48Z

Details

Fixed Issues

$ #25134
PROPOSAL: #25134 (comment)

Tests

Open App -> Go to a chat
Click the '+' button
Click on Add Attachment
Verify a system file picker opens

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open App -> Go to a chat
Click the '+' button
Click on Add Attachment
Verify a system file picker opens

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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-resize.mp4

Android: mWeb Chrome

android-mweb-resize.mp4

iOS: Native

ios-resize.mp4

iOS: mWeb Safari

ios-mweb-resize.mp4

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

desktop-resize.mp4

melvin-bot · 2024-03-06T08:13:21Z

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

blazejkustra

Great work! Just couple of comments

src/components/AttachmentPicker/types.ts

src/components/AttachmentPicker/launchCamera/launchCamera.ios.ts

src/components/AttachmentPicker/launchCamera/types.ts

src/components/AttachmentPicker/index.native.tsx

dukenv0307 · 2024-03-11T10:08:39Z

@blazejkustra Thanks for your comments and suggestions. I just updated the code, please check again.

src/components/AttachmentPicker/index.native.tsx

src/components/AttachmentPicker/types.ts

src/components/AttachmentPicker/index.native.tsx

dukenv0307 · 2024-03-13T18:12:26Z

@blazejkustra I just updated the code, please check again 🙏

src/components/AttachmentPicker/index.native.tsx

src/components/AttachmentPicker/index.tsx

blazejkustra · 2024-03-18T20:26:58Z

@dukenv0307 Is this ready for a another review? cc @situchan

dukenv0307 · 2024-03-21T15:59:07Z

@situchan @blazejkustra I updated the code, please check again 🙏

situchan · 2024-03-23T17:53:29Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/components/AttachmentPicker/index.native.tsx

situchan · 2024-03-23T18:00:26Z

I finished review on my side. Tests well.
@blazejkustra bump for review

Co-authored-by: Situ Chandra Shil <108292595+situchan@users.noreply.github.com>

melvin-bot · 2024-03-25T14:59:52Z

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

src/components/AttachmentPicker/index.native.tsx

tgolen · 2024-03-25T16:42:30Z

src/components/AttachmentPicker/launchCamera/launchCamera.ios.ts

@@ -29,4 +26,5 @@ export default function launchCameraIOS(options, callback) {
                errorCode: error.errorCode || 'others',
            });
        });
-}
+};
+export default launchCameraIOS;


If a module exports something as a default, then it should be exporting something with the same name as the file. Can you please change this to export launchCamera instead, please?

@tgolen launchCamera is already defined in this file here

I suggest importing launchCamera with an alias name in that case. Maybe launchCameraImagePicker

@tgolen I updated.

src/components/AttachmentPicker/types.ts

src/components/AttachmentPicker/launchCamera/types.ts

Co-authored-by: Tim Golen <tgolen@gmail.com>

dukenv0307 · 2024-03-26T04:18:03Z

@tgolen I added descriptions, please check again 🙏

tgolen

Thank you for adding all the descriptions!

tgolen · 2024-03-26T14:54:47Z

src/components/AttachmentPicker/launchCamera/launchCamera.ios.ts

@@ -29,4 +26,5 @@ export default function launchCameraIOS(options, callback) {
                errorCode: error.errorCode || 'others',
            });
        });
-}
+};
+export default launchCameraIOS;


I suggest importing launchCamera with an alias name in that case. Maybe launchCameraImagePicker

tgolen

Great, thank you!

OSBotify · 2024-03-26T16:19:19Z

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

dukenv0307 added 7 commits March 4, 2024 16:41

Migrate 'AttachmentPicker' component to TypeScript

d64a997

fix: type in launch camera

049f950

fix type select item function

d34c62b

fix type

cd2681e

Merge branch 'main' into fix/25134

e8f9f8f

fix: type attachment

2dda80f

fix lint

9ac6e89

dukenv0307 marked this pull request as ready for review March 6, 2024 08:13

dukenv0307 requested a review from a team as a code owner March 6, 2024 08:13

melvin-bot bot requested review from situchan and removed request for a team March 6, 2024 08:13

dukenv0307 mentioned this pull request Mar 6, 2024

[HOLD for payment 2024-04-05] [$250] [TS migration] Migrate 'AttachmentPicker' component to TypeScript #25134

Closed

blazejkustra suggested changes Mar 8, 2024

View reviewed changes

dukenv0307 added 3 commits March 11, 2024 15:22

Merge branch 'main' into fix/25134

ea868c3

fix type launch camera

1e3abba

fix: lint

fc29a73

blazejkustra suggested changes Mar 12, 2024

View reviewed changes

blazejkustra reviewed Mar 12, 2024

View reviewed changes

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

dukenv0307 added 4 commits March 13, 2024 22:22

Merge branch 'main' into fix/25134

d4401b8

fix type attachment picker

8e5a242

fix lint

564b7d5

fix type attachment

1ab9c3c

situchan suggested changes Mar 14, 2024

View reviewed changes

dukenv0307 added 3 commits March 15, 2024 16:07

Merge branch 'main' into fix/25134

7d4f876

fix type attchment picker

1450ea9

fix type attachment picker

b729ae6

fix lint

1ae4e2b

situchan reviewed Mar 23, 2024

View reviewed changes

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

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

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

situchan reviewed Mar 23, 2024

View reviewed changes

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

dukenv0307 and others added 3 commits March 25, 2024 15:18

Update src/components/AttachmentPicker/index.native.tsx

78a345e

Co-authored-by: Situ Chandra Shil <108292595+situchan@users.noreply.github.com>

Merge branch 'main' into fix/25134

9f94ba9

fix: eslint

9e39089

blazejkustra approved these changes Mar 25, 2024

View reviewed changes

situchan approved these changes Mar 25, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen March 25, 2024 15:00

tgolen requested changes Mar 25, 2024

View reviewed changes

dukenv0307 and others added 5 commits March 26, 2024 10:11

Update src/components/AttachmentPicker/types.ts

d3b891e

Co-authored-by: Tim Golen <tgolen@gmail.com>

Add description for each property

b0fd19e

merge main

b41cebe

fix type check

594fafa

fix type check

be0c526

tgolen requested changes Mar 26, 2024

View reviewed changes

dukenv0307 added 4 commits March 26, 2024 21:58

Merge branch 'main' into fix/25134

eba576e

import lanchCamera with alias name

21cb31b

add new line

9c26f07

fix lint

640283e

tgolen approved these changes Mar 26, 2024

View reviewed changes

tgolen merged commit 4d59304 into Expensify:main Mar 26, 2024
15 checks passed

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

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'AttachmentPicker' component to TypeScript #37810

[TS migration] Migrate 'AttachmentPicker' component to TypeScript #37810

dukenv0307 commented Mar 6, 2024 •

edited

Loading

melvin-bot bot commented Mar 6, 2024

blazejkustra left a comment

dukenv0307 commented Mar 11, 2024

dukenv0307 commented Mar 13, 2024

blazejkustra commented Mar 18, 2024

dukenv0307 commented Mar 21, 2024

situchan commented Mar 23, 2024

situchan commented Mar 23, 2024

melvin-bot bot commented Mar 25, 2024

tgolen Mar 25, 2024

dukenv0307 Mar 26, 2024

tgolen Mar 26, 2024

dukenv0307 Mar 26, 2024

dukenv0307 commented Mar 26, 2024

tgolen left a comment

tgolen Mar 26, 2024

tgolen left a comment

OSBotify commented Mar 26, 2024

[TS migration] Migrate 'AttachmentPicker' component to TypeScript #37810

[TS migration] Migrate 'AttachmentPicker' component to TypeScript #37810

Conversation

dukenv0307 commented Mar 6, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 6, 2024

blazejkustra left a comment

Choose a reason for hiding this comment

dukenv0307 commented Mar 11, 2024

dukenv0307 commented Mar 13, 2024

blazejkustra commented Mar 18, 2024

dukenv0307 commented Mar 21, 2024

situchan commented Mar 23, 2024

Reviewer Checklist

Screenshots/Videos

situchan commented Mar 23, 2024

melvin-bot bot commented Mar 25, 2024

tgolen Mar 25, 2024

Choose a reason for hiding this comment

dukenv0307 Mar 26, 2024

Choose a reason for hiding this comment

tgolen Mar 26, 2024

Choose a reason for hiding this comment

dukenv0307 Mar 26, 2024

Choose a reason for hiding this comment

dukenv0307 commented Mar 26, 2024

tgolen left a comment

Choose a reason for hiding this comment

tgolen Mar 26, 2024

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 26, 2024

dukenv0307 commented Mar 6, 2024 •

edited

Loading