Fix: PDF is not cached by tienifr · Pull Request #32678 · Expensify/App

tienifr · 2023-12-07T15:45:59Z

Details

PDF files are not cached. This PR fixes that.

Fixed Issues

Tests

Native only:

Send a large PDF
Open it (the file loading is long)
Close the modal and reopen it
Verify the file is served almost instantly
Log out then login
Open the attachment
Verify that it is loading for a while

We can verify in the Cache folder of the app on native device that the cached PDF file is removed after logging out. We can manually log the file path in finishPDFLoad function to see where it's stored.

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Native only:

Send a large PDF
Open it (the file loading is long)
Close the modal and reopen it
Verify the file is served almost instantly
Log out then login
Open the attachment
Verify that it is loading for a while

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-07.at.22.57.03-compressed.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2023-12-07.at.22.53.29-compressed.mov

Screen.Recording.2023-12-07.at.22.54.07-compressed.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-12-07.at.22.50.55-compressed.mov

MacOS: Desktop

melvin-bot · 2023-12-07T16:50:47Z

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

tienifr · 2023-12-07T16:51:13Z

We don't have to manually clear the cached PDF because the app's Cached folder in native device is automatically cleared after logging out.

getusha · 2023-12-11T07:58:40Z

                        trustAllCerts={false}
                        renderActivityIndicator={() => <FullScreenLoadingIndicator />}
-                        source={{uri: this.props.sourceURL}}
+                        source={{uri: this.props.sourceURL, cache: true, expiration: 864000}}


@tienifr I think we should raise a discussion for the expiration interval. IMO 12 hours should be good.

Raised discussion on Slack.

another question: will the cache be removed when attachment is deleted from the chat?

will the cache be removed when attachment is deleted from the chat

Seems like it does not. But it still gets removed when we logged out.

Seems like it does not. But it still gets removed when we logged out.

We should clear the cache when the attachment is deleted, and i am not sure how this will work incase of protected pdf i am checking.

getusha · 2023-12-18T13:44:38Z

@tienifr any updates on #32678 (comment)?

tienifr · 2023-12-20T11:22:26Z

Working on it. Seems like we still need Onyx.

getusha · 2024-01-06T09:47:06Z

@tienifr Any updates?

tienifr · 2024-01-06T15:12:12Z

Code changes seem good but I'm trying to refactor to make it as short as possible.

getusha · 2024-01-16T10:36:54Z

@tienifr any updates on this?

tienifr · 2024-01-16T10:39:25Z

I'm sorry will get this done today.

getusha · 2024-01-23T19:06:14Z

@tienifr could we please get an update? ty!

tienifr · 2024-01-24T11:41:55Z

@getusha Sorry for the delay. This is ready for review.

