Rename receiptFilename to filename #27203

tgolen · 2023-09-11T21:58:57Z

Details

Held on https://github.com/Expensify/Auth/pull/8623 so that the property is coming from the API correctly

This PR removes the code which looks for both filename and receiptFilename. It also adds a migration to cleanup the Onyx data so that there is no receiptFilename being stored anymore.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/315615
$ #26630

Tests

Run the app in web or desktop and look at the JS console for the logs [Migrate Onyx]
Verify that the migration runs and some data was renamed (probably, as long as you've had past transaction data)
Reload the app
Verify the migration is skipped because there is no more data to update

Repeat these steps for each platform:
Create a distance request
Verify that it is successful and shows a proper receipt image at the end

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

Create a distance request
Verify that it is successful and shows a proper receipt image at the end

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 / 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 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

Web

Mobile Web - Chrome

Chrome keeps crashing on my so I am not able to get a screenshot. Tested on main and it crashes there too, so must not be related to my PR.

Mobile Web - Safari

Desktop

iOS

Note: Receipt images sometimes don't load for me locally due to WARP client we use for security

Android

tgolen · 2023-09-12T11:32:33Z

src/types/onyx/Transaction.ts

@@ -19,25 +19,27 @@ type Route = {
 type Routes = Record<string, Route>;

 type Transaction = {
-    transactionID: string;


I know it's a little OCD but I like the alphabetize these.

melvin-bot · 2023-09-12T11:41:04Z

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

narefyev91 · 2023-09-12T15:18:32Z

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

narefyev91

LGTM!
🎀 👀 🎀 C+ reviewed

melvin-bot · 2023-09-12T15:19:46Z

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

melvin-bot · 2023-09-12T15:19:51Z

🎯 @narefyev91, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #27260.

amyevans

Looks good, just 1 q

amyevans · 2023-09-12T18:14:07Z

src/types/onyx/Transaction.ts

    errors: OnyxCommon.Errors;
+    // The name of the file used for a receipt (formerly receiptFilename)
+    filename: string;


Will the key always be present or should this be filename??

Oh, that's a good question, I didn't know about marking it as optional, but I think that would be preferred. Thanks!

tgolen · 2023-09-21T02:23:00Z

@amyevans or @narefyev91 Could you give one more approve please and then merge this? It is off hold and I had to fix a conflict.

amyevans · 2023-09-21T02:37:13Z

Sure, there are some duplicates in Transaction.ts now though!

tgolen · 2023-09-21T05:49:37Z

I came back here to say "updated", but you already merged! You are fast ⚡

OSBotify · 2023-09-21T05:54:00Z

✋ 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-09-22T14:00:24Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:35:14Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:07:15Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:49:36Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

tgolen added 5 commits September 11, 2023 14:04

Add type for filename property

83cc790

Remove fallback to old property name

3b410aa

Write initial migration

8521bfb

Add an early return

b9a72f4

Clean up final migration

78b8b54

tgolen self-assigned this Sep 11, 2023

tgolen mentioned this pull request Sep 12, 2023

[$500] [HOLD for payment 2023-10-02] Add filename to Transaction.ts #26630

Closed

Merge branch 'main' into tgolen-rename-filename

45e8800

tgolen commented Sep 12, 2023

View reviewed changes

tgolen marked this pull request as ready for review September 12, 2023 11:40

tgolen requested a review from a team as a code owner September 12, 2023 11:40

melvin-bot bot requested review from narefyev91 and removed request for a team September 12, 2023 11:41

narefyev91 approved these changes Sep 12, 2023

View reviewed changes

melvin-bot bot requested a review from amyevans September 12, 2023 15:19

melvin-bot bot mentioned this pull request Sep 12, 2023

Payment issue for E/App PR#27203 #27260

Closed

amyevans previously approved these changes Sep 12, 2023

View reviewed changes

Let property be optional

0ab4031

tgolen dismissed amyevans’s stale review via 0ab4031 September 12, 2023 18:39

tgolen requested a review from amyevans September 12, 2023 19:35

amyevans previously approved these changes Sep 12, 2023

View reviewed changes

tgolen changed the title ~~[HOLD Auth/pull/8623] Rename receiptFilename to filename~~ Rename receiptFilename to filename Sep 21, 2023

Merge branch 'main' into tgolen-rename-filename

f77b7c6

tgolen dismissed amyevans’s stale review via f77b7c6 September 21, 2023 02:22

tgolen and others added 3 commits September 20, 2023 23:28

Remove duplicate props

cb248d2

Merge branch 'main' into tgolen-rename-filename

2b404ad

Lint

20b6ce6

amyevans approved these changes Sep 21, 2023

View reviewed changes

amyevans merged commit 673bc48 into main Sep 21, 2023
11 checks passed

amyevans deleted the tgolen-rename-filename branch September 21, 2023 05:48

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

tgolen mentioned this pull request Nov 14, 2023

Onyx migration for transactions backups #31280

Merged

47 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename receiptFilename to filename #27203

Rename receiptFilename to filename #27203

tgolen commented Sep 11, 2023 •

edited

Loading

tgolen Sep 12, 2023

melvin-bot bot commented Sep 12, 2023

narefyev91 commented Sep 12, 2023

narefyev91 left a comment

melvin-bot bot commented Sep 12, 2023

melvin-bot bot commented Sep 12, 2023

amyevans left a comment

amyevans Sep 12, 2023

tgolen Sep 12, 2023

tgolen commented Sep 21, 2023

amyevans commented Sep 21, 2023

tgolen commented Sep 21, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

Rename receiptFilename to filename #27203

Rename receiptFilename to filename #27203

Conversation

tgolen commented Sep 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tgolen Sep 12, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Sep 12, 2023

narefyev91 commented Sep 12, 2023

Reviewer Checklist

Screenshots/Videos

narefyev91 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 12, 2023

melvin-bot bot commented Sep 12, 2023

amyevans left a comment

Choose a reason for hiding this comment

amyevans Sep 12, 2023

Choose a reason for hiding this comment

tgolen Sep 12, 2023

Choose a reason for hiding this comment

tgolen commented Sep 21, 2023

amyevans commented Sep 21, 2023

tgolen commented Sep 21, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

tgolen commented Sep 11, 2023 •

edited

Loading