fix(medusa, utils): fix the way selects are consumed alongside the relations (#4389)

**What**
There is actually an issue with using the `fields` query params with the way the repositories are using our custom query strategy. This pr aims to fix this issue by reworking the strategy.

What we had to do was to rework the way the selects are built for each subquery in order to follow the aliasing convention and to be taken into consideration. Alongside these changes, the join used to always select everything, this needed to be changed so that if there are any selects provided for a join, the join should not select everything and let the query select the fields that are requested.

Another notable change is that all the repositories are now using the repository util in order to centralize the customization and to have a single place to update when this kind of issue arises. This means that the eager relations when using the query builder are not necessarily taken into account. For that reason, I have removed the `shipping_option` eager option in favor of explicitly asking for the relations like we started to do it in some places.

FIXES CORE-1413
This commit is contained in:
Adrien de Peretti authored and GitHub committed 2023-06-29 13:26:41 +00:00
1 parent 9760d4a96c
commit 9dcdc0041a
38 files changed
+443 -207

No files matched your search

@@ -15,6 +15,7 @@ const defaultRelations = [
"return_order",
"shipping_address",
"shipping_methods",
"shipping_methods.shipping_option",
]
const defaultFields = [
@@ -34,6 +34,7 @@ export const defaultAdminSwapRelations = [
"return_order",
"shipping_address",
"shipping_methods",
"shipping_methods.shipping_option",
]
export const defaultAdminSwapFields = [
@@ -83,6 +83,7 @@ export const defaultStoreOrdersRelations = [
"items",
"items.variant",
"shipping_methods",
"shipping_methods.shipping_option",
"discounts",
"discounts.rule",
"customer",
@@ -104,9 +104,7 @@ export const allowedStoreProductsFields = [
export const allowedStoreProductsRelations = [
...defaultStoreProductsRelations,
"variants.title",
"variants.inventory_items",
"variants.prices.amount",
"sales_channels",
]
@@ -24,10 +24,12 @@ export const defaultStoreSwapRelations = [
"additional_items.variant",
"return_order",
"return_order.shipping_method",
"return_order.shipping_method.shipping_option",
"fulfillments",
"payment",
"shipping_address",
"shipping_methods",
"shipping_methods.shipping_option",
"cart",
]
export const defaultStoreSwapFields: FindConfig<Swap>["select"] = [
@@ -76,7 +76,7 @@ export class ShippingMethod {
@JoinColumn({ name: "return_id" })
return_order: Return
@ManyToOne(() => ShippingOption, { eager: true })
@ManyToOne(() => ShippingOption)
@JoinColumn({ name: "shipping_option_id" })
shipping_option: ShippingOption
+15 -25
View File
@@ -1,8 +1,12 @@
import { objectToStringPath } from "@medusajs/utils"
import { flatten, groupBy, map, merge } from "lodash"
import { FindManyOptions, FindOptionsRelations, In } from "typeorm"
import { FindManyOptions, FindOptionsRelations } from "typeorm"
import { dataSource } from "../loaders/database"
import { Cart } from "../models"
import {
getGroupedRelations,
mergeEntitiesWithRelations,
queryEntityWithIds,
} from "../utils/repository"
export const CartRepository = dataSource.getRepository(Cart).extend({
async findWithRelations(
@@ -12,31 +16,17 @@ export const CartRepository = dataSource.getRepository(Cart).extend({
const entities = await this.find(optionsWithoutRelations)
const entitiesIds = entities.map(({ id }) => id)
const groupedRelations = {}
for (const rel of objectToStringPath(relations)) {
const [topLevel] = rel.split(".")
if (groupedRelations[topLevel]) {
groupedRelations[topLevel].push(rel)
} else {
groupedRelations[topLevel] = [rel]
}
}
const groupedRelations = getGroupedRelations(objectToStringPath(relations))
const entitiesIdsWithRelations = await Promise.all(
Object.entries(groupedRelations).map(async ([_, rels]) => {
return this.find({
where: { id: In(entitiesIds) },
select: ["id"],
relations: rels as string[],
})
})
).then(flatten)
const entitiesAndRelations = entitiesIdsWithRelations.concat(entities)
const entitiesIdsWithRelations = await queryEntityWithIds({
repository: this,
entityIds: entitiesIds,
groupedRelations,
select: ["id"],
})
const entitiesAndRelationsById = groupBy(entitiesAndRelations, "id")
return map(entitiesAndRelationsById, (entityAndRelations) =>
merge({}, ...entityAndRelations)
)
const entitiesAndRelations = entities.concat(entitiesIdsWithRelations)
return mergeEntitiesWithRelations<Cart>(entitiesAndRelations)
},
async findOneWithRelations(
@@ -82,9 +82,9 @@ export const CustomerGroupRepository = dataSource
: { ...idsOrOptionsWithoutRelations.order }
const originalSelect = isOptionsArray
? undefined
: (objectToStringPath(
idsOrOptionsWithoutRelations.select
) as (keyof CustomerGroup)[])
: (objectToStringPath(idsOrOptionsWithoutRelations.select, {
includeParentPropertyFields: false,
}) as (keyof CustomerGroup)[])
const clonedOptions = isOptionsArray
? idsOrOptionsWithoutRelations
: cloneDeep(idsOrOptionsWithoutRelations)
@@ -169,7 +169,7 @@ export const CustomerGroupRepository = dataSource
withDeleted,
})
const entitiesAndRelations = entitiesIdsWithRelations.concat(entities)
const entitiesAndRelations = entities.concat(entitiesIdsWithRelations)
const entitiesToReturn =
mergeEntitiesWithRelations<CustomerGroup>(entitiesAndRelations)
+8 -15
View File
@@ -1,8 +1,12 @@
import { objectToStringPath } from "@medusajs/utils"
import { flatten, groupBy, map, merge } from "lodash"
import { flatten } from "lodash"
import { FindManyOptions, FindOptionsRelations, In } from "typeorm"
import { dataSource } from "../loaders/database"
import { Order } from "../models"
import {
getGroupedRelations,
mergeEntitiesWithRelations,
} from "../utils/repository"
const ITEMS_REL_NAME = "items"
const REGION_REL_NAME = "region"
@@ -15,15 +19,7 @@ export const OrderRepository = dataSource.getRepository(Order).extend({
const entities = await this.find(optionsWithoutRelations)
const entitiesIds = entities.map(({ id }) => id)
const groupedRelations: { [topLevel: string]: string[] } = {}
for (const rel of objectToStringPath(relations)) {
const [topLevel] = rel.split(".")
if (groupedRelations[topLevel]) {
groupedRelations[topLevel].push(rel)
} else {
groupedRelations[topLevel] = [rel]
}
}
const groupedRelations = getGroupedRelations(objectToStringPath(relations))
const entitiesIdsWithRelations = await Promise.all(
Object.entries(groupedRelations).map(async ([topLevel, rels]) => {
@@ -39,11 +35,8 @@ export const OrderRepository = dataSource.getRepository(Order).extend({
})
).then(flatten)
const entitiesAndRelations = entitiesIdsWithRelations.concat(entities)
const entitiesAndRelationsById = groupBy(entitiesAndRelations, "id")
return map(entities, (e) => merge({}, ...entitiesAndRelationsById[e.id]))
const entitiesAndRelations = entities.concat(entitiesIdsWithRelations)
return mergeEntitiesWithRelations<Order>(entitiesAndRelations)
},
async findOneWithRelations(
@@ -1,10 +1,9 @@
import {
Brackets,
DeleteResult,
FindOneOptions,
FindOptionsWhere,
ILike,
DeleteResult,
In,
FindOneOptions,
} from "typeorm"
import { ProductCategory } from "../models/product-category"
import { ExtendedFindConfig, QuerySelector } from "../types/common"
@@ -44,7 +43,9 @@ export const ProductCategoryRepository = dataSource
const options_ = { ...options }
options_.where = options_.where as FindOptionsWhere<ProductCategory>
const columnsSelected = objectToStringPath(options_.select)
const columnsSelected = objectToStringPath(options_.select, {
includeParentPropertyFields: false,
})
const relationsSelected = objectToStringPath(options_.relations)
const fetchSelectColumns = (relationName: string): string[] => {
+18 -15
View File
@@ -18,10 +18,11 @@ import { ExtendedFindConfig } from "@medusajs/types"
import {
applyOrdering,
getGroupedRelations,
mergeEntitiesWithRelations,
queryEntityWithIds,
queryEntityWithoutRelations,
} from "../utils/repository"
import { cloneDeep, groupBy, map, merge } from "lodash"
import { cloneDeep } from "lodash"
export type DefaultWithoutRelations = Omit<
ExtendedFindConfig<Product>,
@@ -213,11 +214,13 @@ export const ProductRepository = dataSource.getRepository(Product).extend({
customJoinBuilders: [
(queryBuilder, alias, topLevel) => {
if (topLevel === "variants") {
queryBuilder.leftJoinAndSelect(
`${alias}.${topLevel}`,
topLevel,
`${topLevel}.deleted_at IS NULL`
)
const joinMethod = select.filter(
(key) => !!key.match(/^variants\.\w+$/i)
).length
? "leftJoin"
: "leftJoinAndSelect"
queryBuilder[joinMethod](`${alias}.${topLevel}`, topLevel)
if (
!Object.keys(order!).some((key) => key.startsWith("variants"))
@@ -228,7 +231,8 @@ export const ProductRepository = dataSource.getRepository(Product).extend({
return false
}
return true
return
},
(queryBuilder, alias, topLevel) => {
if (topLevel === "categories") {
@@ -245,7 +249,7 @@ export const ProductRepository = dataSource.getRepository(Product).extend({
return false
}
return true
return
},
],
})
@@ -479,9 +483,9 @@ export const ProductRepository = dataSource.getRepository(Product).extend({
: { ...idsOrOptionsWithoutRelations.order }
const originalSelect = isOptionsArray
? undefined
: (objectToStringPath(
idsOrOptionsWithoutRelations.select
) as (keyof Product)[])
: (objectToStringPath(idsOrOptionsWithoutRelations.select, {
includeParentPropertyFields: false,
}) as (keyof Product)[])
const clonedOptions = isOptionsArray
? idsOrOptionsWithoutRelations
: cloneDeep(idsOrOptionsWithoutRelations)
@@ -543,10 +547,9 @@ export const ProductRepository = dataSource.getRepository(Product).extend({
withDeleted,
})
const entitiesAndRelations = groupBy(entitiesIdsWithRelations, "id")
const entitiesToReturn = map(entitiesIds, (id) =>
merge({}, ...entitiesAndRelations[id])
)
const entitiesAndRelations = entities.concat(entitiesIdsWithRelations)
const entitiesToReturn =
mergeEntitiesWithRelations<Product>(entitiesAndRelations)
return [entitiesToReturn, count]
},
+2 -1
View File
@@ -34,7 +34,8 @@ export const TaxRateRepository = dataSource.getRepository(TaxRate).extend({
if (isDefined(findOptions.select)) {
const selectableCols: (keyof TaxRate)[] = []
const legacySelect = objectToStringPath(
findOptions.select as FindOptionsSelect<TaxRate>
findOptions.select as FindOptionsSelect<TaxRate>,
{ includeParentPropertyFields: false }
) as (keyof TaxRate)[]
for (const k of legacySelect) {
if (!resolveableFields.includes(k)) {
@@ -865,7 +865,9 @@ describe("CartService", () => {
payment_sessions: true,
region: { countries: true },
shipping_address: true,
shipping_methods: true,
shipping_methods: {
shipping_option: true,
},
}),
expect.objectContaining({
select: undefined,
+34 -37
View File
@@ -12,16 +12,12 @@ import {
ProductVariantInventoryService,
ReturnService,
ShippingOptionService,
TotalsService
TotalsService,
} from "../index"
import LineItemAdjustmentService from "../line-item-adjustment"
import SwapService from "../swap"
import {
LineItemAdjustmentServiceMock
} from "../__mocks__/line-item-adjustment"
import {
ProductVariantInventoryServiceMock
} from "../__mocks__/product-variant-inventory"
import { LineItemAdjustmentServiceMock } from "../__mocks__/line-item-adjustment"
import { ProductVariantInventoryServiceMock } from "../__mocks__/product-variant-inventory"
/* ******************** DEFAULT REPOSITORY MOCKS ******************** */
@@ -273,32 +269,33 @@ describe("SwapService", () => {
expect(swapRepo.findOne).toHaveBeenCalledWith({
relations: {
additional_items: {
variant: true
variant: true,
},
order: {
claims: {
additional_items: true
additional_items: true,
},
discounts: {
rule: true
rule: true,
},
items: {
variant: {
product: true
}
product: true,
},
},
swaps: {
additional_items: true
}
additional_items: true,
},
},
return_order: {
items: true,
shipping_method: {
tax_lines: true
}
}
shipping_option: true,
tax_lines: true,
},
},
},
where: { id: IdMap.getId("swap-1") }
where: { id: IdMap.getId("swap-1") },
})
expect(lineItemService.createReturnLines).toHaveBeenCalledTimes(1)
@@ -413,15 +410,13 @@ describe("SwapService", () => {
describe("success", () => {
const lineItemService = {
generate: jest
.fn()
.mockImplementation(({ variantId, quantity }) => {
return {
unit_price: 100,
variant_id: variantId,
quantity,
}
}),
generate: jest.fn().mockImplementation(({ variantId, quantity }) => {
return {
unit_price: 100,
variant_id: variantId,
quantity,
}
}),
retrieve: () => Promise.resolve({}),
list: () => Promise.resolve([]),
withTransaction: function () {
@@ -457,13 +452,16 @@ describe("SwapService", () => {
)
expect(lineItemService.generate).toHaveBeenCalledTimes(1)
expect(lineItemService.generate).toHaveBeenCalledWith({
quantity: 1,
variantId: IdMap.getId("new-variant")
}, {
"cart": undefined,
region_id: IdMap.getId("region")
})
expect(lineItemService.generate).toHaveBeenCalledWith(
{
quantity: 1,
variantId: IdMap.getId("new-variant"),
},
{
cart: undefined,
region_id: IdMap.getId("region"),
}
)
})
it("creates swap", async () => {
@@ -605,7 +603,7 @@ describe("SwapService", () => {
shipping_methods: existing.shipping_methods,
},
[{ item_id: "1234", quantity: 2 }],
{ swap_id: IdMap.getId("swap"), metadata: {} },
{ swap_id: IdMap.getId("swap"), metadata: {} }
)
})
})
@@ -798,8 +796,7 @@ describe("SwapService", () => {
describe("failure", () => {
const swapRepo = MockRepository({
findOne: () =>
Promise.resolve({ canceled_at: new Date() }),
findOne: () => Promise.resolve({ canceled_at: new Date() }),
})
const swapService = new SwapService({
+12 -2
View File
@@ -1004,7 +1004,7 @@ class CartService extends TransactionBaseService {
* shipping discount
* If a free shipping is present, we set shipping methods price to 0
* if a free shipping was present, we set shipping methods to original amount
* @param cart - the the cart to adjust free shipping for
* @param cart - the cart to adjust free shipping for
* @param shouldAdd - flag to indicate, if we should add or remove
* @return void
*/
@@ -1058,6 +1058,7 @@ class CartService extends TransactionBaseService {
"items.variant",
"items.variant.product",
"shipping_methods",
"shipping_methods.shipping_option",
"shipping_address",
"billing_address",
"gift_cards",
@@ -1530,6 +1531,7 @@ class CartService extends TransactionBaseService {
"discounts.rule",
"payment_sessions",
"shipping_methods",
"shipping_methods.shipping_option",
],
})
@@ -1829,6 +1831,7 @@ class CartService extends TransactionBaseService {
"discounts.rule",
"gift_cards",
"shipping_methods",
"shipping_methods.shipping_option",
"billing_address",
"shipping_address",
"region",
@@ -2170,7 +2173,12 @@ class CartService extends TransactionBaseService {
}
const updatedCart = await this.retrieve(cart.id, {
relations: ["discounts", "discounts.rule", "shipping_methods"],
relations: [
"discounts",
"discounts.rule",
"shipping_methods",
"shipping_methods.shipping_option",
],
})
// if cart has freeshipping, adjust price
@@ -2537,6 +2545,7 @@ class CartService extends TransactionBaseService {
"region.tax_rates",
"shipping_address",
"shipping_methods",
"shipping_methods.shipping_option",
],
})
@@ -2559,6 +2568,7 @@ class CartService extends TransactionBaseService {
"items",
"items.tax_lines",
"shipping_methods",
"shipping_methods.shipping_option",
"shipping_methods.tax_lines",
],
})
+1
View File
@@ -530,6 +530,7 @@ export default class ClaimService extends TransactionBaseService {
"additional_items.variant",
"additional_items.variant.product",
"shipping_methods",
"shipping_methods.shipping_option",
"shipping_methods.tax_lines",
"shipping_address",
"order",
@@ -514,6 +514,7 @@ export default class OrderEditService extends TransactionBaseService {
"items.variant",
"region.tax_rates",
"shipping_methods",
"shipping_methods.shipping_option",
"shipping_methods.tax_lines",
],
})
+1
View File
@@ -596,6 +596,7 @@ class ReturnService extends TransactionBaseService {
"discounts.rule",
"refunds",
"shipping_methods",
"shipping_methods.shipping_option",
"region",
"swaps",
"swaps.additional_items",
+3 -1
View File
@@ -29,7 +29,7 @@ import {
} from "./index"
import { EntityManager, In } from "typeorm"
import { FindConfig, Selector, WithRequiredProperty } from "../types/common"
import { MedusaError, isDefined } from "medusa-core-utils"
import { isDefined, MedusaError } from "medusa-core-utils"
import { buildQuery, setMetadata, validateId } from "../utils"
import { CreateShipmentConfig } from "../types/fulfillment"
@@ -579,6 +579,7 @@ class SwapService extends TransactionBaseService {
"return_order",
"return_order.items",
"return_order.shipping_method",
"return_order.shipping_method.shipping_option",
"return_order.shipping_method.tax_lines",
],
})
@@ -918,6 +919,7 @@ class SwapService extends TransactionBaseService {
"additional_items.variant",
"additional_items.variant.product",
"shipping_methods",
"shipping_methods.shipping_option",
"shipping_methods.tax_lines",
"order",
"order.region",
@@ -197,6 +197,7 @@ class CartCompletionStrategy extends AbstractCartCompletionStrategy {
"region.tax_rates",
"shipping_address",
"shipping_methods",
"shipping_methods.shipping_option",
],
})
+5
View File
@@ -133,9 +133,12 @@ export const defaultAdminOrdersRelations = [
"returns.items",
"returns.items.reason",
"returns.shipping_method",
"returns.shipping_method.shipping_option",
"returns.shipping_method.tax_lines",
"shipping_address",
"shipping_methods",
"shipping_methods.shipping_option",
"shipping_methods.tax_lines",
"swaps",
"swaps.additional_items",
"swaps.additional_items.variant",
@@ -144,9 +147,11 @@ export const defaultAdminOrdersRelations = [
"swaps.payment",
"swaps.return_order",
"swaps.return_order.shipping_method",
"swaps.return_order.shipping_method.shipping_option",
"swaps.return_order.shipping_method.tax_lines",
"swaps.shipping_address",
"swaps.shipping_methods",
"swaps.shipping_methods.shipping_option",
"swaps.shipping_methods.tax_lines",
// "claims.claim_items.tags",
]
+77 -48
View File
@@ -7,6 +7,11 @@ import {
} from "typeorm"
import { ExtendedFindConfig } from "../types/common"
// Regex matches all '.' except the rightmost
export const positiveLookaheadDotReplacer = new RegExp(/\.(?=[^.]*\.)/, "g")
// Replace all '.' with '__' to avoid typeorm's automatic aliasing
export const dotReplacer = new RegExp(/\./, "g")
/**
* Custom query entity, it is part of the creation of a custom findWithRelationsAndCount needs.
* Allow to query the relations for the specified entity ids
@@ -35,62 +40,86 @@ export async function queryEntityWithIds<T extends ObjectLiteral>({
qb: SelectQueryBuilder<T>,
alias: string,
toplevel: string
) => boolean)[]
) => false | undefined)[]
}): Promise<T[]> {
const alias = repository.metadata.name.toLowerCase()
return await Promise.all(
Object.entries(groupedRelations).map(async ([toplevel, rels]) => {
let querybuilder = repository.createQueryBuilder(alias)
Object.entries(groupedRelations).map(
async ([toplevel, topLevelRelations]) => {
let querybuilder = repository.createQueryBuilder(alias)
if (select && select.length) {
querybuilder.select(select.map((f) => `${alias}.${f as string}`))
}
let shouldAttachDefault = true
for (const customJoinBuilder of customJoinBuilders) {
const result = customJoinBuilder(querybuilder, alias, toplevel)
shouldAttachDefault = shouldAttachDefault && result
}
// If the toplevel relation has been attached with a customJoinBuilder and the function return false then
// do not attach the toplevel join bellow.
if (shouldAttachDefault) {
querybuilder = querybuilder.leftJoinAndSelect(
`${alias}.${toplevel}`,
toplevel
)
}
for (const rel of rels) {
const [_, rest] = rel.split(".")
if (!rest) {
continue
if (select?.length) {
querybuilder.select(
(select as string[])
.filter(function (s) {
return s.startsWith(toplevel) || !s.includes(".")
})
.map((column) => {
// In case the column is the toplevel relation, we need to replace the dot with a double underscore if it also contains top level relations
if (column.includes(toplevel)) {
return topLevelRelations.some((rel) => column.includes(rel))
? column.replace(positiveLookaheadDotReplacer, "__")
: column
}
return `${alias}.${column}`
})
)
}
querybuilder = querybuilder.leftJoinAndSelect(
// Regex matches all '.' except the rightmost
rel.replace(/\.(?=[^.]*\.)/g, "__"),
// Replace all '.' with '__' to avoid typeorm's automatic aliasing
rel.replace(/\./g, "__")
)
}
if (withDeleted) {
querybuilder = querybuilder
.where(`${alias}.id IN (:...entitiesIds)`, {
entitiesIds: entityIds,
})
.withDeleted()
} else {
querybuilder = querybuilder.where(
`${alias}.deleted_at IS NULL AND ${alias}.id IN (:...entitiesIds)`,
{
entitiesIds: entityIds,
let shouldAttachDefault: boolean | undefined = true
for (const customJoinBuilder of customJoinBuilders) {
const result = customJoinBuilder(querybuilder, alias, toplevel)
if (result === undefined) {
continue
}
)
}
return querybuilder.getMany()
})
shouldAttachDefault = shouldAttachDefault && result
}
if (shouldAttachDefault) {
const regexp = new RegExp(`^${toplevel}\\.\\w+$`)
const joinMethod = (select as string[]).filter(
(key) => !!key.match(regexp)
).length
? "leftJoin"
: "leftJoinAndSelect"
querybuilder = querybuilder[joinMethod](
`${alias}.${toplevel}`,
toplevel
)
}
for (const rel of topLevelRelations) {
const [_, rest] = rel.split(".")
if (!rest) {
continue
}
const regexp = new RegExp(`^${rel}\\.\\w+$`)
const joinMethod = (select as string[]).filter(
(key) => !!key.match(regexp)
).length
? "leftJoin"
: "leftJoinAndSelect"
querybuilder = querybuilder[joinMethod](
rel.replace(positiveLookaheadDotReplacer, "__"),
rel.replace(dotReplacer, "__")
)
}
querybuilder = querybuilder.where(`${alias}.id IN (:...entitiesIds)`, {
entitiesIds: entityIds,
})
if (withDeleted) {
querybuilder.withDeleted()
}
return querybuilder.getMany()
}
)
).then(flatten)
}