asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

fix(medusa): Throw on flat rate shipping options with no amount (#2628)

Browse Source
This commit is contained in:
Oliver Windall Juhl
2022-12-12 18:34:30 +01:00
committed by GitHub
parent e63777e3c5
commit b2ea8b7d45
8 changed files with 267 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa/src/services/__tests__/shipping-option.js
+46 -12
View File
@@ -1,8 +1,7 @@
import _ from "lodash"
import { IdMap, MockRepository, MockManager } from "medusa-test-utils"
import { IdMap, MockManager, MockRepository } from "medusa-test-utils"
import TaxInclusivePricingFeatureFlag from "../../loaders/feature-flags/tax-inclusive-pricing"
import { FlagRouter } from "../../utils/flag-router"
import ShippingOptionService from "../shipping-option"
import { FlagRouter } from "../../utils/flag-router";
import TaxInclusivePricingFeatureFlag from "../../loaders/feature-flags/tax-inclusive-pricing";
describe("ShippingOptionService", () => {
describe("retrieve", () => {
@@ -36,13 +35,20 @@ describe("ShippingOptionService", () => {
provider_id: "no_calc",
})
case IdMap.getId("validId"):
return Promise.resolve({
provider_id: "provider",
amount: 100,
data: {
provider_data: "true",
},
})
case "flat-rate-no-amount":
return Promise.resolve({
provider_id: "provider",
data: {
provider_data: "true",
},
})
default:
return Promise.resolve({})
}
@@ -137,7 +143,7 @@ describe("ShippingOptionService", () => {
it("sets flat rate price", async () => {
await optionService.update(IdMap.getId("validId"), {
price_type: "flat_rate",
amount: 100,
amount: 200,
})
expect(shippingOptionRepository.save).toHaveBeenCalledTimes(1)
@@ -147,7 +153,37 @@ describe("ShippingOptionService", () => {
provider_data: "true",
},
price_type: "flat_rate",
amount: 100,
amount: 200,
})
})
it("throws on flat rate but no amount", async () => {
expect.assertions(1)
try {
await optionService.update(IdMap.getId("flat-rate-no-amount"), {
price_type: "flat_rate",
})
} catch (error) {
expect(error.message).toEqual(
"Shipping options of type `flat_rate` must have an `amount`"
)
}
})
it("sets a price to", async () => {
await optionService.update(IdMap.getId("validId"), {
price_type: "flat_rate",
amount: 0,
})
expect(shippingOptionRepository.save).toHaveBeenCalledTimes(1)
expect(shippingOptionRepository.save).toHaveBeenCalledWith({
provider_id: "provider",
data: {
provider_data: "true",
},
price_type: "flat_rate",
amount: 0,
})
})
@@ -158,10 +194,8 @@ describe("ShippingOptionService", () => {
expect(fulfillmentProviderService.canCalculate).toHaveBeenCalledTimes(1)
expect(fulfillmentProviderService.canCalculate).toHaveBeenCalledWith({
amount: null,
data: { provider_data: "true" },
provider_id: "provider",
price_type: "calculated",
})
expect(shippingOptionRepository.save).toHaveBeenCalledTimes(1)
@@ -645,7 +679,7 @@ describe("ShippingOptionService", () => {
totalsService,
fulfillmentProviderService: providerService,
featureFlagRouter: new FlagRouter({
[TaxInclusivePricingFeatureFlag.key]: true
[TaxInclusivePricingFeatureFlag.key]: true,
}),
})
@@ -653,11 +687,11 @@ describe("ShippingOptionService", () => {
jest.clearAllMocks()
})
it("should create a shipping method that also includes the taxes", async () => {
it("should create a shipping method that also includes the taxes", async () => {
await optionService.createShippingMethod("random_id", {}, { price: 10 })
expect(shippingMethodRepository.save).toHaveBeenCalledWith(
expect.objectContaining({
includes_tax: true
includes_tax: true,
})
)
})
packages/medusa/src/services/fulfillment-provider.ts
+6 -1
View File
@@ -28,6 +28,11 @@ type FulfillmentProviderContainer = MedusaContainer & {
[key in `${FulfillmentProviderKey}`]: typeof BaseFulfillmentService
}
type CalculateOptionPriceInput = {
provider_id: string
data: Record<string, unknown>
}
/**
* Helps retrive fulfillment providers
*/
@@ -118,7 +123,7 @@ class FulfillmentProviderService extends TransactionBaseService {
) as unknown as Record<string, unknown>
}
async canCalculate(option: ShippingOption): Promise<boolean> {
async canCalculate(option: CalculateOptionPriceInput): Promise<boolean> {
const provider = this.retrieveProvider(option.provider_id)
return provider.canCalculate(option.data) as unknown as boolean
}
packages/medusa/src/services/shipping-option.ts
+65 -28
View File
@@ -1,6 +1,7 @@
import { MedusaError } from "medusa-core-utils"
import { DeepPartial, EntityManager } from "typeorm"
import { EntityManager } from "typeorm"
import { TransactionBaseService } from "../interfaces"
import TaxInclusivePricingFeatureFlag from "../loaders/feature-flags/tax-inclusive-pricing"
import {
Cart,
Order,
@@ -18,12 +19,12 @@ import {
CreateShippingOptionInput,
ShippingMethodUpdate,
UpdateShippingOptionInput,
ValidatePriceTypeAndAmountInput,
} from "../types/shipping-options"
import { buildQuery, isDefined, setMetadata } from "../utils"
import { FlagRouter } from "../utils/flag-router"
import FulfillmentProviderService from "./fulfillment-provider"
import RegionService from "./region"
import { FlagRouter } from "../utils/flag-router"
import TaxInclusivePricingFeatureFlag from "../loaders/feature-flags/tax-inclusive-pricing"
type InjectedDependencies = {
manager: EntityManager
@@ -397,6 +398,42 @@ class ShippingOptionService extends TransactionBaseService {
return option
}
private async validateAndMutatePrice(
option: ShippingOption | CreateShippingOptionInput,
priceInput: ValidatePriceTypeAndAmountInput
): Promise<Omit<ShippingOption, "beforeInsert"> | CreateShippingOptionInput> {
const option_:
| Omit<ShippingOption, "beforeInsert">
| CreateShippingOptionInput = { ...option }
if (isDefined(priceInput.amount)) {
option_.amount = priceInput.amount
}
if (isDefined(priceInput.price_type)) {
option_.price_type = await this.validatePriceType_(
priceInput.price_type,
option_ as ShippingOption
)
if (priceInput.price_type === ShippingOptionPriceType.CALCULATED) {
option_.amount = null
}
}
if (
option_.price_type === ShippingOptionPriceType.FLAT_RATE &&
(option_.amount == null || option_.amount < 0)
) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
"Shipping options of type `flat_rate` must have an `amount`"
)
}
return option_
}
/**
* Creates a new shipping option. Used both for outbound and inbound shipping
* options. The difference is registered by the `is_return` field which
@@ -406,8 +443,12 @@ class ShippingOptionService extends TransactionBaseService {
*/
async create(data: CreateShippingOptionInput): Promise<ShippingOption> {
return this.atomicPhase_(async (manager) => {
const optionWithValidatedPrice = await this.validateAndMutatePrice(data, {
price_type: data.price_type,
})
const optionRepo = manager.getCustomRepository(this.optionRepository_)
const option = optionRepo.create(data as DeepPartial<ShippingOption>)
const option = optionRepo.create(optionWithValidatedPrice)
const region = await this.regionService_
.withTransaction(manager)
@@ -426,10 +467,6 @@ class ShippingOptionService extends TransactionBaseService {
)
}
option.price_type = await this.validatePriceType_(data.price_type, option)
option.amount =
data.price_type === "calculated" ? null : data.amount ?? null
if (
this.featureFlagRouter_.isFeatureEnabled(
TaxInclusivePricingFeatureFlag.key
@@ -440,7 +477,9 @@ class ShippingOptionService extends TransactionBaseService {
}
}
const isValid = await this.providerService_.validateOption(option)
const isValid = await this.providerService_.validateOption(
option as ShippingOption
)
if (!isValid) {
throw new MedusaError(
@@ -496,7 +535,8 @@ class ShippingOptionService extends TransactionBaseService {
): Promise<ShippingOptionPriceType> {
if (
!priceType ||
(priceType !== "flat_rate" && priceType !== "calculated")
(priceType !== ShippingOptionPriceType.FLAT_RATE &&
priceType !== ShippingOptionPriceType.CALCULATED)
) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
@@ -504,8 +544,11 @@ class ShippingOptionService extends TransactionBaseService {
)
}
if (priceType === "calculated") {
const canCalculate = await this.providerService_.canCalculate(option)
if (priceType === ShippingOptionPriceType.CALCULATED) {
const canCalculate = await this.providerService_.canCalculate({
provider_id: option.provider_id,
data: option.data,
})
if (!canCalculate) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
@@ -597,26 +640,20 @@ class ShippingOptionService extends TransactionBaseService {
option.requirements = acc
}
if (isDefined(update.price_type)) {
option.price_type = await this.validatePriceType_(
update.price_type,
option
)
if (update.price_type === "calculated") {
option.amount = null
const optionWithValidatedPrice = await this.validateAndMutatePrice(
option,
{
price_type: update.price_type,
amount: update.amount,
}
}
if (isDefined(update.amount) && option.price_type !== "calculated") {
option.amount = update.amount
}
)
if (isDefined(update.name)) {
option.name = update.name
optionWithValidatedPrice.name = update.name
}
if (isDefined(update.admin_only)) {
option.admin_only = update.admin_only
optionWithValidatedPrice.admin_only = update.admin_only
}
if (
@@ -625,12 +662,12 @@ class ShippingOptionService extends TransactionBaseService {
)
) {
if (typeof update.includes_tax !== "undefined") {
option.includes_tax = update.includes_tax
optionWithValidatedPrice.includes_tax = update.includes_tax
}
}
const optionRepo = manager.getCustomRepository(this.optionRepository_)
return await optionRepo.save(option)
return await optionRepo.save(optionWithValidatedPrice)
})
}
packages/medusa/src/types/shipping-options.ts
+5
View File
@@ -74,3 +74,8 @@ export type UpdateShippingOptionInput = {
data?: string
includes_tax?: boolean
}
export type ValidatePriceTypeAndAmountInput = {
amount?: number
price_type?: ShippingOptionPriceType
}