fix: pdf send attachment regression #30995

HezekielT · 2023-11-07T14:31:48Z

Details

This PR fixes the regression caused by #30050 on android native.

Fixed Issues

$ #30977
#30979
PROPOSAL:

Tests

Launch app
Tap on a report
Tap plus icon near compose and select "Add attachment"
Select any password protected pdf from "Choose document"
Verify Password Protected Preview is shown.
Enter the password.
Scroll the pdf up and down.
Verify the pdf can be scrolled.

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as Tests Section

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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

regressionAndroidNative.mov

Android: mWeb Chrome

regressionAndroidChrome.mov

iOS: Native

regressioniOSNative.mov

iOS: mWeb Safari

regressioniOSSafari.mov

MacOS: Chrome / Safari

regressionWeb.mov

MacOS: Desktop

regressionDesktop.mov

HezekielT · 2023-11-07T14:35:04Z

@mollfpr PR is ready.

melvin-bot · 2023-11-07T14:35:33Z

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

mollfpr · 2023-11-07T14:36:28Z

@HezekielT Could you add the details in description what the issue is?

HezekielT · 2023-11-07T14:46:04Z

@HezekielT Could you add the details in description what the issue is?

@mollfpr I've added a note that states that it fixes the regression caused by #30050

danieldoglas · 2023-11-07T14:53:06Z

@mollfpr can you do the checklist in this one?

mollfpr · 2023-11-07T14:55:00Z

@danieldoglas Yup, on it now!

