refactor: unify shipping line logic #1191
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
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
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 |
|---|---|---|
| @@ -1,61 +1,67 @@ | ||
| import { TransactionModel } from "avatax/lib/models/TransactionModel"; | ||
| import { numbers } from "../../taxes/numbers"; | ||
| import { TaxBadProviderResponseError } from "../../taxes/tax-error"; | ||
| import { taxProviderUtils } from "../../taxes/tax-provider-utils"; | ||
| import { CalculateTaxesResponse } from "../../taxes/tax-provider-webhook"; | ||
| import { avataxShippingLine } from "./avatax-shipping-line"; | ||
| import { createLogger } from "@saleor/apps-logger"; | ||
|
|
||
| const logger = createLogger("transformAvataxTransactionModelIntoShipping"); | ||
|
|
||
| // why is tax rate 0? | ||
| export function transformAvataxTransactionModelIntoShipping( | ||
| transaction: TransactionModel, | ||
| ): Pick< | ||
| CalculateTaxesResponse, | ||
| "shipping_price_gross_amount" | "shipping_price_net_amount" | "shipping_tax_rate" | ||
| > { | ||
| const shippingLine = avataxShippingLine.getFromTransactionModel(transaction); | ||
|
|
||
| if (!shippingLine) { | ||
| logger.warn( | ||
| "Shipping line was not found in the response from AvaTax. The app will return 0s for shipping fields.", | ||
| ); | ||
|
|
||
| return { | ||
| shipping_price_gross_amount: 0, | ||
| shipping_price_net_amount: 0, | ||
| shipping_tax_rate: 0, | ||
| }; | ||
| } | ||
|
|
||
| if (!shippingLine.isItemTaxable) { | ||
| return { | ||
| shipping_price_gross_amount: taxProviderUtils.resolveOptionalOrThrowUnexpectedError( | ||
| shippingLine.lineAmount, | ||
| new TaxBadProviderResponseError("shippingLine.lineAmount is undefined"), | ||
| ), | ||
| shipping_price_net_amount: taxProviderUtils.resolveOptionalOrThrowUnexpectedError( | ||
| shippingLine.lineAmount, | ||
| new TaxBadProviderResponseError("shippingLine.lineAmount is undefined"), | ||
| ), | ||
| /* | ||
| * avatax doesn't return combined tax rate | ||
| * // todo: calculate percentage tax rate | ||
| */ | ||
| shipping_tax_rate: 0, | ||
| }; | ||
| } | ||
|
|
||
| const shippingTaxCalculated = taxProviderUtils.resolveOptionalOrThrowUnexpectedError( | ||
| shippingLine.taxCalculated, | ||
| new TaxBadProviderResponseError("shippingLine.taxCalculated is undefined"), | ||
| ); | ||
| const shippingTaxableAmount = taxProviderUtils.resolveOptionalOrThrowUnexpectedError( | ||
| shippingLine.taxableAmount, | ||
| new TaxBadProviderResponseError("shippingLine.taxableAmount is undefined"), | ||
| ); | ||
| const shippingGrossAmount = numbers.roundFloatToTwoDecimals( | ||
| shippingTaxableAmount + shippingTaxCalculated, | ||
| ); | ||
|
|
||
| return { | ||
| shipping_price_gross_amount: shippingGrossAmount, | ||
| shipping_price_net_amount: shippingTaxableAmount, | ||
| shipping_tax_rate: 0, | ||
| }; | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import { createLogger } from "@saleor/apps-logger"; | ||
| import { LineItemModel } from "avatax/lib/models/LineItemModel"; | ||
| import { TransactionModel } from "avatax/lib/models/TransactionModel"; | ||
|
|
||
| export const SHIPPING_ITEM_CODE = "Shipping"; | ||
|
|
||
| const logger = createLogger("avataxShippingLine"); | ||
|
|
||
| export const avataxShippingLine = { | ||
| // * In AvaTax, shipping is a regular line | ||
| create({ | ||
| amount, | ||
| taxCode, | ||
| taxIncluded, | ||
| }: { | ||
| amount: number; | ||
| taxCode: string | undefined; | ||
| taxIncluded: boolean; | ||
| }): LineItemModel { | ||
| return { | ||
| amount, | ||
| taxIncluded, | ||
| taxCode, | ||
| itemCode: SHIPPING_ITEM_CODE, | ||
| quantity: 1, | ||
| }; | ||
| }, | ||
| getFromTransactionModel(transactionModel: TransactionModel) { | ||
| const shippingLine = transactionModel.lines?.find( | ||
| (line) => line.itemCode === SHIPPING_ITEM_CODE, | ||
| ); | ||
|
|
||
| if (!shippingLine) { | ||
| logger.warn("Shipping line not found in the transaction model"); | ||
| } | ||
|
|
||
| return shippingLine; | ||
| }, | ||
| }; |
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
Oops, something went wrong.
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.
question: I don't see a point to why did we change it into a function instead of class? Is this purely stylistic reason?
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.
Yes, exactly. Initializing a class with no arguments in the constructor and executing its single method takes 2 lines instead of 1 (with function). I think it makes the code less readable.