Fix Attachment download links for non-previewable items

[kidroca]

Details

Update attachment download links to be downloaded relative to the current API in use
Attachments uploaded on PROD but accessed from STAGING would be downloaded from STAGING api (and vice versa)

Only the download links are modified, so we don't break any existing functionality.
E.g. comments with plain links to staging or prod won't be converted, pressing them should open the link in a new window and it will load in the intended environment

The PR also fixes a small problem observed on DEV

1. Pressing a download link on dev opens it in new tab (instead of initiating download)
2. The original tab would print a CORS error in the console (because we send a request directly from localhost to the API (instead of letting it happen through the dev proxy server))

1.New.Expensify.-.Google.Chrome.2023-03-24.20-55-08.mp4

Fixed Issues

$ #16327
PROPOSAL: #16327 (comment) (option 3 at the end)

Tests

Preparation steps

1. Use the actual App to upload a non-preview attachment
   • e.g. go to new.staging.expensify.com and upload something that does not have a preview (like mp4)

Web (and mobile web)

Local DEV by default uses a proxy server so attachments should be resolved from it

• Verify downloading attachments work
  1. Press the download button
  2. A popup should prompt you to save the attachment locally

Desktop / iOS / Android

Use the "staging toggle" from preferences to toggle between environments (on DEV)

• STAGING TO PROD

  1. Use new.staging.expensify.com to upload an non-preview attachment
  2. On DEV set the "staging toggle" to use PROD (this is the default state)
  3. Go and download the attachment
     • the attachment should be downloaded from PROD (because you are on PROD)
     • on Desktop you can use the web inspector and the Network tab to see that a request is actually sent to www.expensify
     • on other platforms it's not as easy to verify because Flipper is broken

• PROD TO STAGING

  1. Use new.expensify.com to upload an non-preview attachment
  2. On DEV set the "staging toggle" to ON
  3. Go and download the attachment
     • the attachment should be downloaded from PROD (because you are on PROD)
     • on Desktop you can use the web inspector and the Network tab to see that a request is actually sent to taging.expensify
     • on other platforms it's not as easy to verify because Flipper is broken

Offline tests

N/A - Downloading files is not possible while offline

Pressing the download button while offline has some weird behavior opening a new window, but it's not introduced in this PR

QA Steps

• Verify that no errors appear in the JS console

on STAGING

1. From PROD new.expensify.com - upload a non-preview attachment (like an mp4 file)
2. Return to STAGING and try to access the attachment
3. Attachment should be resolved and downloaded from STAGING
   • you can only verify this on web and desktop by using the web inspector and the Network tab
   • Go to the Network tab, then press the attachment download link, see a request designated to staging.expensify.com/chat-attachments/...
   • For other platform simply verify that downloading works

on PROD

After the PR is merged to PROD the App should work this way

1. From STAGING staging.new.expensify.com - upload a non-preview attachment (like an mp4 file)
2. Return to PROD and try to access the attachment
3. Attachment should be resolved and downloaded from PROD
   • you can only verify this on web and desktop by using the web inspector and the Network tab
   • Go to the Network tab, then press the attachment download link, see a request designated to www.expensify.com/chat-attachments/...
   • For other platform simply verify that downloading works

You can also use the "staging toggle" from Preferences for this test.
1. On staging -> go to Preferences and switch the toggle so you use PROD
2. Refresh the Browser (because rendered report links are not always re-rendered after switching)
3. Go to a non-preview attachment uploaded on STAGING
4. Press to download it - similary to above, the network tab should show that the attachment is resolved from PROD www.expensify (because we've switched to PROD)

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 / Chrome
  • iOS / native
  • iOS / 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 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 correct English and 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
  • 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 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 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

Web

1.New.Expensify.-.Google.Chrome.2023-03-24.20-56-01.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[MelvinBot]

@mountiny @parasharrajat One of you needs to 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]

[mountiny]

LGTM, gonna wait for @parasharrajat review and checklist, thank you both

[parasharrajat]

Code is clean..Moving to testing.

[parasharrajat]

Question: Are our attachments saved on the same datastore for all ENVs?

[kidroca]

@parasharrajat

Question: Are our attachments saved on the same datastore for all ENVs?

Yes, PROD (DEV) and STAGING use the same bucket
You can upload an attachment from STAGING and use either staging.expensify.com/chat-attachments/{path} or www.expensify.com/chat-attachments/{path} to access it

• It's more consistent to keep the same ENV
• Though there are some considerations to not save the host in the attachment URI in the first place

[parasharrajat]

Thanks, then the code makes sense. I am completing the checklist now.

[parasharrajat]

Screenshots

🔲 iOS / native

screen-2023-03-28_01.49.38.mp4

🔲 iOS / Safari

screen-2023-03-28_01.54.41.mp4

🔲 MacOS / Desktop

screen-2023-03-28_01.46.11.mp4

🔲 MacOS / Chrome

screen-2023-03-28_00.10.23.mp4

🔲 Android / Chrome

screen-2023-03-28_00.13.42.mp4

🔲 Android / native

screen-2023-03-28_00.34.22.mp4

[parasharrajat]

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 / Chrome
  • iOS / native
  • iOS / 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 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 correct English and 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 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

cc: @mountiny

🎀 👀 🎀 C+ reviewed

[mountiny]

Thanks everyone!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.2.91-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.91-1 🚀

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