@mikro-orm/core 7.0.0-dev.21 → 7.0.0-dev.211

package/utils/EntityComparator.d.ts

@@ -1,6 +1,8 @@
-import type { EntityData, EntityDictionary, EntityMetadata, EntityProperty, IMetadataStorage } from '../typings.js';
+import type { EntityData, EntityDictionary, EntityMetadata, EntityName, EntityProperty, IMetadataStorage } from '../typings.js';
 import type { Platform } from '../platforms/Platform.js';
-type Comparator<T> = (a: T, b: T) => EntityData<T>;
+type Comparator<T> = (a: T, b: T, options?: {
+    includeInverseSides?: boolean;
+}) => EntityData<T>;
 type ResultMapper<T> = (result: EntityData<T>) => EntityData<T> | null;
 type SnapshotGenerator<T> = (entity: T) => EntityData<T>;
 type CompositeKeyPart = string | CompositeKeyPart[];
@@ -18,17 +20,19 @@ export declare class EntityComparator {
     /**
      * Computes difference between two entities.
      */
-    diffEntities<T>(entityName: string, a: EntityData<T>, b: EntityData<T>): EntityData<T>;
-    matching<T>(entityName: string, a: EntityData<T>, b: EntityData<T>): boolean;
+    diffEntities<T extends object>(entityName: EntityName<T>, a: EntityData<T>, b: EntityData<T>, options?: {
+        includeInverseSides?: boolean;
+    }): EntityData<T>;
+    matching<T extends object>(entityName: EntityName<T>, a: EntityData<T>, b: EntityData<T>): boolean;
     /**
      * Removes ORM specific code from entities and prepares it for serializing. Used before change set computation.
      * References will be mapped to primary keys, collections to arrays of primary keys.
      */
-    prepareEntity<T>(entity: T): EntityData<T>;
+    prepareEntity<T extends object>(entity: T): EntityData<T>;
     /**
      * Maps database columns to properties.
      */
-    mapResult<T>(entityName: string, result: EntityDictionary<T>): EntityData<T>;
+    mapResult<T>(meta: EntityMetadata<T>, result: EntityDictionary<T>): EntityData<T>;
     /**
      * @internal Highly performance-sensitive method.
      */
@@ -44,7 +48,7 @@ export declare class EntityComparator {
     /**
      * @internal Highly performance-sensitive method.
      */
-    getSnapshotGenerator<T>(entityName: string): SnapshotGenerator<T>;
+    getSnapshotGenerator<T>(entityName: EntityName<T>): SnapshotGenerator<T>;
     /**
      * @internal
      */
@@ -60,7 +64,7 @@ export declare class EntityComparator {
     /**
      * @internal Highly performance-sensitive method.
      */
-    getResultMapper<T>(entityName: string): ResultMapper<T>;
+    getResultMapper<T>(meta: EntityMetadata<T>): ResultMapper<T>;
     private getPropertyCondition;
     private getEmbeddedArrayPropertySnapshot;
     /**
@@ -74,7 +78,7 @@ export declare class EntityComparator {
     /**
      * @internal Highly performance-sensitive method.
      */
-    getEntityComparator<T extends object>(entityName: string): Comparator<T>;
+    getEntityComparator<T extends object>(entityName: EntityName<T>): Comparator<T>;
     private getGenericComparator;
     private getPropertyComparator;
     private wrap;

package/utils/EntityComparator.js

@@ -2,7 +2,8 @@ import { clone } from './clone.js';
 import { ReferenceKind } from '../enums.js';
 import { compareArrays, compareBooleans, compareBuffers, compareObjects, equals, parseJsonSafe, Utils } from './Utils.js';
 import { JsonType } from '../types/JsonType.js';
-import { RawQueryFragment } from './RawQueryFragment.js';
+import { Raw } from './RawQueryFragment.js';
+import { EntityIdentifier } from '../entity/EntityIdentifier.js';
 export class EntityComparator {
     metadata;
     platform;
@@ -20,9 +21,9 @@ export class EntityComparator {
     /**
      * Computes difference between two entities.
      */
-    diffEntities(entityName, a, b) {
+    diffEntities(entityName, a, b, options) {
         const comparator = this.getEntityComparator(entityName);
-        return Utils.callCompiledFunction(comparator, a, b);
+        return Utils.callCompiledFunction(comparator, a, b, options);
     }
     matching(entityName, a, b) {
         const diff = this.diffEntities(entityName, a, b);
@@ -33,22 +34,22 @@ export class EntityComparator {
      * References will be mapped to primary keys, collections to arrays of primary keys.
      */
     prepareEntity(entity) {
-        const generator = this.getSnapshotGenerator(entity.constructor.name);
+        const generator = this.getSnapshotGenerator(entity.constructor);
         return Utils.callCompiledFunction(generator, entity);
     }
     /**
      * Maps database columns to properties.
      */
-    mapResult(entityName, result) {
-        const mapper = this.getResultMapper(entityName);
+    mapResult(meta, result) {
+        const mapper = this.getResultMapper(meta);
         return Utils.callCompiledFunction(mapper, result);
     }
     /**
      * @internal Highly performance-sensitive method.
      */
     getPkGetter(meta) {
-        const exists = this.pkGetters.get(meta.className);
-        /* v8 ignore next 3 */
+        const exists = this.pkGetters.get(meta);
+        /* v8 ignore next */
         if (exists) {
             return exists;
         }
@@ -90,15 +91,15 @@ export class EntityComparator {
         const code = `// compiled pk serializer for entity ${meta.className}\n`
             + `return function(entity) {\n${lines.join('\n')}\n}`;
         const pkSerializer = Utils.createFunction(context, code);
-        this.pkGetters.set(meta.className, pkSerializer);
+        this.pkGetters.set(meta, pkSerializer);
         return pkSerializer;
     }
     /**
      * @internal Highly performance-sensitive method.
      */
     getPkGetterConverted(meta) {
-        const exists = this.pkGettersConverted.get(meta.className);
-        /* v8 ignore next 3 */
+        const exists = this.pkGettersConverted.get(meta);
+        /* v8 ignore next */
         if (exists) {
             return exists;
         }
@@ -140,21 +141,22 @@ export class EntityComparator {
         const code = `// compiled pk getter (with converted custom types) for entity ${meta.className}\n`
             + `return function(entity) {\n${lines.join('\n')}\n}`;
         const pkSerializer = Utils.createFunction(context, code);
-        this.pkGettersConverted.set(meta.className, pkSerializer);
+        this.pkGettersConverted.set(meta, pkSerializer);
         return pkSerializer;
     }
     /**
      * @internal Highly performance-sensitive method.
      */
     getPkSerializer(meta) {
-        const exists = this.pkSerializers.get(meta.className);
-        /* v8 ignore next 3 */
+        const exists = this.pkSerializers.get(meta);
+        /* v8 ignore next */
         if (exists) {
             return exists;
         }
         const lines = [];
         const context = new Map();
         context.set('getCompositeKeyValue', (val) => Utils.flatten(Utils.getCompositeKeyValue(val, meta, 'convertToDatabaseValue', this.platform)));
+        context.set('getPrimaryKeyHash', (val) => Utils.getPrimaryKeyHash(Utils.asArray(val)));
         if (meta.primaryKeys.length > 1) {
             lines.push(`  const pks = entity.__helper.__pk ? getCompositeKeyValue(entity.__helper.__pk) : [`);
             meta.primaryKeys.forEach(pk => {
@@ -170,30 +172,39 @@ export class EntityComparator {
         }
         else {
             const pk = meta.primaryKeys[0];
-            if (meta.properties[pk].kind !== ReferenceKind.SCALAR) {
+            const prop = meta.properties[pk];
+            if (prop.kind !== ReferenceKind.SCALAR) {
                 lines.push(`  if (entity${this.wrap(pk)} != null && (entity${this.wrap(pk)}.__entity || entity${this.wrap(pk)}.__reference)) return entity${this.wrap(pk)}.__helper.getSerializedPrimaryKey();`);
             }
             const serializedPrimaryKey = meta.props.find(p => p.serializedPrimaryKey);
             if (serializedPrimaryKey) {
                 lines.push(`  return '' + entity.${serializedPrimaryKey.name};`);
             }
-            lines.push(`  return '' + entity.${meta.primaryKeys[0]};`);
+            else if (prop.customType) {
+                const convertorKey = this.registerCustomType(meta.properties[pk], context);
+                const idx = this.tmpIndex++;
+                lines.push(`  const val_${idx} = convertToDatabaseValue_${convertorKey}(entity${this.wrap(pk)});`);
+                lines.push(`  return getPrimaryKeyHash(val_${idx});`);
+            }
+            else {
+                lines.push(`  return '' + entity${this.wrap(pk)};`);
+            }
         }
         const code = `// compiled pk serializer for entity ${meta.className}\n`
             + `return function(entity) {\n${lines.join('\n')}\n}`;
         const pkSerializer = Utils.createFunction(context, code);
-        this.pkSerializers.set(meta.className, pkSerializer);
+        this.pkSerializers.set(meta, pkSerializer);
         return pkSerializer;
     }
     /**
      * @internal Highly performance-sensitive method.
      */
     getSnapshotGenerator(entityName) {
-        const exists = this.snapshotGenerators.get(entityName);
+        const meta = this.metadata.find(entityName);
+        const exists = this.snapshotGenerators.get(meta);
         if (exists) {
             return exists;
         }
-        const meta = this.metadata.find(entityName);
         const lines = [];
         const context = new Map();
         context.set('clone', clone);
@@ -211,7 +222,7 @@ export class EntityComparator {
             .forEach(prop => lines.push(this.getPropertySnapshot(meta, prop, context, this.wrap(prop.name), this.wrap(prop.name), [prop.name])));
         const code = `return function(entity) {\n  const ret = {};\n${lines.join('\n')}\n  return ret;\n}`;
         const snapshotGenerator = Utils.createFunction(context, code);
-        this.snapshotGenerators.set(entityName, snapshotGenerator);
+        this.snapshotGenerators.set(meta, snapshotGenerator);
         return snapshotGenerator;
     }
     /**
@@ -261,12 +272,11 @@ export class EntityComparator {
     /**
      * @internal Highly performance-sensitive method.
      */
-    getResultMapper(entityName) {
-        const exists = this.mappers.get(entityName);
+    getResultMapper(meta) {
+        const exists = this.mappers.get(meta);
         if (exists) {
             return exists;
         }
-        const meta = this.metadata.get(entityName);
         const lines = [];
         const context = new Map();
         const tz = this.platform.getTimezone();
@@ -274,10 +284,14 @@ export class EntityComparator {
             lines.push(`${padding}    if (${value} == null || ${value} instanceof Date) {`);
             lines.push(`${padding}      ${key} = ${value};`);
             if (!tz || tz === 'local') {
+                lines.push(`${padding}    } else if (typeof ${value} === 'bigint') {`);
+                lines.push(`${padding}      ${key} = parseDate(Number(${value}));`);
                 lines.push(`${padding}    } else {`);
                 lines.push(`${padding}      ${key} = parseDate(${value});`);
             }
             else {
+                lines.push(`${padding}    } else if (typeof ${value} === 'bigint') {`);
+                lines.push(`${padding}      ${key} = parseDate(Number(${value}));`);
                 lines.push(`${padding}    } else if (typeof ${value} === 'number' || ${value}.includes('+') || ${value}.lastIndexOf('-') > 10 || ${value}.endsWith('Z')) {`);
                 lines.push(`${padding}      ${key} = parseDate(${value});`);
                 lines.push(`${padding}    } else {`);
@@ -321,9 +335,9 @@ export class EntityComparator {
                     context.set(`mapEmbeddedResult_${idx}`, (data) => {
                         const item = parseJsonSafe(data);
                         if (Array.isArray(item)) {
-                            return item.map(row => row == null ? row : this.getResultMapper(prop.type)(row));
+                            return item.map(row => row == null ? row : this.getResultMapper(prop.targetMeta)(row));
                         }
-                        return item == null ? item : this.getResultMapper(prop.type)(item);
+                        return item == null ? item : this.getResultMapper(prop.targetMeta)(item);
                     });
                     lines.push(`${padding}  if (typeof ${this.propName(prop.fieldNames[0])} !== 'undefined') {`);
                     lines.push(`${padding}    ret${this.wrap(prop.name)} = ${this.propName(prop.fieldNames[0])} == null ? ${this.propName(prop.fieldNames[0])} : mapEmbeddedResult_${idx}(${this.propName(prop.fieldNames[0])});`);
@@ -352,11 +366,11 @@ export class EntityComparator {
         else {
             mapEntityProperties(meta);
         }
-        lines.push(`  for (let k in result) { if (Object.hasOwn(result, k) && !mapped[k]) ret[k] = result[k]; }`);
+        lines.push(`  for (let k in result) { if (Object.hasOwn(result, k) && !mapped[k] && ret[k] === undefined) ret[k] = result[k]; }`);
         const code = `// compiled mapper for entity ${meta.className}\n`
             + `return function(result) {\n  const ret = {};\n${lines.join('\n')}\n  return ret;\n}`;
         const resultMapper = Utils.createFunction(context, code);
-        this.mappers.set(entityName, resultMapper);
+        this.mappers.set(meta, resultMapper);
         return resultMapper;
     }
     getPropertyCondition(path) {
@@ -407,11 +421,21 @@ export class EntityComparator {
     }
     getEmbeddedPropertySnapshot(meta, prop, context, level, path, dataKey, object = prop.object) {
         const padding = ' '.repeat(level * 2);
+        const nullCond = `entity${path.map(k => this.wrap(k)).join('')} === null`;
         let ret = `${level === 1 ? '' : '\n'}`;
         if (object) {
-            const nullCond = `entity${path.map(k => this.wrap(k)).join('')} === null`;
             ret += `${padding}if (${nullCond}) ret${dataKey} = null;\n`;
         }
+        else {
+            ret += `${padding}if (${nullCond}) {\n`;
+            ret += meta.props.filter(p => p.embedded?.[0] === prop.name
+                // object for JSON embeddable
+                && (p.object || (p.persist !== false))).map(childProp => {
+                const childDataKey = meta.embeddable || prop.object ? dataKey + this.wrap(childProp.embedded[1]) : this.wrap(childProp.name);
+                return `${padding}  ret${childDataKey} = null;`;
+            }).join('\n') + `\n`;
+            ret += `${padding}}\n`;
+        }
         const cond = `entity${path.map(k => this.wrap(k)).join('')} != null`;
         ret += `${padding}if (${cond}) {\n`;
         if (object) {
@@ -456,8 +480,8 @@ export class EntityComparator {
     registerCustomType(prop, context) {
         const convertorKey = this.safeKey(prop.name);
         context.set(`convertToDatabaseValue_${convertorKey}`, (val) => {
-            /* v8 ignore next 3 */
-            if (RawQueryFragment.isKnownFragment(val)) {
+            /* v8 ignore next */
+            if (Raw.isKnownFragment(val)) {
                 return val;
             }
             return prop.customType.convertToDatabaseValue(val, this.platform, { mode: 'serialization' });
@@ -486,6 +510,23 @@ export class EntityComparator {
                     ret += `    ret${dataKey} = entity${entityKey};\n`;
                 }
             }
+            else if (prop.targetKey) {
+                // When targetKey is set, extract that property value instead of the PK
+                const targetProp = prop.targetMeta?.properties[prop.targetKey];
+                ret += `    if (entity${entityKey} === null) {\n`;
+                ret += `      ret${dataKey} = null;\n`;
+                ret += `    } else if (typeof entity${entityKey} !== 'undefined') {\n`;
+                ret += `      const val${level} = entity${entityKey}${unwrap};\n`;
+                if (targetProp?.customType) {
+                    // If targetKey property has a custom type, convert to database value
+                    const convertorKey = this.registerCustomType(targetProp, context);
+                    ret += `      ret${dataKey} = convertToDatabaseValue_${convertorKey}(val${level}?.${prop.targetKey});\n`;
+                }
+                else {
+                    ret += `      ret${dataKey} = val${level}?.${prop.targetKey};\n`;
+                }
+                ret += `    }\n`;
+            }
             else {
                 const toArray = (val) => {
                     if (Utils.isPlainObject(val)) {
@@ -494,8 +535,11 @@ export class EntityComparator {
                     return val;
                 };
                 context.set('toArray', toArray);
+                context.set('EntityIdentifier', EntityIdentifier);
                 ret += `    if (entity${entityKey} === null) {\n`;
                 ret += `      ret${dataKey} = null;\n`;
+                ret += `    } else if (entity${entityKey}?.__helper.__identifier && !entity${entityKey}.__helper.hasPrimaryKey()) {\n`;
+                ret += `      ret${dataKey} = entity${entityKey}?.__helper.__identifier;\n`;
                 ret += `    } else if (typeof entity${entityKey} !== 'undefined') {\n`;
                 ret += `      ret${dataKey} = toArray(entity${entityKey}.__helper.getPrimaryKey(true));\n`;
                 ret += `    }\n`;
@@ -519,11 +563,11 @@ export class EntityComparator {
      * @internal Highly performance-sensitive method.
      */
     getEntityComparator(entityName) {
-        const exists = this.comparators.get(entityName);
+        const meta = this.metadata.find(entityName);
+        const exists = this.comparators.get(meta);
         if (exists) {
             return exists;
         }
-        const meta = this.metadata.find(entityName);
         const lines = [];
         const context = new Map();
         context.set('compareArrays', compareArrays);
@@ -531,17 +575,27 @@ export class EntityComparator {
         context.set('compareBuffers', compareBuffers);
         context.set('compareObjects', compareObjects);
         context.set('equals', equals);
-        meta.comparableProps.forEach(prop => {
+        for (const prop of meta.comparableProps) {
             lines.push(this.getPropertyComparator(prop, context));
-        });
+        }
+        // also compare 1:1 inverse sides, important for `factory.mergeData`
+        lines.push(`if (options?.includeInverseSides) {`);
+        for (const prop of meta.bidirectionalRelations) {
+            if (prop.kind === ReferenceKind.ONE_TO_ONE && !prop.owner && prop.hydrate !== false) {
+                lines.push(this.getPropertyComparator(prop, context));
+            }
+        }
+        lines.push(`}`);
         const code = `// compiled comparator for entity ${meta.className}\n`
-            + `return function(last, current) {\n  const diff = {};\n${lines.join('\n')}\n  return diff;\n}`;
+            + `return function(last, current, options) {\n  const diff = {};\n${lines.join('\n')}\n  return diff;\n}`;
         const comparator = Utils.createFunction(context, code);
-        this.comparators.set(entityName, comparator);
+        this.comparators.set(meta, comparator);
         return comparator;
     }
     getGenericComparator(prop, cond) {
-        return `  if (current${prop} == null && last${prop} == null) {\n\n` +
+        return `  if (current${prop} === null && last${prop} === undefined) {\n` +
+            `    diff${prop} = current${prop};\n` +
+            `  } else if (current${prop} == null && last${prop} == null) {\n\n` +
             `  } else if ((current${prop} != null && last${prop} == null) || (current${prop} == null && last${prop} != null)) {\n` +
             `    diff${prop} = current${prop};\n` +
             `  } else if (${cond}) {\n` +
@@ -551,18 +605,23 @@ export class EntityComparator {
     getPropertyComparator(prop, context) {
         let type = prop.type.toLowerCase();
         if (prop.kind !== ReferenceKind.SCALAR && prop.kind !== ReferenceKind.EMBEDDED) {
-            const meta2 = this.metadata.find(prop.type);
+            const meta2 = prop.targetMeta;
             if (meta2.primaryKeys.length > 1) {
                 type = 'array';
             }
             else {
-                type = meta2.properties[meta2.primaryKeys[0]].type.toLowerCase();
+                type = meta2.getPrimaryProp().type.toLowerCase();
             }
         }
         if (prop.customType) {
             if (prop.customType.compareValues) {
                 const idx = this.tmpIndex++;
-                context.set(`compareValues_${idx}`, (a, b) => prop.customType.compareValues(a, b));
+                context.set(`compareValues_${idx}`, (a, b) => {
+                    if (Raw.isKnownFragment(a) || Raw.isKnownFragment(b)) {
+                        return Raw.getKnownFragment(a) === Raw.getKnownFragment(b);
+                    }
+                    return prop.customType.compareValues(a, b);
+                });
                 return this.getGenericComparator(this.wrap(prop.name), `!compareValues_${idx}(last${this.wrap(prop.name)}, current${this.wrap(prop.name)})`);
             }
             type = prop.customType.compareAsType().toLowerCase();
@@ -582,10 +641,10 @@ export class EntityComparator {
         if (['buffer', 'uint8array'].includes(type)) {
             return this.getGenericComparator(this.wrap(prop.name), `!compareBuffers(last${this.wrap(prop.name)}, current${this.wrap(prop.name)})`);
         }
-        if (['date'].includes(type)) {
+        if (type === 'date') {
             return this.getGenericComparator(this.wrap(prop.name), `last${this.wrap(prop.name)}.valueOf() !== current${this.wrap(prop.name)}.valueOf()`);
         }
-        if (['objectid'].includes(type)) {
+        if (type === 'objectid') {
             // We might be comparing PK to object, in case we compare with cached data of populated entity
             // in such case we just ignore the comparison and fallback to `equals()` (which will still mark
             // it as not equal as we compare PK to plain object).

package/utils/QueryHelper.d.ts

@@ -1,14 +1,22 @@
-import type { Dictionary, EntityMetadata, EntityProperty, FilterDef, FilterQuery } from '../typings.js';
+import type { Dictionary, EntityMetadata, EntityName, EntityProperty, FilterDef, FilterQuery } from '../typings.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { MetadataStorage } from '../metadata/MetadataStorage.js';
+import type { FilterOptions } from '../drivers/IDatabaseDriver.js';
+/** @internal */
 export declare class QueryHelper {
     static readonly SUPPORTED_OPERATORS: string[];
     static processParams(params: unknown): any;
-    static processObjectParams<T extends object>(params?: T): T;
+    static processObjectParams<T extends Dictionary>(params?: T): T;
+    /**
+     * converts `{ account: { $or: [ [Object], [Object] ] } }`
+     * to `{ $or: [ { account: [Object] }, { account: [Object] } ] }`
+     */
+    static liftGroupOperators<T extends object>(where: Dictionary, meta: EntityMetadata<T>, metadata: MetadataStorage, key?: string): string | undefined;
     static inlinePrimaryKeyObjects<T extends object>(where: Dictionary, meta: EntityMetadata<T>, metadata: MetadataStorage, key?: string): boolean;
     static processWhere<T extends object>(options: ProcessWhereOptions<T>): FilterQuery<T>;
-    static getActiveFilters(entityName: string, options: Dictionary<boolean | Dictionary> | string[] | boolean, filters: Dictionary<FilterDef>): FilterDef[];
-    static isFilterActive(entityName: string, filterName: string, filter: FilterDef, options: Dictionary<boolean | Dictionary>): boolean;
+    static getActiveFilters<T>(meta: EntityMetadata<T>, options: FilterOptions | undefined, filters: Dictionary<FilterDef>): FilterDef[];
+    static mergePropertyFilters(propFilters: FilterOptions | undefined, options: FilterOptions | undefined): FilterOptions | undefined;
+    static isFilterActive<T>(meta: EntityMetadata<T>, filterName: string, filter: FilterDef, options: Dictionary<boolean | Dictionary>): boolean;
     static processCustomType<T extends object>(prop: EntityProperty<T>, cond: FilterQuery<T>, platform: Platform, key?: string, fromQuery?: boolean): FilterQuery<T>;
     private static isSupportedOperator;
     private static processJsonCondition;
@@ -17,11 +25,11 @@ export declare class QueryHelper {
 }
 interface ProcessWhereOptions<T> {
     where: FilterQuery<T>;
-    entityName: string;
+    entityName: EntityName<T>;
     metadata: MetadataStorage;
     platform: Platform;
     aliased?: boolean;
-    aliasMap?: Dictionary<string>;
+    aliasMap?: Dictionary<EntityName>;
     convertCustomTypes?: boolean;
     root?: boolean;
     type?: 'where' | 'orderBy';