New Attachment Upload UX with Real-Time Previews #44889
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kidroca
changed the title
kidroca
force-pushed
the
kidroca/feat/attachment-upload-ux
branch
from
c72cb19
to
0cf6147
Compare
- Consolidated the logic for generating `htmlForNewComment` and `textForNewComment`. - Cleaned up redundant checks for file and text presence. - Optimized creation of the `reportAction` object.
- Introduced a new function `getAttachmentHtml` to handle the generation of attachment HTML. - Updated `addComment` function to use `getAttachmentHtml` for cleaner code. - Ensured `textForNewComment` is parsed from `htmlForNewComment` for consistency.
Renamed the function `getAttachmentHtml` to `getUploadingAttachmentHtml` for better clarity and consistency. The new name more accurately reflects its purpose in generating HTML for uploading attachments.
- Improved `getUploadingAttachmentHtml` function to handle image and video attachments. - Added conditions to check for MIME types and generate appropriate HTML for image and video sources. - Updated `htmlForNewComment` to remove an extra newline character.
Added nullish coalescing operator to ensure `attribs[CONST.ATTACHMENT_SOURCE_ATTRIBUTE]` is defined before using `split()`, preventing potential runtime errors.
- Return HTML string directly within conditionals for image and video attachments. - Ensure a generic message is returned for other file types. - Adjust the HTML for new comments to conditionally include line breaks when an attachment is present. ```
Refactor the order of URL resolution priorities to fix issues with video rendering. Now, the video source URL will first check the ATTACHMENT_SOURCE_ATTRIBUTE, then 'src', and finally 'href'.
Updated the fallback case for handling non-media files in `src/libs/ReportUtils.ts`. Instead of using a generic uploading message, we now present a link to the file for better user experience.
- Introduced `ATTACHMENT_OPTIMISTIC_SOURCE_ATTRIBUTE` in constants. - Updated `ReportUtils` to include the new optimistic source attribute in the HTML output for images, videos, and other file types.
…c in .ts 🧩 - Extracted attachment regex pattern into a constant `ATTACHMENT_PATTERN` - Simplified the return condition by leveraging the extracted constant - Fix function parameter documentation
Updated the `isUploading` condition to use `html.contains(CONST.ATTACHMENT_OPTIMISTIC_SOURCE_ATTRIBUTE)` instead of comparing it to `CONST.ATTACHMENT_UPLOADING_MESSAGE_HTML`, because `CONST.ATTACHMENT_UPLOADING_MESSAGE_HTML` is being removed
Since `CONST.ATTACHMENT_UPLOADING_MESSAGE_HTML` is no longer used it's removed from the check
kidroca
force-pushed
the
kidroca/feat/attachment-upload-ux
branch
from
7824ffa
to
40d07c4
Compare
|
As per the PR Author checklist I'm tagging @Expensify/design to review the UI/UX change This PR introduces a UI/UX change with the attachment upload flow The difference being introduced is now we render a thumbnail of the attachment instead of the text "Uploading attachment..." Below you can see some new vs old samples Attaching an image or videoSBS.Attachment.Upload.movAttaching an image while offline
Attaching a PDF docSBS.PDF.movOther filesSBS.Other.files.movThe UX is identical on iOS and Android native, there are examples attached inside the Screenshots section in the PR description |
- The message "Uploading Attachment..." no longer exists - we don't need to test for such text to match an attachment action - All attachments use the `CONST.ATTACHMENT_SOURCE_ATTRIBUTE` it can be used to distinct them - Attachments in upload use the same attribute as well
The `uploading-attachment` custom model is removed as it is no longer used.
kidroca
force-pushed
the
kidroca/feat/attachment-upload-ux
branch
from
55a79e9
to
27ca9a8
Compare
|
@parasharrajat 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] |
|
I will have updates by tomorrow. |
…raction Update the logic for extracting attachment file names by using the original file name attribute if available. This enhances clarity and ensures that the most accurate file name is utilized, falling back to the source only when necessary.
I've added another small patch to resolve the following issues:
Screen.Recording.2024-07-29.at.20.09.13.mov
Can we just track them under the existing ticket? I can list them in a status update. |
Works for me. |
…rces Added a check to ensure local file sources (file: or blob:) are not included in the download options. This avoids redundancy and potential issues with file not found when attempting to download local files.
kidroca
force-pushed
the
kidroca/feat/attachment-upload-ux
branch
from
caf095f
to
955009b
Compare
|
Thanks for the changes. But I still see following issues.
|
Added a check to ensure the download option is hidden for resources that are currently being uploaded. This prevents users from attempting to download files that are not yet available, improving the user experience.
Removed the download option from the context menu for pending uploads. |
…ents Restores original logic to set translationKey only when the comment is an attachment
|
I see. I am fine with not solving the clipped name issue in this PR. But downloaded file should return the extension for correct type. I will test it in couple of minutes again. |
The clipped filename was happening only if you try to download a file that is not yet uploaded to the backend, no? It's no longer possible to download before the upload completes, so there shouldn't be any issues with the filename and extension. |
Video download has this issue even after file is uploaded to server but same issue is present on staging so we don't have to solve it here. |
parasharrajat
approved these changes
Jul 30, 2024
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
Future Actionable items are mentioned in #44889 (comment). @kidroca @deetergp Let's create a plan for these so we don't see a deploy blocker popping up after merge. |
I've just posted my plan for these in the parent issue: #9402 (comment) |
deetergp
approved these changes
Jul 31, 2024
|
LGTM |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/deetergp in version: 9.0.15-0 🚀
|
This was referenced Jul 31, 2024
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀
|
Closed
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
Show the attachment instead of the text "Uploading attachment..."
Fixed Issues
$ #9402
PROPOSAL: #9402 (comment)
Tests
Open a Chat and Send Attachments
Known Issue
Offline tests
QA Steps
Same as the Tests section above
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android.Emulator.-.Pixel_7_API_33_5554.2024-07-10.20-37-14.mp4
Uploading a PDF doc
Android.Emulator.-.Pixel_7_API_33_5554.2024-07-10.20-51-19.mp4
Android: mWeb Chrome
Android.Emulator.-.Pixel_7_API_33_5554.2024-07-12.15-51-53.mp4
iOS: Native
Screen.Recording.2024-07-05.at.9.45.17.mov
Screen.Recording.2024-07-08.at.21.01.18.mov
Screen.Recording.2024-07-08.at.21.03.11.mov
iOS: mWeb Safari
Screen.Recording.2024-07-12.at.19.50.41.mov
MacOS: Chrome / Safari
New.Expensify.-.Personal.-.Microsoft.Edge.2024-07-12.15-43-15.mp4
Sending while offline
New.Expensify.-.Personal.-.Microsoft.Edge.2024-07-12.15-49-32.mp4
Sending a zip file
Screen.Recording.2024-07-26.at.15.36.38.mov
Sending a pdf doc
Screen.Recording.2024-07-26.at.15.38.05.mov
MacOS: Desktop
Screen.Recording.2024-07-08.at.22.06.45.mov
Offline
Screen.Recording.2024-07-08.at.22.18.39.mov