fix(core): ensure correct state of custom typed data after merging to existing results

Closes #6926

Author: B4nan

packages/core/src/entity/EntityFactory.ts

@@ -205,6 +205,11 @@ export class EntityFactory {
  diff2[key] = entity[prop.name] ? helper(entity[prop.name]!).getPrimaryKey(options.convertCustomTypes) as EntityDataValue<T> : null;
  }
 
+ if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE, ReferenceKind.SCALAR].includes(prop.kind) && prop.customType?.ensureComparable(meta, prop) && diff2[key] != null) {
+ const converted = prop.customType.convertToJSValue(diff2[key], this.platform, { force: true });
+ diff2[key] = prop.customType.convertToDatabaseValue(converted, this.platform, { fromQuery: true });
+ }
+
  originalEntityData[key] = diff2[key] === null ? nullVal : diff2[key];
  helper(entity).__loadedProperties.add(key as string);
  });

packages/core/src/platforms/Platform.ts

@@ -393,13 +393,7 @@ export abstract class Platform {
  return JSON.stringify(value);
  }
 
- convertJsonToJSValue(value: unknown, prop: EntityProperty): unknown {
- const isObjectEmbedded = prop.embedded && prop.object;
-
- if ((this.convertsJsonAutomatically() || isObjectEmbedded) && ['json', 'jsonb', this.getJsonDeclarationSQL()].includes(prop.columnTypes[0])) {
- return value;
- }
-
+ convertJsonToJSValue(value: unknown, context?: TransformContext): unknown {
  return parseJsonSafe(value);
  }
 

packages/core/src/types/JsonType.ts

@@ -20,8 +20,15 @@ export class JsonType extends Type<unknown, string | null> {
  return key + platform.castColumn(this.prop);
  }
 
- override convertToJSValue(value: string | unknown, platform: Platform): unknown {
- return platform.convertJsonToJSValue(value, this.prop!);
+ override convertToJSValue(value: string | unknown, platform: Platform, context?: TransformContext): unknown {
+ const isJsonColumn = ['json', 'jsonb', platform.getJsonDeclarationSQL()].includes(this.prop!.columnTypes[0]);
+ const isObjectEmbedded = this.prop!.embedded && this.prop!.object;
+
+ if ((platform.convertsJsonAutomatically() || isObjectEmbedded) && isJsonColumn && !context?.force) {
+ return value;
+ }
+
+ return platform.convertJsonToJSValue(value, context);
  }
 
  override getColumnType(prop: EntityProperty, platform: Platform): string {

packages/core/src/types/Type.ts

@@ -4,6 +4,7 @@ import type { Constructor, EntityMetadata, EntityProperty } from '../typings';
 
 export interface TransformContext {
  fromQuery?: boolean;
+ force?: boolean;
  key?: string;
  mode?: 'hydration' | 'query' | 'query-data' | 'discovery' | 'serialization';
 }
@@ -32,7 +33,7 @@ export abstract class Type<JSType = string, DBType = JSType> {
  /**
  * Converts a value from its database representation to its JS representation of this type.
  */
- convertToJSValue(value: DBType, platform: Platform): JSType {
+ convertToJSValue(value: DBType, platform: Platform, context?: TransformContext): JSType {
  return value as unknown as JSType;
  }
 

packages/core/src/unit-of-work/UnitOfWork.ts

@@ -130,8 +130,8 @@ export class UnitOfWork {
  }
 
  if (prop.hydrate === false && prop.customType?.ensureComparable(wrapped.__meta, prop)) {
- const converted = prop.customType.convertToJSValue(data[key], this.platform);
- data[key] = prop.customType.convertToDatabaseValue(converted, this.platform);
+ const converted = prop.customType.convertToJSValue(data[key], this.platform, { key, mode: 'hydration', force: true });
+ data[key] = prop.customType.convertToDatabaseValue(converted, this.platform, { key, mode: 'hydration' });
  }
 
  if (forceUndefined) {

packages/mongodb/src/MongoPlatform.ts

@@ -1,8 +1,23 @@
 import { ObjectId } from 'bson';
 import {
- Platform, MongoNamingStrategy, Utils, ReferenceKind, MetadataError, type
- IPrimaryKey, type Primary, type NamingStrategy, type Constructor, type EntityRepository, type EntityProperty, type
- PopulateOptions, type EntityMetadata, type IDatabaseDriver, type EntityManager, type Configuration, type MikroORM,
+ Platform,
+ MongoNamingStrategy,
+ Utils,
+ ReferenceKind,
+ MetadataError,
+ type IPrimaryKey,
+ type Primary,
+ type NamingStrategy,
+ type Constructor,
+ type EntityRepository,
+ type EntityProperty,
+ type PopulateOptions,
+ type EntityMetadata,
+ type IDatabaseDriver,
+ type EntityManager,
+ type Configuration,
+ type MikroORM,
+ type TransformContext,
 } from '@mikro-orm/core';
 import { MongoExceptionConverter } from './MongoExceptionConverter';
 import { MongoEntityRepository } from './MongoEntityRepository';
@@ -83,7 +98,7 @@ export class MongoPlatform extends Platform {
  return Utils.copy(value);
  }
 
- override convertJsonToJSValue(value: unknown, prop: EntityProperty): unknown {
+ override convertJsonToJSValue(value: unknown, context?: TransformContext): unknown {
  return value;
  }
 

tests/issues/GH6723.test.ts

@@ -1,18 +1,24 @@
-import { MikroORM, ArrayType, Entity, JsonType, PrimaryKey, Property } from '@mikro-orm/postgresql';
+import {
+ ArrayType,
+ Entity,
+ JsonType,
+ MikroORM,
+ PrimaryKey,
+ Property,
+} from '@mikro-orm/postgresql';
 import { mockLogger } from '../helpers';
 
-type Child = {
- email: string;
-};
-
 @Entity()
-export class User {
+class User {
 
  @PrimaryKey()
  id!: number;
 
  @Property({ nullable: true, type: JsonType })
- children?: Child[];
+ children?: any[];
+
+ @Property()
+ email!: string;
 
  @Property({ type: ArrayType, nullable: true, persist: true, hydrate: true })
  get childEmails(): string[] | undefined {
@@ -36,6 +42,7 @@ beforeAll(async () => {
  await orm.schema.refreshDatabase();
 
  orm.em.create(User, {
+ email: 'test@example.com',
  children: [{
  email: 'test@example.com',
  }],
@@ -48,7 +55,7 @@ afterAll(async () => {
  await orm.close(true);
 });
 
-test('should not try to persist persisted getter if its value has not changed', async () => {
+test('should not try to persist persisted getter if its value has not changed 1', async () => {
  const r = await orm.em.findAll(User);
 
  const mock = mockLogger(orm);
@@ -60,3 +67,11 @@ test('should not try to persist persisted getter if its value has not changed',
  // child_emails is hydrated, and its value didn't change
  expect(mock.mock.calls[1][0]).toMatch('update "user" set "children" = \'[{"email":"test@example.com"},{"email":"test2"}]\', "child_emails2" = \'{test@example.com,test2}\' where "id" = 1');
 });
+
+test('should not try to persist persisted getter if its value has not changed 2', async () => {
+ await orm.em.findOneOrFail(User, 1);
+ await orm.em.findOneOrFail(User, { email: 'test@example.com' });
+ const mock = mockLogger(orm);
+ await orm.em.flush();
+ expect(mock).not.toHaveBeenCalled();
+});