getusha · 2024-01-24T16:26:46Z

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(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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-26.at.1.35.08.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-01-26.at.2.12.53.PM.mov

iOS: Native

Screen.Recording.2024-01-24.at.7.24.21.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-01-26.at.2.26.06.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-26.at.2.08.21.PM.mov

MacOS: Desktop

Screen.Recording.2024-02-28.at.9.50.50.AM.mov

getusha · 2024-01-24T16:27:10Z

@tienifr looks like we've got a conflict.

getusha · 2024-01-24T17:14:07Z

+        exists(path).then((exist) => {
+            if (!exist) {
+                resolve();
+            }


Lets also update the list stored in Onyx

if (pdfPaths[path]) { delete pdfPaths[path]; Onyx.set(ONYXKEYS.CACHED_PDF_PATHS, pdfPaths); }

I already did that in the caller fucntion here and here.

getusha · 2024-01-24T17:15:23Z

There is also another case, when the pdf cached is sent from the other user and it gets deleted.

tienifr · 2024-01-25T07:31:22Z

@getusha I think that is infeasible. We don't even need to remove cache when delete attachment. IMO, the expiration time alone is enough for this. What do you think?

getusha · 2024-01-31T10:03:59Z

@tienifr any updates, looks like we've got a merge conflict.

getusha · 2024-02-04T19:51:36Z

@tienifr gentle bump :)

getusha · 2024-02-08T11:07:57Z

@tienifr any updates?

tienifr · 2024-02-08T12:20:50Z

I'm working on it. Wrapping up today.

getusha · 2024-02-11T19:03:48Z

@tienifr lets get this done this week.

tienifr · 2024-02-15T07:43:45Z

Sorry I've been OOO the last week. This gets quite complicated and may introduce unnecessary and risky changes. Give me a day or two to do some tests.

getusha · 2024-02-22T18:20:28Z

@tienifr we must complete this, this week 😄

tienifr · 2024-02-24T16:20:23Z

@getusha I took a look at react-native-pdf's source code. The caching mechanism there is too simple. Whenever you open a file, it will check if the cache is expired then delete it and re-cache a new file. That means the cached file, once created, never goes away unless we log out. And the expiration here is the time to cache a new file, not to completely remove it from memory. By that, we can verify that we will never have many duplicated caches for the same file.

So if we want to remove the cache when expiration is over, we need to implement it ourself. The implementation is:

When any PDF file is loaded, we check every single cached paths in Onyx to see if they are expired (based on the file's last modified time metadata)
If yes, then remove it from memory

IMO, the implementation is quite complicated and not a good ROI (i.e. not brings much value). We'd better keep it simple and let they all be wiped out when signed out. What do you think? Do you want to go with it anw?

getusha · 2024-02-24T16:24:42Z

IMO, the implementation is quite complicated and not a good ROI (i.e. not brings much value). We'd better keep it simple and let they all be wiped out when signed out. What do you think? Do you want to go with it anw?

I agree we should keep it simple, thanks for looking into that deeply.

tienifr · 2024-02-26T03:04:08Z

TS check failure is on main and not related to this PR. I'll try to pull main today. If we don't need to improve anything, are we good to go? @getusha

getusha · 2024-02-26T08:23:16Z

        const encryptedSourceUrl = isAuthTokenRequired ? addEncryptedAuthTokenToURL(source) : source;

+        const onPDFLoadComplete = (path) => {
+            if (isUsedInCarousel && reportActionID && path) {


why is this? isUsedInCarousel, logged pdfPaths and it is not storing the paths anymore due to this condition.

That's my fault. I removed it.

tienifr · 2024-02-26T10:25:01Z

@getusha I also handled the case of deleting iou request with PDF receipt.

MonilBhavsar

Thanks! Looks good to me

OSBotify · 2024-02-28T19:23:21Z

✋ 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 · 2024-02-29T00:06:16Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.45-0 🚀

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

OSBotify · 2024-02-29T23:30:44Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

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

tienifr added 3 commits December 7, 2023 22:39

fix: pdf not cached

6749e0a

fix lint

0624e89

fix lint

552592c

tienifr marked this pull request as ready for review December 7, 2023 16:50

tienifr requested a review from a team as a code owner December 7, 2023 16:50

melvin-bot Bot requested review from getusha and removed request for a team December 7, 2023 16:50

getusha reviewed Dec 11, 2023

View reviewed changes

Merge branch 'main' of https://github.com/tienifr/App into fix/32232

ad010da

Merge branch 'main' of https://github.com/tienifr/App into fix/32232

7ef7951

tienifr added 2 commits January 24, 2024 16:29

Merge branch 'main' of https://github.com/tienifr/App into fix/32232

eff555e

remove cached file when delete comment

35c7989

getusha reviewed Jan 24, 2024

View reviewed changes

Comment thread src/libs/actions/CachedPDFPaths.ts

getusha reviewed Jan 24, 2024

View reviewed changes

Comment thread src/libs/actions/CachedPDFPaths.ts Outdated

getusha suggested changes Jan 24, 2024

View reviewed changes

Merge branch 'main' into fix/32232

f296a75

tienifr added 3 commits February 5, 2024 22:46

Merge branch 'main' into fix/32232

5baa4b8

seperate platform logic

9379469

add types for CachedPDFPaths

6eb146a

tienifr added 2 commits February 24, 2024 06:08

Merge branch 'main' into fix/32232

e3c7d72

fix lint

55884df

Merge branch 'main' of https://github.com/tienifr/App into fix/32232

adfae33

getusha reviewed Feb 26, 2024

View reviewed changes

tienifr added 2 commits February 26, 2024 17:15

remove redundant condition

f7ed37e

delete cache for transaction receipt

abd5347

getusha approved these changes Feb 28, 2024

View reviewed changes

melvin-bot Bot requested a review from MonilBhavsar February 28, 2024 08:32

MonilBhavsar approved these changes Feb 28, 2024

View reviewed changes

MonilBhavsar merged commit b8e0989 into Expensify:main Feb 28, 2024

github-actions Bot mentioned this pull request Feb 28, 2024

Deploy Checklist: New Expensify 2024-02-28 #37459

Closed

91 tasks

m-natarajan mentioned this pull request Feb 29, 2024

[HOLD for payment 2024-03-11] [HOLD for payment 2024-03-07] App crashes when uploading PDF or opening any attachment sent after PDF #37469

Closed

6 tasks

melvin-bot Bot mentioned this pull request Feb 29, 2024

[HOLD for payment 2024-03-11] [HOLD for payment 2024-03-07] [$500] iOS - Attachment - PDF files aren't cached and flashes once while loading #32232

Closed

6 tasks

Uh oh!

Conversation

tienifr commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Dec 7, 2023

Uh oh!

tienifr commented Dec 7, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tienifr Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

getusha commented Dec 18, 2023

Uh oh!

tienifr commented Dec 20, 2023

Uh oh!

getusha commented Jan 6, 2024

Uh oh!

tienifr commented Jan 6, 2024

Uh oh!

getusha commented Jan 16, 2024

Uh oh!

tienifr commented Jan 16, 2024

Uh oh!

getusha commented Jan 23, 2024

Uh oh!

tienifr commented Jan 24, 2024

Uh oh!

getusha commented Jan 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

getusha commented Jan 24, 2024

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

getusha commented Jan 24, 2024

Uh oh!

tienifr commented Jan 25, 2024

Uh oh!

getusha commented Jan 31, 2024

Uh oh!

getusha commented Feb 4, 2024

Uh oh!

getusha commented Feb 8, 2024

Uh oh!

tienifr commented Feb 8, 2024

Uh oh!

getusha commented Feb 11, 2024

Uh oh!

tienifr commented Feb 15, 2024

Uh oh!

getusha commented Feb 22, 2024

Uh oh!

tienifr commented Feb 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

getusha commented Feb 24, 2024

Uh oh!

tienifr commented Dec 7, 2023 •

edited

Loading

tienifr Dec 11, 2023 •

edited

Loading

getusha commented Jan 24, 2024 •

edited

Loading

tienifr commented Feb 24, 2024 •

edited

Loading

tienifr commented Feb 26, 2024 •

edited

Loading