Add an action method for creating a distance request #24385
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -100,8 +100,7 @@ function buildOnyxDataForMoneyRequest( | |
| ) { | ||
| const optimisticData = [ | ||
| { | ||
| onyxMethod: Onyx.METHOD.MERGE, | ||
| key: `${ONYXKEYS.COLLECTION.REPORT}${chatReport.reportID}`, | ||
| value: { | ||
| ...chatReport, | ||
|
|
@@ -112,7 +111,7 @@ function buildOnyxDataForMoneyRequest( | |
| }, | ||
| }, | ||
| { | ||
| onyxMethod: Onyx.METHOD.MERGE, | ||
| key: `${ONYXKEYS.COLLECTION.REPORT}${iouReport.reportID}`, | ||
| value: { | ||
| ...iouReport, | ||
|
|
@@ -122,20 +121,20 @@ function buildOnyxDataForMoneyRequest( | |
| }, | ||
| }, | ||
| { | ||
| onyxMethod: Onyx.METHOD.MERGE, | ||
| key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transaction.transactionID}`, | ||
| value: transaction, | ||
| }, | ||
| { | ||
| onyxMethod: Onyx.METHOD.MERGE, | ||
| key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${chatReport.reportID}`, | ||
| value: { | ||
| ...(isNewChatReport ? {[chatCreatedAction.reportActionID]: chatCreatedAction} : {}), | ||
| [reportPreviewAction.reportActionID]: reportPreviewAction, | ||
| }, | ||
| }, | ||
| { | ||
| onyxMethod: Onyx.METHOD.MERGE, | ||
| key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${iouReport.reportID}`, | ||
| value: { | ||
| ...(isNewIOUReport ? {[iouCreatedAction.reportActionID]: iouCreatedAction} : {}), | ||
|
|
@@ -302,19 +301,33 @@ function buildOnyxDataForMoneyRequest( | |
| } | ||
|
|
||
| /** | ||
| * Gathers all the data needed to make a money request. It attempts to find existing reports, iouReports, and receipts. If it doesn't find them, then | ||
| * it creates optimistic versions of them and uses those instead | ||
| * | ||
| * @param {Object} report | ||
| * @param {Object} participant | ||
| * @param {String} comment | ||
| * @param {Number} amount | ||
| * @param {String} currency | ||
| * @param {Number} payeeAccountID | ||
| * @param {String} payeeEmail | ||
| * @param {Object} [receipt] | ||
| * @returns {Object} data | ||
| * @returns {String} data.payerEmail | ||
| * @returns {Object} data.iouReport | ||
| * @returns {Object} data.chatReport | ||
| * @returns {Object} data.transaction | ||
| * @returns {Object} data.iouAction | ||
| * @returns {Object} data.createdChatReportActionID | ||
| * @returns {Object} data.createdIOUReportActionID | ||
| * @returns {Object} data.reportPreviewAction | ||
| * @returns {Object} data.onyxData | ||
| * @returns {Object} data.onyxData.optimisticData | ||
| * @returns {Object} data.onyxData.successData | ||
| * @returns {Object} data.onyxData.failureData | ||
| * @param {String} [existingTransactionID] | ||
| */ | ||
| function getMoneyRequestInformation(report, participant, comment, amount, currency, payeeAccountID, payeeEmail, receipt = undefined, existingTransactionID = null) { | ||
| const payerEmail = OptionsListUtils.addSMSDomainIfPhoneNumber(participant.login); | ||
| const payerAccountID = Number(participant.accountID); | ||
| const isPolicyExpenseChat = participant.isPolicyExpenseChat; | ||
|
|
@@ -364,7 +377,7 @@ function requestMoney(report, amount, currency, payeeEmail, payeeAccountID, part | |
| receiptObject.source = receipt.source; | ||
| receiptObject.state = CONST.IOU.RECEIPT_STATE.SCANREADY; | ||
| } | ||
| const transaction = TransactionUtils.buildOptimisticTransaction( | ||
| ReportUtils.isExpenseReport(iouReport) ? -amount : amount, | ||
| currency, | ||
| iouReport.reportID, | ||
|
|
@@ -373,6 +386,7 @@ function requestMoney(report, amount, currency, payeeEmail, payeeAccountID, part | |
| '', | ||
| undefined, | ||
| receiptObject, | ||
| existingTransactionID, | ||
| ); | ||
|
|
||
| // STEP 4: Build optimistic reportActions. We need: | ||
|
|
@@ -383,18 +397,25 @@ function requestMoney(report, amount, currency, payeeEmail, payeeAccountID, part | |
| // Note: The CREATED action for the IOU report must be optimistically generated before the IOU action so there's no chance that it appears after the IOU action in the chat | ||
| const optimisticCreatedActionForChat = ReportUtils.buildOptimisticCreatedReportAction(payeeEmail); | ||
| const optimisticCreatedActionForIOU = ReportUtils.buildOptimisticCreatedReportAction(payeeEmail); | ||
| const iouAction = ReportUtils.buildOptimisticIOUReportAction( | ||
| CONST.IOU.REPORT_ACTION_TYPE.CREATE, | ||
| amount, | ||
| currency, | ||
| comment, | ||
| [participant], | ||
| transaction.transactionID, | ||
| '', | ||
| iouReport.reportID, | ||
| receiptObject, | ||
| ); | ||
|
|
||
| let reportPreviewAction = isNewIOUReport ? null : ReportActionsUtils.getReportPreviewAction(chatReport.reportID, iouReport.reportID); | ||
| if (reportPreviewAction) { | ||
| reportPreviewAction = ReportUtils.updateReportPreview(iouReport, reportPreviewAction, comment); | ||
| } else { | ||
| reportPreviewAction = ReportUtils.buildOptimisticReportPreview(chatReport, iouReport, comment); | ||
| } | ||
|
|
||
| // Add optimistic personal details for participant | ||
| const optimisticPersonalDetailListAction = isNewChatReport | ||
| ? { | ||
|
|
@@ -407,28 +428,108 @@ function requestMoney(report, amount, currency, payeeEmail, payeeAccountID, part | |
| } | ||
| : undefined; | ||
|
|
||
| // STEP 5: Build Onyx Data | ||
| const [optimisticData, successData, failureData] = buildOnyxDataForMoneyRequest( | ||
| chatReport, | ||
| iouReport, | ||
| transaction, | ||
| optimisticCreatedActionForChat, | ||
| optimisticCreatedActionForIOU, | ||
| iouAction, | ||
| optimisticPersonalDetailListAction, | ||
| reportPreviewAction, | ||
| isNewChatReport, | ||
| isNewIOUReport, | ||
| ); | ||
|
|
||
| return { | ||
| payerEmail, | ||
| iouReport, | ||
| chatReport, | ||
| transaction, | ||
| iouAction, | ||
| createdChatReportActionID: isNewChatReport ? optimisticCreatedActionForChat.reportActionID : 0, | ||
| createdIOUReportActionID: isNewIOUReport ? optimisticCreatedActionForIOU.reportActionID : 0, | ||
| reportPreviewAction, | ||
| onyxData: { | ||
| optimisticData, | ||
| successData, | ||
| failureData, | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Requests money based on a distance (eg. mileage from a map) | ||
| * | ||
| * @param {Object} report | ||
| * @param {String} payeeEmail | ||
| * @param {Number} payeeAccountID | ||
| * @param {Object} participant | ||
| * @param {String} comment | ||
| * @param {Object[]} waypoints | ||
| * @param {String} waypoints[].address required and must be non empty | ||
| * @param {String} [waypoints[].lat] optional | ||
| * @param {String} [waypoints[].lng] optional | ||
| * @param {String} created | ||
| * @param {String} [transactionID] | ||
| */ | ||
| function createDistanceRequest(report, payeeEmail, payeeAccountID, participant, comment, waypoints, created, transactionID) { | ||
| const {payerEmail, iouReport, chatReport, transaction, iouAction, createdChatReportActionID, createdIOUReportActionID, reportPreviewAction, onyxData} = getMoneyRequestInformation( | ||
| report, | ||
| participant, | ||
| comment, | ||
| 0, | ||
| 'USD', | ||
| payeeAccountID, | ||
| payeeEmail, | ||
| null, | ||
|
Comment on lines
+496
to
+500
There was a problem hiding this comment. This caused #26518. We shouldn't have passed in static values like |
||
| transactionID, | ||
| ); | ||
|
|
||
| API.write( | ||
| 'CreateDistanceRequest', | ||
| { | ||
| debtorEmail: payerEmail, | ||
| comment, | ||
| iouReportID: iouReport.reportID, | ||
| chatReportID: chatReport.reportID, | ||
| transactionID: transaction.transactionID, | ||
| reportActionID: iouAction.reportActionID, | ||
| createdChatReportActionID, | ||
| createdIOUReportActionID, | ||
| reportPreviewReportActionID: reportPreviewAction.reportActionID, | ||
| waypoints, | ||
| created, | ||
| }, | ||
| onyxData, | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Request money from another user | ||
| * | ||
| * @param {Object} report | ||
| * @param {Number} amount - always in the smallest unit of the currency | ||
| * @param {String} currency | ||
| * @param {String} payeeEmail | ||
| * @param {Number} payeeAccountID | ||
| * @param {Object} participant | ||
| * @param {String} comment | ||
| * @param {Object} [receipt] | ||
| */ | ||
| function requestMoney(report, amount, currency, payeeEmail, payeeAccountID, participant, comment, receipt = undefined) { | ||
| const {payerEmail, iouReport, chatReport, transaction, iouAction, createdChatReportActionID, createdIOUReportActionID, reportPreviewAction, onyxData} = getMoneyRequestInformation( | ||
| report, | ||
| participant, | ||
| comment, | ||
| amount, | ||
| currency, | ||
| payeeAccountID, | ||
| payeeEmail, | ||
| receipt, | ||
| ); | ||
|
|
||
| API.write( | ||
| 'RequestMoney', | ||
| { | ||
|
|
@@ -438,14 +539,14 @@ function requestMoney(report, amount, currency, payeeEmail, payeeAccountID, part | |
| comment, | ||
| iouReportID: iouReport.reportID, | ||
| chatReportID: chatReport.reportID, | ||
| transactionID: transaction.transactionID, | ||
| reportActionID: iouAction.reportActionID, | ||
| createdChatReportActionID, | ||
| createdIOUReportActionID, | ||
| reportPreviewReportActionID: reportPreviewAction.reportActionID, | ||
| receipt, | ||
| }, | ||
| onyxData, | ||
| ); | ||
| resetMoneyRequestInfo(); | ||
| Navigation.dismissModal(chatReport.reportID); | ||
|
|
@@ -1622,6 +1723,7 @@ function navigateToNextPage(iou, iouType, reportID, report) { | |
| } | ||
|
|
||
| export { | ||
| createDistanceRequest, | ||
| editMoneyRequest, | ||
| deleteMoneyRequest, | ||
| splitBill, | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we removing this condition?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are being changed because:
setjust because "it's faster" is not a reason to use setI checked with @luacmartins who originally made the change and we agreed it was OK to use merge for everything for now.