File size: 4,221 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
import { BaseRecord } from '../../adapters/index.js'
import PropertyDecorator from '../../decorators/property/property-decorator.js'
import { ActionContext } from '../../actions/index.js'
const isValueSearchable = (value: any): value is string | number => (
['string', 'bigint', 'number'].includes(typeof value)
&& value !== null
&& value !== ''
)
/**
* It populates one property in given records
*
* @param {Array<BaseRecord>} records array of records to populate
* @param {PropertyDecorator} property Decorator for the reference property to populate
* @param context
* @private
* @hide
*/
export async function populateProperty(
records: Array<BaseRecord> | null,
property: PropertyDecorator,
context?: ActionContext,
): Promise<Array<BaseRecord> | null> {
const decoratedResource = property.resource()
if (!records || !records.length) {
return records
}
const referencedResource = property.reference()
if (!referencedResource) {
throw new Error([
`There is no reference resource named: "${property.property.reference}"`,
`for property: "${decoratedResource.id()}.properties.${property.propertyPath}"`,
].join('\n'))
}
// I will describe the process for following data:
// - decoratedResource = 'Comment'
// - referenceResource = 'User'
// property.path = 'userId'
// first, we create externalIdsMap[1] = null where 1 is userId. This make keys unique and assign
// nulls to each of them
const externalIdsMap = records.reduce((memo, baseRecord) => {
const foreignKeyValue = baseRecord.get(property.propertyPath, { includeAllSiblings: true })
// 2 kind of properties returning arrays
// - the one with the array type
// - the one which are nested within an arrays (fetched by the help of
// the options { includeAllSiblings: true } in baseRecord.get().
// so we have to take it all into consideration
if (Array.isArray(foreignKeyValue)) {
return foreignKeyValue.reduce((arrayMemo, valueInArray) => ({
...arrayMemo,
...(isValueSearchable(valueInArray) ? { [valueInArray]: valueInArray } : {}),
}), memo)
}
if (!isValueSearchable(foreignKeyValue)) {
return memo
}
memo[foreignKeyValue] = foreignKeyValue
return memo
}, {})
const uniqueExternalIds = Object.values<string | number>(externalIdsMap)
// when no record has reference filled (ie `userId`) = return input `records`
if (!uniqueExternalIds.length) {
return records
}
// now find all referenced records: all users
const referenceRecords = await referencedResource.findMany(uniqueExternalIds, context)
// even if record has value for this reference - it might not have the referenced record itself
// this happens quite often in mongodb where there are no constrains on the database
if (!referenceRecords || !referenceRecords.length) {
return records
}
// now assign these users to `externalIdsMap` instead of the empty object we had. To speed up
// assigning them to record#populated we will do in the next step by calling:
// `externalIdsMap[id]` to get populated record instead of finding them in an array
referenceRecords.forEach((referenceRecord) => {
// example: externalIds[1] = { ...userRecord } | null (if not found)
const foreignKeyValue = referenceRecord.id()
externalIdsMap[foreignKeyValue] = referenceRecord
})
return records.map((record) => {
// first lets extract all the existing params from the given record which belongs to given
// property. Usually it will be just one element, but for arrays and items nested inside arrays
// there will be more like this for array:
// {
// 'professions.0': '5f7462621eb3495ea0f0edd7',
// 'professions.1': '5f7462621eb3495ea0f0edd6',
// }
const referenceParams = record.selectParams(property.propertyPath, {
includeAllSiblings: true,
}) || {}
// next we copy the exact params structure to record.populated changing the value with found
// record
Object.entries(referenceParams).forEach(([path, foreignKeyValueItem]) => {
record.populate(path, externalIdsMap[foreignKeyValueItem])
})
return record
})
}
|