Order by doesn't work on embedded field (Mongodb)

[Trobyss]

Describe the bug

Hey !

I'm trying to sort on embedded field but got these error:

DriverException: Invalid sort direction: {"date":{"arrival":"ASC"}} at MongoExceptionConverter.convertException (/app/node_modules/@mikro-orm/core/platforms/ExceptionConverter.js:8:16) at MongoExceptionConverter.convertException (/app/node_modules/@mikro-orm/mongodb/MongoExceptionConverter.js:17:22) at MongoDriver.convertException (/app/node_modules/@mikro-orm/core/drivers/DatabaseDriver.js:345:54) at /app/node_modules/@mikro-orm/core/drivers/DatabaseDriver.js:349:24 at process.processTicksAndRejections (node:internal/process/task_queues:95:5) at async MongoDriver.find (/app/node_modules/@mikro-orm/mongodb/MongoDriver.js:49:21) at async MongoEntityManager.find (/app/node_modules/@mikro-orm/core/EntityManager.js:144:25) at async Promise.all (index 0) at async MongoEntityManager.findAndCount (/app/node_modules/@mikro-orm/core/EntityManager.js:383:35) at async MongoEntityManager.findByCursor (/app/node_modules/@mikro-orm/core/EntityManager.js:449:35) 

I notice strange behavior:
It work's with flatten key.

 orderBy: { 'details.date.arrival': query.sort, }

But didn't works with first option (I'm trying to sort with cursor)

 { first: 10, orderBy: { 'details.date.arrival': query.sort, } }

The query generated (we can see that order by isn't here):

 [query] db.getCollection('rides').find({ '$and': [ { 'details.date.arrival': { '$lte': ISODate('2024-09-20T15:13:30.758Z') }, 'details.date.departure': { '$gte': ISODate('2024-09-05T15:13:30.758Z') } } ] }, {}).limit(11).toArray(); 

As far as I debugged, I think that there is an issue here:

mikro-orm/packages/core/src/utils/Cursor.ts

Line 185 in 8b30ae2

const prop = meta.properties[key];

=> the properties for the fields is like details_datearrival but the key is details.date.arrival.

Reproduction

import { Embeddable, Embedded, Entity, MikroORM, PrimaryKey, Property, QueryOrder, } from '@mikro-orm/mongodb'; import { MongoMemoryServer } from 'mongodb-memory-server'; @Embeddable() export class RideDetailsDateModel { @Property() arrival: Date; @Property() departure: Date; constructor(arrival: Date, departure: Date) { this.arrival = arrival; this.departure = departure; } } @Embeddable() export class RideDetailsModel { @Embedded({ object: true }) date: RideDetailsDateModel; } @Entity({ collection: 'rides' }) export class RideModel { @PrimaryKey() _id!: number; @Embedded({ object: true }) details: RideDetailsModel; } let orm: MikroORM; let mongodb: MongoMemoryServer; beforeAll(async () => { mongodb = await MongoMemoryServer.create(); orm = await MikroORM.init({ allowGlobalContext: true, // only for testing clientUrl: `${mongodb.getUri()}mikro`, debug: ['query', 'query-params'], entities: [RideModel, RideDetailsModel, RideDetailsDateModel], }); await orm.schema.refreshDatabase(); }); afterAll(async () => { await mongodb.stop(); await orm.close(true); }); test('basic CRUD example', async () => { orm.em.create(RideModel, { details: { date: { arrival: new Date(2024, 1, 2), departure: new Date(2024, 1, 1) }, }, }); orm.em.create(RideModel, { details: { date: { arrival: new Date(2024, 1, 4), departure: new Date(2024, 1, 3) }, }, }); orm.em.create(RideModel, { details: { date: { arrival: new Date(2024, 1, 6), departure: new Date(2024, 1, 5) }, }, }); orm.em.create(RideModel, { details: { date: { arrival: new Date(2024, 1, 8), departure: new Date(2024, 1, 7) }, }, }); await orm.em.flush(); orm.em.clear(); const rides = await orm.em.findByCursor( RideModel, {}, { orderBy: { details: { date: { departure: QueryOrder.ASC, }, }, }, }, ); expect(rides.items[0].details.date).toStrictEqual(new Date(2024, 1, 1)); });

What driver are you using?

@mikro-orm/mongodb

MikroORM version

6.3.8

Node.js version

20

Operating system

node:20 docker image

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 Discord.
• The provided reproduction is a minimal reproducible example of the bug.

[B4nan]

Ups, got confused with your partially working workaround with dot paths, since that is not what you should be doing and will fail with inlined mode, and when trying it out I used an inlined embedded property, which works just fine. You are correct that with object embedded property it's failing the way you mentioned, I believe that is the main thing that needs to be solved. And yeah, I also completely missed your reproduction 🤦 I guess its too hot in here :P

[B4nan]

This will help with the dot paths 2a9ffa3

[Trobyss]

Wow so speed!

I'm going to try this later today and I come back to you :)

Thanks!

[B4nan]

fyi the cursor pagination is still broken, this only fixed the ordering, not the cursor definition

[Trobyss]

Oh yep, did you plan to investigate / fix it soon or do you need some helps ?

[B4nan]

This is actually quite hard to support, I think I am 80% there, but it takes a lot of time.