refactor: Refactor types and structure of AttachmentModalScreen component#69524
Conversation
chrispader
force-pushed
the
@chrispader/attachment-modal-screen-types-and-refactors
branch
from
a3bd44a to
29ef00b
Compare
chrispader
force-pushed
the
@chrispader/attachment-modal-screen-types-and-refactors
branch
from
29ef00b to
1ecd682
Compare
|
Reviewing... |
src/pages/media/AttachmentModalScreen/routes/hooks/useDownloadAttachment.ts
Outdated
Show resolved
Hide resolved
| if (typeof sourceURL === 'string') { | ||
| const fileName = type === CONST.ATTACHMENT_TYPE.SEARCH ? getFileName(`${sourceURL}`) : file?.name; | ||
| const shouldUnlink = !draftTransactionID; | ||
| fileDownload(sourceURL, fileName ?? '', undefined, undefined, undefined, undefined, undefined, shouldUnlink); |
There was a problem hiding this comment.
Not a blocker: we should convert params to object structure for fileDownload.
There was a problem hiding this comment.
I agree, but fileDownload is used in a lot of other files, so i think we should do this in a follow-up to not increase the scope of this PR again.
There was a problem hiding this comment.
Sounds good. Yeah, I agree.. Not in this PR.
src/pages/media/AttachmentModalScreen/routes/ReportAttachmentModalContent.tsx
Outdated
Show resolved
Hide resolved
|
@parasharrajat addressed your change requests! |
|
PR doesn’t need product input as it stands as a refactor. Removing the tag and unsubscribing myself. |
|
NOB: Minor Change (Present on staging): The download button on the newly submitted receipt does not appear immediately. Just noticed that the menu does not show until image loading is complete in mweb. |
| ); | ||
|
|
||
| // Validates the attachment file and renders the appropriate modal type or errors | ||
| const validateFile: OnValidateFileCallback = useCallback( |
There was a problem hiding this comment.
Where is this validation happening now?
There was a problem hiding this comment.
I undid the changes in AttachmentModalBaseContent component which were actually changes for the "Add Attachments" + Multi-File support PR.
The file validation is not really used in RpeortAttachmentModalContent at the moment, but we can keep this in here for now and remove in a later PR when i migrate SCREENS.ATTACHMENTS separately
|
No blocker(Present on staging): Glitch: mweb chrome: Expense Chat profile photo flickers between workspace and user avatar. |
Screenshots🔲 iOS / native29.08.2025_23.01.07_REC.mp429.08.2025_22.57.54_REC.mp4🔲 iOS / Safari29.08.2025_23.27.04_REC.mp4🔲 MacOS / Desktop29.08.2025_23.34.34_REC.mp4🔲 MacOS / Chrome29.08.2025_23.03.16_REC.mp4🔲 Android / Chrome29.08.2025_23.14.53_REC.mp4🔲 Android / native29.08.2025_22.47.10_REC.mp4 |
parasharrajat
left a comment
parasharrajat
left a comment
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
|
Ok, I will retest it as there are changes now. |
|
@chrispader thanks for splitting this up, can you please merge main to fix the reassure tests? |
mountiny
left a comment
mountiny
left a comment
There was a problem hiding this comment.
@blazejkustra @jmusial @adamgrzybowski @WojtekBoman Could one of you also please review this one? thanks!
@mountiny done! |
| updateHiddenAttachments: (reportActionID: string, isHidden: boolean) => void; | ||
| setCurrentAttachment: (attachmentProps: AttachmentModalScreenParams | undefined) => void; | ||
| getCurrentAttachment: () => AttachmentModalScreenParams | undefined; | ||
| setCurrentAttachment: <Route extends AttachmentModalScreenType, RouteParams extends AttachmentModalScreenParams<Route> = AttachmentModalScreenParams<Route>>( |
There was a problem hiding this comment.
This type could be extracted to make it DRYer
There was a problem hiding this comment.
What do you mean? These are generic types which extend (imported) types and have default types
There was a problem hiding this comment.
The user should be able to only call AttachmentModalContext.setCurrentAttachment<'ROUTE_NAME'>({...})
There was a problem hiding this comment.
I just noticed that some of the code looks redundant 😄 If you think it can't be shortened, then it looks good to me
There was a problem hiding this comment.
ok, no unfortunately i cannot shorten this further 😅🙌🏼
|
A few comments bug nothing major. Good job 💪 |
mountiny
left a comment
mountiny
left a comment
There was a problem hiding this comment.
Thanks for the updates, looks good to me
|
Sorry more conflicts |
@mountiny just merged main! |
|
Bump @mountiny |
|
✋ 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/mountiny in version: 9.2.2-0 🚀
|
|
🚀 Deployed to production by https://github.com/francoisl in version: 9.2.2-8 🚀
|
8 participants
@mountiny @parasharrajat
Explanation of Change
In #63630 we migrated the
ReportAttachmentsscreen to the newAttachmentModalScreeninstead ofAttachmentModalcomponent.This PR refactors some of the structure and types of the
AttachmentModalScreencomponent. This is necessary for later migration PRs.Fixed Issues
$ #53493
PROPOSAL:
Tests
There are no specific tests, as this PR should not change anything in the UI. Threrefore, we might need to do a full regression testing/QA run.
Offline tests
Not needed.
QA Steps
// TODO: These must be filled out, or the issue title must include "[No QA]."
No QA - There are no specific tests, as this PR should not change anything in the UI. Threrefore, the full regression testing/QA run should uncover any bugs
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectioncanBeMissingparam foruseOnyxtoggleReportand notonIconClick)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
Screen_Recording_20250207_004027_New.Expensify.Dev.mp4
Screen_Recording_20250207_004044_New.Expensify.Dev.mp4
Screen_Recording_20250207_003937_New.Expensify.Dev.mp4
Screen_Recording_20250207_004006_New.Expensify.Dev.2.mp4
Android: mWeb Chrome
iOS: Native
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-02-06.at.16.32.44.mp4
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-02-06.at.16.32.30.mp4
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-02-03.at.11.26.24.mp4
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-02-06.at.16.32.17.mp4
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-02-06.at.16.33.13.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2025-02-06.at.16.38.14.mov
Screen.Recording.2025-02-06.at.16.37.58.mov
Screen.Recording.2025-02-06.at.16.37.32.mov
Screen.Recording.2025-02-06.at.16.37.47.mov
Screen.Recording.2025-02-06.at.16.36.50.mov
MacOS: Desktop