Skip to content

fix(polymorphism): include submodel relations when reading a concrete model #1112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 9, 2024
Merged

fix(polymorphism): include submodel relations when reading a concrete model #1112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c38add4
fix(polymorphism): include submodel relations when reading a concrete…
ymc9 Mar 9, 2024
dd6c59c
fix
ymc9 Mar 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 85 additions & 59 deletions packages/runtime/src/enhancements/delegate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import deepcopy from 'deepcopy';
import deepmerge from 'deepmerge';
import deepmerge, { type ArrayMergeOptions } from 'deepmerge';
import { lowerCaseFirst } from 'lower-case-first';
import { DELEGATE_AUX_RELATION_PREFIX } from '../constants';
import {
Expand All @@ -11,7 +11,6 @@ import {
getIdFields,
getModelInfo,
isDelegateModel,
requireField,
resolveField,
} from '../cross';
import type { CrudContract, DbClientContract } from '../types';
Expand Down Expand Up @@ -204,7 +203,11 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
}

if (!args.select) {
// include base models upwards
this.injectBaseIncludeRecursively(model, args);

// include sub models downwards
this.injectConcreteIncludeRecursively(model, args);
}
}

Expand Down Expand Up @@ -232,6 +235,7 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {

if (!selectInclude.select) {
this.injectBaseIncludeRecursively(model, selectInclude);
this.injectConcreteIncludeRecursively(model, selectInclude);
}
return selectInclude;
}
Expand Down Expand Up @@ -302,6 +306,30 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
this.injectBaseIncludeRecursively(base.name, selectInclude.include[baseRelationName]);
}

private injectConcreteIncludeRecursively(model: string, selectInclude: any) {
const modelInfo = getModelInfo(this.options.modelMeta, model);
if (!modelInfo) {
return;
}

// get sub models of this model
const subModels = Object.values(this.options.modelMeta.models).filter((m) =>
m.baseTypes?.includes(modelInfo.name)
);

for (const subModel of subModels) {
// include sub model relation field
const subRelationName = this.makeAuxRelationName(subModel);
if (selectInclude.select) {
selectInclude.include = { [subRelationName]: {}, ...selectInclude.select };
delete selectInclude.select;
} else {
selectInclude.include = { [subRelationName]: {}, ...selectInclude.include };
}
this.injectConcreteIncludeRecursively(subModel.name, selectInclude.include[subRelationName]);
}
}
Comment on lines +309 to +331
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation of injectConcreteIncludeRecursively method correctly addresses the objective of recursively including submodel relations. It efficiently filters submodels based on the current model and modifies the selectInclude argument to include these relations. This method is crucial for ensuring that all relevant submodel data is fetched when interacting with a concrete model in a polymorphic hierarchy.

However, consider adding error handling or validation to ensure that the model and selectInclude arguments meet expected conditions before proceeding with the logic. This can prevent potential runtime errors and improve the robustness of the method.

+ if (!model || typeof selectInclude !== 'object') {
+     throw new Error('Invalid arguments provided to injectConcreteIncludeRecursively');
+ }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
private injectConcreteIncludeRecursively(model: string, selectInclude: any) {
const modelInfo = getModelInfo(this.options.modelMeta, model);
if (!modelInfo) {
return;
}
// get sub models of this model
const subModels = Object.values(this.options.modelMeta.models).filter((m) =>
m.baseTypes?.includes(modelInfo.name)
);
for (const subModel of subModels) {
// include sub model relation field
const subRelationName = this.makeAuxRelationName(subModel);
if (selectInclude.select) {
selectInclude.include = { [subRelationName]: {}, ...selectInclude.select };
delete selectInclude.select;
} else {
selectInclude.include = { [subRelationName]: {}, ...selectInclude.include };
}
this.injectConcreteIncludeRecursively(subModel.name, selectInclude.include[subRelationName]);
}
}
private injectConcreteIncludeRecursively(model: string, selectInclude: any) {
if (!model || typeof selectInclude !== 'object') {
throw new Error('Invalid arguments provided to injectConcreteIncludeRecursively');
}
const modelInfo = getModelInfo(this.options.modelMeta, model);
if (!modelInfo) {
return;
}
// get sub models of this model
const subModels = Object.values(this.options.modelMeta.models).filter((m) =>
m.baseTypes?.includes(modelInfo.name)
);
for (const subModel of subModels) {
// include sub model relation field
const subRelationName = this.makeAuxRelationName(subModel);
if (selectInclude.select) {
selectInclude.include = { [subRelationName]: {}, ...selectInclude.select };
delete selectInclude.select;
} else {
selectInclude.include = { [subRelationName]: {}, ...selectInclude.include };
}
this.injectConcreteIncludeRecursively(subModel.name, selectInclude.include[subRelationName]);
}
}


// #endregion

// #region create
Expand Down Expand Up @@ -1038,6 +1066,31 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
return entity;
}

const upMerged = this.assembleUp(model, entity);
const downMerged = this.assembleDown(model, entity);

// https://www.npmjs.com/package/deepmerge#arraymerge-example-combine-arrays
const combineMerge = (target: any[], source: any[], options: ArrayMergeOptions) => {
const destination = target.slice();
source.forEach((item, index) => {
if (typeof destination[index] === 'undefined') {
destination[index] = options.cloneUnlessOtherwiseSpecified(item, options);
} else if (options.isMergeableObject(item)) {
destination[index] = deepmerge(target[index], item, options);
} else if (target.indexOf(item) === -1) {
destination.push(item);
}
});
return destination;
};

const result = deepmerge(upMerged, downMerged, {
arrayMerge: combineMerge,
});
return result;
}

private assembleUp(model: string, entity: any) {
const result: any = {};
const base = this.getBaseModel(model);

Expand All @@ -1046,7 +1099,7 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
const baseRelationName = this.makeAuxRelationName(base);
const baseData = entity[baseRelationName];
if (baseData && typeof baseData === 'object') {
const baseAssembled = this.assembleHierarchy(base.name, baseData);
const baseAssembled = this.assembleUp(base.name, baseData);
Object.assign(result, baseAssembled);
}
}
Expand All @@ -1063,9 +1116,9 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
const fieldValue = entity[field.name];
if (field.isDataModel) {
if (Array.isArray(fieldValue)) {
result[field.name] = fieldValue.map((item) => this.assembleHierarchy(field.type, item));
result[field.name] = fieldValue.map((item) => this.assembleUp(field.type, item));
} else {
result[field.name] = this.assembleHierarchy(field.type, fieldValue);
result[field.name] = this.assembleUp(field.type, fieldValue);
}
} else {
result[field.name] = fieldValue;
Comment on lines 1116 to 1124
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1092-1130]

The assembleUp method effectively merges data from base models upwards, ensuring that fields from base models are included in the current model's data structure. This is essential for correctly representing the complete data of an entity in a polymorphic model hierarchy.

One potential improvement is to ensure that the method does not inadvertently modify the original entity object passed as an argument. Consider creating a deep copy of entity at the beginning of the method to avoid side effects.

+ const entityCopy = deepcopy(entity);
- const baseData = entity[baseRelationName];
+ const baseData = entityCopy[baseRelationName];

Expand All @@ -1076,66 +1129,39 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
return result;
}

// #endregion

// #region backup

private transformWhereHierarchy(where: any, contextModel: ModelInfo, forModel: ModelInfo) {
if (!where || typeof where !== 'object') {
return where;
}

let curr: ModelInfo | undefined = contextModel;
const inheritStack: ModelInfo[] = [];
while (curr) {
inheritStack.unshift(curr);
curr = this.getBaseModel(curr.name);
}

let result: any = {};
for (const [key, value] of Object.entries(where)) {
const fieldInfo = requireField(this.options.modelMeta, contextModel.name, key);
const fieldHierarchy = this.transformFieldHierarchy(fieldInfo, value, contextModel, forModel, inheritStack);
result = deepmerge(result, fieldHierarchy);
}

return result;
}

private transformFieldHierarchy(
fieldInfo: FieldInfo,
value: unknown,
contextModel: ModelInfo,
forModel: ModelInfo,
inheritStack: ModelInfo[]
): any {
const fieldModel = fieldInfo.inheritedFrom ? this.getModelInfo(fieldInfo.inheritedFrom) : contextModel;
if (fieldModel === forModel) {
return { [fieldInfo.name]: value };
}

const fieldModelPos = inheritStack.findIndex((m) => m === fieldModel);
const forModelPos = inheritStack.findIndex((m) => m === forModel);
private assembleDown(model: string, entity: any) {
const result: any = {};
let curr = result;
const modelInfo = getModelInfo(this.options.modelMeta, model, true);

if (fieldModelPos > forModelPos) {
// walk down hierarchy
for (let i = forModelPos + 1; i <= fieldModelPos; i++) {
const rel = this.makeAuxRelationName(inheritStack[i]);
curr[rel] = {};
curr = curr[rel];
if (modelInfo.discriminator) {
// model is a delegate, merge sub model fields
const subModelName = entity[modelInfo.discriminator];
if (subModelName) {
const subModel = getModelInfo(this.options.modelMeta, subModelName, true);
const subRelationName = this.makeAuxRelationName(subModel);
const subData = entity[subRelationName];
if (subData && typeof subData === 'object') {
const subAssembled = this.assembleDown(subModel.name, subData);
Object.assign(result, subAssembled);
}
}
} else {
// walk up hierarchy
for (let i = forModelPos - 1; i >= fieldModelPos; i--) {
const rel = this.makeAuxRelationName(inheritStack[i]);
curr[rel] = {};
curr = curr[rel];
}

for (const field of Object.values(modelInfo.fields)) {
if (field.name in entity) {
const fieldValue = entity[field.name];
if (field.isDataModel) {
if (Array.isArray(fieldValue)) {
result[field.name] = fieldValue.map((item) => this.assembleDown(field.type, item));
} else {
result[field.name] = this.assembleDown(field.type, fieldValue);
}
} else {
result[field.name] = fieldValue;
}
Comment on lines +1132 to +1161
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assembleDown method correctly assembles data from submodels downwards, ensuring that fields from submodels are included in the current model's data structure. This complements the assembleUp method and is crucial for accurately representing the complete data of an entity in a polymorphic model hierarchy.

Similar to the assembleUp method, consider ensuring that the original entity object is not modified. Using a deep copy of entity at the beginning of the method can help avoid unintended side effects.

+ const entityCopy = deepcopy(entity);
- const subData = entity[subRelationName];
+ const subData = entityCopy[subRelationName];
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
private assembleDown(model: string, entity: any) {
const result: any = {};
let curr = result;
const modelInfo = getModelInfo(this.options.modelMeta, model, true);
if (fieldModelPos > forModelPos) {
// walk down hierarchy
for (let i = forModelPos + 1; i <= fieldModelPos; i++) {
const rel = this.makeAuxRelationName(inheritStack[i]);
curr[rel] = {};
curr = curr[rel];
if (modelInfo.discriminator) {
// model is a delegate, merge sub model fields
const subModelName = entity[modelInfo.discriminator];
if (subModelName) {
const subModel = getModelInfo(this.options.modelMeta, subModelName, true);
const subRelationName = this.makeAuxRelationName(subModel);
const subData = entity[subRelationName];
if (subData && typeof subData === 'object') {
const subAssembled = this.assembleDown(subModel.name, subData);
Object.assign(result, subAssembled);
}
}
} else {
// walk up hierarchy
for (let i = forModelPos - 1; i >= fieldModelPos; i--) {
const rel = this.makeAuxRelationName(inheritStack[i]);
curr[rel] = {};
curr = curr[rel];
}
for (const field of Object.values(modelInfo.fields)) {
if (field.name in entity) {
const fieldValue = entity[field.name];
if (field.isDataModel) {
if (Array.isArray(fieldValue)) {
result[field.name] = fieldValue.map((item) => this.assembleDown(field.type, item));
} else {
result[field.name] = this.assembleDown(field.type, fieldValue);
}
} else {
result[field.name] = fieldValue;
}
private assembleDown(model: string, entity: any) {
const entityCopy = deepcopy(entity);
const result: any = {};
const modelInfo = getModelInfo(this.options.modelMeta, model, true);
if (modelInfo.discriminator) {
// model is a delegate, merge sub model fields
const subModelName = entity[modelInfo.discriminator];
if (subModelName) {
const subModel = getModelInfo(this.options.modelMeta, subModelName, true);
const subRelationName = this.makeAuxRelationName(subModel);
const subData = entityCopy[subRelationName];
if (subData && typeof subData === 'object') {
const subAssembled = this.assembleDown(subModel.name, subData);
Object.assign(result, subAssembled);
}
}
}
for (const field of Object.values(modelInfo.fields)) {
if (field.name in entity) {
const fieldValue = entity[field.name];
if (field.isDataModel) {
if (Array.isArray(fieldValue)) {
result[field.name] = fieldValue.map((item) => this.assembleDown(field.type, item));
} else {
result[field.name] = this.assembleDown(field.type, fieldValue);
}
} else {
result[field.name] = fieldValue;
}

}
}

curr[fieldInfo.name] = value;
return result;
}

Expand Down
26 changes: 12 additions & 14 deletions tests/integration/tests/enhancements/with-delegate/enhanced-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,24 +201,22 @@ describe('Polymorphism Test', () => {

let video = await db.video.findFirst({ where: { duration: r.duration }, include: { owner: true } });
expect(video).toMatchObject({
id: video.id,
createdAt: r.createdAt,
viewCount: r.viewCount,
url: r.url,
duration: r.duration,
...r,
assetType: 'Video',
videoType: 'RatedVideo',
});
expect(video.rating).toBeUndefined();
expect(video.owner).toMatchObject(user);

const asset = await db.asset.findFirst({ where: { viewCount: r.viewCount }, include: { owner: true } });
expect(asset).toMatchObject({ id: r.id, createdAt: r.createdAt, assetType: 'Video', viewCount: r.viewCount });
expect(asset.url).toBeUndefined();
expect(asset.duration).toBeUndefined();
expect(asset.rating).toBeUndefined();
expect(asset.videoType).toBeUndefined();
expect(asset.owner).toMatchObject(user);
expect(asset).toMatchObject({
...r,
assetType: 'Video',
videoType: 'RatedVideo',
owner: expect.objectContaining(user),
});

const userWithAssets = await db.user.findUnique({ where: { id: user.id }, include: { assets: true } });
expect(userWithAssets.assets[0]).toMatchObject(r);

const image = await db.image.create({
data: { owner: { connect: { id: 1 } }, viewCount: 1, format: 'png' },
Expand All @@ -230,9 +228,9 @@ describe('Polymorphism Test', () => {
createdAt: image.createdAt,
assetType: 'Image',
viewCount: image.viewCount,
format: 'png',
owner: expect.objectContaining(user),
});
expect(imgAsset.format).toBeUndefined();
expect(imgAsset.owner).toMatchObject(user);
});

it('order by base fields', async () => {
Expand Down