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

Implement Send Invoice flow from Global Create #40015

Merged
merged 64 commits into from
Apr 29, 2024

Conversation

VickyStash
Copy link
Contributor

@VickyStash VickyStash commented Apr 10, 2024

Details

Implementation of invoice creation flow from Global Create

Fixed Issues

$ #40012
PROPOSAL: N/A

Tests

  • Verify that no errors appear in the JS console

Note (!): Use staging server by turning it on in Settings -> Troubleshoot -> Use Staging Server
Note (!): the backend has a know issue related to the invoice currency. If you want your test results to not be affected by that issue, set the sender workspace and the invoice currencies to be USD.

Flow 1

  1. Sign in to the app with a workspace admin account
  2. Open Global Create and verify Send Invoice appears in Global Create
  3. Click Send invoice in Global Create:
    3.1 Verify “Distance” and “Scan" do not appear in the big number pad (BNP) screen.
    3.2 Verify the Currency can be modified
  4. Add an amount -> tap Next
  5. Select the participant, and make sure the participant's step works as expected. Press Next.
  6. Verify all of the information on the confirmation screen looks as expected.
    6.1 The sender Workspace is displayed as expected.
    6.2 The receiver is displayed as expected.
  7. Tap on the Send from workspace, you should be navigated to the Send from the screen.
  8. Select another workspace, and make sure it works as expected.
  9. tap Send $XX.XX invoice, verify all of the necessary data is created in Onyx.

Flow 2

  1. Repeat Flow 1, but select the same sender and receiver.
  2. Make sure you are navigated to the same room after invoice confirmation.

Flow 3

  1. Sign in to the app with an account without workspaces
  2. Confirm you have no Send Invoice option in Global Create

Offline tests

Same as in the Tests section

QA Steps

  • Verify that no errors appear in the JS console

Same as in the Tests section

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
android1.mp4
Android: mWeb Chrome
android_web1.mp4
iOS: Native
ios1.mp4
iOS: mWeb Safari
ios_web1.mp4
MacOS: Chrome / Safari
web1.mp4
MacOS: Desktop
desktop1.mp4

# Conflicts:
#	src/pages/iou/request/IOURequestStartPage.js
#	src/pages/iou/request/MoneyTemporaryForRefactorRequestParticipantsSelector.js
#	src/pages/iou/request/step/withWritableReportOrNotFound.tsx
# Conflicts:
#	src/components/MoneyTemporaryForRefactorRequestConfirmationList.tsx
#	src/pages/iou/request/MoneyTemporaryForRefactorRequestParticipantsSelector.js
#	src/pages/iou/request/step/withFullTransactionOrNotFound.tsx
#	src/pages/iou/request/step/withWritableReportOrNotFound.tsx
src/languages/es.ts Outdated Show resolved Hide resolved
src/styles/index.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

Left comments.

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Show resolved Hide resolved
# Conflicts:
#	src/components/MoneyTemporaryForRefactorRequestConfirmationList.tsx
#	src/libs/PolicyUtils.ts
#	src/libs/actions/IOU.ts
#	src/pages/iou/request/MoneyTemporaryForRefactorRequestParticipantsSelector.js
#	src/pages/iou/request/step/IOURequestStepConfirmation.tsx
@cristipaval cristipaval merged commit 84b7ce7 into Expensify:main Apr 29, 2024
16 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.

@shawnborton
Copy link
Contributor

Similar comment here as the other PR, I think we might not be using the correct room avatars here? cc @puneetlath

I think the idea was to do this for Workspace to Workspace:
image

And to do this for Workspace to Individual:
image

Does that sound right Puneet & @davidcardoza ?

@puneetlath
Copy link
Contributor

Yes, that's right. Just like workspace chats we'd have the big sender avatar of the sender's workspace with the small payer user avatar.

@VickyStash
Copy link
Contributor Author

@cristipaval Can we please create a follow-up issue to update the invoice room avatars display?
cc @waterim

Similar comment here as the other PR, I think we might not be using the correct room avatars here? cc @puneetlath

I think the idea was to do this for Workspace to Workspace: image

And to do this for Workspace to Individual: image

Does that sound right Puneet & @davidcardoza ?

@danielrvidal
Copy link
Contributor

danielrvidal commented Apr 29, 2024

Can we please create a follow-up issue to update the invoice room avatars display?

I created the issue here: #41261

Let me know if I need to do anything else.

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.4.67-7 🚀

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.68-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.4.67-7 🚀

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

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

@MonilBhavsar
Copy link
Contributor

There's a bug noted mostly coming from this PR #41287. If anyone can please take a look

@OSBotify
Copy link
Contributor

OSBotify commented May 1, 2024

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.68-3 🚀

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

type SendInvoiceParams = {
senderWorkspaceID: string;
accountID: number;
receiverEmail?: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice little pro tip: either receiverEmail or receiverInvoiceRoomID is required. So I see why you made them both optional, but it later led to a problem here. So what you can do is use RequireAtLeastOne from type-fest.

@Pujan92
Copy link
Contributor

Pujan92 commented Jun 5, 2024

We missed considering the enabled features of the collect workspace to show in the send invoice confirmation screen which raised an issue here.

}
const reportPreviewAction = ReportUtils.buildOptimisticReportPreview(chatReport, optimisticInvoiceReport, trimmedComment, optimisticTransaction);

// STEP 6: Build Onyx Data
Copy link
Contributor

Choose a reason for hiding this comment

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

We forgot to properly link the reportAction and parent report, which led to bug mentioned #43582

@@ -0,0 +1,19 @@
type SendInvoiceParams = {
Copy link
Contributor

@rayane-djouah rayane-djouah Sep 10, 2024

Choose a reason for hiding this comment

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

FYI, This PR missed createdIOUReportActionID, createdReportActionIDForThread, reportActionID Send Invoice params and caused these issues: #43797, #43571, #43577, #44992. More info in this proposal: #43797 (comment)

*/
function getPrimaryPolicy(activePolicyID?: string): Policy | undefined {
const activeAdminWorkspaces = PolicyUtils.getActiveAdminWorkspaces(allPolicies);
const primaryPolicy: Policy | null | undefined = allPolicies?.[activePolicyID ?? ''];
Copy link
Contributor

Choose a reason for hiding this comment

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

As we did not exclude personal policies while fetching primary policy, this resulted in #46705

Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, this PR caused this issue: #47922 because it missed updating the logic for invoking openDraftWorkspaceRequest to retrieve the policy details (e.g., categories) when changing the invoice sender policy. More info in this proposal: #47922 (comment)

if (isNewChatReport) {
inviteReportAction = ReportUtils.buildOptimisticInviteReportAction(receiver?.displayName ?? '', receiver.accountID ?? -1);
}
const reportPreviewAction = ReportUtils.buildOptimisticReportPreview(chatReport, optimisticInvoiceReport, trimmedComment, optimisticTransaction);
Copy link
Contributor

Choose a reason for hiding this comment

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

We returned an incorrect actorAccountID for the invoice report here. It caused the report preview sender appears and disappears when sending invoices consecutively. More details here #51128 (comment)

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.