feat: append metadata to MongoClient

Author: RaschidJFR

spec/GridFSBucketStorageAdapter.spec.js

@@ -1,6 +1,7 @@
 const GridFSBucketAdapter = require('../lib/Adapters/Files/GridFSBucketAdapter')
   .GridFSBucketAdapter;
 const { randomString } = require('../lib/cryptoUtils');
+const { MongoClient } = require('mongodb');
 const databaseURI = 'mongodb://localhost:27017/parse';
 const request = require('../lib/request');
 
@@ -475,4 +476,16 @@ describe_only_db('mongo')('GridFSBucket', () => {
       expect(e.message).toEqual('Client must be connected before running operations');
     }
   });
+
+  it('pass metadata to MongoClient', async () => {
+    const pkg = require('../package.json');
+    spyOn(MongoClient.prototype, 'appendMetadata').and.callThrough();
+
+    const gfsAdapter = new GridFSBucketAdapter(databaseURI);
+    await gfsAdapter._connect();
+    expect(MongoClient.prototype.appendMetadata).toHaveBeenCalledWith({
+      name: 'Parse Server',
+      version: pkg.version,
+    });
+  });
 });

spec/MongoStorageAdapter.spec.js

@@ -449,6 +449,18 @@ describe_only_db('mongo')('MongoStorageAdapter', () => {
     expect(schemaAfterDeletion.fields.test).toBeUndefined();
   });
 
+  it('pass metadata to MongoClient', async () => {
+    const pkg = require('../package.json');
+    spyOn(MongoClient.prototype, 'appendMetadata').and.callThrough();
+
+    const adapter = new MongoStorageAdapter({ uri: databaseURI });
+    await adapter.connect();
+    expect(adapter.client.appendMetadata).toHaveBeenCalledWith({
+      name: 'Parse Server',
+      version: pkg.version,
+    });
+  });
+
   if (process.env.MONGODB_TOPOLOGY === 'replicaset') {
     describe('transactions', () => {
       const headers = {

src/Adapters/Files/GridFSBucketAdapter.js

@@ -10,6 +10,7 @@
 import { MongoClient, GridFSBucket, Db } from 'mongodb';
 import { FilesAdapter, validateFilename } from './FilesAdapter';
 import defaults, { ParseServerDatabaseOptions } from '../../defaults';
+import pkg from '../../../package.json';
 const crypto = require('crypto');
 
 export class GridFSBucketAdapter extends FilesAdapter {
@@ -47,6 +48,10 @@ export class GridFSBucketAdapter extends FilesAdapter {
     if (!this._connectionPromise) {
       this._connectionPromise = MongoClient.connect(this._databaseURI, this._mongoOptions).then(
         client => {
+          client.appendMetadata?.({
+            name: 'Parse Server',
+            version: pkg.version,
+          });
           this._client = client;
           return client.db(client.s.options.dbName);
         }

src/Adapters/Storage/Mongo/MongoStorageAdapter.js

@@ -19,6 +19,7 @@ import _ from 'lodash';
 import defaults, { ParseServerDatabaseOptions } from '../../../defaults';
 import logger from '../../../logger';
 import Utils from '../../../Utils';
+import pkg from '../../../../package.json';
 
 // @flow-disable-next
 const mongodb = require('mongodb');
@@ -184,6 +185,10 @@ export class MongoStorageAdapter implements StorageAdapter {
         // Starting mongoDB 3.0, the MongoClient.connect don't return a DB anymore but a client
         // Fortunately, we can get back the options and use them to select the proper DB.
         // https://github.com/mongodb/node-mongodb-native/blob/2c35d76f08574225b8db02d7bef687123e6bb018/lib/mongo_client.js#L885
+        client.appendMetadata?.({
+          name: 'Parse Server',
+          version: pkg.version,
+        });
         const options = client.s.options;
         const database = client.db(options.dbName);
         if (!database) {