fix(database): gRPC findMany() empty sort handling (#810)

* fix(database): gRPC findMany() empty sort handling This issue was caused by gRPC server implementations not allowing for undefined object values. According to the gRPC spec, any optional fields that are omitted from the request are to be coalesced with their respective type's default value. For objects, that would be an empty object. * fix(database): mongoose/sequelize schema findMany() sort types * fix(database): sequelize parseStringToQuery() arg type not accepting null queries
ConduitPlatform · Nov 22, 2023 · 3b8ae1f · 3b8ae1f
1 parent 630c2c1
commit 3b8ae1f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 15 deletions.
diff --git a/modules/database/src/Database.ts b/modules/database/src/Database.ts
@@ -343,16 +343,19 @@ export default class DatabaseModule extends ManagedModule<void> {
   async findMany(call: GrpcRequest<FindRequest>, callback: GrpcResponse<QueryResponse>) {
     try {
       const { skip, limit, select, populate } = call.request;
-      const sort = call.request.sort as { [key: string]: -1 | 1 | number } | undefined;
-      if (sort) {
-        Object.keys(sort).forEach(field => {
-          if (sort[field] !== 1 && sort[field] !== -1) {
+      const _sort = call.request.sort as { [field: string]: -1 | 1 | number };
+      // gRPC undefined object field values fall back to  empty objects...
+      let sort: { [field: string]: -1 | 1 } | undefined = undefined;
+      if (_sort && !!Object.keys(_sort).length) {
+        Object.keys(_sort).forEach(field => {
+          if (_sort[field] !== 1 && _sort[field] !== -1) {
             return callback({
               code: status.INVALID_ARGUMENT,
-              message: `Invalid sort field value "${sort[field]}" in field "${field}", should be -1 or 1.`,
+              message: `Invalid sort field value "${_sort[field]}" in field "${field}", should be -1 or 1.`,
             });
           }
         });
+        sort = _sort as { [field: string]: -1 | 1 };
       }
       const schemaAdapter = this._activeAdapter.getSchemaModel(call.request.schemaName);
       const docs = await schemaAdapter.model.findMany(call.request.query, {

diff --git a/modules/database/src/adapters/mongoose-adapter/MongooseSchema.ts b/modules/database/src/adapters/mongoose-adapter/MongooseSchema.ts
@@ -262,7 +262,7 @@ export class MongooseSchema extends SchemaAdapter<Model<any>> {
       skip?: number;
       limit?: number;
       select?: string;
-      sort?: any;
+      sort?: { [field: string]: -1 | 1 };
       populate?: string[];
       userId?: string;
       scope?: string;
@@ -282,16 +282,16 @@ export class MongooseSchema extends SchemaAdapter<Model<any>> {
     }
     let finalQuery = this.model.find(filter, options?.select);
     if (!isNil(options?.skip) && !modified) {
-      finalQuery = finalQuery.skip(options?.skip!);
+      finalQuery = finalQuery.skip(options!.skip!);
     }
     if (!isNil(options?.limit) && !modified) {
-      finalQuery = finalQuery.limit(options?.limit!);
+      finalQuery = finalQuery.limit(options!.limit!);
     }
     if (!isNil(options?.populate)) {
-      finalQuery = this.populate(finalQuery, options?.populate ?? []);
+      finalQuery = this.populate(finalQuery, options!.populate ?? []);
     }
     if (!isNil(options?.sort)) {
-      finalQuery = finalQuery.sort(this.parseSort(options?.sort));
+      finalQuery = finalQuery.sort(this.parseSort(options!.sort));
     }
     return finalQuery.lean().exec();
   }

diff --git a/modules/database/src/adapters/sequelize-adapter/SequelizeSchema.ts b/modules/database/src/adapters/sequelize-adapter/SequelizeSchema.ts
@@ -395,7 +395,7 @@ export class SequelizeSchema extends SchemaAdapter<ModelStatic<any>> {
       skip?: number;
       limit?: number;
       select?: string;
-      sort?: any;
+      sort?: { [field: string]: -1 | 1 };
       populate?: string[];
       userId?: string;
       scope?: string;
@@ -432,13 +432,13 @@ export class SequelizeSchema extends SchemaAdapter<ModelStatic<any>> {
       ),
     };
     if (!isNil(options?.skip) && !modified) {
-      findOptions.offset = options?.skip;
+      findOptions.offset = options!.skip;
     }
     if (!isNil(options?.limit) && !modified) {
-      findOptions.limit = options?.limit;
+      findOptions.limit = options!.limit;
     }
     if (!isNil(options?.sort)) {
-      findOptions.order = this.parseSort(options?.sort);
+      findOptions.order = this.parseSort(options!.sort);
     }
 
     return this.model.findAll(findOptions).then(docs => {
@@ -662,7 +662,7 @@ export class SequelizeSchema extends SchemaAdapter<ModelStatic<any>> {
   }
 
   parseStringToQuery(
-    query: Query | SingleDocQuery | MultiDocQuery,
+    query: Query | SingleDocQuery | MultiDocQuery | null,
   ): ParsedQuery | ParsedQuery[] {
     return typeof query === 'string' ? JSON.parse(query) : query;
   }