Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create upload picker component #51104

Merged
merged 14 commits into from
Oct 29, 2024

Conversation

pasyukevich
Copy link
Contributor

@pasyukevich pasyukevich commented Oct 18, 2024

Details

Fixed Issues

$ #50894
PROPOSAL:

Tests

  • Verify that the avatar with the image picker works correctly

    1. Open settings
    2. Press on profile settings
    3. Click on an avatar to change it
    4. Pick the picture
    5. Submit and verify that the picture has changed
  • Verify that the Attachment picker with the menu item works well

    1. Open any report
    2. Press on the "+" and choose "Add attachment"
    3. Pick the picture and press the "Send" button
    4. Verify that picture upload
  • Verify that the Attachment picker works well

    1. Open any report
    2. Press on the "+" and choose "Submit expense"
    3. Choose the scan
    4. Press on choose file and pick the picture
    5. Submit and observe that picture upload
  • Verify the upload component

    1. Modify the src/settings/pages/Profile/PersonalDetails/LegalNamePage.tsx with next code:
import type {FileObject} from '@components/AttachmentModal';
import UploadFile from '@components/UploadFile';
import * as FormActions from '@userActions/FormActions';
       
const [uploadedIDs, setUploadedID] = useState<FileObject[]>([]);

const handleSelectIDFile = (files: FileObject[]) => {
  FormActions.setDraftValues(ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM, {UPLOADED: [...uploadedIDs, ...files]});
  setUploadedID((prev) => [...prev, ...files]); };

const handleRemoveIDFile = (fileUri: string) => {
    const newUploadedIDs = uploadedIDs.filter((file) => file.uri !== fileUri);
    FormActions.setDraftValues(ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM, {UPLOADED: newUploadedIDs});
    setUploadedID(newUploadedIDs);
};
    
    ...
    
             <FormProvider
                formID={ONYXKEYS.FORMS.ADD_PAYMENT_CARD_FORM}
                validate={validate}
                onSubmit={addPaymentCard}
                submitButtonText={submitButtonText}
                scrollContextEnabled
                style={[styles.mh5, styles.flexGrow1]}
            >
             
             ...
             
              <InputWrapper
                    InputComponent={UploadFile}
                    buttonText="choose file"
                    uploadedFiles={uploadedIDs}
                    onUpload={handleSelectIDFile}
                    onRemove={handleRemoveIDFile}
                    acceptedFileTypes={[...CONST.NON_USD_BANK_ACCOUNT.ALLOWED_FILE_TYPES]}
                    value={uploadedIDs}
                    inputID="INPUT_ID"
                />
                
       
  1. Open the settings/profile and press on legal name
  2. Press on Choose File button
  3. Pick and submit
  4. Verify that file attached and appeared
  5. Remove the file by pressing the cross button
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Screenshots/Videos

Android: Native
android-native-converted.webm
Android: mWeb Chrome
android-web-converted.webm
iOS: Native
ios-nwtive-converted.mp4
iOS: mWeb Safari
ios-web-converted.mp4
MacOS: Chrome / Safari
web-converted.mov
MacOS: Desktop
desktop-converted.mov

Copy link

melvin-bot bot commented Oct 18, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@pasyukevich pasyukevich marked this pull request as ready for review October 22, 2024 14:58
@pasyukevich pasyukevich requested review from a team as code owners October 22, 2024 14:58
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team October 22, 2024 14:58
Copy link

melvin-bot bot commented Oct 22, 2024

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

@shawnborton
Copy link
Contributor

Can we make sure these styles for this here:
CleanShot 2024-10-22 at 20 21 37@2x

Look identical to the styles we use in chat for attachments with no previews?
CleanShot 2024-10-22 at 20 23 58@2x

@pasyukevich
Copy link
Contributor Author

@shawnborton, I've updated the styles to match the attachments for chats

@hungvu193
Copy link
Contributor

Reviewing shortly

@hungvu193
Copy link
Contributor

hungvu193 commented Oct 23, 2024

The changes look good to me.
I think there are 2 things we need to improve here:

  1. We shouldn't show duplicate images if user selects one image twice.
  2. With long file name, the text is cut off.
Screen.Recording.2024-10-23.at.22.52.06.mov

src/components/AttachmentPicker/types.ts Outdated Show resolved Hide resolved
Comment on lines 497 to 498
sizeExceededWithValue: ({maxUploadSizeInMB}: SizeExceededParams) => `Files exceeds ${maxUploadSizeInMB}MB. Please try again.`,
tooManyFiles: ({fileLimit}: FileLimitParams) => `You can only upload up to ${fileLimit} files at a time.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we're still waiting for translation here right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, we don't have the translations yet

src/components/UploadFile.tsx Outdated Show resolved Hide resolved
@shawnborton
Copy link
Contributor

Let us know when you have updated screenshots to review.

@pasyukevich
Copy link
Contributor Author

updated with new videos

@shawnborton @hungvu193

@pasyukevich
Copy link
Contributor Author

@hungvu193 code updated to cover points that you've mentioned

@hungvu193
Copy link
Contributor

@shawnborton Do we have limit lines for the attachment name?

Screenshot 2024-10-25 at 10 05 27

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Oct 25, 2024

I'll let the other @Expensify/design'ers give thoughts, but I kinda think we should limit it to two lines.

And I wonder if we can do the clever thing that MacOS does which is to make sure the file extension still shows even when we use ellipsis. And to avoid having weirdness with too many dots with the extension (long_file_name....pdf), we could show the last 5 letters of the string + the extension:

image

@hungvu193
Copy link
Contributor

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

// running issue

Android: mWeb Chrome
Screen.Recording.2024-10-25.at.13.39.43.mov
iOS: Native
IOS.mov
iOS: mWeb Safari
mSafari.mov
MacOS: Chrome / Safari
Chrome.mov
MacOS: Desktop
Desktop.mov

Copy link
Contributor

@hungvu193 hungvu193 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM!

@melvin-bot melvin-bot bot requested a review from madmax330 October 25, 2024 06:44
@shawnborton
Copy link
Contributor

Totally agree with Jon here, two lines seems more than reasonable and I like the idea of truncation in the middle so you can always see the file extension/ending characters. Otherwise this looks good to me!

@hungvu193

This comment was marked as off-topic.

@dannymcclain
Copy link
Contributor

Love that idea Jon!

@pasyukevich
Copy link
Contributor Author

Updated with translations and basic text cropping

I will focus on the middle crop now. It is a bit complicated, I will divide the implementation for web and native

@madmax330 madmax330 merged commit d9fbd41 into Expensify:main Oct 29, 2024
16 checks passed
@OSBotify
Copy link
Contributor

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

@pasyukevich
Copy link
Contributor Author

Since it was merged can we move this improvement with middle truncation to the separate task?

It is quite easy to implement it for the ios, but for the rest platform, we need to calculate the container size and inner text without the truncation, which can be very heavy.

@hungvu193
Copy link
Contributor

Let's create a follow-up PR for that

Copy link
Contributor

🚀 Deployed to staging by https://github.com/madmax330 in version: 9.0.56-0 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants