query-utils.ts

/* eslint-disable @typescript-eslint/no-explicit-any */
import {
    clone,
    getIdFields,
    getModelInfo,
    getUniqueConstraints,
    resolveField,
    type FieldInfo,
    type NestedWriteVisitorContext,
} from '../../cross';
import type { CrudContract, DbClientContract } from '../../types';
import { getVersion } from '../../version';
import { formatObject } from '../edge';
import { InternalEnhancementOptions } from './create-enhancement';
import { Logger } from './logger';
import { prismaClientUnknownRequestError, prismaClientValidationError } from './utils';

export class QueryUtils {
    private readonly logger: Logger;

    constructor(private readonly prisma: DbClientContract, protected readonly options: InternalEnhancementOptions) {
        this.logger = new Logger(prisma);
    }

    getIdFields(model: string) {
        return getIdFields(this.options.modelMeta, model, true);
    }

    makeIdSelection(model: string) {
        const idFields = this.getIdFields(model);
        return Object.assign({}, ...idFields.map((f) => ({ [f.name]: true })));
    }

    getEntityIds(model: string, entityData: any) {
        const idFields = this.getIdFields(model);
        const result: Record<string, unknown> = {};
        for (const idField of idFields) {
            result[idField.name] = entityData[idField.name];
        }
        return result;
    }

    /**
     * Initiates a transaction.
     */
    transaction<T>(db: CrudContract, action: (tx: CrudContract) => Promise<T>) {
        const fullDb = db as DbClientContract;
        if (fullDb['$transaction']) {
            return fullDb.$transaction(
                (tx) => {
                    (tx as any)[Symbol.for('nodejs.util.inspect.custom')] = 'PrismaClient$tx';
                    return action(tx);
                },
                {
                    maxWait: this.options.transactionMaxWait,
                    timeout: this.options.transactionTimeout,
                    isolationLevel: this.options.transactionIsolationLevel,
                }
            );
        } else {
            // already in transaction, don't nest
            return action(db);
        }
    }

    /**
     * Builds a reversed query for the given nested path.
     */
    async buildReversedQuery(
        db: CrudContract,
        context: NestedWriteVisitorContext,
        forMutationPayload = false,
        uncheckedOperation = false
    ) {
        let result, currQuery: any;
        let currField: FieldInfo | undefined;

        for (let i = context.nestingPath.length - 1; i >= 0; i--) {
            const { field, model, where } = context.nestingPath[i];

            // never modify the original where because it's shared in the structure
            const visitWhere = { ...where };
            if (model && where) {
                // make sure composite unique condition is flattened
                this.flattenGeneratedUniqueField(model, visitWhere);
            }

            if (!result) {
                // first segment (bottom), just use its where clause
                result = currQuery = { ...visitWhere };
                currField = field;
            } else {
                if (!currField) {
                    throw this.unknownError(`missing field in nested path`);
                }
                if (!currField.backLink) {
                    throw this.unknownError(`field ${currField.type}.${currField.name} doesn't have a backLink`);
                }

                const backLinkField = this.getModelField(currField.type, currField.backLink);
                if (!backLinkField) {
                    throw this.unknownError(`missing backLink field ${currField.backLink} in ${currField.type}`);
                }

                if (backLinkField.isArray && !forMutationPayload) {
                    // many-side of relationship, wrap with "some" query
                    currQuery[currField.backLink] = { some: { ...visitWhere } };
                    currQuery = currQuery[currField.backLink].some;
                } else {
                    const fkMapping = where && backLinkField.isRelationOwner && backLinkField.foreignKeyMapping;

                    // calculate if we should preserve the relation condition (e.g., { user: { id: 1 } })
                    const shouldPreserveRelationCondition =
                        // doing a mutation
                        forMutationPayload &&
                        // and it's not an unchecked mutate
                        !uncheckedOperation &&
                        // and the current segment is the direct parent (the last one is the mutate itself),
                        // the relation condition should be preserved and will be converted to a "connect" later
                        i === context.nestingPath.length - 2;

                    if (fkMapping && !shouldPreserveRelationCondition) {
                        // turn relation condition into foreign key condition, e.g.:
                        //     { user: { id: 1 } } => { userId: 1 }

                        let parentPk = visitWhere;
                        if (Object.keys(fkMapping).some((k) => !(k in parentPk) || parentPk[k] === undefined)) {
                            // it can happen that the parent condition actually doesn't contain all id fields
                            // （when the parent condition is not a primary key but unique constraints)
                            // and in such case we need to load it to get the pks

                            if (this.options.logPrismaQuery && this.logger.enabled('info')) {
                                this.logger.info(
                                    `[reverseLookup] \`findUniqueOrThrow\` ${model}: ${formatObject(where)}`
                                );
                            }
                            parentPk = await db[model].findUniqueOrThrow({
                                where,
                                select: this.makeIdSelection(model),
                            });
                        }

                        for (const [r, fk] of Object.entries<string>(fkMapping)) {
                            currQuery[fk] = parentPk[r];
                        }

                        if (i > 0) {
                            // prepare for the next segment
                            currQuery[currField.backLink] = {};
                        }
                    } else {
                        // preserve the original structure
                        currQuery[currField.backLink] = { ...visitWhere };
                    }

                    if (forMutationPayload && currQuery[currField.backLink]) {
                        // reconstruct compound unique field
                        currQuery[currField.backLink] = this.composeCompoundUniqueField(
                            backLinkField.type,
                            currQuery[currField.backLink]
                        );
                    }

                    currQuery = currQuery[currField.backLink];
                }
                currField = field;
            }
        }
        return result;
    }

    /**
     * Composes a compound unique field from multiple fields. E.g.:  { a: '1', b: '1' } => { a_b: { a: '1', b: '1' } }.
     */
    composeCompoundUniqueField(model: string, fieldData: any) {
        const uniqueConstraints = getUniqueConstraints(this.options.modelMeta, model);
        if (!uniqueConstraints) {
            return fieldData;
        }

        const result: any = this.safeClone(fieldData);
        for (const [name, constraint] of Object.entries(uniqueConstraints)) {
            if (constraint.fields.length > 1 && constraint.fields.every((f) => fieldData[f] !== undefined)) {
                // multi-field unique constraint, compose it
                result[name] = constraint.fields.reduce<any>(
                    (prev, field) => ({ ...prev, [field]: fieldData[field] }),
                    {}
                );
                constraint.fields.forEach((f) => delete result[f]);
            }
        }
        return result;
    }

    /**
     * Flattens a generated unique field. E.g.: { a_b: { a: '1', b: '1' } } => { a: '1', b: '1' }.
     */
    flattenGeneratedUniqueField(model: string, args: any) {
        const uniqueConstraints = getUniqueConstraints(this.options.modelMeta, model);
        if (uniqueConstraints && Object.keys(uniqueConstraints).length > 0) {
            for (const [field, value] of Object.entries<any>(args)) {
                if (
                    uniqueConstraints[field] &&
                    uniqueConstraints[field].fields.length > 1 &&
                    typeof value === 'object'
                ) {
                    // multi-field unique constraint, flatten it
                    delete args[field];
                    if (value) {
                        for (const [f, v] of Object.entries(value)) {
                            args[f] = v;
                        }
                    }
                }
            }
        }
    }

    validationError(message: string) {
        return prismaClientValidationError(this.prisma, this.options.prismaModule, message);
    }

    unknownError(message: string) {
        return prismaClientUnknownRequestError(this.prisma, this.options.prismaModule, message, {
            clientVersion: getVersion(),
        });
    }

    getModelFields(model: string) {
        return getModelInfo(this.options.modelMeta, model)?.fields;
    }

    /**
     * Gets information for a specific model field.
     */
    getModelField(model: string, field: string) {
        return resolveField(this.options.modelMeta, model, field);
    }

    /**
     * Clones an object and makes sure it's not empty.
     */
    safeClone(value: unknown): any {
        return value ? clone(value) : value === undefined || value === null ? {} : value;
    }

    getDelegateConcreteModel(model: string, data: any) {
        if (!data || typeof data !== 'object') {
            return model;
        }

        const modelInfo = getModelInfo(this.options.modelMeta, model);
        if (modelInfo?.discriminator) {
            // model has a discriminator so it can be a polymorphic base,
            // need to find the concrete model
            const concreteModelName = data[modelInfo.discriminator];
            if (typeof concreteModelName === 'string' && concreteModelName) {
                return concreteModelName;
            }
        }

        return model;
    }

    /**
     * Gets relation info for a foreign key field.
     */
    getRelationForForeignKey(model: string, fkField: string) {
        const modelInfo = getModelInfo(this.options.modelMeta, model);
        if (!modelInfo) {
            return undefined;
        }

        for (const field of Object.values(modelInfo.fields)) {
            if (field.foreignKeyMapping) {
                const entry = Object.entries(field.foreignKeyMapping).find(([, v]) => v === fkField);
                if (entry) {
                    return { relation: field, idField: entry[0], fkField: entry[1] };
                }
            }
        }

        return undefined;
    }

    /**
     * Gets fields of object with defined values.
     */
    getFieldsWithDefinedValues(data: object) {
        if (!data) {
            return [];
        }
        return Object.entries(data)
            .filter(([, v]) => v !== undefined)
            .map(([k]) => k);
    }
}