$in query throws validation error

[ericuldall]

Validation Errors

{
    instancePath: '/lists',
    schemaPath: '#/properties/lists/anyOf/0/type',
    keyword: 'type',
    params: { type: 'array' },
    message: 'must be array'
  },
  {
    instancePath: '/lists/$in/0',
    schemaPath: '#/properties/lists/anyOf/1/properties/%24in/items/type',
    keyword: 'type',
    params: { type: 'array' },
    message: 'must be array'
  },
  {
    instancePath: '/lists',
    schemaPath: '#/properties/lists/anyOf',
    keyword: 'anyOf',
    params: {},
    message: 'must match a schema in anyOf'
  }

Schema for field lists

lists: Type.Array(ObjectIdSchema())

Logged Query that causes the error

{
  userId: new ObjectId('649ccf34ca1c3d657ef5b746'),
  '$limit': 4,
  '$sort': { createdAt: -1 },
  lists: { '$in': [ new ObjectId('6503a31680438f460904ba7a') ] }
}

$in is included in the operators. Any ideas?

[daffl]

Is lists defined as an Object array?

[ericuldall]

lists is an array of ObjectID's...

Example:

lists: [ new ObjectId('abcd1234'), ... ]

This basically stores reference of lists that saved items are organized into.

[ericuldall]

lists: Type.Array(ObjectIdSchema())

[daffl]

The problem is that the query syntax $in is only supposed to work with primitives and not arrays. MongoDB does allow to query arrays this way but e.g. SQL does not. The best way is probably to declare that property and what you want to query explicitly in the querySchema (or just set it to Type.Object() which I believe should also work).

[ericuldall]

Yes, I had originally done that but it felt hacky so I wanted to get an idea if that current behavior was a bug or a feature.

[ericuldall]

The fix:

// Schema for allowed query properties
const listTypeFixes = Type.Optional(Type.Union([
  ObjectIdSchema(),
  Type.Array(ObjectIdSchema()),
  Type.Object({ $nin: Type.Array(ObjectIdSchema()) }),
  Type.Object({ $in: Type.Array(ObjectIdSchema()) }),
]));
export const myServiceQueryProperties = Type.Pick(myServiceSchema, ['lists'])
export const myServiceQuerySchema = Type.Intersect(
  [
    querySyntax(myServiceQueryProperties),
    // ADD FIX HERE
    Type.Object({
      lists: listTypeFixes,
      $and: Type.Array(Type.Object({ // i'm using an $and for some so I added this too
        lists: listTypeFixes
      }))
    }, { additionalProperties: false })
  ],
  { additionalProperties: false }
)