Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add backup transaction again #39144

Merged
merged 9 commits into from
Apr 11, 2024
Merged

Conversation

DylanDylann
Copy link
Contributor

@DylanDylann DylanDylann commented Mar 28, 2024

Details

This fixes a regression introduced in PR

Fixed Issues

$ #38853
$ #35173
$ #38864

PROPOSAL: NA

Tests

Section 1:

  1. Go to workspace chat
  2. Create a distance request
  3. Go to the request details page
  4. Click Distance
  5. Add a waypoint
  6. Click outside the distance editor (Or click back button on mobile) to dismiss it instead of saving the edit
  7. Click Distance
  8. Verify that the distance editor will not show the new waypoint added in Step 5 because the edit is not saved

Section 2:

  1. Go to workspace chat.
  2. Create a distance request.
  3. Go to the request details page.
  4. Click Distance.
  5. Click the Save button without editing the addresses.
  6. Verify that the map will not reload. Distance row will not show the Route pending
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Same above

  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-04-08.at.17.09.21.mov
Android: mWeb Chrome
Screen.Recording.2024-04-08.at.16.55.03.mov
iOS: Native
Screen.Recording.2024-04-08.at.16.54.13.mov
iOS: mWeb Safari
Screen.Recording.2024-04-08.at.16.51.32.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-08.at.16.45.24.mp4
MacOS: Desktop
Screen.Recording.2024-04-08.at.16.50.36.mov

@DylanDylann DylanDylann requested a review from a team as a code owner March 28, 2024 03:50
@melvin-bot melvin-bot bot removed the request for review from a team March 28, 2024 03:50
Copy link

melvin-bot bot commented Mar 28, 2024

@hoangzinh 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 melvin-bot bot requested a review from hoangzinh March 28, 2024 03:50
@cubuspl42
Copy link
Contributor

Missing "Details"

@hoangzinh
Copy link
Contributor

@cubuspl42 I don't know how to unassign myself from this PR so just go ahead.

@DylanDylann
Copy link
Contributor Author

@cubuspl42 I tried to revert the previous PR yesterday, but it is so late

@cubuspl42
Copy link
Contributor

Missing "Tests" section and videos, basically appears untested

@DylanDylann
Copy link
Contributor Author

@cubuspl42 We still have some problem here, I am trying to resolve

@cubuspl42
Copy link
Contributor

I understand. You can consider marking the PR as a draft when it's being worked on actively, and some aspects are not ready.

@DylanDylann DylanDylann marked this pull request as ready for review April 2, 2024 09:39
@DylanDylann
Copy link
Contributor Author

@cubuspl42 @puneetlath Marked this PR as ready for review to get more eyes.

Before we used transactionBackup to handle cases that users edit distance without saving it. When going to the distance page we will create a copy of the transaction called transactionBackup, we still save any update to the transaction but if users don't click the save button we will restore the transaction based on transactionBackup.

In the previous PR, we missed to migrate the above logic. It caused these bugs #38864, #38853

In this PR, I moved that logic again but this bug still be happening

Screen.Recording.2024-04-02.at.16.40.32.mov

Let's see the above video, the transactionBackup always be empty even after creating transactionBackup (I suspect this is a bug of React-Native-ONYX)

This bug hasn't happened before because previously we created transactionBackup and used transactionBackup in 2 components (EditRequestDistancePage, DistanceRequest/index.tsx we can check here for more detail). But when migrating all logics to new component IOURequestStepDistance, both creating and getting transactionBackup are handled in one component

@cubuspl42
Copy link
Contributor

I suspect this is a bug of React-Native-ONYX

Sometimes, I don't feel confident with Onyx, but if you suspect that there's a bug here, this makes this situation even more tricky 🙁

@puneetlath Do you have any hints or ideas here?

@puneetlath
Copy link
Contributor

Hmm, interesting. I don't have any theories off the top of my head. @DylanDylann what makes you think it's an Onyx bug?

@DylanDylann
Copy link
Contributor Author

@cubuspl42 After investigating again, I see this is not a bug from Onyx. I made a mistake in here.

@cubuspl42
Copy link
Contributor

@DylanDylann So what's the current state of the PR? Is everything finished and tested from your side, and things are ready for a new review round?

@DylanDylann
Copy link
Contributor Author

I updated this PR to fix these issues: #38853 #35173 #38864

Before we used transactionBackup to handle cases that users edit distance without saving it. When going to the distance page we will create a copy of the transaction called transactionBackup, we still save any update to the transaction but if users don't click the save button we will restore the transaction based on transactionBackup.

With this fix, #35173 also be resolved

@DylanDylann
Copy link
Contributor Author

@cubuspl42 I tested and everything works well, I am uploading the video. You can start your work now.

@cubuspl42
Copy link
Contributor

to fix #34610

I'm sorry about this mess, but please change the word "fix" to something else so we revert the auto-linking:

image

@cubuspl42
Copy link
Contributor

Verify that the map will not reload.

add-backup-transaction-again-section-2-web-converted.mp4

@DylanDylann
Copy link
Contributor Author

Is this section platform-specific? I just tried to do this on Android and I don't think it makes sense. Please mark platform-specific testing steps.

Updated

@DylanDylann
Copy link
Contributor Author

@cubuspl42 We need to wait for the map to be loaded before going to the next step to prevent this bug

Screen.Recording.2024-04-10.at.14.44.25.mp4

I don't think it relates to the Distance Page. Even though we don't open the distance page, the map still reload

@cubuspl42
Copy link
Contributor

We need to wait for the map to be loaded before going to the next step to prevent this bug
I don't think it relates to the Distance Page. Even though we don't open the distance page, the map still reload

Okey, thanks for confirming. Maybe we should clarify this in the QA steps, so the QA doesn't raise a false alarm? Technically speaking, the test (as phrased right now) failed in my case.

@cubuspl42
Copy link
Contributor

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
Android: mWeb Chrome
add-backup-transaction-again-section-1-android-web-compressed.mp4
add-backup-transaction-again-section-2-android-web-compressed.mp4
iOS: Native
add-backup-transaction-again-section-1-ios-compressed.mp4
add-backup-transaction-again-section-2-ios-compressed.mp4
iOS: mWeb Safari
add-backup-transaction-again-section-1-ios-web-compressed.mp4
add-backup-transaction-again-section-2-ios-web-compressed.mp4
MacOS: Chrome / Safari
add-backup-transaction-again-section-1-web-converted.mp4
add-backup-transaction-again-section-2-web-converted.mp4
MacOS: Desktop

@melvin-bot melvin-bot bot requested a review from puneetlath April 10, 2024 12:10
Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One very small comment.

src/pages/iou/request/step/IOURequestStepDistance.js Outdated Show resolved Hide resolved
@DylanDylann
Copy link
Contributor Author

@puneetlath Updated. All yours

@puneetlath puneetlath merged commit 7d19f82 into Expensify:main Apr 11, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.63-0 🚀

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

@mountiny
Copy link
Contributor

@DylanDylann Based on this comment #40392 (comment) the PR failed to fix #38864

can you look into this? thanks

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

@cubuspl42
Copy link
Contributor

@DylanDylann Bump

@DylanDylann
Copy link
Contributor Author

@cubuspl42 What bump?

@cubuspl42
Copy link
Contributor

@DylanDylann

This comment (slightly above). Or do you mean that it is outdated? 🤔

@DylanDylann
Copy link
Contributor Author

It resolved. More information here

@cubuspl42
Copy link
Contributor

Sorry then!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants