feat: Add support for MongoDB query comment (#8928)

src/Adapters/Storage/Mongo/MongoCollection.js

@@ -15,7 +15,18 @@ export default class MongoCollection {
   // idea. Or even if this behavior is a good idea.
   find(
     query,
-    { skip, limit, sort, keys, maxTimeMS, readPreference, hint, caseInsensitive, explain } = {}
+    {
+      skip,
+      limit,
+      sort,
+      keys,
+      maxTimeMS,
+      readPreference,
+      hint,
+      caseInsensitive,
+      explain,
+      comment,
+    } = {}
   ) {
     // Support for Full Text Search - $text
     if (keys && keys.$score) {
@@ -32,6 +43,7 @@ export default class MongoCollection {
       hint,
       caseInsensitive,
       explain,
+      comment,
     }).catch(error => {
       // Check for "no geoindex" error
       if (error.code != 17007 && !error.message.match(/unable to find index for .geoNear/)) {
@@ -60,6 +72,7 @@ export default class MongoCollection {
               hint,
               caseInsensitive,
               explain,
+              comment,
             })
           )
       );
@@ -75,7 +88,18 @@ export default class MongoCollection {
 
   _rawFind(
     query,
-    { skip, limit, sort, keys, maxTimeMS, readPreference, hint, caseInsensitive, explain } = {}
+    {
+      skip,
+      limit,
+      sort,
+      keys,
+      maxTimeMS,
+      readPreference,
+      hint,
+      caseInsensitive,
+      explain,
+      comment,
+    } = {}
   ) {
     let findOperation = this._mongoCollection.find(query, {
       skip,
@@ -83,6 +107,7 @@ export default class MongoCollection {
       sort,
       readPreference,
       hint,
+      comment,
     });
 
     if (keys) {
@@ -100,7 +125,7 @@ export default class MongoCollection {
     return explain ? findOperation.explain(explain) : findOperation.toArray();
   }
 
-  count(query, { skip, limit, sort, maxTimeMS, readPreference, hint } = {}) {
+  count(query, { skip, limit, sort, maxTimeMS, readPreference, hint, comment } = {}) {
     // If query is empty, then use estimatedDocumentCount instead.
     // This is due to countDocuments performing a scan,
     // which greatly increases execution time when being run on large collections.
@@ -118,6 +143,7 @@ export default class MongoCollection {
       maxTimeMS,
       readPreference,
       hint,
+      comment,
     });
 
     return countOperation;
@@ -127,9 +153,9 @@ export default class MongoCollection {
     return this._mongoCollection.distinct(field, query);
   }
 
-  aggregate(pipeline, { maxTimeMS, readPreference, hint, explain } = {}) {
+  aggregate(pipeline, { maxTimeMS, readPreference, hint, explain, comment } = {}) {
     return this._mongoCollection
-      .aggregate(pipeline, { maxTimeMS, readPreference, hint, explain })
+      .aggregate(pipeline, { maxTimeMS, readPreference, hint, explain, comment })
       .toArray();
   }
 

src/Adapters/Storage/Mongo/MongoStorageAdapter.js

@@ -603,7 +603,17 @@ export class MongoStorageAdapter implements StorageAdapter {
     className: string,
     schema: SchemaType,
     query: QueryType,
-    { skip, limit, sort, keys, readPreference, hint, caseInsensitive, explain }: QueryOptions
+    {
+      skip,
+      limit,
+      sort,
+      keys,
+      readPreference,
+      hint,
+      caseInsensitive,
+      explain,
+      comment,
+    }: QueryOptions
   ): Promise<any> {
     validateExplainValue(explain);
     schema = convertParseSchemaToMongoSchema(schema);
@@ -646,6 +656,7 @@ export class MongoStorageAdapter implements StorageAdapter {
           hint,
           caseInsensitive,
           explain,
+          comment,
         })
       )
       .then(objects => {
@@ -735,7 +746,9 @@ export class MongoStorageAdapter implements StorageAdapter {
     schema: SchemaType,
     query: QueryType,
     readPreference: ?string,
-    hint: ?mixed
+    _estimate: ?boolean,
+    hint: ?mixed,
+    comment: ?string
   ) {
     schema = convertParseSchemaToMongoSchema(schema);
     readPreference = this._parseReadPreference(readPreference);
@@ -745,6 +758,7 @@ export class MongoStorageAdapter implements StorageAdapter {
           maxTimeMS: this._maxTimeMS,
           readPreference,
           hint,
+          comment,
         })
       )
       .catch(err => this.handleError(err));
@@ -777,7 +791,8 @@ export class MongoStorageAdapter implements StorageAdapter {
     pipeline: any,
     readPreference: ?string,
     hint: ?mixed,
-    explain?: boolean
+    explain?: boolean,
+    comment: ?string
   ) {
     validateExplainValue(explain);
     let isPointerField = false;
@@ -811,6 +826,7 @@ export class MongoStorageAdapter implements StorageAdapter {
           maxTimeMS: this._maxTimeMS,
           hint,
           explain,
+          comment,
         })
       )
       .then(results => {

src/Adapters/Storage/StorageAdapter.js

@@ -19,6 +19,7 @@ export type QueryOptions = {
   caseInsensitive?: boolean,
   action?: string,
   addsField?: boolean,
+  comment?: string,
 };
 
 export type UpdateQueryOptions = {
@@ -97,7 +98,8 @@ export interface StorageAdapter {
     query: QueryType,
     readPreference?: string,
     estimate?: boolean,
-    hint?: mixed
+    hint?: mixed,
+    comment?: string
   ): Promise<number>;
   distinct(
     className: string,
@@ -111,7 +113,8 @@ export interface StorageAdapter {
     pipeline: any,
     readPreference: ?string,
     hint: ?mixed,
-    explain?: boolean
+    explain?: boolean,
+    comment?: string
   ): Promise<any>;
   performInitialization(options: ?any): Promise<void>;
   watch(callback: () => void): void;

src/Controllers/DatabaseController.js

@@ -1188,6 +1188,7 @@ class DatabaseController {
       hint,
       caseInsensitive = false,
       explain,
+      comment,
     }: any = {},
     auth: any = {},
     validSchemaController: SchemaController.SchemaController
@@ -1237,6 +1238,7 @@ class DatabaseController {
             hint,
             caseInsensitive: this.options.enableCollationCaseComparison ? false : caseInsensitive,
             explain,
+            comment,
           };
           Object.keys(sort).forEach(fieldName => {
             if (fieldName.match(/^authData\.([a-zA-Z0-9_]+)\.id$/)) {
@@ -1306,7 +1308,8 @@ class DatabaseController {
                     query,
                     readPreference,
                     undefined,
-                    hint
+                    hint,
+                    comment
                   );
                 }
               } else if (distinct) {
@@ -1325,7 +1328,8 @@ class DatabaseController {
                     pipeline,
                     readPreference,
                     hint,
-                    explain
+                    explain,
+                    comment
                   );
                 }
               } else if (explain) {

src/RestQuery.js

@@ -212,6 +212,7 @@ function _UnsafeRestQuery(
       case 'skip':
       case 'limit':
       case 'readPreference':
+      case 'comment':
         this.findOptions[option] = restOptions[option];
         break;
       case 'order':

src/Routers/AggregateRouter.js

@@ -19,6 +19,10 @@ export class AggregateRouter extends ClassesRouter {
       options.explain = body.explain;
       delete body.explain;
     }
+    if (body.comment) {
+      options.comment = body.comment;
+      delete body.comment;
+    }
     if (body.readPreference) {
       options.readPreference = body.readPreference;
       delete body.readPreference;

src/Routers/ClassesRouter.js

@@ -166,6 +166,7 @@ export class ClassesRouter extends PromiseRouter {
       'subqueryReadPreference',
       'hint',
       'explain',
+      'comment',
     ];
 
     for (const key of Object.keys(body)) {
@@ -215,6 +216,9 @@ export class ClassesRouter extends PromiseRouter {
     if (body.explain) {
       options.explain = body.explain;
     }
+    if (body.comment && typeof body.comment === 'string') {
+      options.comment = body.comment;
+    }
     return options;
   }
 

src/triggers.js

@@ -576,6 +576,10 @@ export function maybeRunQueryTrigger(
           restOptions = restOptions || {};
           restOptions.hint = jsonQuery.hint;
         }
+        if (jsonQuery.comment) {
+          restOptions = restOptions || {};
+          restOptions.comment = jsonQuery.comment;
+        }
         if (requestObject.readPreference) {
           restOptions = restOptions || {};
           restOptions.readPreference = requestObject.readPreference;