mollfpr · 2023-11-07T15:40:48Z

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 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 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(themeColors.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 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

Uploading 30995 Android.mp4…

Android: mWeb Chrome

Uploading 30995 mWeb-Chrome.mp4…

iOS: Native

Uploading 30995 iOS.mp4…

iOS: mWeb Safari

MacOS: Chrome / Safari

Uploading 30995 Web.mp4…

MacOS: Desktop

mollfpr

@HezekielT The test results looks good, but I still don't understand what the problem is and why the solution is this.

HezekielT · 2023-11-07T15:56:41Z

@mollfpr Since we are using gesture detector, if we don't have the right hierarchy of components the solution will not work. The problem is that for a pdf attachment that is already sent, we use <AttachmentCarousel which uses View to wrap <AttachmentCarouselPager but for send attachement we are directly calling <AttachmentView and we are not wrapping it using View component. That is the issue. I hope it makes sense.

HezekielT · 2023-11-07T16:10:14Z

If we don't have the right component structure(hierarchy) and the correct styles applied to the components the event won't properly propagate, which is why the scrolling is not working and the password preview is not shown.

mollfpr · 2023-11-07T16:14:33Z

Should we put the view wrapper here?

App/src/components/Attachments/AttachmentView/index.js

Lines 122 to 126 in 9b53463

    
           if ((_.isString(source) && Str.isPDF(source)) || (file && Str.isPDF(file.name || translate('attachmentView.unknownFilename')))) { 
        
               const encryptedSourceUrl = isAuthTokenRequired ? addEncryptedAuthTokenToURL(source) : source; 
        
               return ( 
        
                   <AttachmentViewPdf

Wrapping it around AttachmentView seems to add unnecessary elements for other attachment types.

HezekielT · 2023-11-07T16:16:51Z

I haven't tested that. Let me try it and I will let you know if it works.

mollfpr · 2023-11-07T16:35:07Z

@HezekielT On second thought, I'm okay with the current changes. I don't see any harm, and it's better since AttachmentView is also called inside the carousel item, so it feels like we doing the same things over again. But let's add a note about why we need that wrapper in the AttachmentModal.

HezekielT · 2023-11-07T16:42:51Z

Ok, I will only add a comment then.

HezekielT · 2023-11-07T16:49:30Z

@mollfpr I have added a comment on why we need the View. Do you think it is enough?

danieldoglas · 2023-11-07T17:13:09Z

@mollfpr can you please check and approve the PR if it's good for you now?

…gression fix: pdf send attachment regression (cherry picked from commit 3bcea70)

OSBotify · 2023-11-07T17:35:36Z

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

OSBotify · 2023-11-07T18:07:10Z

🚀 Cherry-picked to staging by https://github.com/puneetlath in version: 1.3.96-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

mollfpr · 2023-11-07T18:38:49Z

Sorry, I fell asleep waiting for the recordings to be done uploading.

Thank you @danieldoglas for taking care of this 🙏

OSBotify · 2023-11-08T08:30:36Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.96-6 🚀

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

Beamanator · 2023-11-09T14:42:27Z

This may have caused these regressions:

[WAITING ON CHECKLIST][HOLD for payment 2023-11-21] [$500] Attachment - File name is placed on the left of the preview page if add docx and mp4. #31103
[HOLD for payment 2023-11-21] [HOLD for payment 2023-11-17] Chat - Concierge Avatar is not centered #31080

HezekielT · 2023-11-09T14:51:44Z

@Beamanator Apologies for the regression. Had we put the wrapper in AttachmentView instead of in AttachmentModal as suggested by @mollfpr here, I think the regression would have been avoided. my apologies.

mollfpr · 2023-11-09T15:08:50Z

@Beamanator @HezekielT Another regression?? 🥲

Beamanator · 2023-11-09T15:11:06Z

Yepppp 😅

Beamanator · 2023-11-09T15:12:20Z

Ooh if @HezekielT 's comment is right (which was @mollfpr 's idea) maybe we don't need alignItems: 'center' as was proposed in #31080!

mollfpr · 2023-11-09T15:16:17Z

I haven't checked yet if my idea will solve the regression 😅

Beamanator · 2023-11-09T15:17:09Z

I just did a small test & so far it works in all cases (Concierge avatar, uploading video, viewing multiple images carousel) 👍 🙏

mollfpr · 2023-11-09T15:18:28Z

Make sense to me to redo this PR, then.

Beamanator · 2023-11-09T15:19:11Z

Yeah I like that solution better anyway - less elements wrapping other attachment types unnecessarily 👍

Beamanator · 2023-11-09T15:19:46Z

@HezekielT are you around to create this PR? If not, I'll make it now

Beamanator · 2023-11-09T15:22:38Z

@mollfpr here is the PR: #31130

Are you free to test on all platforms? I'm working on adding test steps

looks like @Santhosh-Sellavel was free and will do the testing 🙏

HezekielT · 2023-11-09T15:58:42Z

@Beamanator Thank you for taking care of this. If there is anything I can do to help, I am available now. I'm so sorry once again for the regressions.

Beamanator · 2023-11-10T08:37:17Z

FYI it looks like this is currently in production:

App/src/components/AttachmentModal.js

Lines 444 to 461 in e6451bb

    
           Boolean(sourceForAttachmentView) && 
        
           shouldLoadAttachment && ( 
        
               // We need the following View component on android native 
        
               // So that the event will propagate properly and 
        
               // the Password protected preview will be shown for pdf attachement we are about to send. 
        
               <View style={[styles.flex1, styles.attachmentCarouselContainer]}> 
        
                   <AttachmentView 
        
                       containerStyles={[styles.mh5]} 
        
                       source={sourceForAttachmentView} 
        
                       isAuthTokenRequired={isAuthTokenRequired} 
        
                       file={file} 
        
                       onToggleKeyboard={updateConfirmButtonVisibility} 
        
                       isWorkspaceAvatar={props.isWorkspaceAvatar} 
        
                       fallbackSource={props.fallbackSource} 
        
                       isUsedInAttachmentModal 
        
                   /> 
        
               </View> 
        
           )

OSBotify · 2023-11-10T15:43:30Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

OSBotify · 2023-11-10T16:02:15Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:55:42Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

fix pdf send attachment regression

c8f07c6

HezekielT marked this pull request as ready for review November 7, 2023 14:35

HezekielT requested a review from a team as a code owner November 7, 2023 14:35

melvin-bot bot requested review from burczu and removed request for a team November 7, 2023 14:35

HezekielT mentioned this pull request Nov 7, 2023

[HOLD for payment 2023-11-21] [HOLD for payment 2023-11-17] [$500] Android - Attachments-Password protected file preview is not shown #30977

Closed

6 tasks

HezekielT mentioned this pull request Nov 7, 2023

[$500] Android - Chat - Attachment - Preview of a multi-page PDF cannot be scrolled #30979

Closed

6 tasks

mollfpr reviewed Nov 7, 2023

View reviewed changes

put the logic in AttachmentView instead of AttachmentModal

702fd0c

add a comment

34745c7

HezekielT requested a review from mollfpr November 7, 2023 17:09

danieldoglas approved these changes Nov 7, 2023

View reviewed changes

danieldoglas merged commit 3bcea70 into Expensify:main Nov 7, 2023
13 checks passed

OSBotify pushed a commit that referenced this pull request Nov 7, 2023

Merge pull request #30995 from HezekielT/fix--pdf-send-attachement-re…

b578f3b

…gression fix: pdf send attachment regression (cherry picked from commit 3bcea70)

OSBotify mentioned this pull request Nov 7, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

ishpaul777 mentioned this pull request Nov 8, 2023

[HOLD for payment 2023-11-21] [HOLD for payment 2023-11-17] Chat - Concierge Avatar is not centered #31080

Closed

6 tasks

Beamanator mentioned this pull request Nov 9, 2023

[CP Staging] Move View wrapper to AttachmentViewPdf #31130

Merged

59 tasks

Beamanator mentioned this pull request Nov 10, 2023

[$1000] mWeb - Cannot open protected PDF in chat view while logged into an old account #31166

Closed

6 tasks

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

Santhosh-Sellavel mentioned this pull request Nov 26, 2023

[WAITING ON CHECKLIST][HOLD for payment 2023-11-21] [$500] Attachment - File name is placed on the left of the preview page if add docx and mp4. #31103

Closed

6 tasks

fix: pdf send attachment regression #30995

fix: pdf send attachment regression #30995

Conversation

HezekielT commented Nov 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

HezekielT commented Nov 7, 2023

melvin-bot bot commented Nov 7, 2023

mollfpr commented Nov 7, 2023

HezekielT commented Nov 7, 2023

danieldoglas commented Nov 7, 2023

mollfpr commented Nov 7, 2023

mollfpr commented Nov 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

HezekielT commented Nov 7, 2023 • edited Loading

HezekielT commented Nov 7, 2023

mollfpr commented Nov 7, 2023

HezekielT commented Nov 7, 2023

mollfpr commented Nov 7, 2023

HezekielT commented Nov 7, 2023

HezekielT commented Nov 7, 2023

danieldoglas commented Nov 7, 2023

OSBotify commented Nov 7, 2023

OSBotify commented Nov 7, 2023

mollfpr commented Nov 7, 2023

OSBotify commented Nov 8, 2023

Beamanator commented Nov 9, 2023

HezekielT commented Nov 9, 2023

mollfpr commented Nov 9, 2023

Beamanator commented Nov 9, 2023

Beamanator commented Nov 9, 2023

mollfpr commented Nov 9, 2023

Beamanator commented Nov 9, 2023

mollfpr commented Nov 9, 2023

Beamanator commented Nov 9, 2023

Beamanator commented Nov 9, 2023

Beamanator commented Nov 9, 2023 • edited Loading

HezekielT commented Nov 9, 2023

Beamanator commented Nov 10, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

HezekielT commented Nov 7, 2023 •

edited

Loading

mollfpr commented Nov 7, 2023 •

edited

Loading

HezekielT commented Nov 7, 2023 •

edited

Loading

Beamanator commented Nov 9, 2023 •

edited

Loading