In v6, method convertToDatabaseValueSQL() from custom type is not invoked properly when calling it within the nested embeddables.

[sevenryze]

Describe the bug

Method convertToDatabaseValueSQL() from custom type is not invoked properly when calling it within the nested embeddables. It gets error: DriverException: Trying to serialize raw SQL fragment.

Reproduction

import {
  Embeddable,
  Embedded,
  Entity,
  MikroORM,
  PrimaryKey,
  Property,
  Type,
} from '@mikro-orm/sqlite';

class GeoPoint {

  constructor(
    readonly latitude: number,
    readonly longitude: number,
  ) {}

}

class GeoPointType extends Type<GeoPoint | undefined, string | undefined> {

  override convertToDatabaseValue(
    value: GeoPoint | undefined,
  ): string | undefined {
    if (!value) {
      return value;
    }

    return `point(${value.latitude} ${value.longitude})`;
  }

  override convertToJSValue(value: string | undefined): GeoPoint | undefined {
    const m = value?.match(/point\((-?\d+(\.\d+)?) (-?\d+(\.\d+)?)\)/i);

    if (!m) {
      return undefined;
    }

    return new GeoPoint(+m[1], +m[3]);
  }

  override convertToJSValueSQL(key: string) {
    return `ST_AsText(${key})`;
  }

  override convertToDatabaseValueSQL(key: string) {
    return `ST_PointFromText(${key}, 4326)`;
  }

  override getColumnType(): string {
    return 'point SRID 4326';
  }

}

@Embeddable()
class SnapshotMore {

  @Property({
    type: GeoPointType,
  })
  position!: GeoPoint;

  @Property({
    nullable: true,
  })
  description?: string;

}

@Embeddable()
class Snapshot {

  @Embedded(() => SnapshotMore, {
    object: true,
  })
  ref!: SnapshotMore;

}

@Entity()
class Outer {

  @PrimaryKey()
  id!: number;

  @Embedded(() => Snapshot, {
    object: true,
  })
  bigSnapshot!: Snapshot;

}

describe('GH issue 1003', () => {

  let orm: MikroORM;

  beforeAll(async () => {
    orm = await MikroORM.init({
      dbName: ':memory:',
      debug: true,
      entities: [Outer, Snapshot],
    });
    await orm.schema.createSchema();
  });

  afterAll(async () => {
    await orm.close(true);
  });

  test(`GH issue 1003`, async () => {
    const em = orm.em.fork();

    const snapshotMore = new SnapshotMore();
    snapshotMore.position = new GeoPoint(21, 32);

    const snapshot = new Snapshot();
    snapshot.ref = snapshotMore;

    const outer = new Outer();
    outer.id = 123_456;
    outer.bigSnapshot = snapshot;

    await em.persistAndFlush([outer]);

    const result = await em.findOne(Outer, {
      id: outer.id,
    });
  });

});

What driver are you using?

@mikro-orm/mysql

MikroORM version

6.0.0-rc3

Node.js version

v20.3.1

Operating system

MacOS 14.2.1

Validations

• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Slack.
• The provided reproduction is a minimal reproducible example of the bug.

[B4nan]

This is a wontfix, those SQL converters are only supported on actual database columns, while a property on nested object embedded entity is just a part of a JSON object.

I will look into why it fails this way, but the bottom line is - you are trying something that's not supposed to be working (the SQL converter is not supposed to be fired at all for object embeddables).

[sevenryze]

Understood, it makes sense. Also, thank you for such a quick response!

[B4nan]

I think the proper fix to this will be to skip the convertors completely if we see we are inside object embedded property, that will fix it universally for all drivers.

[B4nan]

This should help 83b989e